influx telegrafs
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
The influx telegrafs command lists Telegraf configurations. Subcommands manage Telegraf configurations.
Usage
1. influx telegrafs [flags]
2. influx telegrafs [command]
Subcommands
| Subcommand | Description |
|---|---|
| create | Create a Telegraf configuration |
| rm | Remove a Telegraf configuration |
| update | Update a Telegraf configuration |
Flags
| Flag | Description | Input type | Maps to ? | |
|---|---|---|---|---|
-c |
—active-config |
CLI configuration to use for command | string | |
—configs-path |
Path to influx CLI configurations (default ~/.influxdbv2/configs) |
string | INFLUX_CONFIGS_PATH |
|
-h |
—help |
Help for the telegrafs command |
||
—hide-headers |
Hide table headers | INFLUX_HIDE_HEADERS |
||
-i |
—id |
Telegraf configuration ID to retrieve | string | |
—json |
Output data as JSON | INFLUX_OUTPUT_JSON |
||
-o |
—org |
Organization name (mutually exclusive with —org-id) |
string | INFLUX_ORG |
—org-id |
Organization ID (mutually exclusive with —org) |
string | INFLUX_ORG_ID |
|
—skip-verify |
Skip TLS certificate verification | INFLUX_SKIP_VERIFY |
||
-t |
—token |
API token | string | INFLUX_TOKEN |
Examples
Authentication credentials
The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:
--host: InfluxDB host-o, --orgor--org-id: InfluxDB organization name or ID-t, --token: InfluxDB API token
List all Telegraf configurations
1. influx telegrafs
List a Telegraf configuration with the specified ID
1. influx telegrafs --id 0Xx0oox00XXoxxoo1
Related
- Telegraf configurations
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions
