Register a Remote Cluster.

post

https://cluster.ip.address/v2/remote-clusters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the request to register Remote Cluster.

Specifies the parameters to register a Remote Cluster.

nodeAddresses

array of strings

required

length ≥ 1

Specifies the VIP or IP addresses of the Nodes on the Remote Cluster to connect with. Hostnames are not supported.

nodeAddresses*

password

string

required

Specifies the password for Cohesity user to use when connecting to the Remote Cluster.

username

string

required

Specifies the Cohesity user name used to connect to the Remote Cluster.

autoRegisterTarget

boolean | null

Defaults to false

Specifies if the Tx clusters should be automatically registered at the Rx site.

description

string | null

Specifies any additional information if needed.

networkInterface

string | null

Specifies the name of the network interfaces to use for communicating with the Remote Cluster.

purpose

array of strings | null

Specifies the purpose for which the remote cluster is being registered.

purpose

Allowed:

replicationParams

object | null

Specifies the replication config for a Remote Cluster. Required when usedForReplication is set to true.

201Success