Skip to content
Documentation

xcsh_network_interface (Data Source)

Retrieves information about a Network Interface resource in F5 Distributed Cloud for network interface represents configuration of a network device. it is created by users in system namespace. configuration. This is a read-only data source.

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

Example Usage

Section titled “Example Usage”
# NetworkInterface Data Source Example


terraform {
  required_version = ">= 1.0"


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


# Look up an existing NetworkInterface by name
data "xcsh_network_interface" "example" {
  name      = "example-network-interface"
  namespace = "staging"
}


output "network_interface_id" {
  value = data.xcsh_network_interface.example.id
}

Argument Reference

Section titled “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

Section titled “Metadata Argument Reference”

• name - Required String
Name of the NetworkInterface

• namespace - Required String
Namespace where the NetworkInterface exists

Attributes Reference

Section titled “Attributes Reference”

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

• annotations - Optional Map
Annotations applied to this resource

• dedicated_interface - Optional String
Configuration parameter for dedicated interface

• dedicated_management_interface - Optional String
Configuration parameter for dedicated management interface

• description - Optional String
Description of the NetworkInterface

• ethernet_interface - Optional String
Configuration parameter for ethernet interface

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• layer2_interface - Optional String
Configuration parameter for layer2 interface

• tunnel_interface - Optional String
Configuration parameter for tunnel interface

• cluster - Optional Object
Enable this option

• device - Optional String
Name of the device for which interface is configured. Use wwan0 for 4G/LTE

• is_primary - Optional Object
Enable this option

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• node - Optional String
Configuration will apply to a device on the given node of the site

• not_primary - Optional Object
Configuration parameter for not primary

• priority - Optional Number
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority

• cluster - Optional Object
Enable this option

• device - Optional String
Name of the device for which interface is configured

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• node - Optional String
Configuration will apply to a device on the given node of the site

• cluster - Optional Object
Enable this option

• device - Optional String
Interface configuration for the ethernet device

• dhcp_client - Optional Object
Enable this option

• dhcp_server - Optional String
Configuration parameter for DHCP server

• ipv6_auto_config - Optional String
IPV6AutoConfigType

• is_primary - Optional Object
Enable this option

• monitor - Optional Object
Link Quality Monitoring configuration for a network interface

• monitor_disabled - Optional Object
Enable this option

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• no_ipv6_address - Optional Object
Enable this option

• node - Optional String
Configuration will apply to a device on the given node

• not_primary - Optional Object
Configuration parameter for not primary

• priority - Optional Number
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority

• site_local_inside_network - Optional Object
Enable this option

• site_local_network - Optional Object
Enable this option

• static_ip - Optional String
Static IP Parameters. Configure Static IP parameters

• static_ipv6_address - Optional String
Static IP Parameters. Configure Static IP parameters

• storage_network - Optional Object
Configuration parameter for storage network

• untagged - Optional Object
Enable this option

• vlan_id - Optional Number
Configure a VLAN tagged ethernet interface

• automatic_from_end - Optional Object
Configuration parameter for automatic from end

• automatic_from_start - Optional Object
Configuration parameter for automatic from start

• dhcp_networks - Optional List
List of networks from which DHCP Server can allocate IPv4 Addresses

• dhcp_option82_tag - Optional String
DHCP option 82 tag

• fixed_ip_map - Optional Map
Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client

• interface_ip_map - Optional String
Interface IPv4 Assignments. Specify static IPv4 addresses per node

• dgw_address - Optional String
Enter a IPv4 address from the network prefix to be used as the default gateway

• dns_address - Optional String
Enter a IPv4 address from the network prefix to be used as the DNS server

• first_address - Optional Object
Enable this option

• last_address - Optional Object
Enable this option

• network_prefix - Optional String
Set the network prefix for the site. Ex: 192.0.2.0/24

• pool_settings - Optional String Defaults to INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
Possible values are INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS, EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation

• pools - Optional List
List of non overlapping IP address ranges

• same_as_dgw - Optional Object
Configuration parameter for same as dgw

• end_ip - Optional String
Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 192.0.2.39 with prefix length of 24, end offset is 192.0.2.186

• exclude - Optional Bool
Exclude this address range from DHCP allocation

• start_ip - Optional String
Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 192.0.2.173 with prefix length of 24, start offset is 192.0.2.96

• interface_ip_map - Optional Map
Specify static IPv4 addresses per site:node

• host - Optional Object
Hostname or IP address of the target server

• router - Optional String
IPV6AutoConfigRouterType

• dns_config - Optional String
IPV6DnsConfig

• network_prefix - Optional String
Network prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862

• stateful - Optional String
DHCPIPV6 Stateful Server

• configured_list - Optional String
IPV6DnsList

• local_dns - Optional String
IPV6LocalDnsAddress

• dns_list - Optional List
List of IPv6 Addresses acting as DNS servers

• configured_address - Optional String
Configured address from the network prefix is chosen as DNS server

• first_address - Optional Object
Enable this option

• last_address - Optional Object
Enable this option

• automatic_from_end - Optional Object
Configuration parameter for automatic from end

• automatic_from_start - Optional Object
Configuration parameter for automatic from start

• dhcp_networks - Optional List
List of networks from which DHCP server can allocate IP addresses

• fixed_ip_map - Optional Map
Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client

• interface_ip_map - Optional String
Map of Interface IPv6 assignments per node

• network_prefix - Optional String
Network Prefix to be used for IPv6 address auto configuration

• pool_settings - Optional String Defaults to INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
Possible values are INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS, EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
[Enum: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS|EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS] Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation

• pools - Optional List
List of non overlapping IP address ranges

• end_ip - Optional String
Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix

• start_ip - Optional String
Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5

• interface_ip_map - Optional Map
Site:Node to IPv6 Mapping. Map of Site:Node to IPv6 address

• cluster_static_ip - Optional String
Configure Static IP parameters for cluster

• node_static_ip - Optional String
Configure Static IP parameters for a node

• interface_ip_map - Optional Map
Map of Node to Static IP configuration value, Key:Node, Value:IP Address

• default_gw - Optional String
Default Gateway. IP address of the default gateway

• dns_server - Optional String
DNS server address for the static interface configuration

• ip_address - Optional String
IP address of the interface and prefix length

• cluster_static_ip - Optional String
Configure Static IP parameters for cluster

• node_static_ip - Optional String
Configure Static IP parameters for a node

• interface_ip_map - Optional Map
Map of Node to Static IP configuration value, Key:Node, Value:IP Address

• default_gw - Optional String
Default Gateway. IP address of the default gateway

• dns_server - Optional String
DNS server address for the static interface configuration

• ip_address - Optional String
IP address of the interface and prefix length

• l2sriov_interface - Optional String
Configuration parameter for l2sriov interface

• l2vlan_interface - Optional String
Configuration parameter for l2vlan interface

• l2vlan_slo_interface - Optional String
Layer2 Site Local Outside VLAN Interface Configuration

• device - Optional String
Ethernet Device. Physical ethernet interface

• untagged - Optional Object
Enable this option

• vlan_id - Optional Number
Configure a VLAN tagged interface

• device - Optional String
Ethernet Device. Physical ethernet interface

• vlan_id - Optional Number
VLAN ID. VLAN ID

• vlan_id - Optional Number
VLAN ID. VLAN ID

• mtu - Optional Number
Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384

• node - Optional String
Configuration will apply to a given device on the given node

• priority - Optional Number
Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority

• site_local_inside_network - Optional Object
Enable this option

• site_local_network - Optional Object
Enable this option

• static_ip - Optional String
Static IP Parameters. Configure Static IP parameters

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

• cluster_static_ip - Optional String
Configure Static IP parameters for cluster

• node_static_ip - Optional String
Configure Static IP parameters for a node

• interface_ip_map - Optional Map
Map of Node to Static IP configuration value, Key:Node, Value:IP Address

• default_gw - Optional String
Default Gateway. IP address of the default gateway

• dns_server - Optional String
DNS server address for the static interface configuration

• ip_address - Optional String
IP address of the interface and prefix length

• 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

Common Types

Section titled “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}

Section titled “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.

FieldTypeDescription
nameStringName of the referenced object
namespaceStringNamespace containing the referenced object
tenantStringTenant of the referenced object (system-managed)

Transformers {#common-transformers}

Section titled “Transformers {#common-transformers}”

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

ValueDescription
LOWER_CASEConvert to lowercase
UPPER_CASEConvert to uppercase
BASE64_DECODEDecodebase64 content
NORMALIZE_PATHNormalize URL path
REMOVE_WHITESPACERemove whitespace characters
URL_DECODEDecode URL-encoded characters
TRIM_LEFTTrim leading whitespace
TRIM_RIGHTTrim trailing whitespace
TRIMTrim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

Section titled “HTTP Methods {#common-http-methods}”

HTTP methods used for request matching.

ValueDescription
ANYMatch any HTTP method
GETHTTP GET request
HEADHTTP HEAD request
POSTHTTP POST request
PUTHTTP PUT request
DELETEHTTP DELETE request
CONNECTHTTP CONNECT request
OPTIONSHTTP OPTIONS request
TRACEHTTP TRACE request
PATCHHTTP PATCH request
COPYHTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

Section titled “TLS Fingerprints {#common-tls-fingerprints}”

TLS fingerprint categories for malicious client detection.

ValueDescription
TLS_FINGERPRINT_NONENo fingerprint matching
ANY_MALICIOUS_FINGERPRINTMatch any known malicious fingerprint
ADWAREAdware-associated fingerprints
DRIDEXDridex malware fingerprints
GOOTKITGootkit malware fingerprints
RANSOMWARERansomware-associated fingerprints
TRICKBOTTrickbot malware fingerprints

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

Section titled “IP Threat Categories {#common-ip-threat-categories}”

IP address threat categories for security filtering.

ValueDescription
SPAM_SOURCESKnown spam sources
WINDOWS_EXPLOITSWindows exploit sources
WEB_ATTACKSWeb attack sources
BOTNETSKnown botnet IPs
SCANNERSNetwork scanner IPs
REPUTATIONPoor reputation IPs
PHISHINGPhishing-related IPs
PROXYAnonymous proxy IPs
MOBILE_THREATSMobile threat sources
TOR_PROXYTor exit nodes
DENIAL_OF_SERVICEDoS attack sources
NETWORKKnown bad network ranges