models.create_view_box_params module

class models.create_view_box_params.CreateViewBoxParams(cluster_partition_id=None, name=None, ad_domain_name=None, client_subnet_white_list=None, cloud_down_waterfall_threshold_pct=None, cloud_down_waterfall_threshold_secs=None, default_user_quota_policy=None, default_view_quota_policy=None, direct_archive_enabled=None, ldap_provider_id=None, nis_domain_name_vec=None, physical_quota=None, s_3_buckets_allowed=None, storage_policy=None, tenant_id_vec=None)

Bases: object

Implementation of the ‘CreateViewBoxParams’ model.

Provides details about the Storage Domain (View Box).

Attributes:

ad_domain_name (string): Specifies an active directory domain that

this view box is mapped to.

client_subnet_white_list (list of Subnet): Array of Subnets.

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

cloud_down_waterfall_threshold_pct (int): 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.

cloud_down_waterfall_threshold_secs (int): Specifies the cloud down

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

cluster_partition_id (long|int): Specifies the Cluster Partition id

where the Storage Domain (View Box) is located.

default_user_quota_policy (QuotaPolicy): Specifies an optional quota

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

default_view_quota_policy (QuotaPolicy): 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.

direct_archive_enabled (bool): 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’.

ldap_provider_id (long|int): 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.

nis_domain_name_vec (list of string): Specifies the NIS domain that

this view box is mapped to.

name (string): Specifies the name of the Storage Domain (View Box). physical_quota (QuotaPolicy): 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.

s_3_buckets_allowed (bool): 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.

storage_policy (StoragePolicy): Specifies the storage options applied

to a Storage Domain (View Box).

tenant_id_vec (list of string): 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.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.