xcsh_external_connector (Data Source)

Retrieves information about an External Connector resource in F5 Distributed Cloud for external_connector configuration specification. configuration. This is a read-only data source.

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

Example Usage

# ExternalConnector Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing ExternalConnector by name
data "xcsh_external_connector" "example" {
  name      = "example-external-connector"
  namespace = "staging"
}

output "external_connector_id" {
  value = data.xcsh_external_connector.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 ExternalConnector

• namespace - Required String
Namespace where the ExternalConnector exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

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

• description - Optional String
Description of the ExternalConnector

• gre - Optional String
GRE. External Connector with GRE tunnel

• id - Optional String
Unique identifier for the resource

• ipsec - Optional String
IPsec. External Connector with IPsec tunnel

• labels - Optional Map
Labels applied to this resource

• 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

---

Gre

A gre block supports the following:

• gre_parameters - Optional String
GRE configuration parameters required for GRE Connection type

Gre Gre Parameters

A gre_parameters block (within gre) supports the following:

• peer_ip_address - Optional String
IPv4 Address. IPv4 Address in dot-decimal notation

• segment - Optional String
Segment Reference Type. Reference to Segment Object

• site_local_inside_network - Optional Object
Enable this option

• site_local_network - Optional Object
Enable this option

• tunnel_eps - Optional List
Configure tunnel parameters, source, destination, IP addresses

• tunnel_mtu - Optional Number
Configure MTU for the GRE tunnel interface

Gre Gre Parameters Peer IP Address

A peer_ip_address block (within gre.gre_parameters) supports the following:

• addr - Optional String
IPv4 Address in string form with dot-decimal notation

Gre Gre Parameters Segment

A segment block (within gre.gre_parameters) supports the following:

• refs - Optional List
Segment. Reference to Segment Object

Gre Gre Parameters Segment Refs

A refs block (within gre.gre_parameters.segment) supports the following:

• 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

Gre Gre Parameters Site Local Inside Network

A site_local_inside_network block (within gre.gre_parameters) supports the following:

Gre Gre Parameters Site Local Network

A site_local_network block (within gre.gre_parameters) supports the following:

Gre Gre Parameters Tunnel Eps

A tunnel_eps block (within gre.gre_parameters) supports the following:

• interface - Optional String
For the chosen node, specify the interface that will be the tunnel source

• local_tunnel_ip - Optional String
For a particular tunnel on a node, specify the local tunnel IP Address i.e. The IP address of the tunnel on the CE node itself and a subnet prefix length

• node - Optional String
CE site is composed of multiple nodes. Choose a node that will be part of this external connection

• remote_tunnel_ip - Optional String
For a particular tunnel on a node, specify the remote tunnel IP Address i.e. The IP address of the tunnel on the remote gateway and a subnet prefix length

Ipsec

An ipsec block supports the following:

• ike_parameters - Optional String
IKE configuration parameters required for IPsec Connection type

• ipsec_tunnel_parameters - Optional String
In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment

Ipsec IKE Parameters

An ike_parameters block (within ipsec) supports the following:

• dpd_disabled - Optional Object
Enable this option

• dpd_keep_alive_timer - Optional String
Configuration parameter for dpd keep alive timer

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

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

• initiator - Optional Object
Enable this option

• responder - Optional Object
Enable this option

• rm_hostname - Optional String
Configure an hostname Remote IKE ID

• rm_ip_address - Optional String
IP Address used to specify an IPv4 or IPv6 address

• use_default_local_ike_id - Optional String
Enable this option

• use_default_remote_ike_id - Optional Object
Enable this option

Ipsec IKE Parameters Dpd Disabled

A dpd_disabled block (within ipsec.ike_parameters) supports the following:

Ipsec IKE Parameters Dpd Keep Alive Timer

A dpd_keep_alive_timer block (within ipsec.ike_parameters) supports the following:

• timeout - Optional Number
Keepalive Timer. Operation timeout duration

Ipsec IKE Parameters IKE Phase1 Profile

An ike_phase1_profile block (within ipsec.ike_parameters) 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

Ipsec IKE Parameters IKE Phase2 Profile

An ike_phase2_profile block (within ipsec.ike_parameters) 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

Ipsec IKE Parameters Initiator

An initiator block (within ipsec.ike_parameters) supports the following:

Ipsec IKE Parameters Responder

A responder block (within ipsec.ike_parameters) supports the following:

Ipsec IKE Parameters Rm IP Address

A rm_ip_address block (within ipsec.ike_parameters) supports the following:

• ipv4 - Optional String
IPv4 address in dotted decimal notation (e.g., 192.0.2.1)

• ipv6 - Optional String
IPv6 Address specified as hexadecimal numbers separated by ’:‘

Ipsec IKE Parameters Rm IP Address IPv4

An ipv4 block (within ipsec.ike_parameters.rm_ip_address) supports the following:

• addr - Optional String
IPv4 Address in string form with dot-decimal notation

Ipsec IKE Parameters Rm IP Address IPv6

An ipv6 block (within ipsec.ike_parameters.rm_ip_address) supports the following:

• addr - Optional String
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::‘

Ipsec IKE Parameters Use Default Local IKE ID

Deeply nested ID block collapsed for readability.

Ipsec IKE Parameters Use Default Remote IKE ID

Deeply nested ID block collapsed for readability.

Ipsec Ipsec Tunnel Parameters

An ipsec_tunnel_parameters block (within ipsec) supports the following:

• peer_ip_address - Optional String
IPv4 Address. IPv4 Address in dot-decimal notation

• psk - Optional String
The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation

• segment - Optional String
Segment Reference Type. Reference to Segment Object

• site_local_inside_network - Optional Object
Enable this option

• site_local_network - Optional Object
Enable this option

• tunnel_eps - Optional List
Configure tunnel parameters, local and remote IP addresses

• tunnel_mtu - Optional Number
The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented

Ipsec Ipsec Tunnel Parameters Peer IP Address

A peer_ip_address block (within ipsec.ipsec_tunnel_parameters) supports the following:

• addr - Optional String
IPv4 Address in string form with dot-decimal notation

Ipsec Ipsec Tunnel Parameters Segment

A segment block (within ipsec.ipsec_tunnel_parameters) supports the following:

• refs - Optional List
Segment. Reference to Segment Object

Ipsec Ipsec Tunnel Parameters Segment Refs

A refs block (within ipsec.ipsec_tunnel_parameters.segment) supports the following:

• 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

Ipsec Ipsec Tunnel Parameters Site Local Inside Network

Deeply nested Network block collapsed for readability.

Ipsec Ipsec Tunnel Parameters Site Local Network

A site_local_network block (within ipsec.ipsec_tunnel_parameters) supports the following:

Ipsec Ipsec Tunnel Parameters Tunnel Eps

A tunnel_eps block (within ipsec.ipsec_tunnel_parameters) supports the following:

• interface - Optional String
For the chosen node, specify the interface that will be the tunnel source

• local_tunnel_ip - Optional String
For a particular tunnel on a node, specify the local tunnel IP Address i.e. The IP address of the tunnel on the CE node itself and a subnet prefix length

• node - Optional String
CE site is composed of multiple nodes. Choose a node that will be part of this external connection

• remote_tunnel_ip - Optional String
For a particular tunnel on a node, specify the remote tunnel IP Address i.e. The IP address of the tunnel on the remote gateway and a subnet prefix length

---

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