Get

/viewpolicies/{id}/

This endpoint returns a specified view policy.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

The ID of the view policy

Responses

200

Expand All

object

id

integer

ID

guid

string

Globally unique identifier

name

string

Name of the policy

created

string (date-time)

internal

boolean

gid_inheritance

string

Specifies how files receive their owning group when they are created. 'LINUX' (default): Each new file inherits its owning group from the group ID of the user who creates the file. 'BSD': Each new file inherits its owning group from the group ID of the parent directory.

Valid values[ "LINUX", "BSD" ]

flavor

string

Security flavor, which determines how file and directory permissions are applied in multiprotocol views.

Valid values[ "NFS", "SMB", "MIXED_LAST_WINS", "S3_NATIVE", "BLOCK" ]

access_flavor

string

Applicable with MIXED_LAST_WINS security flavor (Access can be set via NFSv3 regardless of this option)

path_length

string

How to determine the maximum allowed path component name length. 'LCD' (default): Imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols, regardless of the specific protocol enabled on a specific view. 'YOYO': Imposes no limitation beyond that of the client protocol.

Valid values[ "LCD", "YOYO" ]

allowed_characters

string

How to determine which characters are allowed in file names. 'LCD' (default): Allows only characters allowed by all VAST Cluster-supported protocols, regardless of the specific protocol enabled on a specific view. With this (default) option, the limitation on the length of a single component of the path is 255 characters. 'YOYO': Imposes no limitation beyond that of the client protocol.

Valid values[ "LCD", "YOYO" ]

use_32bit_fileid

boolean

If true, the VAST Cluster's NFS server uses 32bit file IDs. This setting supports legacy 32-bit applications running over NFS.

expose_id_in_fsid

boolean

s3_special_chars_support

boolean

This will enable object names that contain “//“ or “/../“ and are incompatible with other protocols

inherit_parent_mode_bits

boolean

Enable NFS behavior of inheriting POSIX settings from the parent directory versus configured values.

nfs_enforce_tls_relaxed

boolean

Applicable if nfs_enforce_tls is enabled. Allows non-TLS connections on auxiliary NFSv3 subprotocols (MOUNT, NLM, NSM, RQUOTA, NFSACL)

smb_is_ca

boolean

When enabled, the SMB share exposed by the view is set as continuously available, which allows SMB3 clients to request use of persistent file handles and keep their connections to this share in case of a failover event.

use_auth_provider

boolean

Not in use

auth_source

string

Specifies which source is trusted for the user's group memberships, when users' access to the view is authorized.

Valid values[ "RPC", "PROVIDERS", "RPC_AND_PROVIDERS" ]

read_write

Array of string

Hosts with NFS read/write permissions

string

read

Array of string

Hosts with read permissions

string

change

Array of string

string

full

Array of string

string

read_only

Array of string

Hosts with NFS read only permissions

string

nfs_read_write

Array of string

Hosts with NFS read/write permissions

string

nfs_read_only

string

Hosts with NFS read only permissions

smb_read_write

Array of string

Hosts with SMB read/write permissions

string

smb_read_only

Array of string

Hosts with SMB read only permissions

string

s3_read_write

Array of string

Hosts with S3 read/write permissions

string

s3_read_only

Array of string

Hosts with S3 read only permissions

string

trash_access

Array of string

Hosts with trash access permission

string

nfs_posix_acl

boolean

True if support is enabled for extended POSIX Access Control Lists (ACL) for NFSv3 clients.

nfs_return_open_permissions

boolean

when using smb use open permissions for files

nfs_no_squash

Array of string

Hosts with no squash policy

string

nfs_root_squash

Array of string

Hosts with root squash policy

string

nfs_all_squash

Array of string

Hosts with all squash policy

string

nfs_case_insensitive

boolean

Force case insensitivity for NFSv3 and NFSv4

nfs_enforce_mtls

boolean

Specifies whether to enforce mTLS authentication over NFS. If enabled, the cluster denies access for clients that do not present an appropriate client certificate. This also applies to clients accessing the cluster from allowed client virtual IPs configured for the tenant. This flag can only be set for view policies that do not span multiple tenants. Enabling this option also causes TLS encryption to be enforced."

smb_file_mode

integer

Default unix type permissions on new file

smb_directory_mode

integer

Default unix type permissions on new folder

smb_file_mode_padded

string

Default unix type permissions on new file

smb_directory_mode_padded

string

Default unix type permissions on new folder

disable_read_lease

boolean

disable_write_lease

boolean

disable_handle_lease

boolean

cluster

string

Parent Cluster

cluster_id

integer

Parent Cluster ID

title

string

tenant_id

integer

Tenant ID

tenant_name

string

Tenant Name

url

string

Endpoint URL for API operations on the view policy object

atime_frequency

string

Frequency for updating the atime attribute of NFS files. atime is updated on read operations if the difference between the current time and the file's atime value is greater than the atime frequency. Default: 3600

sync

string

Synchronization state with leader

vip_pools

Array of integer

Comma separated vip pool ids. Restricts view access to specified VIP pools.

integer

sync_time

string

Synchronization time with leader

nfs_minimal_protection_level

string

Minimal Protection Level for NFSv4 client mounts: 'KRB_AUTH_ONLY' allows client mounts with Kerberos authentication only (using the RPCSEC_GSS authentication service), 'SYSTEM' allows client mounts using either the AUTH_SYS RCP security flavor (the traditional default NFS authentication scheme) or with Kerberos authentication, 'NONE' (default) allows client mounts with the AUTH_NONE (anonymous access), or AUTH_SYS RCP security flavors, or with Kerberos authentication.

Valid values[ "NONE", "SYSTEM", "KRB_AUTH_ONLY", "KRB_INTEGRITY", "KRB_PRIVACY" ]

s3_visibility

Array of string

Users with permission to list buckets that are created using this policy even if they do not have permission to access those buckets.

string

s3_visibility_groups

Array of string

Groups with permission to list buckets that are created using this policy even if they do not have permission to access those buckets.

string

apple_sid

boolean

For use when connecting from Mac clients to SMB shares, this option enables Security IDs (SIDs) to be returned in Apple compatible representation.

pretty_auth_source

string

pretty_atime_frequency

string

protocols_audit

object

Audit settings. Any settings enabled here apply to attached views, in addition to any audit settings enabled on the cluster.

read_data

boolean

Audit operations that read data

modify_data

boolean

Audit operations that modify data

log_username

boolean

Log username of requesting user. Disabled by default

read_data_md

boolean

Audit operations that read metadata

log_full_path

boolean

Log full Element Store path to the requested resource. Enabled by default. May affect performance. When disabled, the view path is recorded.

modify_data_md

boolean

Audit operations that modify metadata

session_create_close

boolean

Audit session creation and closing operations for sessions that use Kerberos 5 authentication (krb5, krb5i, or krb5p)

log_deleted_files_dirs

boolean

Log deleted files and directories

create_delete_files_dirs_objects

boolean

Audit operations that create or delete files, directories, or objects

protocols

Array of string

Array of protocols to audit

string

Valid values[ "NFSv3", "NFSv4.1", "SMB", "S3", "NDB" ]

data_create_delete

boolean

Create/Delete Files/Directories/Objects

data_modify

boolean

Modify data/MD

data_read

boolean

Read data

log_full_path

boolean

Log full path

log_hostname

boolean

Log hostname

log_username

boolean

Log username

log_deleted

boolean

Log deleted files/dirs from trash dir

remote_mapping

object

count_views

integer

Number of Policy related Views

enable_snapshot_lookup

boolean

Specifies whether to make the .snapshot directory accessible in subdirectories of the View.

enable_access_to_snapshot_dir_in_subdirs

boolean

Specifies whether to make the .snapshot directory visible in subdirectories of the View.

enable_listing_of_snapshot_dir

boolean

Specifies whether to make the .snapshot directory visible in subdirectories of the View.

enable_visibility_of_snapshot_dir

boolean

Specifies whether to make the .snapshot directory visible in subdirectories of the View.

nfs_enforce_tls

boolean

Accept NFSv3 and NFSv4 client mounts only if they are TLS-encrypted. Use only with Minimal Protection Level set to System or None.

smb_recursive_change_notify

boolean

Whether SMB recursive change notification is enabled. If disabled, SMB change notifications are supported for the directory where the client has subscribed for change notifications, but not for changes occurring in subdirectories. If enabled, change notifications are provided also for any files or directories contained in subdirectories of the subscribed directory.

is_s3_default_policy

boolean

Specifies whether to make this View Policy default for S3

s3_flavor_allow_free_listing

boolean

Allow NFS clients freely list bucket views and their subdirectories, regardless of individual object permissions.

s3_flavor_detect_full_pathname

boolean

When this flag is enabled in S3 flavor, NFS access to objects is determined based on the full resource names specified in the identity policies. When disabled, only the bucket name is compared to the identity policy.

permission_per_vip_pool

object (ArbitraryStringsObject)

property*

string additionalProperties

is_block_default_policy

boolean

If true, the view policy is the default block view policy. When block-enabled views are replicated, subsystems created at the destination are associated with the default block view policy.

Return Details of a View Policy