Getting StartedAPI ReferenceRecipesGitHub
API Reference

Update the configuration of this Cohesity Cluster.

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

Privileges: CLUSTER_MODIFY

Returns the updated Cluster configuration.

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

Update Cluster Parameter.

Specifies the configuration settings that can be updated on the
Cohesity Cluster.

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.

boolean | null

To attempt agent connection on port 21213 first

boolean | null

Specifies whether UI banner is enabled on the cluster or not. When banner
is enabled, UI will make an additional API call to fetch the banner and
show at the login page.

boolean | null

Specifies if the Cloud RF1 is enabled on the cluster.

clusterAuditLogConfig
object | null

Cluster Audit Log Configuration.

dnsServerIps
array of strings | null

Array of IP Addresses of DNS Servers.

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

dnsServerIps
domainNames
array of strings | null

Array of Domain Names.

The first domain name specified in the array is the fully qualified
domain name assigned to the Cohesity Cluster. Any additional
domain names specified are used for the domain search list for
hostname look-up.

domainNames
boolean | null

Specifies if Cohesity can receive monitoring information from the
Cohesity Cluster.
If 'true', remote monitoring of the Cohesity Cluster is allowed.

boolean | null

Specifies whether to enable downloading patches from Cohesity download
site.

int64 | null

Specifies the period of time (in seconds) when encryption keys are rotated.
By default, the encryption keys are rotated every 77760000 seconds
(30 days).

string | null
enum

Specifies the level which 'MetadataFaultToleranceFactor' applies to.
'kNode' indicates 'MetadataFaultToleranceFactor' applies to Node level.
'kChassis' indicates 'MetadataFaultToleranceFactor' applies to Chassis
level.
'kRack' indicates 'MetadataFaultToleranceFactor' applies to Rack level.

Allowed:
filerAuditLogConfig
object | null

Filer Audit Log Configuration.

string | null

Specifies the gateway IP address.

boolean | null

Specifies whether Google Analytics is enabled.

boolean | null

Specifies what version of the documentation is used.
If 'true', the version of documentation stored locally on the Cohesity
Cluster is used.
If 'false', the documentation stored on a Cohesity Web Server
is used. The default is 'false'.
Cohesity recommends accessing the Help from the Cohesity Web site which
provides the newest and most complete version of Help.

int64 | null

Specifies the KMS Server Id.
This can only be set when the encryption is enabled on cluster.

string | null

Specifies the language and locale for this Cohesity Cluster.

string | null

Domain name for SMB local authentication.

boolean | null

Specifies whether to enable local groups on cluster. Once it is enabled,
it cannot be disabled.

int32 | null

Specifies metadata fault tolerance setting for the cluster. This denotes
the number of simultaneous failures[node] supported by metadata services
like gandalf and scribe.

boolean | null

Specifies if multi tenancy is enabled in the cluster. Authentication &
Authorization will always use tenant_id, however, some UI elements may be
disabled when multi tenancy is disabled.

string | null

Specifies the name of the Cohesity Cluster.

ntpSettings
object | null

Specifies if the ntp/primary secondary scheme should be disabled for this
cluster.

int32 | null

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

boolean | null

Specifies if protorpc encryption is enabled or not.

boolean | null

ReverseTunnelEnableExtension specifies if the reverse tunnel should be
extended.

boolean | null

If 'true', Cohesity's Remote Tunnel is enabled.
Cohesity can access the Cluster and provide remote assistance
via a Remote Tunnel.

int64 | null

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

int64 | null

ReverseTunnelExtensionDurationHours specifies the number of hours to
extend the reverse tunnel.

s3VirtualHostedDomainNames
array of strings | null

Specifies the list of domain names for S3
Virtual Hosted Style Paths. If set, all the Cohesity S3 Views in the
cluster can be accessed using any of the specified domain names.

s3VirtualHostedDomainNames
int32 | null

Specifies the admission control for cluster SATAHDD storage tier.

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. If 'true', Active Directory is disabled.

boolean | null

Specifies whether SMB multichannel is enabled on the cluster. When this is
set to true, then any SMB3 multichannel enabled client can establish
multiple TCP connection per session to the Server.

boolean | null

TODO(mitch) StigMode is deprecated. Should it still be in this list??

syslogServers
array of objects | null

Syslog servers.

syslogServers
boolean | null

In case multi tenancy is enabled, this flag controls whether multiple
tenants can be placed on the same viewbox. Once set to true, this flag
should never become false.

tieringAuditLogConfig
object | null

Tiering Audit Log Configuration.

string | null

Specifies the timezone to use for showing time in emails, reports,
filer audit logs, etc.

boolean | null

Specifies if the TLS is enabled on the remote cluster.

boolean | null

Specifies if the cluster is in Turbo mode.

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.

Responses

Updated about 5 hours 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 about 5 hours ago

Did this page help you?