Skip to main content

vserver object-store-server bucket show-nas-bucket

Contributors
Suggest changes
PDFs

Display NAS buckets

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver object-store-server bucket show-nas-bucket command displays information about the object store server NAS buckets.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-vserver <Vserver Name>] - Vserver Name

If you specify this parameter, the command displays information only about the object store server NAS buckets for the specified Vserver

[-bucket <TextNoCase>] - Object Store Server Bucket Name

If you specify this parameter, the command displays information only for object store server NAS buckets that match the specified bucket.

[-versioning-state {disabled|enabled|suspended}] - Object Store Server Versioning State

If you specify this parameter, the command displays information only for object store server buckets that match the specified versioning-state field. This parameter specifies the state of the versioning on a bucket. This parameter is only supported for S3 buckets and not NAS buckets.

[-uuid <UUID>] - Object Store Server Bucket UUID

If you specify this parameter, the command displays information only for object store server buckets that match the specified bucket UUID.

[-comment <text>] - Object Store Server Bucket Comment

If you specify this parameter, the command displays information only for object store server buckets that match the specified comment.

[-volume <volume name>] - Hosting Volume Name

If you specify this parameter, the command displays information only for object store server buckets that match the specified volume. This parameter is only supported for S3 buckets and not NAS buckets.

[-size {<integer>[KB|MB|GB|TB|PB]}] - Size of the Bucket

If you specify this parameter, the command displays information only for object store server buckets that match the specified size. This parameter is only supported for S3 buckets and not NAS buckets.

[-logical-used {<integer>[KB|MB|GB|TB|PB]}] - Object Store Server Bucket Logical Used Size

If you specify this parameter, the command displays information only for object store server buckets that match the specified logical used size. This parameter is only supported for S3 buckets and not NAS buckets.

[-object-count <integer>] - Object Store Server Object Count

If you specify this parameter, the command displays information only for object store server buckets that match the specified object-count. This parameter is only supported for S3 buckets and not NAS buckets.

[-encryption {true|false}] - Is Encryption Enabled on Bucket

If you specify this parameter, the command displays information only for object store server buckets that match the specified encryption field. This parameter is only supported for S3 buckets and not NAS buckets.

[-qos-policy-group <text>] - QoS policy group

If you specify this parameter, the command displays information only for object store server buckets that match the specified qos-policy-group field. A policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a bucket, the system wil not monitor and control the traffic to it. This parameter is only supported for S3 buckets and not NAS buckets.

[-is-protected {true|false}] - Is bucket a FabricLink source and protected

If you specify this parameter, the command displays information only for object store server buckets that match the specified is-protected field. This parameter specifies whether a bucket is protected using Snapmirror relationship to another bucket. This parameter is only supported for S3 buckets and not NAS buckets.

[-is-protected-on-ontap {true|false}] - Is bucket protected over ONTAP

If you specify this parameter, the command displays information only for object store server buckets that match the specified is-protected-on-ontap field. This parameter specifies whether a bucket is protected using Snapmirror relationship to another ONTAP bucket. This parameter is only supported for S3 buckets and not NAS buckets.

[-is-protected-on-cloud {true|false}] - Is bucket protected over Cloud

If you specify this parameter, the command displays information only for object store server buckets that match the specified is-protected-on-cloud field. This parameter specifies whether a bucket is protected using Snapmirror relationship to a Cloud bucket. This parameter is only supported for S3 buckets and not NAS buckets.

[-is-protected-on-external-cloud {true|false}] - Is bucket protected on External Cloud

If you specify this parameter, the command displays information only for object store server buckets that match the specified is-protected-on-external-cloud. This parameter specifies whether a bucket is protected in a backup relationship with objects outside Ontap. This parameter is only supported for S3 buckets and not NAS buckets.

[-nas-path <text>] - NAS Path corresponding to the Bucket

If you specify this parameter, the command displays information only for NAS buckets that match the specified nas-path. This parameter specifies the path to the NAS directory which the bucket maps to.

[-retention-mode {no-lock|compliance|governance}] - Bucket Retention Mode

If you specify this parameter, the command displays information only for object store server buckets that match the specified retention-mode. This parameter specifies the object locking mode of the bucket. This parameter is only supported for S3 buckets and not NAS buckets.

[-default-retention-period {{<integer> days|years} | none}] - Bucket Default Retention Period

If you specify this parameter, the command displays information only for object store server buckets that match the specified default-retention-period field. This parameter specifies the default-retention-period applied on the bucket. This parameter is only supported for S3 buckets and not NAS buckets.

Examples

The following example displays information of all NAS buckets:

cluster1::> vserver object-store-server bucket show-nas-bucket
Vserver     Bucket          Type     Volume            Size       Encryption Role       Nas Path
----------- --------------- -------- ----------------- ---------- ---------- ---------- ----------
vs1         nas-bucket      nas      -                 -          -          -          /