> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/6.0/getting-started-with-weka/weka-cli-overview/cli-reference-guide/weka-telemetry.md).

# weka telemetry

Manage telemetry exports.

```sh
weka telemetry
```

## weka telemetry exports

Manage telemetry export destinations.

```sh
weka telemetry exports
```

### weka telemetry exports add

Add a new telemetry export destination.

```sh
weka telemetry exports add
```

#### weka telemetry exports add kafka

Add a new Kafka telemetry export destination.

```sh
weka telemetry exports add kafka <name> [--allow-unverified-certificate] [--ca-cert <string>] [--disabled] [--key-field <string>] [--sasl-mechanism <kafka-sasl-mechanism>] [--sasl-password <string>] [--sasl-username <string>] [--sources <source-type>…] [--target <string>] [--topic <string>] [--use-sasl] [--verify-with-cluster-cacert] [--without-sources]
```

| Parameter                                  | Description                                                                                                                                                                               |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                                   | Name for the new export.                                                                                                                                                                  |
| `--allow-unverified-certificate`           | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                            |
| `--ca-cert` \<string>                      | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                |
| `--disabled`                               | Create the export in a disabled state.                                                                                                                                                    |
| `--key-field` \<string>                    | Message field to use as the Kafka record key.                                                                                                                                             |
| `--sasl-mechanism` \<kafka-sasl-mechanism> | SASL mechanism: plain, scram-sha-256, or scram-sha-512. Valid values: plain, scram-sha-256, scram-sha-512.                                                                                |
| `--sasl-password` \<string>                | SASL password.                                                                                                                                                                            |
| `--sasl-username` \<string>                | SASL username.                                                                                                                                                                            |
| `--sources` \<source-type>…                | Telemetry source to attach to this export: audit or s3\_events. An export carries at most one source. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>                       | Destination target (host:port or URL) for the export.                                                                                                                                     |
| `--topic` \<string>                        | Kafka topic to publish telemetry to.                                                                                                                                                      |
| `--use-sasl`                               | Authenticate to the Kafka brokers using SASL.                                                                                                                                             |
| `--verify-with-cluster-cacert`             | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                             |
| `--without-sources`                        | Create the export with no sources attached, without being prompted for --sources.                                                                                                         |

#### weka telemetry exports add s3

Add a new S3 telemetry export destination.

```sh
weka telemetry exports add s3 <name> [--access-key-id <string>] [--allow-unverified-certificate] [--bucket-name <string>] [--ca-cert <string>] [--disabled] [--region <string>] [--secret-key <string>] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert] [--without-sources]
```

| Parameter                        | Description                                                                                                                                                                               |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                         | Name for the new export.                                                                                                                                                                  |
| `--access-key-id` \<string>      | S3 access key ID.                                                                                                                                                                         |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                            |
| `--bucket-name` \<string>        | Name of the S3 bucket to export telemetry to.                                                                                                                                             |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                |
| `--disabled`                     | Create the export in a disabled state.                                                                                                                                                    |
| `--region` \<string>             | S3 bucket region.                                                                                                                                                                         |
| `--secret-key` \<string>         | S3 secret access key.                                                                                                                                                                     |
| `--sources` \<source-type>…      | Telemetry source to attach to this export: audit or s3\_events. An export carries at most one source. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | Destination target (host:port or URL) for the export.                                                                                                                                     |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                             |
| `--without-sources`              | Create the export with no sources attached, without being prompted for --sources.                                                                                                         |

#### weka telemetry exports add splunk

Add a new Splunk telemetry export destination.

```sh
weka telemetry exports add splunk <name> [--allow-unverified-certificate] [--auth-token <string>] [--ca-cert <string>] [--disabled] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert] [--without-sources]
```

| Parameter                        | Description                                                                                                                                                                               |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                         | Name for the new export.                                                                                                                                                                  |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                            |
| `--auth-token` \<string>         | Splunk HTTP Event Collector authentication token.                                                                                                                                         |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                |
| `--disabled`                     | Create the export in a disabled state.                                                                                                                                                    |
| `--sources` \<source-type>…      | Telemetry source to attach to this export: audit or s3\_events. An export carries at most one source. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | Destination target (host:port or URL) for the export.                                                                                                                                     |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                             |
| `--without-sources`              | Create the export with no sources attached, without being prompted for --sources.                                                                                                         |

#### weka telemetry exports add syslog

Add a new Syslog telemetry export destination.

```sh
weka telemetry exports add syslog <name> [--allow-unverified-certificate] [--ca-cert <string>] [--disabled] [--facility <syslog-facility>] [--mode <syslog-mode>] [--rfc <syslog-rfc>] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert] [--without-sources]
```

| Parameter                        | Description                                                                                                                                                                               |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                         | Name for the new export.                                                                                                                                                                  |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                            |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                |
| `--disabled`                     | Create the export in a disabled state.                                                                                                                                                    |
| `--facility` \<syslog-facility>  | Syslog facility: local0 through local7 (default local0). Valid values: local0, local1, local2, local3, local4, local5, local6, local7.                                                    |
| `--mode` \<syslog-mode>          | Syslog transport mode: tcp or udp (default tcp). Valid values: tcp, udp.                                                                                                                  |
| `--rfc` \<syslog-rfc>            | Syslog message framing: rfc5424 or rfc3164 (default rfc5424). Valid values: rfc5424, rfc3164.                                                                                             |
| `--sources` \<source-type>…      | Telemetry source to attach to this export: audit or s3\_events. An export carries at most one source. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | Destination target (host:port or URL) for the export.                                                                                                                                     |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                             |
| `--without-sources`              | Create the export with no sources attached, without being prompted for --sources.                                                                                                         |

### weka telemetry exports attach

Attach sources to a telemetry export.

```sh
weka telemetry exports attach <export-id> <sources>…
```

| Parameter     | Description                     |
| ------------- | ------------------------------- |
| `export-id`\* | Export ID to attach sources to. |
| `sources`\*…  | Sources to attach.              |

### weka telemetry exports detach

Detach sources from a telemetry export.

```sh
weka telemetry exports detach <export-id> <sources>… [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `export-id`\*   | Export ID to detach sources from.                               |
| `sources`\*…    | Sources to detach.                                              |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

### weka telemetry exports disable

Disable a telemetry export.

```sh
weka telemetry exports disable <export-id>
```

| Parameter     | Description           |
| ------------- | --------------------- |
| `export-id`\* | Export ID to disable. |

### weka telemetry exports enable

Enable a telemetry export.

```sh
weka telemetry exports enable <export-id>
```

| Parameter     | Description          |
| ------------- | -------------------- |
| `export-id`\* | Export ID to enable. |

### weka telemetry exports list

List configured telemetry export destinations.

```sh
weka telemetry exports list [--name <string>] [--type <export-type>]
```

| Parameter               | Description                                                                            |
| ----------------------- | -------------------------------------------------------------------------------------- |
| `--name` \<string>      | Show only the export with this exact name (case-insensitive).                          |
| `--type` \<export-type> | Show only exports of this type. Valid values: file, splunk, s3, vector, kafka, syslog. |

**Columns:** `id`, `name`, `enabled`, `export_type`, `target`, `sources`

### weka telemetry exports remove

Remove a telemetry export.

```sh
weka telemetry exports remove <export-id> [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `export-id`\*   | Export ID to remove.                                            |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

### weka telemetry exports status

Show the health of every telemetry export, measured against the containers expected to report it.

Stalled means the export delivered nothing for over a minute. The cluster sends an audit heartbeat through every export once a minute, so a stalled export is stuck or its destination stopped accepting data.

The cluster reports export state per server, so containers on the same server share one state.

The ratio counts the containers the cluster expects a report from: those that own drive or compute cores. A container that reports an export without being expected to — a protocol container, say — is not in the ratio, but a problem it reports is listed and makes the export degraded.

TELEMETRY OFF means the cluster's telemetry is switched off, so nothing is exported whatever an export's own state says. Turn it on with 'weka audit cluster enable'.

Counts are exact. Server names are a sample: the cluster names a limited number of servers per state, so a container beyond that sample is counted but not named.

The numbers are a point in time. The cluster is read four times, not in one atomic snapshot, so during a scale event the ratio can disagree with itself. Let an alert built on this output hold for a few minutes before it fires.

```sh
weka telemetry exports status [<export-id>] [--check] [--containers]
```

| Parameter      | Description                                                                                                                           |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `export-id`    | Export ID to report on. Reports on every export when omitted.                                                                         |
| `--check`      | Exit with code 2 when any export shown is down, degraded, telemetry off, or in a health state this version cannot read.               |
| `--containers` | Show one row per container instead of one row per export. JSON output keeps one object per export, with its containers nested inside. |

**Columns:** `export_id`, `name`, `health`, `reporting`, `problems`

### weka telemetry exports update

Update an existing telemetry export's configuration.

```sh
weka telemetry exports update
```

#### weka telemetry exports update kafka

Update an existing Kafka telemetry export's configuration.

```sh
weka telemetry exports update kafka <export-id> [--allow-unverified-certificate] [--ca-cert <string>] [--clear-tls-settings] [--key-field <string>] [--name <string>] [--sasl-mechanism <kafka-sasl-mechanism>] [--sasl-password <string>] [--sasl-username <string>] [--sources <source-type>…] [--target <string>] [--topic <string>] [--use-sasl] [--verify-with-cluster-cacert]
```

| Parameter                                  | Description                                                                                                                                                                                                                                       |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `export-id`\*                              | Export ID to update.                                                                                                                                                                                                                              |
| `--allow-unverified-certificate`           | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                                                                                    |
| `--ca-cert` \<string>                      | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                                                                        |
| `--clear-tls-settings`                     | Clear the export's TLS settings, reverting it to the default (unverified) certificate handling.                                                                                                                                                   |
| `--key-field` \<string>                    | New message field to use as the Kafka record key.                                                                                                                                                                                                 |
| `--name` \<string>                         | New name for the export.                                                                                                                                                                                                                          |
| `--sasl-mechanism` \<kafka-sasl-mechanism> | New SASL mechanism: plain, scram-sha-256, or scram-sha-512. Valid values: plain, scram-sha-256, scram-sha-512.                                                                                                                                    |
| `--sasl-password` \<string>                | New SASL password.                                                                                                                                                                                                                                |
| `--sasl-username` \<string>                | New SASL username.                                                                                                                                                                                                                                |
| `--sources` \<source-type>…                | Attach this source to the export. An export carries at most one source, so this fails on an export that already carries a different source; use detach first. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>                       | New destination target (host:port or URL) for the export.                                                                                                                                                                                         |
| `--topic` \<string>                        | New Kafka topic to publish telemetry to.                                                                                                                                                                                                          |
| `--use-sasl`                               | Enable or disable SASL authentication to the Kafka brokers.                                                                                                                                                                                       |
| `--verify-with-cluster-cacert`             | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                                                                                     |

#### weka telemetry exports update s3

Update an existing S3 telemetry export's configuration.

```sh
weka telemetry exports update s3 <export-id> [--access-key-id <string>] [--allow-unverified-certificate] [--bucket-name <string>] [--ca-cert <string>] [--clear-tls-settings] [--name <string>] [--region <string>] [--secret-key <string>] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert]
```

| Parameter                        | Description                                                                                                                                                                                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `export-id`\*                    | Export ID to update.                                                                                                                                                                                                                              |
| `--access-key-id` \<string>      | New S3 access key ID.                                                                                                                                                                                                                             |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                                                                                    |
| `--bucket-name` \<string>        | New name of the S3 bucket to export telemetry to.                                                                                                                                                                                                 |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                                                                        |
| `--clear-tls-settings`           | Clear the export's TLS settings, reverting it to the default (unverified) certificate handling.                                                                                                                                                   |
| `--name` \<string>               | New name for the export.                                                                                                                                                                                                                          |
| `--region` \<string>             | New S3 bucket region.                                                                                                                                                                                                                             |
| `--secret-key` \<string>         | New S3 secret access key.                                                                                                                                                                                                                         |
| `--sources` \<source-type>…      | Attach this source to the export. An export carries at most one source, so this fails on an export that already carries a different source; use detach first. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | New destination target (host:port or URL) for the export.                                                                                                                                                                                         |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                                                                                     |

#### weka telemetry exports update splunk

Update an existing Splunk telemetry export's configuration.

```sh
weka telemetry exports update splunk <export-id> [--allow-unverified-certificate] [--auth-token <string>] [--ca-cert <string>] [--clear-tls-settings] [--name <string>] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert]
```

| Parameter                        | Description                                                                                                                                                                                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `export-id`\*                    | Export ID to update.                                                                                                                                                                                                                              |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                                                                                    |
| `--auth-token` \<string>         | New Splunk HTTP Event Collector authentication token.                                                                                                                                                                                             |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                                                                        |
| `--clear-tls-settings`           | Clear the export's TLS settings, reverting it to the default (unverified) certificate handling.                                                                                                                                                   |
| `--name` \<string>               | New name for the export.                                                                                                                                                                                                                          |
| `--sources` \<source-type>…      | Attach this source to the export. An export carries at most one source, so this fails on an export that already carries a different source; use detach first. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | New destination target (host:port or URL) for the export.                                                                                                                                                                                         |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                                                                                     |

#### weka telemetry exports update syslog

Update an existing Syslog telemetry export's configuration.

```sh
weka telemetry exports update syslog <export-id> [--allow-unverified-certificate] [--ca-cert <string>] [--clear-tls-settings] [--facility <syslog-facility>] [--mode <syslog-mode>] [--name <string>] [--rfc <syslog-rfc>] [--sources <source-type>…] [--target <string>] [--verify-with-cluster-cacert]
```

| Parameter                        | Description                                                                                                                                                                                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `export-id`\*                    | Export ID to update.                                                                                                                                                                                                                              |
| `--allow-unverified-certificate` | Allow connecting to the export's target without verifying its TLS certificate.                                                                                                                                                                    |
| `--ca-cert` \<string>            | Path to a PEM-encoded CA certificate file to verify the export's TLS connection against (max 16384 bytes).                                                                                                                                        |
| `--clear-tls-settings`           | Clear the export's TLS settings, reverting it to the default (unverified) certificate handling.                                                                                                                                                   |
| `--facility` \<syslog-facility>  | New Syslog facility: local0 through local7. Valid values: local0, local1, local2, local3, local4, local5, local6, local7.                                                                                                                         |
| `--mode` \<syslog-mode>          | New Syslog transport mode: tcp or udp. Valid values: tcp, udp.                                                                                                                                                                                    |
| `--name` \<string>               | New name for the export.                                                                                                                                                                                                                          |
| `--rfc` \<syslog-rfc>            | New Syslog message framing: rfc5424 or rfc3164. Valid values: rfc5424, rfc3164.                                                                                                                                                                   |
| `--sources` \<source-type>…      | Attach this source to the export. An export carries at most one source, so this fails on an export that already carries a different source; use detach first. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--target` \<string>             | New destination target (host:port or URL) for the export.                                                                                                                                                                                         |
| `--verify-with-cluster-cacert`   | Verify the export's TLS certificate against the cluster's own CA certificate.                                                                                                                                                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.weka.io/6.0/getting-started-with-weka/weka-cli-overview/cli-reference-guide/weka-telemetry.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
