influx replication update

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

Replication remotes and replication streams can only be configured for InfluxDB OSS.

The influx replication update command updates an InfluxDB replication stream.

Usage

  1. influx replication update [command options] [arguments...]

Flag

FlagDescriptionInput typeMaps to ?
-i—idReplication stream ID to updatestring
-n—nameNew replication stream namestring
-d—descriptionNew replication stream descriptionstring
—remote-idNew remote connection ID to send data tostring
—remote-bucket-idNew remote bucket ID to replicate data tostring
—max-queue-bytesNew max queue size in bytes (default: 0)integer
—drop-non-retryable-dataDrop data when a non-retryable error is encountered
—no-drop-non-retryable-dataDo not drop data when a non-retryable error is encountered
—max-ageSpecify a maximum age (in seconds) for data before it is droppedinteger
—hostInfluxDB HTTP address (default http://localhost:8086)stringINFLUX_HOST
—skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
—configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-c—active-configCLI configuration to use for commandstring
—http-debugInspect communication with InfluxDB serversstring
—jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
—hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
-t—tokenInfluxDB API tokenstringINFLUX_TOKEN

Example

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

Update a replication

  1. Use influx replication list to get the ID for the replication you want to update.

    1. $ influx replication list
    2. ID                    Name        Org ID
    3. 0ooxX0xxXo0x              myreplication    [...]

  2. Use the following command to update the replication:

    1. influx replication update \
    2.   --id 0ooxX0xxXo0x
    3.   --name new-replication-name
    4.   --description new-replication-description
    5.   --replication-url http://new-replication-url.com
    6.   --replication-api-token new-replication-api-token
    7.   --replication-org-id new-replication-org-id

write replication