Getting StartedAPI ReferenceRecipesGitHub
API Reference

Create a View

post
https://cluster.ip.address/v2/file-services/views

Creates a View.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a View.

Specifies the information required for creating a new View.

boolean | null

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

intent
object | null

Specifies the intent of the View.

string | null
enum

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.

Allowed:
boolean | null

Specifies whether to support s3 folder support feature. This
parameter can only be set during create and cannot be changed.

int64 | null
required

Specifies the id of the Storage Domain (View Box) where the View will be
created.

viewProtectionConfig
object | null

Specifies the protection config of the 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
boolean | null

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.

antivirusScanConfig
object | null

Specifies the antivirus scan config settings for this View.

string | null
enum
required

Specifies the category of the View.

Allowed:
string | null

Specifies an optional text description about the View.

boolean | null

Specifies if Filer Audit Logging is enabled for this view.

boolean | null

Specifies whether to enable live indexing for the view.

boolean | null

Specifies if metadata accelerator is enabled for this view. Only
supported while creating a view.

boolean | null

Specifies if this view should allow minion or not. If true, this will
allow minion.

boolean | null

Specifies whether to enable offline file caching of the view.

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.

filerLifecycleManagement
object | null

Specifies the Lifecycle policy of this filer (NFS/SMB) view.

boolean | null

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.

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.

boolean | null

If small files are accessed sequentially from a client,
this specifies whether to detect and
prefetch files based on the lexicographic index to
improve file read performance.

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.

string | null

Specifies the name of the View.

netgroupWhitelist
object | null

Array of Netgroups.
Specifies a list of netgroups with domains that have permissions to
access the View. (Overrides or extends the Netgroup specified at the global
Cohesity Cluster level.)

boolean | null

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

boolean | null

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

protocolAccess
array of objects | null
required

Specifies the supported Protocols for the View.

protocolAccess*
qos
object | null
required

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

string | null
enum

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.

Allowed:
selfServiceSnapshotConfig
object | null

Specifies self service config of this 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 or extends the Subnets specified at the global
Cohesity Cluster level.)

subnetWhitelist
string | null

Optional tenant id who has access to this View.

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.

boolean | null

If set, it enables NFS Kerberos Authentication

boolean | null

If set, it enables NFS Kerberos Integrity

boolean | null

If set, it enables NFS Kerberos Privacy

boolean | null

If set, it enables NFS UNIX Authentication

boolean | null

If set, it enables discovery of view for NFS.

boolean | null

If set, it enables NFS weak cache consistency.

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.

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.

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.

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.

boolean | null

Specifies whether SMB opportunistic lock is enabled.

boolean | null

If set, it enables discovery of view for SMB.

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.

sharePermissions
object | null

Specifies share level permissions of the view.

smbPermissionsInfo
object | null

Specifies the SMB permissions for the View.

aclConfig
object | null

Specifies the ACL config of the View as an S3 bucket.

bucketPolicy
object | null

Specifies the policy in effect for this bucket.

boolean | null

Specifies if this View has S3 ABAC enabled. This can only be set
while creating a view. The ABAC server corresponding the tenant
will be used for authentication and authorization checks.

lifecycleManagement
object | null

Specifies the S3 Lifecycle policy of the bucket

ownerInfo
object | null

Specifies the owner info of the View as an S3 bucket.

int32 | null

Specifies if this View has S3 MPU 2.0 enabled. This can set
while editing a view.

boolean | null

Specifies if this View has S3 MPU 2.0 enabled. This can set
while editing a view.

string | null
enum

Specifies the migration state for this view. A view can be under
following migration states: Enabled, Paused, Complete,
UnderMigration.

Allowed:
string | null
enum

Specifies the versioning state of S3 bucket. Buckets can be in one of three states: UnVersioned (default), VersioningEnabled, or VersioningSuspended. Once versioning is enabled for a bucket, it can never return to an UnVersioned state. However, versioning on the bucket can be suspended.

Allowed:
string | null

Specifies the Keystone project domain.

string | null

Specifies the Keystone project name.

string | null

Specifies the Keystone user domain.

string | null

Specifies the Keystone username.

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?