Getting StartedAPI ReferenceRecipesGitHub
API Reference
Start typing to search…

Create a Storage Domain.

post
https://cluster.ip.address/v2/storage-domains

Privileges: STORAGE_DOMAIN_MODIFY

Create a Storage Domain.

Body Params

Specified the request to create a Storage Domain.

string | null

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

int32 | null

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

int64 | null

Specifies the cloud domain Id.

cloudDownWaterFallParams
object | null

Specifies parameters for cloud down water fall thresholds.

int64 | null
required

Specifies the cluster partition id of the Storage Domain.

defaultUserQuota
object | null

Specifies a quota limit that can be optionally applied to Views and Storage Domains. At the View level, this quota defines a logical limit for usage on the View. At the Storage Domain level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for Storage Domain, this quota defines a physical limit for the usage on the Storage Domain. If a default logical View quota is specified for Storage Domain, this limit is inherited by all the Views in that Storage Domain. However, this inherited quota can be overwritten at the View level. A new write is not allowed if the resource will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the resource, as the Cluster calculates the usage across Nodes.

defaultViewQuota
object | null

Specifies a quota limit that can be optionally applied to Views and Storage Domains. At the View level, this quota defines a logical limit for usage on the View. At the Storage Domain level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for Storage Domain, this quota defines a physical limit for the usage on the Storage Domain. If a default logical View quota is specified for Storage Domain, this limit is inherited by all the Views in that Storage Domain. However, this inherited quota can be overwritten at the View level. A new write is not allowed if the resource will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the resource, as the Cluster calculates the usage across Nodes.

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.

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.

string | null

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

int64 | null

Specifies the associated KMS server id.

int64 | null

Last key rotation timestamp in msecs for storage domain.

int64 | null

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

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 that can be optionally applied to Views and Storage Domains. At the View level, this quota defines a logical limit for usage on the View. At the Storage Domain level, this quota defines a physical limit or a default logical View limit. If a physical quota is specified for Storage Domain, this quota defines a physical limit for the usage on the Storage Domain. If a default logical View quota is specified for Storage Domain, this limit is inherited by all the Views in that Storage Domain. However, this inherited quota can be overwritten at the View level. A new write is not allowed if the resource will exceed the specified quota. However, it takes time for the Cohesity Cluster to calculate the usage across Nodes, so the limit may be exceeded by a small amount. In addition, if the limit is increased or data is removed, there may be a delay before the Cohesity Cluster allows more data to be written to the resource, as the Cluster calculates the usage across Nodes.

boolean | null

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

storagePolicy
object | null

Specifies the storage policy of a 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
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.)

int64 | null

Specifies the vault Id associated with cloud domain ID.

Responses

Updated 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago