Update a Remote Cluster config.

put

https://helios.cohesity.com/v2/remote-clusters/{clusterId}

Update the connection settings of the specified Remote Cluster that is registered on this Cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clusterId

int64

required

Specifies the cluster id of the Remote Cluster to update.

Body Params

Specifies the request to update Remote Cluster config.

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.

effectiveAesEncryptionMode

string | null

enum

Specifies the effective AES Encryption mode negotiated between local and the remote cluster.

Allowed:

multiTenancyEnabled

boolean | null

Specifies if the Remote Cluster has Multi-Tenancy enabled.

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

replicationParams

object | null

Specifies the replication config for a Remote Cluster.

supportedAesEncryptionMode

string | null

enum

Specifies the AES Encryption mode of the remote cluster.

Allowed:

tenantStorageDomainSharingEnabled

boolean | null

Specifies if Tenant Storage Domain sharing is enabled on the Remote Cluster.

tlsEnabled

boolean | null

Specifies if TLS is enabled on the Remote Cluster.

nodeAddresses

array of strings

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 | null

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

username

string

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

otpCode

string | null

Specifies OTP code for MFA verification.

otpType

string | null

enum

Specifies the list of mechanism to receive the OTP code. Supported types are: TOTP (Helios OnPrem Only) -> Time based OTP. Email OTP (Helios OnPrem Only) -> OTP via Email.

Allowed:

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError