Skip to content

Commit 203d898

Browse files
committed
DOC-5354 Added missing instance parameters and details to crdb-cli crdb add-instance reference
1 parent 1bb3f76 commit 203d898

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

content/operate/rs/references/cli-utilities/crdb-cli/crdb/add-instance.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,20 @@ Adds a peer replica to an existing Active-Active database in order to host the d
1414

1515
```sh
1616
crdb-cli crdb add-instance --crdb-guid <guid>
17-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
18-
[ --compression <0-6> ]
19-
[ --no-wait ]
17+
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=https://<hostname-or-IP>:9443,replication_endpoint=<hostname-or-IP>:<port>,replication_tls_sni=<hostname>]
18+
[--compression <0-6>]
19+
[--wait | --no-wait]
2020
```
2121

2222
### Parameters
2323

2424
| Parameter | Value | Description |
2525
|-----------|---------|-------------|
2626
| crdb-guid | string | The GUID of the database (required) |
27-
| instance | strings | The connection information for the new participating cluster (required) |
28-
| compression | 0-6 | The level of data compression: 0=Compression disabled <br> <br> 6=High compression and resource load (Default: 3) |
29-
| no-wait | | Does not wait for the task to complete |
27+
| instance fqdn=\<cluster_fqdn\>,username=\<username\>,password=\<password\>,url=https://\<hostname-or-IP\>:9443,replication_endpoint=\<hostname-or-IP\>:\<port\>,replication_tls_sni=\<hostname\> | strings | The connection information for the new participating cluster (required)<br/><br/>**Required:**<br/>• `fqdn` - Cluster fully qualified domain name<br/>• `username` - Cluster username<br/>• `password` - Cluster password<br/><br/>**Optional:**<br/>• `url` - URL to access the cluster's REST API<br/>• `replication_endpoint` - Address to access the database instance for peer replication<br/>• `replication_tls_sni` - Cluster [Server Name Indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) hostname for TLS connections |
28+
| compression | 0-6 | The level of data compression: <br /><br > 0 = No compression <br /><br > 6 = High compression and resource load (Default: 3) |
29+
| wait | | Prevents `crdb-cli` from running another command before this command finishes |
30+
| no-wait | | `crdb-cli` can run another command before this command finishes |
3031

3132
### Returns
3233

0 commit comments

Comments
 (0)