Create a Domain (View Box).

post

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

Privileges: STORAGE_DOMAIN_MODIFY

Returns the created Domain (View Box).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a Storage Domain (View Box) configuration.

Provides details about the Storage Domain (View Box).

adDomainName

string | null

Specifies an active directory domain that this view box is mapped to.

brickSize

int32 | null

Specifies the default brick size used by the viewbox.

clientSubnetWhiteList

array of objects | null

Array of Subnets.

Specifies the Subnets from which this Storage Domain (View Box) accepts
requests.

clientSubnetWhiteList

cloudDownWaterfallThresholdPct

int32 | null

Specifies the cloud down water-fall threshold percentage. This indicates
how full should a viewbox at least be before we down water-fall its data
to cloud tier. If this field is set, the physical quota limit must be set
also and will be used as viewbox capacity.

cloudDownWaterfallThresholdSecs

int32 | null

Specifies the cloud down water-fall threshold seconds. This indicates
what's the time threshold on water-falling data to cloud tier.

clusterPartitionId

int64 | null

required

Specifies the Cluster Partition id where the Storage Domain (View Box) is
located.

defaultUserQuotaPolicy

object | null

Specifies an optional quota policy/limits that are inherited by all users
within the views in this viewbox.

defaultViewQuotaPolicy

object | null

Specifies an optional default logical quota limit (in bytes)
for the Views in this Storage Domain (View Box).
(Logical data is when the data is fully hydrated and expanded.)
However, this inherited quota can be overwritten at the View level.
A new write is not allowed if the Storage Domain (View Box) 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 delay before the Cohesity Cluster allows more data
to be written to the Storage Domain (View Box), as the Cluster is
calculating the usage across Nodes.

dekRotationEnabled

boolean | null

Specifies whether DEK(Data Encryption Key) rotation is enabled for this
viewbox. This is applicable only when the viewbox 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 this viewbox can be used as a staging area while copying
a largedataset that can't fit on the cluster to an external target. The
amount of data that can be stored on the viewbox can be specified using
'physical_quota'.

kerberosRealmName

string | null

Specifies the Kerberos domain that this view box is mapped to.

kmsServerId

int64 | null

Specifies the associated KMS Server ID.

ldapProviderId

int64 | null

When set, the following provides the LDAP provider the view box is
mapped to. For any view from this view box, when accessed via NFS the
following LDAP provider is looked up for getting Unix IDs of the
corresponding user. Similarly, when a view is accessed via SMB and if
the AD user's domain matches with the view box's AD, the following LDAP
provider will be used to lookup Unix IDs for the corresponding AD user.
Additionally there is also a mapping between LDAP provider and AD domain
that is stored in AD provider config. It will be used if AD is not set
on the view box.

name

string | null

required

Specifies the name of the Storage Domain (View Box).

nisDomainNameVec

array of strings | null

Specifies the NIS domain that this view box is mapped to.

nisDomainNameVec

physicalQuota

object | null

Specifies an optional quota limit (in bytes) for the physical
usage of this Storage Domain (View Box).
This quota limit defines a physical limit for size of the data that
can be physically stored on the Storage Domain (View Box), after the data
has been reduced by change block tracking, compression and deduplication.
The physical usage is the aggregate sum of the data stored for this
Storage Domain (View Box) on all disks in the Cluster.
(The usage includes Cloud Tier data and user data.)
A new write is not allowed if the Storage Domain (View Box) 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 Storage Domain (View Box), as the Cluster is
calculating the usage across Nodes.

s3BucketsAllowed

boolean | null

Specifies whether creation of a S3 bucket is allowed in this
Storage Domain (View Box).
When a new S3 bucket creation request arrives, we'll look at all the View
Boxes and the first Storage Domain (View Box) that allows creating S3
buckets in it will be the one where the bucket will be placed.

storagePolicy

object | null

Specifies the storage options applied to the Storage Domain (View Box).

tenantIdVec

array of strings | null

Optional ids for the tenants that this view box belongs. This must be
checked before granting access to users. Unless the cluster enables view
box sharing between tenants is allowed, there shall be at most one item
in this list. Note that if all tenant may be deleted - such viewboxes
must be garbage collected. This is currently done by a background thread
in iris.

tenantIdVec

updatedBrickSize

int32 | null

Specifies the brick size to be used by the viewbox for creating any new
blobs.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError