xcsh_proxy (Data Source)

Retrieves information about a Proxy resource in F5 Distributed Cloud for tcp loadbalancer create specification. configuration. This is a read-only data source.

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

Example Usage

# Proxy Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing Proxy by name
data "xcsh_proxy" "example" {
  name      = "example-proxy"
  namespace = "staging"
}

output "proxy_id" {
  value = data.xcsh_proxy.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 Proxy

• namespace - Required String
Namespace where the Proxy exists

Attributes Reference

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

• active_forward_proxy_policies - Optional String
Ordered List of Forward Proxy Policies active

• annotations - Optional Map
Annotations applied to this resource

• connection_timeout - Optional Number Defaults to 2000 Specified in milliseconds
The timeout for new network connections to upstream server. The (2 seconds)

• description - Optional String
Description of the Proxy

• do_not_advertise - Optional Object
Configuration parameter for do not advertise

• dynamic_proxy - Optional String
Configuration parameter for dynamic proxy

• http_proxy - Optional String
HTTP Connect Proxy. Parameters for HTTP Connect Proxy

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• no_forward_proxy_policy - Optional Object
Policy configuration for this feature

• no_interception - Optional Object
Configuration parameter for no interception

• site_local_inside_network - Optional Object
Enable this option

• site_local_network - Optional Object
Enable this option

• site_virtual_sites - Optional String
Defines a way to advertise a VIP on specific sites

• tls_intercept - Optional String
Configuration to enable TLS interception

• forward_proxy_policies - Optional List
Ordered List of Forward Proxy Policies active

• 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

• disable_dns_masquerade - Optional Object
Configuration parameter for disable DNS masquerade

• domains - Optional List
List of Domains to be proxied. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: www.example.com. 2

• enable_dns_masquerade - Optional Object
Configuration parameter for enable DNS masquerade

• http_proxy - Optional String
Dynamic HTTP Proxy Type. Parameters for dynamic HTTP proxy

• https_proxy - Optional String
Configuration parameter for HTTPS proxy

• sni_proxy - Optional String
Dynamic SNI Proxy Type. Parameters for dynamic SNI proxy

• more_option - Optional String
Defines various OPTIONS to define a route

• buffer_policy - Optional String
Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config

• compression_params - Optional String
Enables loadbalancer to compress dispatched data from an upstream service upon client request. The content is compressed and then sent to the client with the appropriate headers if either response and request allow. Only GZIP compression is supported

• custom_errors - Optional Map
Map of integer error codes as keys and string values that can be used to provide custom HTTP pages for each error code. Key of the map can be either response code class or HTTP Error code. Response code classes for key is configured as follows 3 — for 3xx response code class 4 — for 4xx

• disable_default_error_pages - Optional Bool
Disable the use of default F5XC error pages

• disable_path_normalize - Optional Object
Enable this option

• enable_path_normalize - Optional Object
Enable this option

• idle_timeout - Optional Number
The amount of time that a stream can exist without upstream or downstream activity, in milliseconds. The stream is terminated with an HTTP 504 (Gateway Timeout) error code if no upstream response header has been received, otherwise the stream is reset

• max_request_header_size - Optional Number
The maximum request header size for downstream connections, in KiB. A HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size. If multiple load balancers share the same advertise_policy, the highest value configured across all such load balancers is used

• max_requests_per_connection - Optional Number
Sets the maximum number of requests a downstream client can send over a single connection to Envoy. Enter a value >=1 to define the request limit per connection

• no_request_limit_per_connection - Optional Object
Configuration parameter for no request limit per connection

• request_cookies_to_add - Optional List
Cookies are key-value pairs to be added to HTTP request being routed towards upstream. Cookies specified at this level are applied after cookies from matched Route are applied

• request_cookies_to_remove - Optional List
List of keys of Cookies to be removed from the HTTP request being sent towards upstream

• request_headers_to_add - Optional List
Headers are key-value pairs to be added to HTTP request being routed towards upstream. Headers specified at this level are applied after headers from matched Route are applied

• request_headers_to_remove - Optional List
List of keys of Headers to be removed from the HTTP request being sent towards upstream

• response_cookies_to_add - Optional List
Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream. Cookies specified at this level are applied after cookies from matched Route are applied

• response_cookies_to_remove - Optional List
List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed

• response_headers_to_add - Optional List
Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied after headers from matched Route are applied

• response_headers_to_remove - Optional List
List of keys of Headers to be removed from the HTTP response being sent towards downstream

• disabled - Optional Bool
Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host

• max_request_bytes - Optional Number
The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response

• content_length - Optional Number Defaults to 30
Minimum response length, in bytes, which will trigger compression. The

• content_type - Optional List
Set of strings that allows specifying which mime-types yield compression When this field is not defined, compression will be applied to the following mime-types: ‘application/JavaScript’ ‘application/JSON’, ‘application/xhtml+XML’ ‘image/svg+XML’ ‘text/CSS’ ‘text/HTML’ ‘text/plain’ ‘text/XML’

• disable_on_etag_header - Optional Bool
If true, disables compression when the response contains an etag header. When it is false, weak etags will be preserved and the ones that require strong validation will be removed

• remove_accept_encoding_header - Optional Bool
If true, removes accept-encoding from the request headers before dispatching it to the upstream so that responses do not GET compressed before reaching the filter

• name - Optional String
Name. Name of the cookie in Cookie header

• overwrite - Optional Bool Defaults to do
Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite

• secret_value - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• value - Optional String
Value of the Cookie header

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• store_provider - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• provider_ref - Optional String
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///

• url - Optional String
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding

• append - Optional Bool Defaults to do
Should the value be appended? If true, the value is appended to existing values. not append

• name - Optional String
Name. Name of the HTTP header

• secret_value - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• value - Optional String
Value of the HTTP header

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• add_domain - Optional String
Add domain attribute

• add_expiry - Optional String
Add expiry attribute

• add_httponly - Optional Object
Configuration parameter for add httponly

• add_partitioned - Optional Object
Configuration parameter for add partitioned

• add_path - Optional String
Add path attribute

• add_secure - Optional Object
Enable this option

• ignore_domain - Optional Object
Configuration parameter for ignore domain

• ignore_expiry - Optional Object
Configuration parameter for ignore expiry

• ignore_httponly - Optional Object
Configuration parameter for ignore httponly

• ignore_max_age - Optional Object
Configuration parameter for ignore max age

• ignore_partitioned - Optional Object
Configuration parameter for ignore partitioned

• ignore_path - Optional Object
Enable this option

• ignore_samesite - Optional Object
Enable this option

• ignore_secure - Optional Object
Enable this option

• ignore_value - Optional Object
Configuration parameter for ignore value

• max_age_value - Optional Number
Add max age attribute

• name - Optional String
Name. Name of the cookie in Cookie header

• overwrite - Optional Bool Defaults to do
Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite

• samesite_lax - Optional Object
Enable this option

• samesite_none - Optional Object
Enable this option

• samesite_strict - Optional Object
Enable this option

• secret_value - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• value - Optional String
Value of the Cookie header

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• append - Optional Bool Defaults to do
Should the value be appended? If true, the value is appended to existing values. not append

• name - Optional String
Name. Name of the HTTP header

• secret_value - Optional String
SecretType is used in an object to indicate a sensitive/confidential field

• value - Optional String
Value of the HTTP header

• blindfold_secret_info - Optional String
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management

• clear_secret_info - Optional String
ClearSecretInfoType specifies information about the Secret that is not encrypted

• decryption_provider - Optional String
Name of the Secret Management Access object that contains information about the backend Secret Management service

• location - Optional String
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location

• more_option - Optional String
Defines various OPTIONS to define a route

• tls_params - Optional String
Inline TLS Parameters. Inline TLS parameters