xcsh_nfv_service (Data Source)

Retrieves information about new NFV service with configured parameters in F5 Distributed Cloud. This is a read-only data source.

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

Example Usage

# NfvService Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing NfvService by name
data "xcsh_nfv_service" "example" {
  name      = "example-nfv-service"
  namespace = "staging"
}

output "nfv_service_id" {
  value = data.xcsh_nfv_service.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 NfvService

• namespace - Required String
Namespace where the NfvService exists

Attributes Reference

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

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the NfvService

• disable_https_management - Optional Object
Configuration parameter for disable HTTPS management

• disable_ssh_access - Optional Object
Configuration parameter for disable SSH access

• enabled_ssh_access - Optional String
Configuration parameter for enabled SSH access

• f5_big_ip_aws_service - Optional String
Virtual BIG-IP AWS. Virtual BIG-IP specification for AWS

• https_management - Optional String
Configuration parameter for HTTPS management

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• palo_alto_fw_service - Optional String
Palo Alto Networks VM-Series next-generation firewall configuration

• advertise_on_sli - Optional Object
Configuration parameter for advertise on SLI

• advertise_on_slo - Optional Object
Configuration parameter for advertise on slo

• advertise_on_slo_sli - Optional Object
Configuration parameter for advertise on slo SLI

• domain_suffix - Optional String
Domain suffix will be used along with node name to form the hostname for SSH node management

• node_ssh_ports - Optional List
Management Node SSH Port. Enter TCP port and node name per node

• node_name - Optional String
Node name will be used to match a particular node with the desired TCP port

• ssh_port - Optional Number
SSH Port. Enter TCP port per node

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

• admin_username - Optional String
Admin Username. Admin Username for BIG-IP

• aws_tgw_site_params - Optional String
BIG-IP AWS TGW Site. BIG-IP AWS TGW site specification

• endpoint_service - Optional String
Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with a new destination address

• market_place_image - Optional String
BIG-IP AWS Pay as You Go Image Selection

• nodes - Optional List
Specify how and where the service nodes are spawned

• ssh_key - Optional String
Public SSH key for accessing the Big IP nodes

• tags - Optional Map
AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console

• 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

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

• 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

• advertise_on_slo_ip - Optional Object
Enable this option

• advertise_on_slo_ip_external - Optional Object
Enable this option

• automatic_vip - Optional Object
Enable this option

• configured_vip - Optional String
Enter IP address for the default VIP

• custom_tcp_ports - Optional String
Port Range List. List of port ranges

• custom_udp_ports - Optional String
Port Range List. List of port ranges

• default_tcp_ports - Optional Object
Enable this option

• disable_advertise_on_slo_ip - Optional Object
Enable this option

• http_port - Optional Object
Enable this option

• https_port - Optional Object
Enable this option

• no_tcp_ports - Optional Object
Enable this option

• no_udp_ports - Optional Object
Enable this option

• ports - Optional List
List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192

• awafpay_g200_mbps - Optional Object
Configuration parameter for AWAFPayG200Mbps

• awafpay_g3_gbps - Optional Object
Configuration parameter for AWAFPayG3Gbps

• automatic_prefix - Optional Object
Configuration parameter for automatic prefix

• aws_az_name - Optional String
The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site

• mgmt_subnet - Optional String
Configuration parameter for mgmt subnet

• node_name - Optional String
Node Name will be used to assign as hostname to the service

• reserved_mgmt_subnet - Optional Object
Configuration parameter for reserved mgmt subnet

• tunnel_prefix - Optional String
Enter IP prefix for the tunnel, it has to be /30

• existing_subnet_id - Optional String
Information about existing subnet ID

• subnet_param - Optional String
Parameters for creating a new cloud subnet

• ipv4 - Optional String
IPv4 Subnet. IPv4 subnet prefix for this subnet

• advertise_on_internet - Optional String
Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available

• advertise_on_internet_default_vip - Optional Object
Enable this option

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

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

• advertise_on_slo_sli - Optional String
Configuration parameter for advertise on slo SLI

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

• default_https_port - Optional Object
Enable this option

• domain_suffix - Optional String
Domain suffix will be used along with node name to form URL to access node management

• https_port - Optional Number
Enter TCP port number

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

• 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

• no_mtls - Optional Object
Enable this option

• tls_certificates - Optional List
Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms

• tls_config - Optional String
Defines various OPTIONS to configure TLS configuration parameters

• use_mtls - Optional String
Validation context for downstream client TLS connections

• certificate_url - Optional String
TLS certificate. Certificate or certificate chain in PEM format including the PEM headers

• custom_hash_algorithms - Optional String
Specifies the hash algorithms to be used

• description_spec - Optional String
Description. Description for the certificate

• disable_ocsp_stapling - Optional Object
Configuration parameter for disable OCSP stapling

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

• use_system_defaults - Optional Object
Configuration parameter for use system defaults

• hash_algorithms - Optional List Defaults to INVALID_HASH_ALGORITHM
Possible values are INVALID_HASH_ALGORITHM, SHA256, SHA1
[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Ordered list of hash algorithms to be used

• 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

• custom_security - Optional String
Defines TLS protocol config including min/max versions and allowed ciphers

• default_security - Optional Object
Enable this option

• low_security - Optional Object
Enable this option

• medium_security - Optional Object
Enable this option

• cipher_suites - Optional List
The TLS listener will only support the specified cipher list

• max_version - Optional String Defaults to TLS_AUTO
Possible values are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3
[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version

• min_version - Optional String Defaults to TLS_AUTO
Possible values are TLS_AUTO, TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3
[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version

• client_certificate_optional - Optional Bool
Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated

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

• no_crl - Optional Object
Enable this option

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

• trusted_ca_url - Optional String
Upload a Root CA Certificate specifically for this Load Balancer

• xfcc_disabled - Optional Object
Enable this option

• xfcc_options - Optional String
X-Forwarded-Client-Cert header elements to be added to requests

• 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

• xfcc_header_elements - Optional List Defaults to XFCC_NONE
Possible values are XFCC_NONE, XFCC_CERT, XFCC_CHAIN, XFCC_SUBJECT, XFCC_URI, XFCC_DNS
[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] X-Forwarded-Client-Cert header elements to be added to requests