xcsh_global_log_receiver (Resource)

Manages new Global Log Receiver object in F5 Distributed Cloud.

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

Example Usage

# GlobalLogReceiver Resource Example
# Manages new Global 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 GlobalLogReceiver configuration
resource "xcsh_global_log_receiver" "example" {
  name      = "example-global-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.

Minimum Configuration

Required fields:

• name
• namespace
• log_type
• receiver_choice

Example (API format):

metadata:
  name: my-log-receiver
  namespace: demo-app
spec:
  request_logs: {}
  http_receiver:
    uri: `http://logs.example.com/ingest`

Metadata Argument Reference

• name - Required String
Name of the Global Log Receiver. Must be unique within the namespace

• namespace - Required String
Namespace where the Global 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

-> One of the following: • audit_logs - Optional Object
Enable this option

• dns_logs - Optional Object
Enable this option

• request_logs - Optional Block
Configuration for request logs with sampling choice. Allows selection between sampled (default) or unsampled (full) request logs

• security_events - Optional Object
Enable this option

-> One of the following: • aws_cloud_watch_receiver - Optional Block
AWS Cloudwatch Logs Configuration for Global Log Receiver
See AWS Cloud Watch Receiver below for details.

• azure_event_hubs_receiver - Optional Block
Azure Event Hubs Configuration for Global Log Receiver
See Azure Event Hubs Receiver below for details.

• azure_receiver - Optional Block
Azure Blob Configuration for Global Log Receiver
See Azure Receiver below for details.

• datadog_receiver - Optional Block
Datadog Configuration. Configuration for Datadog endpoint
See Datadog Receiver below for details.

• gcp_bucket_receiver - Optional Block
GCP Bucket Configuration for Global Log Receiver
See GCP Bucket Receiver below for details.

• http_receiver - Optional Block
Configuration parameter for HTTP receiver

• kafka_receiver - Optional Block
Kafka Configuration for Global Log Receiver

• new_relic_receiver - Optional Block
Configuration parameter for new relic receiver

• qradar_receiver - Optional Block
Configuration parameter for qradar receiver

• s3_receiver - Optional Block
S3 Configuration for Global Log Receiver

• splunk_receiver - Optional Block
Configuration for Splunk HEC Logs endpoint

• sumo_logic_receiver - Optional Block
Configuration parameter for sumo logic receiver

-> One of the following: • ns_all - Optional Object
Enable this option

• ns_current - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• ns_list - Optional Block
Namespace List. Namespace List

• timeouts - Optional Block

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

AWS Cloud Watch Receiver

An aws_cloud_watch_receiver block supports the following:

• aws_cred - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See AWS Cred below.

• aws_region - Optional String
Possible values are ap-northeast-1, ap-southeast-1, eu-central-1, eu-west-1, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-2, CA-central-1, af-south-1, ap-east-1, ap-south-1, ap-northeast-2, ap-southeast-2, eu-south-1, eu-north-1, eu-west-2, me-south-1, us-west-1, ap-southeast-3
[Enum: ap-northeast-1|ap-southeast-1|eu-central-1|eu-west-1|eu-west-3|sa-east-1|us-east-1|us-east-2|us-west-2|CA-central-1|af-south-1|ap-east-1|ap-south-1|ap-northeast-2|ap-southeast-2|eu-south-1|eu-north-1|eu-west-2|me-south-1|us-west-1|ap-southeast-3] AWS Region. AWS Region Name

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• group_name - Optional String
The group name of the target Cloudwatch Logs stream

• stream_name - Optional String
The stream name of the target Cloudwatch Logs stream. Note that there can only be one writer to a log stream at a time

AWS Cloud Watch Receiver AWS Cred

An aws_cred block (within aws_cloud_watch_receiver) 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

AWS Cloud Watch Receiver Batch

A batch block (within aws_cloud_watch_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

AWS Cloud Watch Receiver Batch Max Bytes Disabled

Deeply nested Disabled block collapsed for readability.

AWS Cloud Watch Receiver Batch Max Events Disabled

Deeply nested Disabled block collapsed for readability.

AWS Cloud Watch Receiver Batch Timeout Seconds Default

Deeply nested Default block collapsed for readability.

AWS Cloud Watch Receiver Compression

A compression block (within aws_cloud_watch_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

AWS Cloud Watch Receiver Compression Compression Default

A compression_default block (within aws_cloud_watch_receiver.compression) supports the following:

AWS Cloud Watch Receiver Compression Compression Gzip

A compression_gzip block (within aws_cloud_watch_receiver.compression) supports the following:

AWS Cloud Watch Receiver Compression Compression None

A compression_none block (within aws_cloud_watch_receiver.compression) supports the following:

Azure Event Hubs Receiver

An azure_event_hubs_receiver block supports the following:

• connection_string - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Connection String below.

• instance - Optional String
Event Hubs Instance name into which logs should be stored

• namespace - Optional String
Event Hubs Namespace is namespace with instance into which logs should be stored

Azure Event Hubs Receiver Connection String

A connection_string block (within azure_event_hubs_receiver) 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.

Azure Event Hubs Receiver Connection String Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Azure Event Hubs Receiver Connection String Clear Secret Info

Deeply nested Info block collapsed for readability.

Azure Receiver

An azure_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• connection_string - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Connection String below.

• container_name - Optional String
Container Name is the name of the container into which logs should be stored

• filename_options - Optional Block
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file
See Filename Options below.

Azure Receiver Batch

A batch block (within azure_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

Azure Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within azure_receiver.batch) supports the following:

Azure Receiver Batch Max Events Disabled

A max_events_disabled block (within azure_receiver.batch) supports the following:

Azure Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within azure_receiver.batch) supports the following:

Azure Receiver Compression

A compression block (within azure_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

Azure Receiver Compression Compression Default

A compression_default block (within azure_receiver.compression) supports the following:

Azure Receiver Compression Compression Gzip

A compression_gzip block (within azure_receiver.compression) supports the following:

Azure Receiver Compression Compression None

A compression_none block (within azure_receiver.compression) supports the following:

Azure Receiver Connection String

A connection_string block (within azure_receiver) 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.

Azure Receiver Connection String Blindfold Secret Info

A blindfold_secret_info block (within azure_receiver.connection_string) supports the following:

• 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:///

Azure Receiver Connection String Clear Secret Info

A clear_secret_info block (within azure_receiver.connection_string) supports the following:

• 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

Azure Receiver Filename Options

A filename_options block (within azure_receiver) supports the following:

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

Azure Receiver Filename Options Log Type Folder

A log_type_folder block (within azure_receiver.filename_options) supports the following:

Azure Receiver Filename Options No Folder

A no_folder block (within azure_receiver.filename_options) supports the following:

Datadog Receiver

A datadog_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

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

• endpoint - Optional String
Datadog Endpoint,

• no_tls - Optional Object
Enable this option

• site - Optional String
Datadog Site,

• use_tls - Optional Block
TLS Parameters for client connection to the endpoint
See Use TLS below.

Datadog Receiver Batch

A batch block (within datadog_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

Datadog Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within datadog_receiver.batch) supports the following:

Datadog Receiver Batch Max Events Disabled

A max_events_disabled block (within datadog_receiver.batch) supports the following:

Datadog Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within datadog_receiver.batch) supports the following:

Datadog Receiver Compression

A compression block (within datadog_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

Datadog Receiver Compression Compression Default

A compression_default block (within datadog_receiver.compression) supports the following:

Datadog Receiver Compression Compression Gzip

A compression_gzip block (within datadog_receiver.compression) supports the following:

Datadog Receiver Compression Compression None

A compression_none block (within datadog_receiver.compression) supports the following:

Datadog Receiver Datadog API Key

A datadog_api_key block (within datadog_receiver) 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.

Datadog Receiver Datadog API Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Datadog Receiver Datadog API Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Datadog Receiver No TLS

A no_tls block (within datadog_receiver) supports the following:

Datadog Receiver Use TLS

An use_tls block (within datadog_receiver) supports the following:

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
mTLS Client config allows configuration of mTLS client OPTIONS
See mTLS Enable below.

• no_ca - Optional Object
Enable this option

• 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

Datadog Receiver Use TLS Disable Verify Certificate

A disable_verify_certificate block (within datadog_receiver.use_tls) supports the following:

Datadog Receiver Use TLS Disable Verify Hostname

A disable_verify_hostname block (within datadog_receiver.use_tls) supports the following:

Datadog Receiver Use TLS Enable Verify Certificate

An enable_verify_certificate block (within datadog_receiver.use_tls) supports the following:

Datadog Receiver Use TLS Enable Verify Hostname

An enable_verify_hostname block (within datadog_receiver.use_tls) supports the following:

Datadog Receiver Use TLS mTLS Disabled

A mtls_disabled block (within datadog_receiver.use_tls) supports the following:

Datadog Receiver Use TLS mTLS Enable

A mtls_enable block (within datadog_receiver.use_tls) 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.

Datadog Receiver Use TLS mTLS Enable Key URL

Deeply nested URL block collapsed for readability.

Datadog Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Datadog Receiver Use TLS mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

Datadog Receiver Use TLS No CA

A no_ca block (within datadog_receiver.use_tls) supports the following:

DNS Logs

A dns_logs block supports the following:

GCP Bucket Receiver

A gcp_bucket_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• bucket - Optional String
GCP Bucket Name. GCP Bucket Name

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• filename_options - Optional Block
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file
See Filename Options below.

• gcp_cred - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See GCP Cred below.

GCP Bucket Receiver Batch

A batch block (within gcp_bucket_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

GCP Bucket Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within gcp_bucket_receiver.batch) supports the following:

GCP Bucket Receiver Batch Max Events Disabled

A max_events_disabled block (within gcp_bucket_receiver.batch) supports the following:

GCP Bucket Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within gcp_bucket_receiver.batch) supports the following:

GCP Bucket Receiver Compression

A compression block (within gcp_bucket_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

GCP Bucket Receiver Compression Compression Default

A compression_default block (within gcp_bucket_receiver.compression) supports the following:

GCP Bucket Receiver Compression Compression Gzip

A compression_gzip block (within gcp_bucket_receiver.compression) supports the following:

GCP Bucket Receiver Compression Compression None

A compression_none block (within gcp_bucket_receiver.compression) supports the following:

GCP Bucket Receiver Filename Options

A filename_options block (within gcp_bucket_receiver) supports the following:

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

GCP Bucket Receiver Filename Options Log Type Folder

Deeply nested Folder block collapsed for readability.

GCP Bucket Receiver Filename Options No Folder

A no_folder block (within gcp_bucket_receiver.filename_options) supports the following:

GCP Bucket Receiver GCP Cred

A gcp_cred block (within gcp_bucket_receiver) 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

HTTP Receiver

A http_receiver block supports the following:

• auth_basic - Optional Block
Authentication parameters to access HTPP Log Receiver Endpoint
See Auth Basic below.

• auth_none - Optional Object
Enable this option

• auth_token - Optional Block
Access Token. Authentication Token for access
See Auth Token below.

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• no_tls - Optional Object
Enable this option

• uri - Optional String
HTTP URI is the URI of the HTTP endpoint to send logs to,

• use_tls - Optional Block
TLS Parameters for client connection to the endpoint
See Use TLS below.

HTTP Receiver Auth Basic

An auth_basic block (within http_receiver) supports the following:

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

• user_name - Optional String
username. HTTP Basic Auth username

HTTP Receiver Auth Basic Password

A password block (within http_receiver.auth_basic) 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.

HTTP Receiver Auth Basic Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Auth Basic Password Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Auth None

An auth_none block (within http_receiver) supports the following:

HTTP Receiver Auth Token

An auth_token block (within http_receiver) supports the following:

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

HTTP Receiver Auth Token Token

A token block (within http_receiver.auth_token) 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.

HTTP Receiver Auth Token Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Auth Token Token Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Batch

A batch block (within http_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

HTTP Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within http_receiver.batch) supports the following:

HTTP Receiver Batch Max Events Disabled

A max_events_disabled block (within http_receiver.batch) supports the following:

HTTP Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within http_receiver.batch) supports the following:

HTTP Receiver Compression

A compression block (within http_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

HTTP Receiver Compression Compression Default

A compression_default block (within http_receiver.compression) supports the following:

HTTP Receiver Compression Compression Gzip

A compression_gzip block (within http_receiver.compression) supports the following:

HTTP Receiver Compression Compression None

A compression_none block (within http_receiver.compression) supports the following:

HTTP Receiver No TLS

A no_tls block (within http_receiver) supports the following:

HTTP Receiver Use TLS

An use_tls block (within http_receiver) supports the following:

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
mTLS Client config allows configuration of mTLS client OPTIONS
See mTLS Enable below.

• no_ca - Optional Object
Enable this option

• 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

HTTP Receiver Use TLS Disable Verify Certificate

A disable_verify_certificate block (within http_receiver.use_tls) supports the following:

HTTP Receiver Use TLS Disable Verify Hostname

A disable_verify_hostname block (within http_receiver.use_tls) supports the following:

HTTP Receiver Use TLS Enable Verify Certificate

An enable_verify_certificate block (within http_receiver.use_tls) supports the following:

HTTP Receiver Use TLS Enable Verify Hostname

An enable_verify_hostname block (within http_receiver.use_tls) supports the following:

HTTP Receiver Use TLS mTLS Disabled

A mtls_disabled block (within http_receiver.use_tls) supports the following:

HTTP Receiver Use TLS mTLS Enable

A mtls_enable block (within http_receiver.use_tls) 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.

HTTP Receiver Use TLS mTLS Enable Key URL

Deeply nested URL block collapsed for readability.

HTTP Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Use TLS mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

HTTP Receiver Use TLS No CA

A no_ca block (within http_receiver.use_tls) supports the following:

Kafka Receiver

A kafka_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• bootstrap_servers - Optional List
List of host:port pairs of the Kafka brokers

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• kafka_topic - Optional String
The Kafka topic name to write events to

• no_tls - Optional Object
Enable this option

• use_tls - Optional Block
TLS Parameters for client connection to the endpoint
See Use TLS below.

Kafka Receiver Batch

A batch block (within kafka_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

Kafka Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within kafka_receiver.batch) supports the following:

Kafka Receiver Batch Max Events Disabled

A max_events_disabled block (within kafka_receiver.batch) supports the following:

Kafka Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within kafka_receiver.batch) supports the following:

Kafka Receiver Compression

A compression block (within kafka_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

Kafka Receiver Compression Compression Default

A compression_default block (within kafka_receiver.compression) supports the following:

Kafka Receiver Compression Compression Gzip

A compression_gzip block (within kafka_receiver.compression) supports the following:

Kafka Receiver Compression Compression None

A compression_none block (within kafka_receiver.compression) supports the following:

Kafka Receiver No TLS

A no_tls block (within kafka_receiver) supports the following:

Kafka Receiver Use TLS

An use_tls block (within kafka_receiver) supports the following:

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
mTLS Client config allows configuration of mTLS client OPTIONS
See mTLS Enable below.

• no_ca - Optional Object
Enable this option

• 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

Kafka Receiver Use TLS Disable Verify Certificate

A disable_verify_certificate block (within kafka_receiver.use_tls) supports the following:

Kafka Receiver Use TLS Disable Verify Hostname

A disable_verify_hostname block (within kafka_receiver.use_tls) supports the following:

Kafka Receiver Use TLS Enable Verify Certificate

An enable_verify_certificate block (within kafka_receiver.use_tls) supports the following:

Kafka Receiver Use TLS Enable Verify Hostname

An enable_verify_hostname block (within kafka_receiver.use_tls) supports the following:

Kafka Receiver Use TLS mTLS Disabled

A mtls_disabled block (within kafka_receiver.use_tls) supports the following:

Kafka Receiver Use TLS mTLS Enable

A mtls_enable block (within kafka_receiver.use_tls) 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.

Kafka Receiver Use TLS mTLS Enable Key URL

Deeply nested URL block collapsed for readability.

Kafka Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Kafka Receiver Use TLS mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

Kafka Receiver Use TLS No CA

A no_ca block (within kafka_receiver.use_tls) supports the following:

New Relic Receiver

A new_relic_receiver block supports the following:

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

• eu - Optional Object
Enable this option

• us - Optional Object
Enable this option

New Relic Receiver API Key

An api_key block (within new_relic_receiver) 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.

New Relic Receiver API Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

New Relic Receiver API Key Clear Secret Info

Deeply nested Info block collapsed for readability.

New Relic Receiver Eu

An eu block (within new_relic_receiver) supports the following:

New Relic Receiver Us

An us block (within new_relic_receiver) supports the following:

Ns All

A ns_all block supports the following:

Ns Current

A ns_current block supports the following:

Ns List

A ns_list block supports the following:

• namespaces - Optional List
Namespaces. List of namespaces to stream logs for

Qradar Receiver

A qradar_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• no_tls - Optional Object
Enable this option

• uri - Optional String
Log Source Collector URL is the URL of the IBM QRadar Log Source Collector to send logs to,

• use_tls - Optional Block
TLS Parameters for client connection to the endpoint
See Use TLS below.

Qradar Receiver Batch

A batch block (within qradar_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

Qradar Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within qradar_receiver.batch) supports the following:

Qradar Receiver Batch Max Events Disabled

A max_events_disabled block (within qradar_receiver.batch) supports the following:

Qradar Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within qradar_receiver.batch) supports the following:

Qradar Receiver Compression

A compression block (within qradar_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

Qradar Receiver Compression Compression Default

A compression_default block (within qradar_receiver.compression) supports the following:

Qradar Receiver Compression Compression Gzip

A compression_gzip block (within qradar_receiver.compression) supports the following:

Qradar Receiver Compression Compression None

A compression_none block (within qradar_receiver.compression) supports the following:

Qradar Receiver No TLS

A no_tls block (within qradar_receiver) supports the following:

Qradar Receiver Use TLS

An use_tls block (within qradar_receiver) supports the following:

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
mTLS Client config allows configuration of mTLS client OPTIONS
See mTLS Enable below.

• no_ca - Optional Object
Enable this option

• 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

Qradar Receiver Use TLS Disable Verify Certificate

A disable_verify_certificate block (within qradar_receiver.use_tls) supports the following:

Qradar Receiver Use TLS Disable Verify Hostname

A disable_verify_hostname block (within qradar_receiver.use_tls) supports the following:

Qradar Receiver Use TLS Enable Verify Certificate

An enable_verify_certificate block (within qradar_receiver.use_tls) supports the following:

Qradar Receiver Use TLS Enable Verify Hostname

An enable_verify_hostname block (within qradar_receiver.use_tls) supports the following:

Qradar Receiver Use TLS mTLS Disabled

A mtls_disabled block (within qradar_receiver.use_tls) supports the following:

Qradar Receiver Use TLS mTLS Enable

A mtls_enable block (within qradar_receiver.use_tls) 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.

Qradar Receiver Use TLS mTLS Enable Key URL

Deeply nested URL block collapsed for readability.

Qradar Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Qradar Receiver Use TLS mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

Qradar Receiver Use TLS No CA

A no_ca block (within qradar_receiver.use_tls) supports the following:

Request Logs

A request_logs block supports the following:

• sampled - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• unsampled - Optional Object
Enable this option

Request Logs Sampled

A sampled block (within request_logs) supports the following:

Request Logs Unsampled

An unsampled block (within request_logs) supports the following:

S3 Receiver

A s3_receiver block supports the following:

• aws_cred - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See AWS Cred below.

• aws_region - Optional String
Possible values are ap-northeast-1, ap-southeast-1, eu-central-1, eu-west-1, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-2, CA-central-1, af-south-1, ap-east-1, ap-south-1, ap-northeast-2, ap-southeast-2, eu-south-1, eu-north-1, eu-west-2, me-south-1, us-west-1, ap-southeast-3
[Enum: ap-northeast-1|ap-southeast-1|eu-central-1|eu-west-1|eu-west-3|sa-east-1|us-east-1|us-east-2|us-west-2|CA-central-1|af-south-1|ap-east-1|ap-south-1|ap-northeast-2|ap-southeast-2|eu-south-1|eu-north-1|eu-west-2|me-south-1|us-west-1|ap-southeast-3] AWS Region. AWS Region Name

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• bucket - Optional String
S3 Bucket Name. S3 Bucket Name

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• filename_options - Optional Block
Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file
See Filename Options below.

S3 Receiver AWS Cred

An aws_cred block (within s3_receiver) 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

S3 Receiver Batch

A batch block (within s3_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

S3 Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within s3_receiver.batch) supports the following:

S3 Receiver Batch Max Events Disabled

A max_events_disabled block (within s3_receiver.batch) supports the following:

S3 Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within s3_receiver.batch) supports the following:

S3 Receiver Compression

A compression block (within s3_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

S3 Receiver Compression Compression Default

A compression_default block (within s3_receiver.compression) supports the following:

S3 Receiver Compression Compression Gzip

A compression_gzip block (within s3_receiver.compression) supports the following:

S3 Receiver Compression Compression None

A compression_none block (within s3_receiver.compression) supports the following:

S3 Receiver Filename Options

A filename_options block (within s3_receiver) supports the following:

• custom_folder - Optional String
Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match

• log_type_folder - Optional Object
Configuration parameter for log type folder

• no_folder - Optional Object
Enable this option

S3 Receiver Filename Options Log Type Folder

A log_type_folder block (within s3_receiver.filename_options) supports the following:

S3 Receiver Filename Options No Folder

A no_folder block (within s3_receiver.filename_options) supports the following:

Security Events

A security_events block supports the following:

Splunk Receiver

A splunk_receiver block supports the following:

• batch - Optional Block
Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint
See Batch below.

• compression - Optional Block
Configuration parameter for compression
See Compression below.

• endpoint - Optional String
Splunk HEC Logs Endpoint. Splunk HEC Logs Endpoint, (Note: must not contain /services/collector)

• no_tls - Optional Object
Enable this option

• splunk_hec_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Splunk Hec Token below.

• use_tls - Optional Block
TLS Parameters for client connection to the endpoint
See Use TLS below.

Splunk Receiver Batch

A batch block (within splunk_receiver) supports the following:

• max_bytes - Optional Number
Send batch to endpoint after the batch is equal to or larger than this many bytes

• max_bytes_disabled - Optional Object
Enable this option

• max_events - Optional Number
Send batch to endpoint after this many log messages are in the batch

• max_events_disabled - Optional Object
Enable this option

• timeout_seconds - Optional String
Send batch to the endpoint after this many seconds

• timeout_seconds_default - Optional Object
Enable this option

Splunk Receiver Batch Max Bytes Disabled

A max_bytes_disabled block (within splunk_receiver.batch) supports the following:

Splunk Receiver Batch Max Events Disabled

A max_events_disabled block (within splunk_receiver.batch) supports the following:

Splunk Receiver Batch Timeout Seconds Default

A timeout_seconds_default block (within splunk_receiver.batch) supports the following:

Splunk Receiver Compression

A compression block (within splunk_receiver) supports the following:

• compression_default - Optional Object
Configuration parameter for compression default

• compression_gzip - Optional Object
Enable this option

• compression_none - Optional Object
Configuration parameter for compression none

Splunk Receiver Compression Compression Default

A compression_default block (within splunk_receiver.compression) supports the following:

Splunk Receiver Compression Compression Gzip

A compression_gzip block (within splunk_receiver.compression) supports the following:

Splunk Receiver Compression Compression None

A compression_none block (within splunk_receiver.compression) supports the following:

Splunk Receiver No TLS

A no_tls block (within splunk_receiver) supports the following:

Splunk Receiver Splunk Hec Token

A splunk_hec_token block (within splunk_receiver) 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.

Splunk Receiver Splunk Hec Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Splunk Receiver Splunk Hec Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Splunk Receiver Use TLS

An use_tls block (within splunk_receiver) supports the following:

• disable_verify_certificate - Optional Object
Configuration parameter for disable verify certificate

• disable_verify_hostname - Optional Object
Enable this option

• enable_verify_certificate - Optional Object
Configuration parameter for enable verify certificate

• enable_verify_hostname - Optional Object
Enable this option

• mtls_disabled - Optional Object
Enable this option

• mtls_enable - Optional Block
mTLS Client config allows configuration of mTLS client OPTIONS
See mTLS Enable below.

• no_ca - Optional Object
Enable this option

• 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

Splunk Receiver Use TLS Disable Verify Certificate

A disable_verify_certificate block (within splunk_receiver.use_tls) supports the following:

Splunk Receiver Use TLS Disable Verify Hostname

A disable_verify_hostname block (within splunk_receiver.use_tls) supports the following:

Splunk Receiver Use TLS Enable Verify Certificate

An enable_verify_certificate block (within splunk_receiver.use_tls) supports the following:

Splunk Receiver Use TLS Enable Verify Hostname

An enable_verify_hostname block (within splunk_receiver.use_tls) supports the following:

Splunk Receiver Use TLS mTLS Disabled

A mtls_disabled block (within splunk_receiver.use_tls) supports the following:

Splunk Receiver Use TLS mTLS Enable

A mtls_enable block (within splunk_receiver.use_tls) 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.

Splunk Receiver Use TLS mTLS Enable Key URL

Deeply nested URL block collapsed for readability.

Splunk Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Splunk Receiver Use TLS mTLS Enable Key URL Clear Secret Info

Deeply nested Info block collapsed for readability.

Splunk Receiver Use TLS No CA

A no_ca block (within splunk_receiver.use_tls) supports the following:

Sumo Logic Receiver

A sumo_logic_receiver block supports the following:

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

Sumo Logic Receiver URL

An url block (within sumo_logic_receiver) 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.

Sumo Logic Receiver URL Blindfold Secret Info

A blindfold_secret_info block (within sumo_logic_receiver.url) supports the following:

• 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:///

Sumo Logic Receiver URL Clear Secret Info

A clear_secret_info block (within sumo_logic_receiver.url) supports the following:

• 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

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_global_log_receiver.example system/example