@robinmordasiewicz/f5xc-terraform-mcp 3.10.3 → 3.10.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/policer.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/resources/bgp.md +205 -37
- package/dist/docs/resources/cloud_connect.md +2 -2
- package/dist/docs/resources/fast_acl.md +166 -60
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +44 -825
- package/dist/docs/resources/network_policy.md +125 -119
- package/dist/docs/resources/policer.md +10 -50
- package/dist/docs/resources/securemesh_site.md +253 -1614
- package/dist/docs/resources/site.md +527 -233
- package/dist/docs/resources/workload.md +2951 -9
- package/dist/metadata/resource-metadata.json +301 -621
- package/dist/services/addons.js +2 -2
- package/dist/services/addons.js.map +1 -1
- package/dist/services/api-specs.js.map +1 -1
- package/dist/services/documentation.js +1 -1
- package/dist/services/documentation.js.map +1 -1
- package/dist/services/metadata.js +1 -1
- package/dist/services/metadata.js.map +1 -1
- package/dist/tools/auth.js +2 -2
- package/dist/tools/auth.js.map +1 -1
- package/dist/tools/metadata.js +4 -4
- package/dist/tools/metadata.js.map +1 -1
- package/package.json +7 -2
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_log_receiver Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Monitoring"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages new
|
|
5
|
+
Manages new Log Receiver object. in F5 Distributed Cloud.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_log_receiver (Resource)
|
|
9
9
|
|
|
10
|
-
Manages new
|
|
10
|
+
Manages new Log Receiver object. in F5 Distributed Cloud.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages new Global Log Receiver object. in F5 Distributed Cloud.
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Log Receiver Resource Example
|
|
18
|
-
# Manages new
|
|
18
|
+
# Manages new Log Receiver object. in F5 Distributed Cloud.
|
|
19
19
|
|
|
20
20
|
# Basic Log Receiver configuration
|
|
21
21
|
resource "f5xc_log_receiver" "example" {
|
|
@@ -65,32 +65,11 @@ resource "f5xc_log_receiver" "example" {
|
|
|
65
65
|
|
|
66
66
|
### Spec Argument Reference
|
|
67
67
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
<
|
|
71
|
-
|
|
72
|
-
<
|
|
73
|
-
|
|
74
|
-
-> **One of the following:**
|
|
75
|
-
• <a id="aws-cloud-watch-receiver"></a>[`aws_cloud_watch_receiver`](#aws-cloud-watch-receiver) - Optional Block<br>AWS Cloudwatch Logs Configuration for Global Log Receiver<br>See [AWS Cloud Watch Receiver](#aws-cloud-watch-receiver) below for details.
|
|
76
|
-
<br><br>• <a id="azure-event-hubs-receiver"></a>[`azure_event_hubs_receiver`](#azure-event-hubs-receiver) - Optional Block<br>Azure Event Hubs Configuration for Global Log Receiver<br>See [Azure Event Hubs Receiver](#azure-event-hubs-receiver) below for details.
|
|
77
|
-
<br><br>• <a id="azure-receiver"></a>[`azure_receiver`](#azure-receiver) - Optional Block<br>Azure Blob Configuration for Global Log Receiver<br>See [Azure Receiver](#azure-receiver) below for details.
|
|
78
|
-
<br><br>• <a id="datadog-receiver"></a>[`datadog_receiver`](#datadog-receiver) - Optional Block<br>Datadog Configuration. Configuration for Datadog endpoint<br>See [Datadog Receiver](#datadog-receiver) below for details.
|
|
79
|
-
<br><br>• <a id="gcp-bucket-receiver"></a>[`gcp_bucket_receiver`](#gcp-bucket-receiver) - Optional Block<br>GCP Bucket Configuration for Global Log Receiver<br>See [GCP Bucket Receiver](#gcp-bucket-receiver) below for details.
|
|
80
|
-
<br><br>• <a id="http-receiver"></a>[`http_receiver`](#http-receiver) - Optional Block<br>HTTP Configuration. Configuration for HTTP endpoint
|
|
81
|
-
<br><br>• <a id="kafka-receiver"></a>[`kafka_receiver`](#kafka-receiver) - Optional Block<br>Kafka Configuration for Global Log Receiver
|
|
82
|
-
<br><br>• <a id="new-relic-receiver"></a>[`new_relic_receiver`](#new-relic-receiver) - Optional Block<br>NewRelic Configuration. Configuration for NewRelic endpoint
|
|
83
|
-
<br><br>• <a id="qradar-receiver"></a>[`qradar_receiver`](#qradar-receiver) - Optional Block<br>IBM QRadar Configuration. Configuration for IBM QRadar endpoint
|
|
84
|
-
<br><br>• <a id="s3-receiver"></a>[`s3_receiver`](#s3-receiver) - Optional Block<br>S3 Configuration for Global Log Receiver
|
|
85
|
-
<br><br>• <a id="splunk-receiver"></a>[`splunk_receiver`](#splunk-receiver) - Optional Block<br>Configuration for Splunk HEC Logs endpoint
|
|
86
|
-
<br><br>• <a id="sumo-logic-receiver"></a>[`sumo_logic_receiver`](#sumo-logic-receiver) - Optional Block<br>SumoLogic Configuration. Configuration for SumoLogic endpoint
|
|
87
|
-
|
|
88
|
-
-> **One of the following:**
|
|
89
|
-
• <a id="ns-all"></a>[`ns_all`](#ns-all) - Optional Block<br>Enable this option
|
|
90
|
-
<br><br>• <a id="ns-current"></a>[`ns_current`](#ns-current) - Optional Block<br>Enable this option
|
|
91
|
-
<br><br>• <a id="ns-list"></a>[`ns_list`](#ns-list) - Optional Block<br>Namespace List. Namespace List
|
|
92
|
-
|
|
93
|
-
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
68
|
+
<a id="site-local"></a>• [`site_local`](#site-local) - Optional Block<br>Enable this option
|
|
69
|
+
|
|
70
|
+
<a id="syslog"></a>• [`syslog`](#syslog) - Optional Block<br>Syslog Server Configuration. Configuration for syslog server<br>See [Syslog](#syslog) below for details.
|
|
71
|
+
|
|
72
|
+
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
94
73
|
|
|
95
74
|
### Attributes Reference
|
|
96
75
|
|
|
@@ -100,837 +79,77 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
100
79
|
|
|
101
80
|
---
|
|
102
81
|
|
|
103
|
-
####
|
|
104
|
-
|
|
105
|
-
An [`aws_cloud_watch_receiver`](#aws-cloud-watch-receiver) block supports the following:
|
|
106
|
-
|
|
107
|
-
<a id="aws-cloud-watch-receiver-aws-cred"></a>• [`aws_cred`](#aws-cloud-watch-receiver-aws-cred) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [AWS Cred](#aws-cloud-watch-receiver-aws-cred) below.
|
|
108
|
-
|
|
109
|
-
<a id="aws-cloud-watch-receiver-aws-region"></a>• [`aws_region`](#aws-cloud-watch-receiver-aws-region) - Optional String<br>AWS Region. AWS Region Name
|
|
110
|
-
|
|
111
|
-
<a id="aws-cloud-watch-receiver-batch"></a>• [`batch`](#aws-cloud-watch-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#aws-cloud-watch-receiver-batch) below.
|
|
112
|
-
|
|
113
|
-
<a id="aws-cloud-watch-receiver-compression"></a>• [`compression`](#aws-cloud-watch-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#aws-cloud-watch-receiver-compression) below.
|
|
114
|
-
|
|
115
|
-
<a id="aws-cloud-watch-receiver-group-name"></a>• [`group_name`](#aws-cloud-watch-receiver-group-name) - Optional String<br>The group name of the target Cloudwatch Logs stream
|
|
116
|
-
|
|
117
|
-
<a id="aws-cloud-watch-receiver-stream-name"></a>• [`stream_name`](#aws-cloud-watch-receiver-stream-name) - Optional String<br>The stream name of the target Cloudwatch Logs stream. Note that there can only be one writer to a log stream at a time
|
|
118
|
-
|
|
119
|
-
#### AWS Cloud Watch Receiver AWS Cred
|
|
120
|
-
|
|
121
|
-
An [`aws_cred`](#aws-cloud-watch-receiver-aws-cred) block (within [`aws_cloud_watch_receiver`](#aws-cloud-watch-receiver)) supports the following:
|
|
122
|
-
|
|
123
|
-
<a id="aws-cloud-watch-receiver-aws-cred-name"></a>• [`name`](#aws-cloud-watch-receiver-aws-cred-name) - Optional String<br>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
|
|
124
|
-
|
|
125
|
-
<a id="namespace-b9cb40"></a>• [`namespace`](#namespace-b9cb40) - Optional String<br>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
|
|
126
|
-
|
|
127
|
-
<a id="tenant-fc3ba9"></a>• [`tenant`](#tenant-fc3ba9) - Optional String<br>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
|
|
128
|
-
|
|
129
|
-
#### AWS Cloud Watch Receiver Batch
|
|
130
|
-
|
|
131
|
-
A [`batch`](#aws-cloud-watch-receiver-batch) block (within [`aws_cloud_watch_receiver`](#aws-cloud-watch-receiver)) supports the following:
|
|
132
|
-
|
|
133
|
-
<a id="bytes-fb8782"></a>• [`max_bytes`](#bytes-fb8782) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
134
|
-
|
|
135
|
-
<a id="disabled-e2ec6b"></a>• [`max_bytes_disabled`](#disabled-e2ec6b) - Optional Block<br>Enable this option
|
|
136
|
-
|
|
137
|
-
<a id="events-0606a7"></a>• [`max_events`](#events-0606a7) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
138
|
-
|
|
139
|
-
<a id="disabled-3c3dcd"></a>• [`max_events_disabled`](#disabled-3c3dcd) - Optional Block<br>Enable this option
|
|
140
|
-
|
|
141
|
-
<a id="seconds-d5b12a"></a>• [`timeout_seconds`](#seconds-d5b12a) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
142
|
-
|
|
143
|
-
<a id="default-697810"></a>• [`timeout_seconds_default`](#default-697810) - Optional Block<br>Enable this option
|
|
144
|
-
|
|
145
|
-
#### AWS Cloud Watch Receiver Compression
|
|
146
|
-
|
|
147
|
-
A [`compression`](#aws-cloud-watch-receiver-compression) block (within [`aws_cloud_watch_receiver`](#aws-cloud-watch-receiver)) supports the following:
|
|
148
|
-
|
|
149
|
-
<a id="default-963843"></a>• [`compression_default`](#default-963843) - Optional Block<br>Enable this option
|
|
150
|
-
|
|
151
|
-
<a id="gzip-2ccbff"></a>• [`compression_gzip`](#gzip-2ccbff) - Optional Block<br>Enable this option
|
|
152
|
-
|
|
153
|
-
<a id="none-640cb2"></a>• [`compression_none`](#none-640cb2) - Optional Block<br>Enable this option
|
|
154
|
-
|
|
155
|
-
#### Azure Event Hubs Receiver
|
|
156
|
-
|
|
157
|
-
An [`azure_event_hubs_receiver`](#azure-event-hubs-receiver) block supports the following:
|
|
158
|
-
|
|
159
|
-
<a id="string-b729f9"></a>• [`connection_string`](#string-b729f9) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Connection String](#string-b729f9) below.
|
|
160
|
-
|
|
161
|
-
<a id="azure-event-hubs-receiver-instance"></a>• [`instance`](#azure-event-hubs-receiver-instance) - Optional String<br>Event Hubs Instance name into which logs should be stored
|
|
162
|
-
|
|
163
|
-
<a id="azure-event-hubs-receiver-namespace"></a>• [`namespace`](#azure-event-hubs-receiver-namespace) - Optional String<br>Event Hubs Namespace is namespace with instance into which logs should be stored
|
|
164
|
-
|
|
165
|
-
#### Azure Event Hubs Receiver Connection String
|
|
166
|
-
|
|
167
|
-
A [`connection_string`](#string-b729f9) block (within [`azure_event_hubs_receiver`](#azure-event-hubs-receiver)) supports the following:
|
|
168
|
-
|
|
169
|
-
<a id="info-0b01ca"></a>• [`blindfold_secret_info`](#info-0b01ca) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-0b01ca) below.
|
|
170
|
-
|
|
171
|
-
<a id="info-a586ad"></a>• [`clear_secret_info`](#info-a586ad) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-a586ad) below.
|
|
172
|
-
|
|
173
|
-
#### Azure Event Hubs Receiver Connection String Blindfold Secret Info
|
|
174
|
-
|
|
175
|
-
<a id="deep-93e549"></a>Deeply nested **Info** block collapsed for readability.
|
|
176
|
-
|
|
177
|
-
#### Azure Event Hubs Receiver Connection String Clear Secret Info
|
|
178
|
-
|
|
179
|
-
<a id="deep-2ae3ac"></a>Deeply nested **Info** block collapsed for readability.
|
|
180
|
-
|
|
181
|
-
#### Azure Receiver
|
|
182
|
-
|
|
183
|
-
An [`azure_receiver`](#azure-receiver) block supports the following:
|
|
184
|
-
|
|
185
|
-
<a id="azure-receiver-batch"></a>• [`batch`](#azure-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#azure-receiver-batch) below.
|
|
186
|
-
|
|
187
|
-
<a id="azure-receiver-compression"></a>• [`compression`](#azure-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#azure-receiver-compression) below.
|
|
188
|
-
|
|
189
|
-
<a id="azure-receiver-connection-string"></a>• [`connection_string`](#azure-receiver-connection-string) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Connection String](#azure-receiver-connection-string) below.
|
|
190
|
-
|
|
191
|
-
<a id="azure-receiver-container-name"></a>• [`container_name`](#azure-receiver-container-name) - Optional String<br>Container Name is the name of the container into which logs should be stored
|
|
192
|
-
|
|
193
|
-
<a id="azure-receiver-filename-options"></a>• [`filename_options`](#azure-receiver-filename-options) - Optional Block<br>Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file<br>See [Filename Options](#azure-receiver-filename-options) below.
|
|
194
|
-
|
|
195
|
-
#### Azure Receiver Batch
|
|
196
|
-
|
|
197
|
-
A [`batch`](#azure-receiver-batch) block (within [`azure_receiver`](#azure-receiver)) supports the following:
|
|
198
|
-
|
|
199
|
-
<a id="azure-receiver-batch-max-bytes"></a>• [`max_bytes`](#azure-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
200
|
-
|
|
201
|
-
<a id="azure-receiver-batch-max-bytes-disabled"></a>• [`max_bytes_disabled`](#azure-receiver-batch-max-bytes-disabled) - Optional Block<br>Enable this option
|
|
202
|
-
|
|
203
|
-
<a id="azure-receiver-batch-max-events"></a>• [`max_events`](#azure-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
204
|
-
|
|
205
|
-
<a id="disabled-754236"></a>• [`max_events_disabled`](#disabled-754236) - Optional Block<br>Enable this option
|
|
206
|
-
|
|
207
|
-
<a id="azure-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#azure-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
208
|
-
|
|
209
|
-
<a id="default-19a14b"></a>• [`timeout_seconds_default`](#default-19a14b) - Optional Block<br>Enable this option
|
|
210
|
-
|
|
211
|
-
#### Azure Receiver Compression
|
|
212
|
-
|
|
213
|
-
A [`compression`](#azure-receiver-compression) block (within [`azure_receiver`](#azure-receiver)) supports the following:
|
|
214
|
-
|
|
215
|
-
<a id="default-02273a"></a>• [`compression_default`](#default-02273a) - Optional Block<br>Enable this option
|
|
216
|
-
|
|
217
|
-
<a id="gzip-156cfe"></a>• [`compression_gzip`](#gzip-156cfe) - Optional Block<br>Enable this option
|
|
218
|
-
|
|
219
|
-
<a id="none-aaef5b"></a>• [`compression_none`](#none-aaef5b) - Optional Block<br>Enable this option
|
|
220
|
-
|
|
221
|
-
#### Azure Receiver Connection String
|
|
222
|
-
|
|
223
|
-
A [`connection_string`](#azure-receiver-connection-string) block (within [`azure_receiver`](#azure-receiver)) supports the following:
|
|
224
|
-
|
|
225
|
-
<a id="info-e8810f"></a>• [`blindfold_secret_info`](#info-e8810f) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-e8810f) below.
|
|
226
|
-
|
|
227
|
-
<a id="info-e37fa5"></a>• [`clear_secret_info`](#info-e37fa5) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-e37fa5) below.
|
|
228
|
-
|
|
229
|
-
#### Azure Receiver Connection String Blindfold Secret Info
|
|
230
|
-
|
|
231
|
-
A [`blindfold_secret_info`](#info-e8810f) block (within [`azure_receiver.connection_string`](#azure-receiver-connection-string)) supports the following:
|
|
232
|
-
|
|
233
|
-
<a id="provider-89bfbb"></a>• [`decryption_provider`](#provider-89bfbb) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
234
|
-
|
|
235
|
-
<a id="location-15db90"></a>• [`location`](#location-15db90) - Optional String<br>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
|
|
236
|
-
|
|
237
|
-
<a id="provider-b18b33"></a>• [`store_provider`](#provider-b18b33) - Optional String<br>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:///
|
|
238
|
-
|
|
239
|
-
#### Azure Receiver Connection String Clear Secret Info
|
|
240
|
-
|
|
241
|
-
A [`clear_secret_info`](#info-e37fa5) block (within [`azure_receiver.connection_string`](#azure-receiver-connection-string)) supports the following:
|
|
242
|
-
|
|
243
|
-
<a id="ref-29f26d"></a>• [`provider_ref`](#ref-29f26d) - Optional String<br>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:///
|
|
244
|
-
|
|
245
|
-
<a id="url-06a3b0"></a>• [`url`](#url-06a3b0) - Optional String<br>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
|
|
246
|
-
|
|
247
|
-
#### Azure Receiver Filename Options
|
|
248
|
-
|
|
249
|
-
A [`filename_options`](#azure-receiver-filename-options) block (within [`azure_receiver`](#azure-receiver)) supports the following:
|
|
250
|
-
|
|
251
|
-
<a id="folder-153221"></a>• [`custom_folder`](#folder-153221) - Optional String<br>Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match
|
|
252
|
-
|
|
253
|
-
<a id="folder-1cd085"></a>• [`log_type_folder`](#folder-1cd085) - Optional Block<br>Enable this option
|
|
254
|
-
|
|
255
|
-
<a id="folder-569968"></a>• [`no_folder`](#folder-569968) - Optional Block<br>Enable this option
|
|
256
|
-
|
|
257
|
-
#### Datadog Receiver
|
|
258
|
-
|
|
259
|
-
A [`datadog_receiver`](#datadog-receiver) block supports the following:
|
|
260
|
-
|
|
261
|
-
<a id="datadog-receiver-batch"></a>• [`batch`](#datadog-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#datadog-receiver-batch) below.
|
|
262
|
-
|
|
263
|
-
<a id="datadog-receiver-compression"></a>• [`compression`](#datadog-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#datadog-receiver-compression) below.
|
|
264
|
-
|
|
265
|
-
<a id="datadog-receiver-datadog-api-key"></a>• [`datadog_api_key`](#datadog-receiver-datadog-api-key) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Datadog API Key](#datadog-receiver-datadog-api-key) below.
|
|
266
|
-
|
|
267
|
-
<a id="datadog-receiver-endpoint"></a>• [`endpoint`](#datadog-receiver-endpoint) - Optional String<br>Datadog Endpoint,
|
|
268
|
-
|
|
269
|
-
<a id="datadog-receiver-no-tls"></a>• [`no_tls`](#datadog-receiver-no-tls) - Optional Block<br>Enable this option
|
|
270
|
-
|
|
271
|
-
<a id="datadog-receiver-site"></a>• [`site`](#datadog-receiver-site) - Optional String<br>Datadog Site,
|
|
272
|
-
|
|
273
|
-
<a id="datadog-receiver-use-tls"></a>• [`use_tls`](#datadog-receiver-use-tls) - Optional Block<br>TLS Parameters for client connection to the endpoint<br>See [Use TLS](#datadog-receiver-use-tls) below.
|
|
274
|
-
|
|
275
|
-
#### Datadog Receiver Batch
|
|
276
|
-
|
|
277
|
-
A [`batch`](#datadog-receiver-batch) block (within [`datadog_receiver`](#datadog-receiver)) supports the following:
|
|
278
|
-
|
|
279
|
-
<a id="datadog-receiver-batch-max-bytes"></a>• [`max_bytes`](#datadog-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
280
|
-
|
|
281
|
-
<a id="disabled-96f32b"></a>• [`max_bytes_disabled`](#disabled-96f32b) - Optional Block<br>Enable this option
|
|
282
|
-
|
|
283
|
-
<a id="datadog-receiver-batch-max-events"></a>• [`max_events`](#datadog-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
284
|
-
|
|
285
|
-
<a id="disabled-a9dbc9"></a>• [`max_events_disabled`](#disabled-a9dbc9) - Optional Block<br>Enable this option
|
|
286
|
-
|
|
287
|
-
<a id="datadog-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#datadog-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
288
|
-
|
|
289
|
-
<a id="default-f00e06"></a>• [`timeout_seconds_default`](#default-f00e06) - Optional Block<br>Enable this option
|
|
290
|
-
|
|
291
|
-
#### Datadog Receiver Compression
|
|
292
|
-
|
|
293
|
-
A [`compression`](#datadog-receiver-compression) block (within [`datadog_receiver`](#datadog-receiver)) supports the following:
|
|
294
|
-
|
|
295
|
-
<a id="default-888579"></a>• [`compression_default`](#default-888579) - Optional Block<br>Enable this option
|
|
296
|
-
|
|
297
|
-
<a id="gzip-004135"></a>• [`compression_gzip`](#gzip-004135) - Optional Block<br>Enable this option
|
|
298
|
-
|
|
299
|
-
<a id="none-4e31f2"></a>• [`compression_none`](#none-4e31f2) - Optional Block<br>Enable this option
|
|
300
|
-
|
|
301
|
-
#### Datadog Receiver Datadog API Key
|
|
302
|
-
|
|
303
|
-
A [`datadog_api_key`](#datadog-receiver-datadog-api-key) block (within [`datadog_receiver`](#datadog-receiver)) supports the following:
|
|
304
|
-
|
|
305
|
-
<a id="info-c8197d"></a>• [`blindfold_secret_info`](#info-c8197d) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-c8197d) below.
|
|
306
|
-
|
|
307
|
-
<a id="info-400d24"></a>• [`clear_secret_info`](#info-400d24) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-400d24) below.
|
|
308
|
-
|
|
309
|
-
#### Datadog Receiver Datadog API Key Blindfold Secret Info
|
|
310
|
-
|
|
311
|
-
<a id="deep-c2b922"></a>Deeply nested **Info** block collapsed for readability.
|
|
312
|
-
|
|
313
|
-
#### Datadog Receiver Datadog API Key Clear Secret Info
|
|
314
|
-
|
|
315
|
-
<a id="deep-e21218"></a>Deeply nested **Info** block collapsed for readability.
|
|
316
|
-
|
|
317
|
-
#### Datadog Receiver Use TLS
|
|
318
|
-
|
|
319
|
-
An [`use_tls`](#datadog-receiver-use-tls) block (within [`datadog_receiver`](#datadog-receiver)) supports the following:
|
|
320
|
-
|
|
321
|
-
<a id="certificate-fc103e"></a>• [`disable_verify_certificate`](#certificate-fc103e) - Optional Block<br>Enable this option
|
|
322
|
-
|
|
323
|
-
<a id="hostname-e3faa0"></a>• [`disable_verify_hostname`](#hostname-e3faa0) - Optional Block<br>Enable this option
|
|
324
|
-
|
|
325
|
-
<a id="certificate-37d53f"></a>• [`enable_verify_certificate`](#certificate-37d53f) - Optional Block<br>Enable this option
|
|
326
|
-
|
|
327
|
-
<a id="hostname-5c7a30"></a>• [`enable_verify_hostname`](#hostname-5c7a30) - Optional Block<br>Enable this option
|
|
328
|
-
|
|
329
|
-
<a id="datadog-receiver-use-tls-mtls-disabled"></a>• [`mtls_disabled`](#datadog-receiver-use-tls-mtls-disabled) - Optional Block<br>Enable this option
|
|
330
|
-
|
|
331
|
-
<a id="datadog-receiver-use-tls-mtls-enable"></a>• [`mtls_enable`](#datadog-receiver-use-tls-mtls-enable) - Optional Block<br>mTLS Client config allows configuration of mTLS client OPTIONS<br>See [mTLS Enable](#datadog-receiver-use-tls-mtls-enable) below.
|
|
332
|
-
|
|
333
|
-
<a id="datadog-receiver-use-tls-no-ca"></a>• [`no_ca`](#datadog-receiver-use-tls-no-ca) - Optional Block<br>Enable this option
|
|
334
|
-
|
|
335
|
-
<a id="datadog-receiver-use-tls-trusted-ca-url"></a>• [`trusted_ca_url`](#datadog-receiver-use-tls-trusted-ca-url) - Optional String<br>The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers
|
|
336
|
-
|
|
337
|
-
#### Datadog Receiver Use TLS mTLS Enable
|
|
338
|
-
|
|
339
|
-
A [`mtls_enable`](#datadog-receiver-use-tls-mtls-enable) block (within [`datadog_receiver.use_tls`](#datadog-receiver-use-tls)) supports the following:
|
|
340
|
-
|
|
341
|
-
<a id="certificate-a6bd6b"></a>• [`certificate`](#certificate-a6bd6b) - Optional String<br>Client certificate is PEM-encoded certificate or certificate-chain
|
|
342
|
-
|
|
343
|
-
<a id="url-266095"></a>• [`key_url`](#url-266095) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Key URL](#url-266095) below.
|
|
344
|
-
|
|
345
|
-
#### Datadog Receiver Use TLS mTLS Enable Key URL
|
|
346
|
-
|
|
347
|
-
<a id="deep-fe94b6"></a>Deeply nested **URL** block collapsed for readability.
|
|
348
|
-
|
|
349
|
-
#### Datadog Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info
|
|
350
|
-
|
|
351
|
-
<a id="deep-5cf738"></a>Deeply nested **Info** block collapsed for readability.
|
|
352
|
-
|
|
353
|
-
#### Datadog Receiver Use TLS mTLS Enable Key URL Clear Secret Info
|
|
354
|
-
|
|
355
|
-
<a id="deep-3705c0"></a>Deeply nested **Info** block collapsed for readability.
|
|
356
|
-
|
|
357
|
-
#### GCP Bucket Receiver
|
|
358
|
-
|
|
359
|
-
A [`gcp_bucket_receiver`](#gcp-bucket-receiver) block supports the following:
|
|
360
|
-
|
|
361
|
-
<a id="gcp-bucket-receiver-batch"></a>• [`batch`](#gcp-bucket-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#gcp-bucket-receiver-batch) below.
|
|
362
|
-
|
|
363
|
-
<a id="gcp-bucket-receiver-bucket"></a>• [`bucket`](#gcp-bucket-receiver-bucket) - Optional String<br>GCP Bucket Name. GCP Bucket Name
|
|
364
|
-
|
|
365
|
-
<a id="gcp-bucket-receiver-compression"></a>• [`compression`](#gcp-bucket-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#gcp-bucket-receiver-compression) below.
|
|
366
|
-
|
|
367
|
-
<a id="gcp-bucket-receiver-filename-options"></a>• [`filename_options`](#gcp-bucket-receiver-filename-options) - Optional Block<br>Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file<br>See [Filename Options](#gcp-bucket-receiver-filename-options) below.
|
|
368
|
-
|
|
369
|
-
<a id="gcp-bucket-receiver-gcp-cred"></a>• [`gcp_cred`](#gcp-bucket-receiver-gcp-cred) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [GCP Cred](#gcp-bucket-receiver-gcp-cred) below.
|
|
370
|
-
|
|
371
|
-
#### GCP Bucket Receiver Batch
|
|
372
|
-
|
|
373
|
-
A [`batch`](#gcp-bucket-receiver-batch) block (within [`gcp_bucket_receiver`](#gcp-bucket-receiver)) supports the following:
|
|
374
|
-
|
|
375
|
-
<a id="gcp-bucket-receiver-batch-max-bytes"></a>• [`max_bytes`](#gcp-bucket-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
376
|
-
|
|
377
|
-
<a id="disabled-2aebe7"></a>• [`max_bytes_disabled`](#disabled-2aebe7) - Optional Block<br>Enable this option
|
|
378
|
-
|
|
379
|
-
<a id="gcp-bucket-receiver-batch-max-events"></a>• [`max_events`](#gcp-bucket-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
380
|
-
|
|
381
|
-
<a id="disabled-6b6d30"></a>• [`max_events_disabled`](#disabled-6b6d30) - Optional Block<br>Enable this option
|
|
382
|
-
|
|
383
|
-
<a id="seconds-a39e0f"></a>• [`timeout_seconds`](#seconds-a39e0f) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
384
|
-
|
|
385
|
-
<a id="default-2db988"></a>• [`timeout_seconds_default`](#default-2db988) - Optional Block<br>Enable this option
|
|
386
|
-
|
|
387
|
-
#### GCP Bucket Receiver Compression
|
|
388
|
-
|
|
389
|
-
A [`compression`](#gcp-bucket-receiver-compression) block (within [`gcp_bucket_receiver`](#gcp-bucket-receiver)) supports the following:
|
|
390
|
-
|
|
391
|
-
<a id="default-db78dc"></a>• [`compression_default`](#default-db78dc) - Optional Block<br>Enable this option
|
|
392
|
-
|
|
393
|
-
<a id="gzip-c72b3f"></a>• [`compression_gzip`](#gzip-c72b3f) - Optional Block<br>Enable this option
|
|
394
|
-
|
|
395
|
-
<a id="none-8916e9"></a>• [`compression_none`](#none-8916e9) - Optional Block<br>Enable this option
|
|
396
|
-
|
|
397
|
-
#### GCP Bucket Receiver Filename Options
|
|
398
|
-
|
|
399
|
-
A [`filename_options`](#gcp-bucket-receiver-filename-options) block (within [`gcp_bucket_receiver`](#gcp-bucket-receiver)) supports the following:
|
|
400
|
-
|
|
401
|
-
<a id="folder-ab0859"></a>• [`custom_folder`](#folder-ab0859) - Optional String<br>Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match
|
|
402
|
-
|
|
403
|
-
<a id="folder-3d88ea"></a>• [`log_type_folder`](#folder-3d88ea) - Optional Block<br>Enable this option
|
|
404
|
-
|
|
405
|
-
<a id="folder-0b7426"></a>• [`no_folder`](#folder-0b7426) - Optional Block<br>Enable this option
|
|
406
|
-
|
|
407
|
-
#### GCP Bucket Receiver GCP Cred
|
|
408
|
-
|
|
409
|
-
A [`gcp_cred`](#gcp-bucket-receiver-gcp-cred) block (within [`gcp_bucket_receiver`](#gcp-bucket-receiver)) supports the following:
|
|
410
|
-
|
|
411
|
-
<a id="gcp-bucket-receiver-gcp-cred-name"></a>• [`name`](#gcp-bucket-receiver-gcp-cred-name) - Optional String<br>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
|
|
412
|
-
|
|
413
|
-
<a id="gcp-bucket-receiver-gcp-cred-namespace"></a>• [`namespace`](#gcp-bucket-receiver-gcp-cred-namespace) - Optional String<br>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
|
|
414
|
-
|
|
415
|
-
<a id="gcp-bucket-receiver-gcp-cred-tenant"></a>• [`tenant`](#gcp-bucket-receiver-gcp-cred-tenant) - Optional String<br>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
|
|
416
|
-
|
|
417
|
-
#### HTTP Receiver
|
|
418
|
-
|
|
419
|
-
A [`http_receiver`](#http-receiver) block supports the following:
|
|
420
|
-
|
|
421
|
-
<a id="http-receiver-auth-basic"></a>• [`auth_basic`](#http-receiver-auth-basic) - Optional Block<br>Authentication parameters to access HTPP Log Receiver Endpoint<br>See [Auth Basic](#http-receiver-auth-basic) below.
|
|
422
|
-
|
|
423
|
-
<a id="http-receiver-auth-none"></a>• [`auth_none`](#http-receiver-auth-none) - Optional Block<br>Enable this option
|
|
424
|
-
|
|
425
|
-
<a id="http-receiver-auth-token"></a>• [`auth_token`](#http-receiver-auth-token) - Optional Block<br>Access Token. Authentication Token for access<br>See [Auth Token](#http-receiver-auth-token) below.
|
|
426
|
-
|
|
427
|
-
<a id="http-receiver-batch"></a>• [`batch`](#http-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#http-receiver-batch) below.
|
|
428
|
-
|
|
429
|
-
<a id="http-receiver-compression"></a>• [`compression`](#http-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#http-receiver-compression) below.
|
|
430
|
-
|
|
431
|
-
<a id="http-receiver-no-tls"></a>• [`no_tls`](#http-receiver-no-tls) - Optional Block<br>Enable this option
|
|
432
|
-
|
|
433
|
-
<a id="http-receiver-uri"></a>• [`uri`](#http-receiver-uri) - Optional String<br>HTTP URI is the URI of the HTTP endpoint to send logs to,
|
|
434
|
-
|
|
435
|
-
<a id="http-receiver-use-tls"></a>• [`use_tls`](#http-receiver-use-tls) - Optional Block<br>TLS Parameters for client connection to the endpoint<br>See [Use TLS](#http-receiver-use-tls) below.
|
|
436
|
-
|
|
437
|
-
#### HTTP Receiver Auth Basic
|
|
438
|
-
|
|
439
|
-
An [`auth_basic`](#http-receiver-auth-basic) block (within [`http_receiver`](#http-receiver)) supports the following:
|
|
440
|
-
|
|
441
|
-
<a id="http-receiver-auth-basic-password"></a>• [`password`](#http-receiver-auth-basic-password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#http-receiver-auth-basic-password) below.
|
|
442
|
-
|
|
443
|
-
<a id="http-receiver-auth-basic-user-name"></a>• [`user_name`](#http-receiver-auth-basic-user-name) - Optional String<br>User Name. HTTP Basic Auth User Name
|
|
444
|
-
|
|
445
|
-
#### HTTP Receiver Auth Basic Password
|
|
446
|
-
|
|
447
|
-
A [`password`](#http-receiver-auth-basic-password) block (within [`http_receiver.auth_basic`](#http-receiver-auth-basic)) supports the following:
|
|
448
|
-
|
|
449
|
-
<a id="info-265ff8"></a>• [`blindfold_secret_info`](#info-265ff8) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-265ff8) below.
|
|
450
|
-
|
|
451
|
-
<a id="info-b23662"></a>• [`clear_secret_info`](#info-b23662) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-b23662) below.
|
|
452
|
-
|
|
453
|
-
#### HTTP Receiver Auth Basic Password Blindfold Secret Info
|
|
454
|
-
|
|
455
|
-
<a id="deep-b0986f"></a>Deeply nested **Info** block collapsed for readability.
|
|
456
|
-
|
|
457
|
-
#### HTTP Receiver Auth Basic Password Clear Secret Info
|
|
458
|
-
|
|
459
|
-
<a id="deep-7ce803"></a>Deeply nested **Info** block collapsed for readability.
|
|
460
|
-
|
|
461
|
-
#### HTTP Receiver Auth Token
|
|
462
|
-
|
|
463
|
-
An [`auth_token`](#http-receiver-auth-token) block (within [`http_receiver`](#http-receiver)) supports the following:
|
|
464
|
-
|
|
465
|
-
<a id="http-receiver-auth-token-token"></a>• [`token`](#http-receiver-auth-token-token) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Token](#http-receiver-auth-token-token) below.
|
|
466
|
-
|
|
467
|
-
#### HTTP Receiver Auth Token Token
|
|
468
|
-
|
|
469
|
-
A [`token`](#http-receiver-auth-token-token) block (within [`http_receiver.auth_token`](#http-receiver-auth-token)) supports the following:
|
|
470
|
-
|
|
471
|
-
<a id="info-5dfb53"></a>• [`blindfold_secret_info`](#info-5dfb53) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-5dfb53) below.
|
|
472
|
-
|
|
473
|
-
<a id="info-f68d67"></a>• [`clear_secret_info`](#info-f68d67) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-f68d67) below.
|
|
474
|
-
|
|
475
|
-
#### HTTP Receiver Auth Token Token Blindfold Secret Info
|
|
476
|
-
|
|
477
|
-
<a id="deep-8c7fd3"></a>Deeply nested **Info** block collapsed for readability.
|
|
478
|
-
|
|
479
|
-
#### HTTP Receiver Auth Token Token Clear Secret Info
|
|
480
|
-
|
|
481
|
-
<a id="deep-99cc0d"></a>Deeply nested **Info** block collapsed for readability.
|
|
482
|
-
|
|
483
|
-
#### HTTP Receiver Batch
|
|
484
|
-
|
|
485
|
-
A [`batch`](#http-receiver-batch) block (within [`http_receiver`](#http-receiver)) supports the following:
|
|
486
|
-
|
|
487
|
-
<a id="http-receiver-batch-max-bytes"></a>• [`max_bytes`](#http-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
488
|
-
|
|
489
|
-
<a id="http-receiver-batch-max-bytes-disabled"></a>• [`max_bytes_disabled`](#http-receiver-batch-max-bytes-disabled) - Optional Block<br>Enable this option
|
|
490
|
-
|
|
491
|
-
<a id="http-receiver-batch-max-events"></a>• [`max_events`](#http-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
492
|
-
|
|
493
|
-
<a id="http-receiver-batch-max-events-disabled"></a>• [`max_events_disabled`](#http-receiver-batch-max-events-disabled) - Optional Block<br>Enable this option
|
|
494
|
-
|
|
495
|
-
<a id="http-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#http-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
496
|
-
|
|
497
|
-
<a id="default-07fa28"></a>• [`timeout_seconds_default`](#default-07fa28) - Optional Block<br>Enable this option
|
|
498
|
-
|
|
499
|
-
#### HTTP Receiver Compression
|
|
500
|
-
|
|
501
|
-
A [`compression`](#http-receiver-compression) block (within [`http_receiver`](#http-receiver)) supports the following:
|
|
502
|
-
|
|
503
|
-
<a id="default-acdb2d"></a>• [`compression_default`](#default-acdb2d) - Optional Block<br>Enable this option
|
|
504
|
-
|
|
505
|
-
<a id="gzip-aa097d"></a>• [`compression_gzip`](#gzip-aa097d) - Optional Block<br>Enable this option
|
|
506
|
-
|
|
507
|
-
<a id="none-64622e"></a>• [`compression_none`](#none-64622e) - Optional Block<br>Enable this option
|
|
508
|
-
|
|
509
|
-
#### HTTP Receiver Use TLS
|
|
510
|
-
|
|
511
|
-
An [`use_tls`](#http-receiver-use-tls) block (within [`http_receiver`](#http-receiver)) supports the following:
|
|
512
|
-
|
|
513
|
-
<a id="certificate-44f578"></a>• [`disable_verify_certificate`](#certificate-44f578) - Optional Block<br>Enable this option
|
|
514
|
-
|
|
515
|
-
<a id="hostname-b557e6"></a>• [`disable_verify_hostname`](#hostname-b557e6) - Optional Block<br>Enable this option
|
|
516
|
-
|
|
517
|
-
<a id="certificate-2245f4"></a>• [`enable_verify_certificate`](#certificate-2245f4) - Optional Block<br>Enable this option
|
|
518
|
-
|
|
519
|
-
<a id="hostname-080fc4"></a>• [`enable_verify_hostname`](#hostname-080fc4) - Optional Block<br>Enable this option
|
|
520
|
-
|
|
521
|
-
<a id="http-receiver-use-tls-mtls-disabled"></a>• [`mtls_disabled`](#http-receiver-use-tls-mtls-disabled) - Optional Block<br>Enable this option
|
|
522
|
-
|
|
523
|
-
<a id="http-receiver-use-tls-mtls-enable"></a>• [`mtls_enable`](#http-receiver-use-tls-mtls-enable) - Optional Block<br>mTLS Client config allows configuration of mTLS client OPTIONS<br>See [mTLS Enable](#http-receiver-use-tls-mtls-enable) below.
|
|
524
|
-
|
|
525
|
-
<a id="http-receiver-use-tls-no-ca"></a>• [`no_ca`](#http-receiver-use-tls-no-ca) - Optional Block<br>Enable this option
|
|
526
|
-
|
|
527
|
-
<a id="http-receiver-use-tls-trusted-ca-url"></a>• [`trusted_ca_url`](#http-receiver-use-tls-trusted-ca-url) - Optional String<br>The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers
|
|
528
|
-
|
|
529
|
-
#### HTTP Receiver Use TLS mTLS Enable
|
|
530
|
-
|
|
531
|
-
A [`mtls_enable`](#http-receiver-use-tls-mtls-enable) block (within [`http_receiver.use_tls`](#http-receiver-use-tls)) supports the following:
|
|
532
|
-
|
|
533
|
-
<a id="certificate-c3cc99"></a>• [`certificate`](#certificate-c3cc99) - Optional String<br>Client certificate is PEM-encoded certificate or certificate-chain
|
|
534
|
-
|
|
535
|
-
<a id="url-12d8b8"></a>• [`key_url`](#url-12d8b8) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Key URL](#url-12d8b8) below.
|
|
536
|
-
|
|
537
|
-
#### HTTP Receiver Use TLS mTLS Enable Key URL
|
|
538
|
-
|
|
539
|
-
<a id="deep-905126"></a>Deeply nested **URL** block collapsed for readability.
|
|
540
|
-
|
|
541
|
-
#### HTTP Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info
|
|
542
|
-
|
|
543
|
-
<a id="deep-3f60c5"></a>Deeply nested **Info** block collapsed for readability.
|
|
544
|
-
|
|
545
|
-
#### HTTP Receiver Use TLS mTLS Enable Key URL Clear Secret Info
|
|
546
|
-
|
|
547
|
-
<a id="deep-0d953c"></a>Deeply nested **Info** block collapsed for readability.
|
|
548
|
-
|
|
549
|
-
#### Kafka Receiver
|
|
550
|
-
|
|
551
|
-
A [`kafka_receiver`](#kafka-receiver) block supports the following:
|
|
552
|
-
|
|
553
|
-
<a id="kafka-receiver-batch"></a>• [`batch`](#kafka-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#kafka-receiver-batch) below.
|
|
554
|
-
|
|
555
|
-
<a id="kafka-receiver-bootstrap-servers"></a>• [`bootstrap_servers`](#kafka-receiver-bootstrap-servers) - Optional List<br>List of host:port pairs of the Kafka brokers
|
|
556
|
-
|
|
557
|
-
<a id="kafka-receiver-compression"></a>• [`compression`](#kafka-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#kafka-receiver-compression) below.
|
|
558
|
-
|
|
559
|
-
<a id="kafka-receiver-kafka-topic"></a>• [`kafka_topic`](#kafka-receiver-kafka-topic) - Optional String<br>The Kafka topic name to write events to
|
|
560
|
-
|
|
561
|
-
<a id="kafka-receiver-no-tls"></a>• [`no_tls`](#kafka-receiver-no-tls) - Optional Block<br>Enable this option
|
|
562
|
-
|
|
563
|
-
<a id="kafka-receiver-use-tls"></a>• [`use_tls`](#kafka-receiver-use-tls) - Optional Block<br>TLS Parameters for client connection to the endpoint<br>See [Use TLS](#kafka-receiver-use-tls) below.
|
|
564
|
-
|
|
565
|
-
#### Kafka Receiver Batch
|
|
566
|
-
|
|
567
|
-
A [`batch`](#kafka-receiver-batch) block (within [`kafka_receiver`](#kafka-receiver)) supports the following:
|
|
568
|
-
|
|
569
|
-
<a id="kafka-receiver-batch-max-bytes"></a>• [`max_bytes`](#kafka-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
570
|
-
|
|
571
|
-
<a id="kafka-receiver-batch-max-bytes-disabled"></a>• [`max_bytes_disabled`](#kafka-receiver-batch-max-bytes-disabled) - Optional Block<br>Enable this option
|
|
572
|
-
|
|
573
|
-
<a id="kafka-receiver-batch-max-events"></a>• [`max_events`](#kafka-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
574
|
-
|
|
575
|
-
<a id="disabled-103987"></a>• [`max_events_disabled`](#disabled-103987) - Optional Block<br>Enable this option
|
|
576
|
-
|
|
577
|
-
<a id="kafka-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#kafka-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
578
|
-
|
|
579
|
-
<a id="default-f70ae5"></a>• [`timeout_seconds_default`](#default-f70ae5) - Optional Block<br>Enable this option
|
|
580
|
-
|
|
581
|
-
#### Kafka Receiver Compression
|
|
582
|
-
|
|
583
|
-
A [`compression`](#kafka-receiver-compression) block (within [`kafka_receiver`](#kafka-receiver)) supports the following:
|
|
584
|
-
|
|
585
|
-
<a id="default-c0d204"></a>• [`compression_default`](#default-c0d204) - Optional Block<br>Enable this option
|
|
586
|
-
|
|
587
|
-
<a id="gzip-6f882e"></a>• [`compression_gzip`](#gzip-6f882e) - Optional Block<br>Enable this option
|
|
588
|
-
|
|
589
|
-
<a id="none-c368ff"></a>• [`compression_none`](#none-c368ff) - Optional Block<br>Enable this option
|
|
590
|
-
|
|
591
|
-
#### Kafka Receiver Use TLS
|
|
592
|
-
|
|
593
|
-
An [`use_tls`](#kafka-receiver-use-tls) block (within [`kafka_receiver`](#kafka-receiver)) supports the following:
|
|
594
|
-
|
|
595
|
-
<a id="certificate-7c4499"></a>• [`disable_verify_certificate`](#certificate-7c4499) - Optional Block<br>Enable this option
|
|
596
|
-
|
|
597
|
-
<a id="hostname-1988d1"></a>• [`disable_verify_hostname`](#hostname-1988d1) - Optional Block<br>Enable this option
|
|
598
|
-
|
|
599
|
-
<a id="certificate-d5b68f"></a>• [`enable_verify_certificate`](#certificate-d5b68f) - Optional Block<br>Enable this option
|
|
600
|
-
|
|
601
|
-
<a id="hostname-d84dcb"></a>• [`enable_verify_hostname`](#hostname-d84dcb) - Optional Block<br>Enable this option
|
|
602
|
-
|
|
603
|
-
<a id="kafka-receiver-use-tls-mtls-disabled"></a>• [`mtls_disabled`](#kafka-receiver-use-tls-mtls-disabled) - Optional Block<br>Enable this option
|
|
604
|
-
|
|
605
|
-
<a id="kafka-receiver-use-tls-mtls-enable"></a>• [`mtls_enable`](#kafka-receiver-use-tls-mtls-enable) - Optional Block<br>mTLS Client config allows configuration of mTLS client OPTIONS<br>See [mTLS Enable](#kafka-receiver-use-tls-mtls-enable) below.
|
|
606
|
-
|
|
607
|
-
<a id="kafka-receiver-use-tls-no-ca"></a>• [`no_ca`](#kafka-receiver-use-tls-no-ca) - Optional Block<br>Enable this option
|
|
608
|
-
|
|
609
|
-
<a id="kafka-receiver-use-tls-trusted-ca-url"></a>• [`trusted_ca_url`](#kafka-receiver-use-tls-trusted-ca-url) - Optional String<br>The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers
|
|
610
|
-
|
|
611
|
-
#### Kafka Receiver Use TLS mTLS Enable
|
|
612
|
-
|
|
613
|
-
A [`mtls_enable`](#kafka-receiver-use-tls-mtls-enable) block (within [`kafka_receiver.use_tls`](#kafka-receiver-use-tls)) supports the following:
|
|
614
|
-
|
|
615
|
-
<a id="certificate-3abf3c"></a>• [`certificate`](#certificate-3abf3c) - Optional String<br>Client certificate is PEM-encoded certificate or certificate-chain
|
|
616
|
-
|
|
617
|
-
<a id="url-27a26d"></a>• [`key_url`](#url-27a26d) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Key URL](#url-27a26d) below.
|
|
618
|
-
|
|
619
|
-
#### Kafka Receiver Use TLS mTLS Enable Key URL
|
|
620
|
-
|
|
621
|
-
<a id="deep-6a8d7d"></a>Deeply nested **URL** block collapsed for readability.
|
|
622
|
-
|
|
623
|
-
#### Kafka Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info
|
|
624
|
-
|
|
625
|
-
<a id="deep-f04153"></a>Deeply nested **Info** block collapsed for readability.
|
|
626
|
-
|
|
627
|
-
#### Kafka Receiver Use TLS mTLS Enable Key URL Clear Secret Info
|
|
628
|
-
|
|
629
|
-
<a id="deep-95b0cb"></a>Deeply nested **Info** block collapsed for readability.
|
|
630
|
-
|
|
631
|
-
#### New Relic Receiver
|
|
632
|
-
|
|
633
|
-
A [`new_relic_receiver`](#new-relic-receiver) block supports the following:
|
|
634
|
-
|
|
635
|
-
<a id="new-relic-receiver-api-key"></a>• [`api_key`](#new-relic-receiver-api-key) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [API Key](#new-relic-receiver-api-key) below.
|
|
636
|
-
|
|
637
|
-
<a id="new-relic-receiver-eu"></a>• [`eu`](#new-relic-receiver-eu) - Optional Block<br>Enable this option
|
|
638
|
-
|
|
639
|
-
<a id="new-relic-receiver-us"></a>• [`us`](#new-relic-receiver-us) - Optional Block<br>Enable this option
|
|
640
|
-
|
|
641
|
-
#### New Relic Receiver API Key
|
|
642
|
-
|
|
643
|
-
An [`api_key`](#new-relic-receiver-api-key) block (within [`new_relic_receiver`](#new-relic-receiver)) supports the following:
|
|
644
|
-
|
|
645
|
-
<a id="info-262674"></a>• [`blindfold_secret_info`](#info-262674) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-262674) below.
|
|
646
|
-
|
|
647
|
-
<a id="info-6a5234"></a>• [`clear_secret_info`](#info-6a5234) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-6a5234) below.
|
|
648
|
-
|
|
649
|
-
#### New Relic Receiver API Key Blindfold Secret Info
|
|
650
|
-
|
|
651
|
-
<a id="deep-f36179"></a>Deeply nested **Info** block collapsed for readability.
|
|
652
|
-
|
|
653
|
-
#### New Relic Receiver API Key Clear Secret Info
|
|
654
|
-
|
|
655
|
-
<a id="deep-48a9d0"></a>Deeply nested **Info** block collapsed for readability.
|
|
656
|
-
|
|
657
|
-
#### Ns List
|
|
658
|
-
|
|
659
|
-
A [`ns_list`](#ns-list) block supports the following:
|
|
660
|
-
|
|
661
|
-
<a id="ns-list-namespaces"></a>• [`namespaces`](#ns-list-namespaces) - Optional List<br>List of namespaces to stream logs for
|
|
662
|
-
|
|
663
|
-
#### Qradar Receiver
|
|
664
|
-
|
|
665
|
-
A [`qradar_receiver`](#qradar-receiver) block supports the following:
|
|
666
|
-
|
|
667
|
-
<a id="qradar-receiver-batch"></a>• [`batch`](#qradar-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#qradar-receiver-batch) below.
|
|
668
|
-
|
|
669
|
-
<a id="qradar-receiver-compression"></a>• [`compression`](#qradar-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#qradar-receiver-compression) below.
|
|
670
|
-
|
|
671
|
-
<a id="qradar-receiver-no-tls"></a>• [`no_tls`](#qradar-receiver-no-tls) - Optional Block<br>Enable this option
|
|
672
|
-
|
|
673
|
-
<a id="qradar-receiver-uri"></a>• [`uri`](#qradar-receiver-uri) - Optional String<br>Log Source Collector URL is the URL of the IBM QRadar Log Source Collector to send logs to,
|
|
674
|
-
|
|
675
|
-
<a id="qradar-receiver-use-tls"></a>• [`use_tls`](#qradar-receiver-use-tls) - Optional Block<br>TLS Parameters for client connection to the endpoint<br>See [Use TLS](#qradar-receiver-use-tls) below.
|
|
676
|
-
|
|
677
|
-
#### Qradar Receiver Batch
|
|
678
|
-
|
|
679
|
-
A [`batch`](#qradar-receiver-batch) block (within [`qradar_receiver`](#qradar-receiver)) supports the following:
|
|
680
|
-
|
|
681
|
-
<a id="qradar-receiver-batch-max-bytes"></a>• [`max_bytes`](#qradar-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
682
|
-
|
|
683
|
-
<a id="disabled-d39134"></a>• [`max_bytes_disabled`](#disabled-d39134) - Optional Block<br>Enable this option
|
|
684
|
-
|
|
685
|
-
<a id="qradar-receiver-batch-max-events"></a>• [`max_events`](#qradar-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
686
|
-
|
|
687
|
-
<a id="disabled-2a2589"></a>• [`max_events_disabled`](#disabled-2a2589) - Optional Block<br>Enable this option
|
|
688
|
-
|
|
689
|
-
<a id="qradar-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#qradar-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
690
|
-
|
|
691
|
-
<a id="default-300883"></a>• [`timeout_seconds_default`](#default-300883) - Optional Block<br>Enable this option
|
|
692
|
-
|
|
693
|
-
#### Qradar Receiver Compression
|
|
694
|
-
|
|
695
|
-
A [`compression`](#qradar-receiver-compression) block (within [`qradar_receiver`](#qradar-receiver)) supports the following:
|
|
696
|
-
|
|
697
|
-
<a id="default-997ec4"></a>• [`compression_default`](#default-997ec4) - Optional Block<br>Enable this option
|
|
698
|
-
|
|
699
|
-
<a id="gzip-ab6766"></a>• [`compression_gzip`](#gzip-ab6766) - Optional Block<br>Enable this option
|
|
700
|
-
|
|
701
|
-
<a id="none-06fddb"></a>• [`compression_none`](#none-06fddb) - Optional Block<br>Enable this option
|
|
702
|
-
|
|
703
|
-
#### Qradar Receiver Use TLS
|
|
704
|
-
|
|
705
|
-
An [`use_tls`](#qradar-receiver-use-tls) block (within [`qradar_receiver`](#qradar-receiver)) supports the following:
|
|
706
|
-
|
|
707
|
-
<a id="certificate-ebfded"></a>• [`disable_verify_certificate`](#certificate-ebfded) - Optional Block<br>Enable this option
|
|
708
|
-
|
|
709
|
-
<a id="hostname-9850c1"></a>• [`disable_verify_hostname`](#hostname-9850c1) - Optional Block<br>Enable this option
|
|
710
|
-
|
|
711
|
-
<a id="certificate-0c5d39"></a>• [`enable_verify_certificate`](#certificate-0c5d39) - Optional Block<br>Enable this option
|
|
712
|
-
|
|
713
|
-
<a id="hostname-726508"></a>• [`enable_verify_hostname`](#hostname-726508) - Optional Block<br>Enable this option
|
|
714
|
-
|
|
715
|
-
<a id="qradar-receiver-use-tls-mtls-disabled"></a>• [`mtls_disabled`](#qradar-receiver-use-tls-mtls-disabled) - Optional Block<br>Enable this option
|
|
716
|
-
|
|
717
|
-
<a id="qradar-receiver-use-tls-mtls-enable"></a>• [`mtls_enable`](#qradar-receiver-use-tls-mtls-enable) - Optional Block<br>mTLS Client config allows configuration of mTLS client OPTIONS<br>See [mTLS Enable](#qradar-receiver-use-tls-mtls-enable) below.
|
|
718
|
-
|
|
719
|
-
<a id="qradar-receiver-use-tls-no-ca"></a>• [`no_ca`](#qradar-receiver-use-tls-no-ca) - Optional Block<br>Enable this option
|
|
720
|
-
|
|
721
|
-
<a id="qradar-receiver-use-tls-trusted-ca-url"></a>• [`trusted_ca_url`](#qradar-receiver-use-tls-trusted-ca-url) - Optional String<br>The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers
|
|
722
|
-
|
|
723
|
-
#### Qradar Receiver Use TLS mTLS Enable
|
|
724
|
-
|
|
725
|
-
A [`mtls_enable`](#qradar-receiver-use-tls-mtls-enable) block (within [`qradar_receiver.use_tls`](#qradar-receiver-use-tls)) supports the following:
|
|
726
|
-
|
|
727
|
-
<a id="certificate-018262"></a>• [`certificate`](#certificate-018262) - Optional String<br>Client certificate is PEM-encoded certificate or certificate-chain
|
|
728
|
-
|
|
729
|
-
<a id="url-b85773"></a>• [`key_url`](#url-b85773) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Key URL](#url-b85773) below.
|
|
730
|
-
|
|
731
|
-
#### Qradar Receiver Use TLS mTLS Enable Key URL
|
|
732
|
-
|
|
733
|
-
<a id="deep-ebd591"></a>Deeply nested **URL** block collapsed for readability.
|
|
734
|
-
|
|
735
|
-
#### Qradar Receiver Use TLS mTLS Enable Key URL Blindfold Secret Info
|
|
736
|
-
|
|
737
|
-
<a id="deep-272547"></a>Deeply nested **Info** block collapsed for readability.
|
|
738
|
-
|
|
739
|
-
#### Qradar Receiver Use TLS mTLS Enable Key URL Clear Secret Info
|
|
740
|
-
|
|
741
|
-
<a id="deep-7c4a8f"></a>Deeply nested **Info** block collapsed for readability.
|
|
742
|
-
|
|
743
|
-
#### S3 Receiver
|
|
744
|
-
|
|
745
|
-
A [`s3_receiver`](#s3-receiver) block supports the following:
|
|
746
|
-
|
|
747
|
-
<a id="s3-receiver-aws-cred"></a>• [`aws_cred`](#s3-receiver-aws-cred) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [AWS Cred](#s3-receiver-aws-cred) below.
|
|
748
|
-
|
|
749
|
-
<a id="s3-receiver-aws-region"></a>• [`aws_region`](#s3-receiver-aws-region) - Optional String<br>AWS Region. AWS Region Name
|
|
750
|
-
|
|
751
|
-
<a id="s3-receiver-batch"></a>• [`batch`](#s3-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#s3-receiver-batch) below.
|
|
752
|
-
|
|
753
|
-
<a id="s3-receiver-bucket"></a>• [`bucket`](#s3-receiver-bucket) - Optional String<br>S3 Bucket Name. S3 Bucket Name
|
|
754
|
-
|
|
755
|
-
<a id="s3-receiver-compression"></a>• [`compression`](#s3-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#s3-receiver-compression) below.
|
|
756
|
-
|
|
757
|
-
<a id="s3-receiver-filename-options"></a>• [`filename_options`](#s3-receiver-filename-options) - Optional Block<br>Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file<br>See [Filename Options](#s3-receiver-filename-options) below.
|
|
758
|
-
|
|
759
|
-
#### S3 Receiver AWS Cred
|
|
760
|
-
|
|
761
|
-
An [`aws_cred`](#s3-receiver-aws-cred) block (within [`s3_receiver`](#s3-receiver)) supports the following:
|
|
762
|
-
|
|
763
|
-
<a id="s3-receiver-aws-cred-name"></a>• [`name`](#s3-receiver-aws-cred-name) - Optional String<br>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
|
|
764
|
-
|
|
765
|
-
<a id="s3-receiver-aws-cred-namespace"></a>• [`namespace`](#s3-receiver-aws-cred-namespace) - Optional String<br>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
|
|
766
|
-
|
|
767
|
-
<a id="s3-receiver-aws-cred-tenant"></a>• [`tenant`](#s3-receiver-aws-cred-tenant) - Optional String<br>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
|
|
768
|
-
|
|
769
|
-
#### S3 Receiver Batch
|
|
770
|
-
|
|
771
|
-
A [`batch`](#s3-receiver-batch) block (within [`s3_receiver`](#s3-receiver)) supports the following:
|
|
772
|
-
|
|
773
|
-
<a id="s3-receiver-batch-max-bytes"></a>• [`max_bytes`](#s3-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
774
|
-
|
|
775
|
-
<a id="s3-receiver-batch-max-bytes-disabled"></a>• [`max_bytes_disabled`](#s3-receiver-batch-max-bytes-disabled) - Optional Block<br>Enable this option
|
|
776
|
-
|
|
777
|
-
<a id="s3-receiver-batch-max-events"></a>• [`max_events`](#s3-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
778
|
-
|
|
779
|
-
<a id="s3-receiver-batch-max-events-disabled"></a>• [`max_events_disabled`](#s3-receiver-batch-max-events-disabled) - Optional Block<br>Enable this option
|
|
780
|
-
|
|
781
|
-
<a id="s3-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#s3-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
782
|
-
|
|
783
|
-
<a id="default-cab3a5"></a>• [`timeout_seconds_default`](#default-cab3a5) - Optional Block<br>Enable this option
|
|
784
|
-
|
|
785
|
-
#### S3 Receiver Compression
|
|
786
|
-
|
|
787
|
-
A [`compression`](#s3-receiver-compression) block (within [`s3_receiver`](#s3-receiver)) supports the following:
|
|
788
|
-
|
|
789
|
-
<a id="default-3ba737"></a>• [`compression_default`](#default-3ba737) - Optional Block<br>Enable this option
|
|
790
|
-
|
|
791
|
-
<a id="gzip-5b8271"></a>• [`compression_gzip`](#gzip-5b8271) - Optional Block<br>Enable this option
|
|
792
|
-
|
|
793
|
-
<a id="none-d52f11"></a>• [`compression_none`](#none-d52f11) - Optional Block<br>Enable this option
|
|
794
|
-
|
|
795
|
-
#### S3 Receiver Filename Options
|
|
796
|
-
|
|
797
|
-
A [`filename_options`](#s3-receiver-filename-options) block (within [`s3_receiver`](#s3-receiver)) supports the following:
|
|
798
|
-
|
|
799
|
-
<a id="folder-b580e4"></a>• [`custom_folder`](#folder-b580e4) - Optional String<br>Use your own folder name as the name of the folder in the endpoint bucket or file The folder name must match
|
|
800
|
-
|
|
801
|
-
<a id="folder-07aa29"></a>• [`log_type_folder`](#folder-07aa29) - Optional Block<br>Enable this option
|
|
802
|
-
|
|
803
|
-
<a id="s3-receiver-filename-options-no-folder"></a>• [`no_folder`](#s3-receiver-filename-options-no-folder) - Optional Block<br>Enable this option
|
|
804
|
-
|
|
805
|
-
#### Splunk Receiver
|
|
806
|
-
|
|
807
|
-
A [`splunk_receiver`](#splunk-receiver) block supports the following:
|
|
808
|
-
|
|
809
|
-
<a id="splunk-receiver-batch"></a>• [`batch`](#splunk-receiver-batch) - Optional Block<br>Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint<br>See [Batch](#splunk-receiver-batch) below.
|
|
810
|
-
|
|
811
|
-
<a id="splunk-receiver-compression"></a>• [`compression`](#splunk-receiver-compression) - Optional Block<br>Compression Type. Compression Type<br>See [Compression](#splunk-receiver-compression) below.
|
|
812
|
-
|
|
813
|
-
<a id="splunk-receiver-endpoint"></a>• [`endpoint`](#splunk-receiver-endpoint) - Optional String<br>Splunk HEC Logs Endpoint. Splunk HEC Logs Endpoint, (Note: must not contain `/services/collector`)
|
|
814
|
-
|
|
815
|
-
<a id="splunk-receiver-no-tls"></a>• [`no_tls`](#splunk-receiver-no-tls) - Optional Block<br>Enable this option
|
|
816
|
-
|
|
817
|
-
<a id="splunk-receiver-splunk-hec-token"></a>• [`splunk_hec_token`](#splunk-receiver-splunk-hec-token) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Splunk Hec Token](#splunk-receiver-splunk-hec-token) below.
|
|
818
|
-
|
|
819
|
-
<a id="splunk-receiver-use-tls"></a>• [`use_tls`](#splunk-receiver-use-tls) - Optional Block<br>TLS Parameters for client connection to the endpoint<br>See [Use TLS](#splunk-receiver-use-tls) below.
|
|
820
|
-
|
|
821
|
-
#### Splunk Receiver Batch
|
|
822
|
-
|
|
823
|
-
A [`batch`](#splunk-receiver-batch) block (within [`splunk_receiver`](#splunk-receiver)) supports the following:
|
|
824
|
-
|
|
825
|
-
<a id="splunk-receiver-batch-max-bytes"></a>• [`max_bytes`](#splunk-receiver-batch-max-bytes) - Optional Number<br>Send batch to endpoint after the batch is equal to or larger than this many bytes
|
|
826
|
-
|
|
827
|
-
<a id="disabled-ee4057"></a>• [`max_bytes_disabled`](#disabled-ee4057) - Optional Block<br>Enable this option
|
|
828
|
-
|
|
829
|
-
<a id="splunk-receiver-batch-max-events"></a>• [`max_events`](#splunk-receiver-batch-max-events) - Optional Number<br>Send batch to endpoint after this many log messages are in the batch
|
|
830
|
-
|
|
831
|
-
<a id="disabled-36f259"></a>• [`max_events_disabled`](#disabled-36f259) - Optional Block<br>Enable this option
|
|
832
|
-
|
|
833
|
-
<a id="splunk-receiver-batch-timeout-seconds"></a>• [`timeout_seconds`](#splunk-receiver-batch-timeout-seconds) - Optional String<br>Send batch to the endpoint after this many seconds
|
|
834
|
-
|
|
835
|
-
<a id="default-2d39cb"></a>• [`timeout_seconds_default`](#default-2d39cb) - Optional Block<br>Enable this option
|
|
836
|
-
|
|
837
|
-
#### Splunk Receiver Compression
|
|
838
|
-
|
|
839
|
-
A [`compression`](#splunk-receiver-compression) block (within [`splunk_receiver`](#splunk-receiver)) supports the following:
|
|
840
|
-
|
|
841
|
-
<a id="default-a97e9d"></a>• [`compression_default`](#default-a97e9d) - Optional Block<br>Enable this option
|
|
842
|
-
|
|
843
|
-
<a id="gzip-27c06f"></a>• [`compression_gzip`](#gzip-27c06f) - Optional Block<br>Enable this option
|
|
844
|
-
|
|
845
|
-
<a id="none-d4e3e3"></a>• [`compression_none`](#none-d4e3e3) - Optional Block<br>Enable this option
|
|
846
|
-
|
|
847
|
-
#### Splunk Receiver Splunk Hec Token
|
|
848
|
-
|
|
849
|
-
A [`splunk_hec_token`](#splunk-receiver-splunk-hec-token) block (within [`splunk_receiver`](#splunk-receiver)) supports the following:
|
|
850
|
-
|
|
851
|
-
<a id="info-2c09a2"></a>• [`blindfold_secret_info`](#info-2c09a2) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-2c09a2) below.
|
|
852
|
-
|
|
853
|
-
<a id="info-08aaec"></a>• [`clear_secret_info`](#info-08aaec) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-08aaec) below.
|
|
854
|
-
|
|
855
|
-
#### Splunk Receiver Splunk Hec Token Blindfold Secret Info
|
|
856
|
-
|
|
857
|
-
<a id="deep-6ec437"></a>Deeply nested **Info** block collapsed for readability.
|
|
858
|
-
|
|
859
|
-
#### Splunk Receiver Splunk Hec Token Clear Secret Info
|
|
860
|
-
|
|
861
|
-
<a id="deep-546f66"></a>Deeply nested **Info** block collapsed for readability.
|
|
862
|
-
|
|
863
|
-
#### Splunk Receiver Use TLS
|
|
82
|
+
#### Syslog
|
|
864
83
|
|
|
865
|
-
|
|
84
|
+
A [`syslog`](#syslog) block supports the following:
|
|
866
85
|
|
|
867
|
-
<a id="
|
|
86
|
+
<a id="syslog-syslog-rfc5424"></a>• [`syslog_rfc5424`](#syslog-syslog-rfc5424) - Optional Number<br>Select RFC5424 syslog format and maximum message length
|
|
868
87
|
|
|
869
|
-
<a id="
|
|
88
|
+
<a id="syslog-tcp-server"></a>• [`tcp_server`](#syslog-tcp-server) - Optional Block<br>TCP Server name and Port Number. Name and port number for a TCP server<br>See [TCP Server](#syslog-tcp-server) below.
|
|
870
89
|
|
|
871
|
-
<a id="
|
|
90
|
+
<a id="syslog-tls-server"></a>• [`tls_server`](#syslog-tls-server) - Optional Block<br>TLS config for client of discovery service<br>See [TLS Server](#syslog-tls-server) below.
|
|
872
91
|
|
|
873
|
-
<a id="
|
|
92
|
+
<a id="syslog-udp-server"></a>• [`udp_server`](#syslog-udp-server) - Optional Block<br>UDP Server Name and Port Number. Name and port number for a UDP server<br>See [UDP Server](#syslog-udp-server) below.
|
|
874
93
|
|
|
875
|
-
|
|
94
|
+
#### Syslog TCP Server
|
|
876
95
|
|
|
877
|
-
|
|
96
|
+
A [`tcp_server`](#syslog-tcp-server) block (within [`syslog`](#syslog)) supports the following:
|
|
878
97
|
|
|
879
|
-
<a id="
|
|
98
|
+
<a id="syslog-tcp-server-port"></a>• [`port`](#syslog-tcp-server-port) - Optional Number<br>Port number used for communication
|
|
880
99
|
|
|
881
|
-
<a id="
|
|
100
|
+
<a id="syslog-tcp-server-server-name"></a>• [`server_name`](#syslog-tcp-server-server-name) - Optional String<br>Server name is fully qualified domain name or IP address of the server
|
|
882
101
|
|
|
883
|
-
####
|
|
102
|
+
#### Syslog TLS Server
|
|
884
103
|
|
|
885
|
-
A [`
|
|
104
|
+
A [`tls_server`](#syslog-tls-server) block (within [`syslog`](#syslog)) supports the following:
|
|
886
105
|
|
|
887
|
-
<a id="
|
|
106
|
+
<a id="syslog-tls-server-default-https-port"></a>• [`default_https_port`](#syslog-tls-server-default-https-port) - Optional Block<br>Enable this option
|
|
888
107
|
|
|
889
|
-
<a id="
|
|
108
|
+
<a id="port-c39d1c"></a>• [`default_syslog_tls_port`](#port-c39d1c) - Optional Block<br>Enable this option
|
|
890
109
|
|
|
891
|
-
|
|
110
|
+
<a id="syslog-tls-server-mtls-disabled"></a>• [`mtls_disabled`](#syslog-tls-server-mtls-disabled) - Optional Block<br>Enable this option
|
|
892
111
|
|
|
893
|
-
<a id="
|
|
112
|
+
<a id="syslog-tls-server-mtls-enable"></a>• [`mtls_enable`](#syslog-tls-server-mtls-enable) - Optional Block<br>mTLS Client Config. TLS config for client<br>See [mTLS Enable](#syslog-tls-server-mtls-enable) below.
|
|
894
113
|
|
|
895
|
-
|
|
114
|
+
<a id="syslog-tls-server-port"></a>• [`port`](#syslog-tls-server-port) - Optional Number<br>Custom port number used for communication
|
|
896
115
|
|
|
897
|
-
<a id="
|
|
116
|
+
<a id="syslog-tls-server-server-name"></a>• [`server_name`](#syslog-tls-server-server-name) - Optional String<br>ServerName is passed to the server for SNI and is used in the client to check server certificates against
|
|
898
117
|
|
|
899
|
-
|
|
118
|
+
<a id="syslog-tls-server-trusted-ca-url"></a>• [`trusted_ca_url`](#syslog-tls-server-trusted-ca-url) - Optional String<br>The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers
|
|
900
119
|
|
|
901
|
-
<a id="
|
|
120
|
+
<a id="syslog-tls-server-volterra-ca"></a>• [`volterra_ca`](#syslog-tls-server-volterra-ca) - Optional Block<br>Enable this option
|
|
902
121
|
|
|
903
|
-
####
|
|
122
|
+
#### Syslog TLS Server mTLS Enable
|
|
904
123
|
|
|
905
|
-
A [`
|
|
124
|
+
A [`mtls_enable`](#syslog-tls-server-mtls-enable) block (within [`syslog.tls_server`](#syslog-tls-server)) supports the following:
|
|
906
125
|
|
|
907
|
-
<a id="
|
|
126
|
+
<a id="certificate-bd035f"></a>• [`certificate`](#certificate-bd035f) - Optional String<br>Client certificate is PEM-encoded certificate or certificate-chain
|
|
908
127
|
|
|
909
|
-
|
|
128
|
+
<a id="syslog-tls-server-mtls-enable-key-url"></a>• [`key_url`](#syslog-tls-server-mtls-enable-key-url) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Key URL](#syslog-tls-server-mtls-enable-key-url) below.
|
|
910
129
|
|
|
911
|
-
|
|
130
|
+
#### Syslog TLS Server mTLS Enable Key URL
|
|
912
131
|
|
|
913
|
-
|
|
132
|
+
A [`key_url`](#syslog-tls-server-mtls-enable-key-url) block (within [`syslog.tls_server.mtls_enable`](#syslog-tls-server-mtls-enable)) supports the following:
|
|
914
133
|
|
|
915
|
-
<a id="info-
|
|
134
|
+
<a id="info-306978"></a>• [`blindfold_secret_info`](#info-306978) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-306978) below.
|
|
916
135
|
|
|
917
|
-
|
|
136
|
+
<a id="info-2b11e1"></a>• [`clear_secret_info`](#info-2b11e1) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-2b11e1) below.
|
|
918
137
|
|
|
919
|
-
|
|
138
|
+
#### Syslog TLS Server mTLS Enable Key URL Blindfold Secret Info
|
|
920
139
|
|
|
921
|
-
<a id="
|
|
140
|
+
<a id="deep-259b9d"></a>Deeply nested **Info** block collapsed for readability.
|
|
922
141
|
|
|
923
|
-
|
|
142
|
+
#### Syslog TLS Server mTLS Enable Key URL Clear Secret Info
|
|
924
143
|
|
|
925
|
-
<a id="
|
|
144
|
+
<a id="deep-fa3192"></a>Deeply nested **Info** block collapsed for readability.
|
|
926
145
|
|
|
927
|
-
####
|
|
146
|
+
#### Syslog UDP Server
|
|
928
147
|
|
|
929
|
-
|
|
148
|
+
An [`udp_server`](#syslog-udp-server) block (within [`syslog`](#syslog)) supports the following:
|
|
930
149
|
|
|
931
|
-
<a id="
|
|
150
|
+
<a id="syslog-udp-server-port"></a>• [`port`](#syslog-udp-server-port) - Optional Number<br>Port number used for communication
|
|
932
151
|
|
|
933
|
-
<a id="
|
|
152
|
+
<a id="syslog-udp-server-server-name"></a>• [`server_name`](#syslog-udp-server-server-name) - Optional String<br>Server name is fully qualified domain name or IP address of the server
|
|
934
153
|
|
|
935
154
|
#### Timeouts
|
|
936
155
|
|