Update a View.

put

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

Privileges: STORAGE_MODIFY

Returns the updated View.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to update a view.

Specifies the settings that define a View.

accessSids

array of strings | null

Array of Security Identifiers (SIDs)

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

accessSids

antivirusScanConfig

object | null

Specifies the antivirus scan config settings for this View.

dataLockMode

string | null

Specifies the WORM datalock mode for this view. This may be unset
for WORM views created through legacy flows (such as Iris,
Magneto snapshots, or cloning). WORM status must therefore be
determined by worm_lock_expiry_usecs.
Enum: [Compliance Enterprise]

description

string | null

Specifies an optional text description about the View.

enableFastDurableHandle

boolean | null

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.

enableFilerAuditLogging

boolean | null

Specifies if Filer Audit Logging is enabled for this view.

enableLiveIndexing

boolean | null

Specifies whether to enable live indexing for the view.

enableMetadataAccelerator

boolean | null

Specifies whether view is blur enabled.

enableMixedModePermissions

boolean | null

If set, mixed mode (NFS and SMB) access is enabled for this view.
This field is deprecated. Use the field SecurityMode.
deprecated: true

enableNfsViewDiscovery

boolean | null

If set, it enables discovery of view for NFS.

enableOfflineCaching

boolean | null

Specifies whether to enable offline file caching of the view.

enableSmbAccessBasedEnumeration

boolean | null

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.

enableSmbEncryption

boolean | null

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.

enableSmbOplock

boolean | null

Specifies whether SMB opportunistic lock is enabled.

enableSmbViewDiscovery

boolean | null

If set, it enables discovery of view for SMB.

enforceSmbEncryption

boolean | null

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.

fileExtensionFilter

object | null

Optional filtering criteria that should be satisfied by all the files
created in this view. It does not affect existing files.

fileLockConfig

object | null

Optional config that enables file locking for this view. It cannot be
disabled during the edit of a view, if it has been enabled during the
creation of the view. Also, it cannot be enabled if it was disabled
during the creation of the view.

isExternallyTriggeredBackupTarget

boolean | null

Specifies whether view is for externally triggered backup target.

isReadOnly

boolean | null

Specifies if the view is a read only view. User will no longer be able to
write to this view if this is set to true.

logicalQuota

object | null

Specifies an optional logical quota limit (in bytes) for the usage allowed
on this View.
(Logical data is when the data is fully hydrated and expanded.)
This limit overrides the limit inherited from the Storage Domain
(View Box) (if set).
If logicalQuota is nil, the limit is inherited from the
Storage Domain (View Box) (if set).
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 View, as the Cluster is calculating the usage
across Nodes.

netgroupWhitelist

array of objects | null

Array of Netgroups.

Specifies a list of Netgroups that have permissions to access the
View. (Overrides the Netgroups specified at the global Cohesity
Cluster level.)

netgroupWhitelist

nfsAllSquash

object | null

Specifies the NFS all squash config.

nfsRootPermissions

object | null

Specifies the NFS root permission config of the view file system.

nfsRootSquash

object | null

Specifies the NFS root squash config.

overrideGlobalNetgroupWhitelist

boolean | null

Specifies whether view level client netgroup allowlist overrides cluster
and global setting.

overrideGlobalWhitelist

boolean | null

Specifies whether view level client subnet allowlist overrides cluster and
global setting.

protocolAccess

string | null

enum

Deprecated: Specifies the supported Protocols for the View.
'kAll' enables protocol access to following three views: NFS, SMB and S3.
'kNFSOnly' enables protocol access to NFS only.
'kSMBOnly' enables protocol access to SMB only.
'kS3Only' enables protocol access to S3 only.
'kSwiftOnly' enables protocol access to Swift only.
'kUnknown' indicates that the protocol access of a view does not match
any of the above. In this case, the constant is used as 'catch-all'.

Allowed:

qos

object | null

Specifies the Quality of Service (QoS) Policy for the View.

securityMode

string | null

enum

Specifies the security mode used for this view.
Currently we support the following modes: Native, Unified and NTFS style.
'kNativeMode' indicates a native security mode.
'kUnifiedMode' indicates a unified security mode.
'kNtfsMode' indicates a NTFS style security mode.

Allowed:

sharePermissions

array of objects | null

Specifies a list of share level permissions.

sharePermissions

smbPermissionsInfo

object | null

Specifies the SMB permissions for the View.

storagePolicyOverride

object | null

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

subnetWhitelist

array of objects | null

Array of Subnets.

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

subnetWhitelist

superUserSids

array of strings | null

Specifies a list of user sids who have Superuser access to this view.

superUserSids

swiftProjectDomain

string | null

Specifies the Keystone project domain.

swiftProjectName

string | null

Specifies the Keystone project name.

tenantId

string | null

Optional tenant id who has access to this View.

viewLockEnabled

boolean | null

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

viewPinningConfig

object | null

Specifies the pinning config of this view.

viewProtocol

array of objects | null

Specifies the supported Protocols for the View.

viewProtocol

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