xcsh_policy_based_routing (Data Source)

Retrieves information about a Policy Based Routing resource in F5 Distributed Cloud for network policy based routing create specification. configuration. This is a read-only data source.

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# PolicyBasedRouting Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing PolicyBasedRouting by name
data "xcsh_policy_based_routing" "example" {
  name      = "example-policy-based-routing"
  namespace = "staging"
}

output "policy_based_routing_id" {
  value = data.xcsh_policy_based_routing.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the PolicyBasedRouting

• namespace - Required String
Namespace where the PolicyBasedRouting exists

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the PolicyBasedRouting

• forward_proxy_pbr - Optional String
Configuration parameter for forward proxy pbr

• forwarding_class_list - Optional List
Ordered list of forwarding Class to be used if source application match and no rule match

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• network_pbr - Optional String
Configuration parameter for network pbr

• forward_proxy_pbr_rules - Optional List
L3/L4 routing rules. Network(L3/L4) routing policy rules

• all_destinations - Optional Object
Configuration parameter for all destinations

• all_sources - Optional Object
Configuration parameter for all sources

• forwarding_class_list - Optional List
Ordered list of forwarding Class to be used if no rule match

• http_list - Optional String
URLListType

• ip_prefix_set - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• label_selector - Optional String
Type can be used to establish a ‘selector reference’ from one object(called selector) to a set of other objects(called selectees) based on the value of expressions. A label selector is a label query over a set of resources. An empty label selector matches all objects

• metadata - Optional String
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create

• prefix_list - Optional String
List of IPv4 prefixes that represent an endpoint

• tls_list - Optional String
DomainListType

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• http_list - Optional List
HTTP URLs. URLs for HTTP connections

• any_path - Optional Object
Enable this option

• exact_value - Optional String
Exact domain name

• path_exact_value - Optional String
Exact Path to match

• path_prefix_value - Optional String
Prefix of Path e.g ‘/abc/xyz’ will match ‘/abc/xyz/.*’

• path_regex_value - Optional String
Regular Expression value for the Path to match

• regex_value - Optional String
Regular Expression value for the domain name

• suffix_value - Optional String
Suffix of domain names e.g ‘xyz.com’ will match ‘*.xyz.com’

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• expressions - Optional List
Expressions contains the Kubernetes style label expression for selections

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• prefixes - Optional List
List of IPv4 prefixes that represent an endpoint

• tls_list - Optional List
TLS Domains. Domains in SNI for TLS connections

• exact_value - Optional String
Exact domain name

• regex_value - Optional String
Regular Expression value for the domain name

• suffix_value - Optional String
Suffix of domain name e.g ‘xyz.com’ will match ‘*.xyz.com’ and ‘xyz.com’

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• any - Optional Object
Enable this option

• network_pbr_rules - Optional List
L3/L4 Destination Routing Rules. Network(L3/L4) routing policy rule

• prefix_list - Optional String
List of IPv4 prefixes that represent an endpoint

• expressions - Optional List
Expressions contains the Kubernetes style label expression for selections

• all_tcp_traffic - Optional Object
Configuration parameter for all TCP traffic

• all_traffic - Optional Object
Configuration parameter for all traffic

• all_udp_traffic - Optional Object
Configuration parameter for all UDP traffic

• any - Optional Object
Enable this option

• applications - Optional String
Configuration parameter for applications

• dns_name - Optional String
Resolve hostname to GET the IP

• forwarding_class_list - Optional List
Ordered list of forwarding Class to be used if rule match

• ip_prefix_set - Optional String
List of references to ip_prefix_set objects

• prefix_list - Optional String
List of IPv4 prefixes that represent an endpoint

• protocol_port_range - Optional String
Protocol and Port. Protocol and Port ranges

• applications - Optional List Defaults to APPLICATION_HTTP
Possible values are APPLICATION_HTTP, APPLICATION_HTTPS, APPLICATION_SNMP, APPLICATION_DNS
[Enum: APPLICATION_HTTP|APPLICATION_HTTPS|APPLICATION_SNMP|APPLICATION_DNS] Application Protocols. Application protocols like HTTP, SNMP

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• ref - Optional List
List of references to ip_prefix_set objects

• kind - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. ‘route’)

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

• uid - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• prefixes - Optional List
List of IPv4 prefixes that represent an endpoint

• port_ranges - Optional List
List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192

• protocol - Optional String
Possible values are ALL, TCP, UDP, ICMP
[Enum: ALL|TCP|UDP|ICMP] Protocol in IP packet to be used as match criteria Values are TCP, UDP, and ICMP

• prefixes - Optional List
List of IPv4 prefixes that represent an endpoint

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
`name`	String	Name of the referenced object
`namespace`	String	Namespace containing the referenced object
`tenant`	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
`LOWER_CASE`	Convert to lowercase
`UPPER_CASE`	Convert to uppercase
`BASE64_DECODE`	Decodebase64 content
`NORMALIZE_PATH`	Normalize URL path
`REMOVE_WHITESPACE`	Remove whitespace characters
`URL_DECODE`	Decode URL-encoded characters
`TRIM_LEFT`	Trim leading whitespace
`TRIM_RIGHT`	Trim trailing whitespace
`TRIM`	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
`ANY`	Match any HTTP method
`GET`	HTTP GET request
`HEAD`	HTTP HEAD request
`POST`	HTTP POST request
`PUT`	HTTP PUT request
`DELETE`	HTTP DELETE request
`CONNECT`	HTTP CONNECT request
`OPTIONS`	HTTP OPTIONS request
`TRACE`	HTTP TRACE request
`PATCH`	HTTP PATCH request
`COPY`	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
`TLS_FINGERPRINT_NONE`	No fingerprint matching
`ANY_MALICIOUS_FINGERPRINT`	Match any known malicious fingerprint
`ADWARE`	Adware-associated fingerprints
`DRIDEX`	Dridex malware fingerprints
`GOOTKIT`	Gootkit malware fingerprints
`RANSOMWARE`	Ransomware-associated fingerprints
`TRICKBOT`	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
`SPAM_SOURCES`	Known spam sources
`WINDOWS_EXPLOITS`	Windows exploit sources
`WEB_ATTACKS`	Web attack sources
`BOTNETS`	Known botnet IPs
`SCANNERS`	Network scanner IPs
`REPUTATION`	Poor reputation IPs
`PHISHING`	Phishing-related IPs
`PROXY`	Anonymous proxy IPs
`MOBILE_THREATS`	Mobile threat sources
`TOR_PROXY`	Tor exit nodes
`DENIAL_OF_SERVICE`	DoS attack sources
`NETWORK`	Known bad network ranges