influx export all
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.
The influx export all
command exports all resources in an organization as an InfluxDB template. For detailed examples of exporting InfluxDB templates, see Create an InfluxDB template.
To export resources as a template, you must use the Operator token created for the initial InfluxDB user or an All-Access token. For information about creating an All-Access API token, see Create an API token.
Usage
influx export all [flags]
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 | |
-f | —file | Template output file. Defaults to stdout. Use .yml or .json file extensions. | string | |
—filter | Specify resources to export by labelName or resourceKind (format: —filter=labelName=example ) | stringArray | ||
-h | —help | Help for the export all command | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers. | string | ||
-o | —org | Organization name that owns the resources (mutually exclusive with —org-id ) | string | INFLUX_ORG |
—org-id | Organization ID that owns the resources (mutually exclusive with —org ) | string | INFLUX_ORG_ID | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
Resources
The following resources can be exported:
- Bucket
- Check
- CheckDeadman
- CheckThreshold
- Dashboard
- Label
- NotificationEndpoint
- NotificationEndpointHTTP
- NotificationEndpointPagerDuty
- NotificationEndpointSlack
- NotificationRule
- Task
- Telegraf
- Variable
For additional information on each resource, please see template resources.
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, --org
or--org-id
: InfluxDB organization name or ID-t, --token
: InfluxDB API token- Export all bucket resources as a template
- Export all resources associated with label Foo
- Export all bucket resources and with label Foo
- Export all bucket or dashboard resources with label Foo
Export all resources in an organization as a template
influx export all
Export all bucket resources as a template
influx export all --filter=resourceKind=Bucket
Export all resources associated with label Foo
influx export all --filter=labelName=Foo
Export all bucket resources and with label Foo
influx export all \
--filter=resourceKind=Bucket \
--filter=labelName=Foo
Export all bucket or dashboard resources with label Foo
influx export all \
--filter=resourceKind=Bucket \
--filter=resourceKind=Dashboard \
--filter=labelName=Foo
Related
- Create an InfluxDB template
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions