{
  "id": "add-instance",
  "title": "crdb-cli crdb add-instance",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/crdb-cli/crdb/add-instance/",
  "summary": "Adds a peer replica to an Active-Active database.",
  "content": "\nAdds a peer replica to an existing Active-Active database in order to host the database on another cluster. This creates an additional active instance of the database on the specified cluster.\n\n```sh\ncrdb-cli crdb add-instance --crdb-guid \u003cguid\u003e\n         --instance fqdn=\u003ccluster_fqdn\u003e,username=\u003cusername\u003e,password=\u003cpassword\u003e[,url=https://\u003chostname-or-IP\u003e:9443,replication_endpoint=\u003chostname-or-IP\u003e:\u003cport\u003e,replication_tls_sni=\u003chostname\u003e]\n         [--compression \u003c0-6\u003e]\n         [--wait | --no-wait]\n```\n\n### Parameters\n\n| Parameter | Value   | Description |\n|-----------|---------|-------------|\n| crdb-guid | string  | The GUID of the database (required) |\n| instance fqdn=\\\u003ccluster_fqdn\\\u003e,username=\\\u003cusername\\\u003e,password=\\\u003cpassword\\\u003e,url=https://\\\u003chostname-or-IP\\\u003e:9443,replication_endpoint=\\\u003chostname-or-IP\\\u003e:\\\u003cport\\\u003e,replication_tls_sni=\\\u003chostname\\\u003e | strings | The connection information for the new participating cluster (required)\u003cbr/\u003e\u003cbr/\u003e**Required:**\u003cbr/\u003e• `fqdn` - Cluster fully qualified domain name\u003cbr/\u003e• `username` - Cluster username\u003cbr/\u003e• `password` - Cluster password\u003cbr/\u003e\u003cbr/\u003e**Optional:**\u003cbr/\u003e• `url` - URL to access the cluster's REST API\u003cbr/\u003e• `replication_endpoint` - Address to access the database instance for peer replication\u003cbr/\u003e• `replication_tls_sni` - Cluster [Server Name Indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) hostname for TLS connections |\n| compression | 0-6 | The level of data compression: \u003cbr /\u003e\u003cbr \u003e 0 = No compression \u003cbr /\u003e\u003cbr \u003e 6 = High compression and resource load (Default: 3) |\n| wait | | Prevents `crdb-cli` from running another command before this command finishes |\n| no-wait | | `crdb-cli` can run another command before this command finishes |\n\n### Returns\n\nReturns the task ID of the task that is adding the new instance.\n\nIf `--no-wait` is specified, the command exits. Otherwise, it will wait for the instance to be added and return `finished`.\n\n### Example\n\n```sh\n$ crdb-cli crdb add-instance --crdb-guid db6365b5-8aca-4055-95d8-7eb0105c0b35 \\\n        --instance fqdn=cluster2.redis.local,username=admin@redis.local,password=admin-password\nTask f809fae7-8e26-4c8f-9955-b74dbbd47949 created\n  ---\u003e Status changed: queued -\u003e started\n  ---\u003e Status changed: started -\u003e finished\n```\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}