models_v2.view_1 module

class models_v2.view_1.View1(protocol_access=None, qos=None, override_global_subnet_whitelist=None, subnet_whitelist=None, override_global_netgroup_whitelist=None, netgroup_whitelist=None, security_mode=None, storage_policy_override=None, logical_quota=None, file_lock_config=None, file_extension_filter=None, antivirus_scan_config=None, description=None, allow_mount_on_windows=None, enable_minion=None, enable_filer_audit_logging=None, tenant_id=None, enable_live_indexing=None, enable_offline_caching=None, swift_project_domain=None, swift_project_name=None, access_sids=None, view_lock_enabled=None, is_externally_triggered_backup_target=None, enable_nfs_view_discovery=None, nfs_all_squash=None, nfs_root_permissions=None, nfs_root_squash=None, enable_smb_view_discovery=None, enable_smb_access_based_enumeration=None, enable_smb_encryption=None, enforce_smb_encryption=None, enable_fast_durable_handle=None, enable_smb_oplock=None, smb_permissions_info=None, share_permissions=None, acl_config=None, owner_info=None, category=None, name=None, view_id=None, is_category_inferred=None, storage_domain_id=None, storage_domain_name=None, create_time_msecs=None, basic_mount_path=None, nfs_mount_path=None, smb_mount_paths=None, case_insensitive_names_enabled=None, view_protection=None, data_lock_expiry_usecs=None, aliases=None, is_target_for_migrated_data=None, stats=None, object_services_mapping_config=None, s_3_access_path=None, swift_user_domain=None, swift_username=None)

Bases: object

Implementation of the ‘View.1’ model.

Specifies settings for defining a storage location (called a View) with NFS and SMB mount paths in a Storage Domain (View Box) on the Cohesity Cluster.

Attributes:

protocol_access (list of ProtocolOption): Specifies the supported

Protocols for the View.

qos (QoS): Specifies the Quality of Service (QoS) Policy for the

View.

override_global_subnet_whitelist (bool): Specifies whether view level

client subnet whitelist overrides cluster and global setting.

subnet_whitelist (list of Subnet): Array of Subnets. Specifies a list

of Subnets with IP addresses that have permissions to access the View. (Overrides or extends the Subnets specified at the global Cohesity Cluster level.)

override_global_netgroup_whitelist (bool): Specifies whether view

level client netgroup whitelist overrides cluster and global setting.

netgroup_whitelist (NisNetgroups): Response of NIS Netgroups. security_mode (SecurityModeEnum): Specifies the security mode used for

this view. Currently we support the following modes: Native, Unified and NTFS style. ‘NativeMode’ indicates a native security mode. ‘UnifiedMode’ indicates a unified security mode. ‘NtfsMode’ indicates a NTFS style security mode.

storage_policy_override (StoragePolicyOverride): Specifies if inline

deduplication and compression settings inherited from Storage Domain (View Box) should be disabled for this View.

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

file_lock_config (FileLevelDataLockConfigurations): Specifies a config

to lock files in a view - to protect from malicious or an accidental attempt to delete or modify the files in this view.

file_extension_filter (FileExtensionFilter): TODO: type description

here.

antivirus_scan_config (AntivirusScanConfig): Specifies the antivirus

scan config settings for this View.

description (string): Specifies an optional text description about the

View.

allow_mount_on_windows (bool): Specifies if this View can be mounted

using the NFS protocol on Windows systems. If true, this View can be NFS mounted on Windows systems. hidden: true

enable_minion (bool): Specifies if this view should allow minion or

not. If true, this will allow minion. hidden: true

enable_filer_audit_logging (bool): Specifies if Filer Audit Logging is

enabled for this view.

tenant_id (string): Optional tenant id who has access to this View. enable_live_indexing (bool): Specifies whether to enable live indexing

for the view.

enable_offline_caching (bool): Specifies whether to enable offline

file caching of the view.

swift_project_domain (string): Specifies the Keystone project domain. swift_project_name (string): Specifies the Keystone project name. access_sids (list of string): Array of Security Identifiers (SIDs)

Specifies the list of security identifiers (SIDs) for the restricted Principals who have access to this View.

view_lock_enabled (bool): Specifies whether view lock is enabled. If

enabled the view cannot be modified or deleted until unlock. By default it is disabled.

is_externally_triggered_backup_target (bool): Specifies whether the

view is for externally triggered backup target. If so, Magneto will ignore the backup schedule for the view protection job of this view. By default it is disabled.

enable_nfs_view_discovery (bool): If set, it enables discovery of view

for NFS.

nfs_all_squash

(NfsSquashSpecifiesTheSquashConfigForClientSubnetWhitelist): TODO: type description here.

nfs_root_permissions (NfsRootPermissions): Specifies the config of NFS

root permission of a view file system.

nfs_root_squash

(NfsSquashSpecifiesTheSquashConfigForClientSubnetWhitelist): TODO: type description here.

enable_smb_view_discovery (bool): If set, it enables discovery of view

for SMB.

enable_smb_access_based_enumeration (bool): Specifies if access-based

enumeration should be enabled. If ‘true’, only files and folders that the user has permissions to access are visible on the SMB share for that user.

enable_smb_encryption (bool): Specifies the SMB encryption for the

View. If set, it enables the SMB encryption for the View. Encryption is supported only by SMB 3.x dialects. Dialects that do not support would still access data in unencrypted format.

enforce_smb_encryption (bool): Specifies the SMB encryption for all

the sessions for the View. If set, encryption is enforced for all the sessions for the View. When enabled all future and existing unencrypted sessions are disallowed.

enable_fast_durable_handle (bool): Specifies whether fast durable

handle is enabled. If enabled, view open handle will be kept in memory, which results in a higher performance. But the handles cannot be recovered if node or service crashes.

enable_smb_oplock (bool): Specifies whether SMB opportunistic lock is

enabled.

smb_permissions_info (SMBPermissionsInformation): Specifies

information about SMB permissions.

share_permissions (list of SMBPermission): Specifies a list of share

level permissions.

acl_config (AclConfig1): Specifies the ACL config of the View as an S3

bucket.

owner_info (OwnerInfo2): Specifies the owner info of the View as an S3

bucket.

category (Category1Enum): Specifies the category of the View. name (string): Specifies the name of the View. view_id (long|int): Specifies an id of the View assigned by the

Cohesity Cluster.

is_category_inferred (bool): If True, category in response is not set

by user but inferred by Iris because none is set. Category can only be none when view was created by v1 API or cloned from a view created by v1 API. Inference Logic is as follows: 1. Object Services if only S3 or Swift protocol is selected. 2. Backup Target only if one read-write protocol is selected and QoS is “Backup Target Commvault” or “Backup Target SSD”. 3. File Services if there are more than 1 read-write protocol or it doesn’t fit any other category.

storage_domain_id (long|int): Specifies the id of the Storage Domain

(View Box) where the View is stored.

storage_domain_name (string): Specifies the name of the Storage Domain

(View Box) where the View is stored.

create_time_msecs (long|int): Specifies the time that the View was

created in milliseconds.

basic_mount_path (string): Specifies the NFS mount path of the View

(without the hostname information). This path is used to support NFS mounting of the paths specified in the nfsExportPathList on Windows systems.

nfs_mount_path (string): Specifies the path for mounting this View as

an NFS share.

smb_mount_paths (list of string): Array of SMB Paths. Specifies the

possible paths that can be used to mount this View as a SMB share. If Active Directory has multiple account names; each machine account has its own path.

case_insensitive_names_enabled (bool): Specifies whether to support

case insensitive file/folder names. This parameter can only be set during create and cannot be changed.

view_protection (ViewProtection): Specifies information about the

Protection Groups that are protecting the View.

data_lock_expiry_usecs (long|int): DataLock (Write Once Read Many)

lock expiry epoch time in microseconds. If a view is marked as a DataLock view, only a Data Security Officer (a user having Data Security Privilege) can delete the view until the lock expiry time.

aliases (list of ViewAliasInformation): Aliases created for the view.

A view alias allows a directory path inside a view to be mounted using the alias name.

is_target_for_migrated_data (bool): Specifies if a view contains

migrated data.

stats (ViewStats): Provides statistics about the View. object_services_mapping_config (ObjectServicesMappingConfigEnum):

Specifies the Object Services key mapping config of the view. This parameter can only be set during create and cannot be changed. Configuration of Object Services key mapping. Specifies the type of Object Services key mapping config.

s_3_access_path (string): Specifies the path to access this View as an

S3 share.

swift_user_domain (string): Specifies the Keystone user domain. swift_username (string): Specifies the Keystone username.

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.