Documentation

influx replication update

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

The influx replication update command updates an InfluxDB replication stream.

Usage

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-bucketRemote bucket name to replicate data to (mutually exclusive with --remote-bucket-id)string
--remote-bucket-idRemote bucket ID to replicate data to (mutually exclusive with --remote-bucket-name)string
--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.
    $ influx replication list
    ID			        Name		Org ID
    0ooxX0xxXo0x      	    myreplication    [...]
    
  2. Use the following command to update the replication:
    influx replication update \
      --id 0ooxX0xxXo0x
      --name new-replication-name
      --description new-replication-description
      --replication-url http://new-replication-url.com
      --replication-api-token new-replication-api-token
      --replication-org-id new-replication-org-id
    

Was this page helpful?

Thank you for your feedback!


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:

InfluxDB Cloud powered by TSM