f5xc_policy_based_routing Resource - terraform-provider-f5xc

f5xc_policy_based_routing (Resource)

Manages a Policy Based Routing resource in F5 Distributed Cloud for network policy based routing create specification. configuration.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# Policy Based Routing Resource Example
# Manages a Policy Based Routing resource in F5 Distributed Cloud for network policy based routing create specification. configuration.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic Policy Based Routing configuration
resource "f5xc_policy_based_routing" "example" {
  name      = "example-policy-based-routing"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Resource-specific configuration
  # Ordered list of forwarding Class to be used if source app...
  forwarding_class_list {
    # Configure forwarding_class_list settings
  }
  # [OneOf: forward_proxy_pbr, network_pbr] Configuration par...
  forward_proxy_pbr {
    # Configure forward_proxy_pbr settings
  }
  # L3/L4 routing rules. Network(L3/L4) routing policy rules.
  forward_proxy_pbr_rules {
    # Configure forward_proxy_pbr_rules settings
  }
}

Argument Reference

🔶 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 Policy Based Routing. Must be unique within the namespace

• namespace - Required String
Namespace where the Policy Based Routing will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

-> One of the following: • forward_proxy_pbr - Optional Block
Configuration parameter for forward proxy pbr
See Forward Proxy Pbr below for details.

• network_pbr - Optional Block
Configuration parameter for network pbr
See Network Pbr below for details.

• forwarding_class_list - Optional Block
Ordered list of forwarding Class to be used if source application match and no rule match
See Forwarding Class List below for details.

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

Forward Proxy Pbr

A forward_proxy_pbr block supports the following:

• forward_proxy_pbr_rules - Optional Block
L3/L4 routing rules. Network(L3/L4) routing policy rules
See Forward Proxy Pbr Rules below.

Forward Proxy Pbr Forward Proxy Pbr Rules

A forward_proxy_pbr_rules block (within forward_proxy_pbr) supports the following:

• all_destinations - Optional Block
Configuration parameter for all destinations

• all_sources - Optional Block
Configuration parameter for all sources

• forwarding_class_list - Optional Block
Ordered list of forwarding Class to be used if no rule match
See Forwarding Class List below.

• http_list - Optional Block
URLListType
See HTTP List below.

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

• label_selector - Optional Block
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
See Label Selector below.

• metadata - Optional Block
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
See Metadata below.

• prefix_list - Optional Block
List of IPv4 prefixes that represent an endpoint
See Prefix List below.

• tls_list - Optional Block
DomainListType
See TLS List below.

Forward Proxy Pbr Forward Proxy Pbr Rules Forwarding Class List

Deeply nested List block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules HTTP List

Deeply nested List block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules HTTP List HTTP List

Deeply nested List block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules IP Prefix Set

Deeply nested Set block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules Label Selector

Deeply nested Selector block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules Metadata

Deeply nested Metadata block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules Prefix List

Deeply nested List block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules TLS List

Deeply nested List block collapsed for readability.

Forward Proxy Pbr Forward Proxy Pbr Rules TLS List TLS List

Deeply nested List block collapsed for readability.

Forwarding Class List

A forwarding_class_list block supports the following:

• 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

Network Pbr

A network_pbr block supports the following:

• any - Optional Block
Enable this option

• network_pbr_rules - Optional Block
L3/L4 Destination Routing Rules. Network(L3/L4) routing policy rule
See Network Pbr Rules below.

• prefix_list - Optional Block
List of IPv4 prefixes that represent an endpoint
See Prefix List below.

Network Pbr Label Selector

A label_selector block (within network_pbr) supports the following:

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

Network Pbr Network Pbr Rules

A network_pbr_rules block (within network_pbr) supports the following:

• all_tcp_traffic - Optional Block
Configuration parameter for all TCP traffic

• all_traffic - Optional Block
Configuration parameter for all traffic

• all_udp_traffic - Optional Block
Configuration parameter for all UDP traffic

• any - Optional Block
Enable this option

• applications - Optional Block
Configuration parameter for applications
See Applications below.

• dns_name - Optional String
Resolve hostname to GET the IP

• forwarding_class_list - Optional Block
Ordered list of forwarding Class to be used if rule match
See Forwarding Class List below.

• ip_prefix_set - Optional Block
List of references to ip_prefix_set objects
See IP Prefix Set below.

• prefix_list - Optional Block
List of IPv4 prefixes that represent an endpoint
See Prefix List below.

• protocol_port_range - Optional Block
Protocol and Port. Protocol and Port ranges
See Protocol Port Range below.

Network Pbr Network Pbr Rules Applications

An applications block (within network_pbr.network_pbr_rules) supports the following:

• 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

Network Pbr Network Pbr Rules Forwarding Class List

Deeply nested List block collapsed for readability.

Network Pbr Network Pbr Rules IP Prefix Set

Deeply nested Set block collapsed for readability.

Network Pbr Network Pbr Rules IP Prefix Set Ref

Deeply nested Ref block collapsed for readability.

Network Pbr Network Pbr Rules Metadata

A metadata block (within network_pbr.network_pbr_rules) supports the following:

• 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

Network Pbr Network Pbr Rules Prefix List

A prefix_list block (within network_pbr.network_pbr_rules) supports the following:

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

Network Pbr Network Pbr Rules Protocol Port Range

Deeply nested Range block collapsed for readability.

Network Pbr Prefix List

A prefix_list block (within network_pbr) supports the following:

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

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

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

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_policy_based_routing.example system/example