xcsh_forward_proxy_policy (Data Source)

Retrieves information about a Forward Proxy Policy resource in F5 Distributed Cloud for forward proxy policy specification. configuration. This is a read-only data source.

~> Note: For more information, see the Forward Proxy Policy API documentation.

Example Usage

# ForwardProxyPolicy Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing ForwardProxyPolicy by name
data "xcsh_forward_proxy_policy" "example" {
  name      = "example-forward-proxy-policy"
  namespace = "staging"
}

output "forward_proxy_policy_id" {
  value = data.xcsh_forward_proxy_policy.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 ForwardProxyPolicy

• namespace - Required String
Namespace where the ForwardProxyPolicy exists

Attributes Reference

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

• allow_all - Optional Object
Enable this option

• allow_list - Optional String
URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)

• annotations - Optional Map
Annotations applied to this resource

• any_proxy - Optional Object
Enable this option

• deny_list - Optional String
URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)

• description - Optional String
Description of the ForwardProxyPolicy

• drp_http_connect - Optional Object
Configuration parameter for drp HTTP connect

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• network_connector - 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

• proxy_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

• rule_list - Optional String
Custom Rule List. List of custom rules

• default_action_allow - Optional Object
Enable this option

• default_action_deny - Optional Object
Enable this option

• default_action_next_policy - Optional Object
Policy configuration for this feature

• dest_list - Optional List
L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI

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

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

• ipv6_prefixes - Optional List
IPv6 Prefixes. Destination IPv6 prefixes

• port_ranges - Optional String
String containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by ’-’

• prefixes - Optional List
IPv4 Prefixes. Destination IPv4 prefixes

• 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’

• 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’

• default_action_allow - Optional Object
Enable this option

• default_action_deny - Optional Object
Enable this option

• default_action_next_policy - Optional Object
Policy configuration for this feature

• dest_list - Optional List
L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI

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

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

• ipv6_prefixes - Optional List
IPv6 Prefixes. Destination IPv6 prefixes

• port_ranges - Optional String
String containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by ’-’

• prefixes - Optional List
IPv4 Prefixes. Destination IPv4 prefixes

• 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’

• 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

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

• rules - Optional List
Custom Rule List. List of custom rules

• action - Optional String Defaults to DENY
Possible values are DENY, ALLOW, NEXT_POLICY
[Enum: DENY|ALLOW|NEXT_POLICY] The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds forward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to

• all_destinations - Optional Object
Configuration parameter for all destinations

• all_sources - Optional Object
Configuration parameter for all sources

• dst_asn_list - Optional String
Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer

• dst_asn_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

• dst_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

• dst_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

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

• 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

• no_http_connect_port - Optional Object
Enable this option

• port_matcher - Optional String
Port matcher specifies a list of port ranges as match criteria. The match is considered successful if the input port falls within any of the port ranges. The result of the match is inverted if invert_matcher is true

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

• tls_list - Optional String
DomainListType

• url_category_list - Optional String
URL Category List Type. List of URL categories

• as_numbers - Optional List
Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer

• 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

• 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

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