Getting StartedAPI ReferenceRecipesGitHub
API Reference

Update a cluster.

put
https://cluster.ip.address/v2/clusters

Privileges: CLUSTER_MODIFY

Update the Cluster with the given configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the parameters to update cluster.

Specifies the cluster details.

string | null

Specifies the default AES Encryption mode on the cluster.

amqpTargetConfig
object | null

Specifies the AMQP target config.

appsSubnet
object | null

The subnet for Athena apps.

int32 | null

Specifies the number of racks in cluster with at least one rack assigned.

boolean | null

To attempt agent connection on port 21213 first.

boolean | null

Specifies if cluster can support authHeaders for upgrade.

string | null
enum

Specifies the authentication scheme for the cluster.

Allowed:
authorizedSshPublicKeys
array of strings | null

Specifies a list of authorized SSH public keys that have been uploaded to this Cohesity Cluster.

authorizedSshPublicKeys
int64 | null

Specifies information about storage available for metadata

boolean | null

Specifies whether UI banner is enabled on the cluster or not.

int32 | null

Specifies the number of chassis in cluster.

clusterAuditLogConfig
object | null

Specifies the Cluster audit log configuration.

string | null

Specifies the current release of the Cohesity software running on the Cohesity Cluster.

int64 | null

Specifies the time when the Cohesity Cluster was created.

int64 | null

Specifies the time scheduled by the Cohesity Cluster to start the current running operation.

string | null
enum

Specifies the current Cluster-level operation in progress.

int64 | null

Specifies the current system time on the Cohesity Cluster.

string | null

Description of the cluster.

diskCountByTier
array of objects | null

Specifies the number of disks on the cluster by Storage Tier.

diskCountByTier
dnsServerIps
array of strings | null

Specifies the IP addresses of the DNS Servers used by the Cohesity Cluster.

dnsServerIps
domainNames
array of strings | null

Specifies array of Domain Names.

domainNames
boolean | null

Specifies if Cohesity can receive monitoring information from the Cohesity Cluster.

boolean | null

Specifies whether to enable downloading patches from Cohesity download site.

boolean | null

If 'true', Cohesity's upgrade server is polled for new releases.

int64 | null

Specifies the period of time (in seconds) when encryption keys are rotated

eulaConfig
object | null

Specifies the End User License Agreement acceptance information.

string | null
enum

Specifies the level which 'MetadataFaultToleranceFactor' applies to.

Allowed:
fileServicesAuditLogConfig
object | null

Specifies the File Services audit log configuration.

string | null

Specifies the gateway IP address.

boolean | null

Specifies whether Google Analytics is enabled.

boolean | null

Specifies if hardware encryption(SED) is enabled.

hardwareInfo
object | null

Specifies a hardware type for motherboard of the nodes that make dnsServerIps this Cohesity Cluster

int32 | null

Specifies IP preference.

boolean | null

Specifies whether or not athena subnet is clashing with some other internal subnet

boolean | null

Specifies if MFA is enabled on cluster.

boolean | null

Specifies what version of the documentation is used.

boolean | null

Specifies that the patch apply was aborted.

boolean | null

Specifies that the patch revert was aborted.

boolean | null

Specifies if the current upgrade has been aborted.

int64 | null

Specifies the KMS Server Id.

string | null

Specifies the language and locale for this Cohesity Cluster.

licenseState
object | null

Specifies the state of licensing workflow.

loadBalancerVipConfig
object | null

Load balancer VIP config for OneHelios cluster.

string | null

Specifies domain name for SMB local authentication.

boolean | null

Specifies whether to enable local groups on cluster.

int32 | null

Specifies metadata fault tolerance setting for the cluster.

int32 | null

Specifies minimum failure domains needed in the cluster.

boolean | null

Specifies if multi tenancy is enabled in the cluster.

string | null

Name of the cluster.

networkConfig
object

Network config of the cluster.

int64 | null

Specifies the number of Nodes in the Cohesity Cluster.

string | null

Specifies IP addresses of nodes in the cluster.

ntpSettings
object | null

Specifies if the ntp/primary secondary scheme should be disabled

string | null

Specifies the error message for a failed patch apply.

string | null

Specifies the error message for a failed patch revert.

string | null

Specifies the target version for reverting the patch.

string | null

Specifies the target version for applying the patch.

boolean | null

Specifies if cluster can support patch reverts.

string | null

Specifies the patch version applied to cluster.

int32 | null

Specifies the rebalance delay in seconds for cluster PcieSSD storage tier.

boolean | null

Specifies if protorpc encryption is enabled or not.

proxyServerConfig
object | null

Specifies the proxy to use for external HTTP traffic.

string | null

Specifies the subnet reserved for ProxyVM.

boolean | null

If 'true', Cohesity's Remote Tunnel is enabled.

int64 | null

Specifies the end time in milliseconds since epoch until when the reverse tunnel will stay enabled.

rigelClusterParams
object | null

Specifies the Rigel specific parameters.

s3VirtualHostedDomainNames
array of strings | null

Specifies the list of domain names for S3.

s3VirtualHostedDomainNames
int32 | null

Specifies the admission control for cluster SATAHDD storage tier.

schemaInfoList
array of objects | null

Specifies the time series schema info of the cluster.

schemaInfoList
boolean | null

Specifies if Security Mode DOD is enabled or not.

boolean | null

Specifies if Active Directory should be disabled for authentication of SMB shares.

boolean | null

Specifies whether SMB multichannel is enabled on the cluster.

string | null
enum

Specifies the type of Cohesity Software.

Allowed:
boolean | null

Specifies if split key host access is enabled.

stats
object | null

Specifies statistics about the Cohesity Cluster.

supportedConfig
object | null

Specifies information about supported configuration.

string | null

Specifies the Cohesity release that this Cluster is being upgraded to if an upgrade operation is in progress.

boolean | null

Specifies whether multiple tenants can be placed on the same viewbox.

tieringAuditLogConfig
object | null

Specifies the SmartTier audit log configuration.

string | null

Specifies the timezone to use.

string | null

Specifies the Trust Domain.

boolean | null

Specifies if the cluster is in Turbo mode..

string | null

Error string to capture why the upgrade failed.

boolean | null

To use default ports 50051 & 21213.

boolean | null

Specifies whether to enable Heimdall which tells whether services should use temporary fleet instances to mount disks by talking to Heimdall.

float | null

Measures the percentage about storage used for metadata over the total storage available for metadata

viewsGlobalSettings
object | null

Specifies the Global Settings for SmartFiles.

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?