Update a Storage Domain.

put

https://cluster.ip.address/v2/storage-domains/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specified the Storage Domain id to update.

Body Params

Specified the request to update a Storage Domain.

Specifies the parameter to update a Storage Domain.

adDomainName

string | null

Specifies the Active Directory domain name that this Storage Domain is mapped to.

blobBrickSizeBytes

int32 | null

Specifies the brick size used for blobs in this Storage Domain.

cloudDomainId

int64 | null

Specifies the cloud domain Id.

cloudDownWaterFallParams

object | null

Specifies the cloud down water fall parameters for this Storage Domain.

clusterPartitionId

int64 | null

required

Specifies the cluster partition id of the Storage Domain.

defaultUserQuota

object | null

Specifies a default user quota limit for users within views in this Storage Domain.

defaultViewQuota

object | null

Specifies a default logical quota limit for all views in this Storage Domain. This quota can be overwritten by a view level quota.

dekRotationEnabled

boolean | null

Specifies whether DEK(Data Encryption Key) rotation is enabled for this Storage Domain. This is applicable only when the Storage Domain uses AWS or similar KMS in which the KEK (Key Encryption Key) is not created and maintained by Cohesity. For Internal KMS and keys stored in Safenet servers, DEK rotation will not be performed.

directArchiveEnabled

boolean | null

Specifies whether to enable driect archive on this Storage Domain. If enabled, this Storage Domain can be used as a staging area while copying a large dataset that can't fit on the cluster to an external target.

kerberosRealmName

string | null

Specifies the Kerberos realm name that this Storage Domain is mapped to.

kmsServerId

int64 | null

Specifies the associated KMS server id.

ldapProviderId

int64 | null

Specifies the LDAP provider id that this Storage Domain is mapped to.

name

string | null

required

Specifies the Storage Domain name.

nisDomainNames

array of strings | null

Specifies the NIS domain names that this Storage Domain is mapped to.

nisDomainNames

physicalQuota

object | null

Specifies a quota limit for physical usage of this Storage Domain. This quota defines a limit of data that can be physically (after data size is reduced by block tracking, compression and deduplication) stored on this storage domain. A new write will not be allowed when the storage domain usage will exceeds the specified quota. Due to the latency of calculating usage across all nodes, the actual storage domain usage may exceed the quota limit by a little bit.

s3BucketsEnabled

boolean | null

Specifies whether to enable creation of S3 bucket on this Storage Domain.

storagePolicy

object | null

Specifies the storage policy for this Storage Domain.

subnetWhitelist

array of objects | null

Specifies a list of Subnets with IP addresses that have permissions to access the Storage Domain.

subnetWhitelist

tenantIds

array of strings | null

Specifies a list of tenant ids that that Storage Domain belongs. There can only be one tenant id in this field unless Storage Domain sharing between tenants is allowed on this cluster.

tenantIds

treatFileSyncAsDataSync

boolean | null

If 'true', when the Cohesity Cluster is writing to a file, the file modification time is not persisted synchronously during the file write, so the modification time may not be accurate. (Typically the file modification time is off by 30 seconds but it can be longer.)

vaultId

int64 | null

Specifies the vault Id associated with cloud domain ID.

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