Documentation

InfluxDB Clustered

influxctl

Limited availability

InfluxDB Clustered is currently only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

The influxctl command line interface (CLI) performs administrative tasks in an cluster.

Usage

influxctl [flags] [command]

Commands

CommandDescription
clusterList InfluxDB v3 cluster information
databaseManage InfluxDB v3 databases
tokenManage InfluxDB v3 database tokens
versionOutput the current influxctl version
helpOutput influxctl help information

Global flags

FlagDescription
--debugEnable debug logging
--accountOverride account ID value in configuration file
--clusterOverride cluster ID value in configuration file
--configPath to configuration file to use
--profileSpecify a connection profile to use (default is default)
-h--helpShow help

Download and install influxctl

macOS Linux Windows

  1. Download the influxctl CLI package appropriate for your CPU type. Download the package from your browser or command line.

    Browser

    influxctl CLI v2.0.4 (x86_64) influxctl CLI v2.0.4 (arm64)

    Command line
    # x86_64
curl -Oo ~/Downloads/ https://dl.influxdata.com/influxctl/releases/influxctl-v2.0.4-darwin-x86_64.zip

# arm64
curl -Oo ~/Downloads/ https://dl.influxdata.com/influxctl/releases/influxctl-v2.0.4-darwin-arm64.zip

  2. Unpackage the downloaded package.

    Do one of the following:

    • In Finder, double-click the downloaded package file.
    • From the command line, run the following command appropriate for your CPU type:
    # x86_64
unzip ~/Downloads/influxctl-v2.0.4-darwin-x86_64.zip

# arm64
unzip ~/Downloads/influxctl-v2.0.4-darwin-arm64.zip

  3. (Optional) Place the binary in your $PATH.

    # x86_64
sudo cp ~/Downloads/influxctl-v2.0.4-darwin-x86_64/influxctl /usr/local/bin/

# arm64
sudo cp ~/Downloads/influxctl-v2.0.4-darwin-arm64/influxctl /usr/local/bin/

  4. Create a connection profile that stores connection credentials for your cluster.

To download the Linux influxctl package, do one of the following:

Use a package manager

Ubuntu & Debian (.deb) Red Hat & CentOS (.rpm)

# influxdata-archive_compat.key GPG fingerprint:
#     9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E
wget -q https://repos.influxdata.com/influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list

sudo apt-get update && sudo apt-get install influxctl

# influxdata-archive_compat.key GPG fingerprint:
#     9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E
cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo
[influxdata]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF

sudo yum install influxctl

Manually download the package

  1. Download the influxctl CLI package appropriate for your CPU type. Download the package from your browser or command line.

    Browser

    influxctl CLI v2.0.4 (x86_64) influxctl CLI v2.0.4 (arm64)

    Command line
    # amd64
curl -O https://dl.influxdata.com/influxctl/releases/influxctl-v2.0.4-linux-x86_64.tar.gz

# arm64
curl -O https://dl.influxdata.com/influxctl/releases/influxctl-v2.0.4-linux-arm64.tar.gz

  2. Unpackage the downloaded package.

    # amd64
tar zxvf influxctl-v2.0.4-linux-x86_64.tar.gz

# arm64
tar zxvf influxctl-v2.0.4-linux-arm64.tar.gz

  3. (Optional) Place the binary in your $PATH.

    # amd64
sudo cp influxctl-v2.0.4-darwin-x86_64/influxctl /usr/local/bin/

# arm64
sudo cp influxctl-v2.0.4-darwin-arm64/influxctl /usr/local/bin/

  4. Create a connection profile that stores connection credentials for your cluster.

  1. Download the influxctl CLI package.

    influxctl CLI v2.0.4 (x86_64)

  2. Expand the downloaded archive.

    Expand the downloaded archive into C:\Program Files\InfluxData\ and rename it if desired.

    Expand-Archive .\influxctl-v2.0.4-windows-x86_64.zip `
-DestinationPath 'C:\Program Files\InfluxData\'
mv 'C:\Program Files\InfluxData\influxctl-v2.0.4-windows-x86_64' `
'C:\Program Files\InfluxData\influxctl'

  3. Grant network access to the influx CLI.

    When using the influxctl CLI for the first time, Windows Defender displays the following message:

    Windows Defender Firewall has blocked some features of this app.

    To grant the influxctl CLI the required access, do the following:

    Select Private networks, such as my home or work network. Click Allow access.

  4. Create a connection profile that stores connection credentials for your cluster.

Configure connection profiles

To connect with your InfluxDB cluster, influxctl needs the following credentials:

  • InfluxDB cluster host
  • InfluxDB cluster port
  • OAuth provider credentials (what credentials are needed depend on your OAuth provider)

Create a configuration file

Create a config.toml that includes the necessary credentials. If stored at the default location for your operating system, influxctl automatically detects and uses the connection profile configurations. If stored at a non-default location, include the --config flag with each influxctl command and provide the path to your profile configuration file.

View sample config.toml

Default connection profile store location

The influxctl CLI checks for connection profiles in a config.toml file at a default location based on your operating system:

Operating systemDefault profile configuration file path
Linux~/.config/influxctl/config.toml
macOS~/Library/Application Support/influxctl/config.toml
Windows%APPDATA%\influxctl\config.toml

Authentication

The influxctl CLI uses Auth0 to authenticate access to your InfluxDB cluster. When you issue an influxctl command, the CLI checks for an active Auth0 token. If none exists, you are directed to login to Auth0 via a browser using credentials you should have created when setting up your InfluxDB cluster. Auth0 issues a short-lived (1 hour) token that authenticates access to your InfluxDB cluster.

Troubleshoot

  • Not loading module “atk-bridge”: When authenticating, some Linux systems might report the following warning in the terminal (on stderr):

    Not loading module "atk-bridge": The functionality is provided by GTK natively. Please try to not load it.

    To silence the warning when running influxctl commands, unset the GTK_MODULES environment variable (or remove gail:atk-bridge from its value)–for example:

    GTK_MODULES= influxctl ...
cli

Was this page helpful?

Thank you for your feedback!

© 2023 InfluxData, Inc.

What is your InfluxDB cluster URL?

Enter your InfluxDB cluster URL and we’ll update code examples for you.

Enter cluster URL

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.