xcsh_nginx_server (Data Source)

Retrieves information about a Nginx Server resource in F5 Distributed Cloud for get nginx server block configuration. configuration. (read-only data source)

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

Example Usage

# NginxServer Data Source Example

terraform {
  required_version = ">= 1.0"

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

# Look up an existing NginxServer by name
data "xcsh_nginx_server" "example" {
  name      = "example-nginx-server"
  namespace = "staging"
}

output "nginx_server_id" {
  value = data.xcsh_nginx_server.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.

Metadata Argument Reference

• name - Required String
Name of the NginxServer to look up

• namespace - Required String
Namespace of the NginxServer

Attributes Reference

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

• annotations - Optional Map
Annotations

• dataplane_ref - Optional String
DataplaneReference

• description - Optional String
Description

• id - Optional String
Unique identifier

• labels - Optional Map
Labels

• server_spec - Optional String
Configuration for server_spec

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

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

• 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

• api_discovery_spec - Optional String
Configuration for api_discovery_spec

• domains - Optional List
Server name list specified as ${server_name} in NGINX config. If no value is specified corresponding to this variable, ‘default’ is used Reference: HTTPS://nginx.org/en/docs/HTTP/ngx_http_core_module.HTML#server.

• locations - Optional List
Configuration of the set of locations corresponding to this server

• nginx_one_object_id - Optional String
Signifies the uniqueness identifier for NGINX One representation of this NGINX server

• nginx_one_object_name - Optional String
Hostname value set for Instance or Name for a Config Sync Group in NGINX One

• port - Optional Number
Signifies the port configured for the NGINX server

• server_name - Optional String
Signifies the combination of first element in domains array and the port configured for the NGINX server

• total_routes - Optional Number
Total locations configured in the NGINX Server

• waf_spec - Optional String
Configuration for waf_spec

• disabled - Optional Object
Enable this option

• enabled - Optional Object
Enable this option

• api_discovery_spec - Optional String
Configuration for api_discovery_spec

• definition - Optional String
Location definition specified as the attributes of ${location} block in NGINX config. This includes both the optional_modifier and the location_match combined. A location can either be defined by a prefix string, or by a regular expression

• name - Optional String
Uniqueness identifier for a location definition

• waf_spec - Optional String
Configuration for waf_spec

• disabled - Optional Object
Enable this option

• enabled - Optional Object
Enable this option

• blocking_waf_mode - Optional Object
Enable this option

• distributed_cloud_policy_management - Optional Object
Configuration parameter for distributed cloud policy management

• monitoring_waf_mode - Optional Object
Configuration parameter for monitoring WAF mode

• nginx_policy_management - Optional Object
Configuration parameter for nginx policy management

• none_waf_mode - Optional Object
Configuration parameter for none WAF mode

• policy_file_name - Optional String
WAF Policy filename. Policy filename for WAF

• policy_name - Optional String
WAF Policy Name. Policy name configured for WAF

• security_log_enabled - Optional Bool
Specifies if security logging is enabled

• security_log_file_names - Optional List
Specifies the list of security log files specification

• blocking_waf_mode - Optional Object
Enable this option

• distributed_cloud_policy_management - Optional Object
Configuration parameter for distributed cloud policy management

• monitoring_waf_mode - Optional Object
Configuration parameter for monitoring WAF mode

• nginx_policy_management - Optional Object
Configuration parameter for nginx policy management

• none_waf_mode - Optional Object
Configuration parameter for none WAF mode

• policy_file_name - Optional String
WAF Policy filename. Policy filename for WAF

• policy_name - Optional String
WAF Policy Name. Policy name configured for WAF

• security_log_enabled - Optional Bool
Specifies if security logging is enabled

• security_log_file_names - Optional List
Specifies the list of security log files specification

---

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