xcsh_log_receiver (Resource)

Manages new Log Receiver object in F5 Distributed Cloud.

~> Note: For more information, see the Log Receiver API documentation.

Example Usage

# LogReceiver Resource Example
# Manages new Log Receiver object in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

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

# Basic LogReceiver configuration
resource "xcsh_log_receiver" "example" {
  name      = "example-log-receiver"
  namespace = "staging"
}

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 Log Receiver. Must be unique within the namespace

• namespace - Required String
Namespace where the Log Receiver is created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true administratively disables the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

• site_local - Optional Block
Enable this option

• syslog - Optional Block
Syslog Server Configuration. Configuration for syslog server
See Syslog below for details.

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

Syslog

A syslog block supports the following:

• syslog_rfc5424 - Optional Number
Select RFC5424 syslog format and maximum message length

• tcp_server - Optional Block
TCP Server name and Port Number. Name and port number for a TCP server
See TCP Server below.

• tls_server - Optional Block
TLS config for client of discovery service
See TLS Server below.

• udp_server - Optional Block
UDP Server Name and Port Number. Name and port number for a UDP server
See UDP Server below.

Syslog TCP Server

A tcp_server block (within syslog) supports the following:

• port - Optional Number
Port Number. Port number used for communication

• server_name - Optional String
Server name is fully qualified domain name or IP address of the server

Syslog TLS Server

A tls_server block (within syslog) supports the following:

• default_https_port - Optional Object
Enable this option

• default_syslog_tls_port - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
Configuration parameter for mTLS enable
See mTLS Enable below.

• port - Optional Number
Custom port number used for communication

• server_name - Optional String
ServerName is passed to the server for SNI and is used in the client to check server certificates against

• trusted_ca_url - Optional String
The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers

• volterra_ca - Optional Object
Configuration parameter for volterra CA

Syslog TLS Server Default HTTPS Port

A default_https_port block (within syslog.tls_server) supports the following:

Syslog TLS Server Default Syslog TLS Port

A default_syslog_tls_port block (within syslog.tls_server) supports the following:

Syslog TLS Server mTLS Disabled

A mtls_disabled block (within syslog.tls_server) supports the following:

Syslog TLS Server mTLS Enable

A mtls_enable block (within syslog.tls_server) supports the following:

• certificate - Optional String
Client certificate is PEM-encoded certificate or certificate-chain

• key_url - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Key URL below.

Syslog TLS Server mTLS Enable Key URL

A key_url block (within syslog.tls_server.mtls_enable) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

Syslog TLS Server mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Syslog TLS Server mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

Syslog TLS Server Volterra CA

A volterra_ca block (within syslog.tls_server) supports the following:

Syslog UDP Server

An udp_server block (within syslog) supports the following:

• port - Optional Number
Port Number. Port number used for communication

• server_name - Optional String
Server name is fully qualified domain name or IP address of the server

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

---

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

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import xcsh_log_receiver.example system/example