Register a remote Cluster on this local Cluster for replication.

post

https://cluster.ip.address/irisservices/api/v1/public/remoteClusters

Privileges: CLUSTER_REMOTE_MODIFY

For a Protection Job to replicate Snapshots from one Cluster
to another Cluster, the Clusters must be paired together by
registering each Cluster on the other Cluster.
For example, Cluster A must be registered on Cluster B
and Cluster B must be registered on Cluster A.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to register a remote Cluster.

Specifies the settings required for registering a remote Cluster
on this local Cluster.

allEndpointsReachable

boolean | null

Specifies whether any endpoint (such as a Node) on the remote Cluster
is reachable from this local Cluster.
If true, a service running on the local Cluster can communicate
directly with any of its peers running on the remote Cluster, without
using a proxy.

autoRegisterTarget

boolean | null

Specifies whether the remote cluster needs to be kept in sync.
This will be set to true by default.

autoRegistration

boolean | null

Specifies whether the remote registration has happened automatically
(due to registration on the other site).
Can't think of other states (other than manually & automatically) so this
isn't an enum.
For a manual registration, this field will not be set.

bandwidthLimit

object | null

Specifies settings for limiting the data transfer rate between
the local and remote Clusters.

clusterId

int64 | null

Specifies the unique id of the remote Cluster.

clusterIncarnationId

int64 | null

Specifies the unique incarnation id of the remote Cluster. This
id is determined dynamically by contacting the remote Cluster.

compressionEnabled

boolean | null

Specifies whether to compress the outbound data when
transferring the replication data over the network to the remote Cluster.

description

string | null

Specifies any additional information if needed.

domain

string | null

Specifies the domain of the user account. For AD accounts,
specify the AD domain name. Omit or use 'LOCAL' for local
Cohesity accounts.

encryptionKey

string | null

Specifies the encryption key used for encrypting the replication data
from a local Cluster to a remote Cluster.
If a key is not specified, replication traffic encryption is disabled.
When Snapshots are replicated from a local Cluster to a remote Cluster,
the encryption key specified on the local Cluster must be the same
as the key specified on the remote Cluster.

name

string | null

Specifies the name of the remote cluster. This field is determined
dynamically by contacting the remote cluster.

networkInterface

string | null

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

password

string | null

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

purposeRemoteAccess

boolean | null

Whether the remote cluster will be used for remote access for SPOG.

purposeReplication

boolean | null

Whether the remote cluster will be used for replication.

remoteAccessCredentials

object | null

Optional field for the user credentials to connect to Iris for remote
access for SPOG. If this is not specified, then credentials specified
for replication set up will be used for remote access for SPOG.
Allowing a different user credentials to be set up for SPOG permits
having different roles for remote access for SPOG and replication set
up.

remoteIps

array of strings | null

Array of Remote Node IP Addresses.

Specifies the IP addresses of the Nodes on the remote Cluster to
connect with. These IP addresses can also be VIPS.
Specifying hostnames is not supported.

remoteIps

remoteIrisPorts

array of int64s | null

Array of Ports.

Specifies the ports to use when connecting to the Nodes of the
remote Cluster.

remoteIrisPorts

reverseRegisted

boolean | null

Specifies whether the Rx regiseter the Tx.

tlsEnabled

boolean | null

Specifies if the TLS is enabled on the remote cluster.

userName

string | null

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

validateOnly

boolean | null

Whether to only validate the credentials without saving the information.

viewBoxPairInfo

array of objects | null

Array of Storage Domain (View Box) Pairs.

Specifies pairings between Storage Domains (View Boxes) on the local Cluster
with Storage Domains (View Boxes) on a remote Cluster that are used in
replication.

viewBoxPairInfo

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

defaultError