vserver object-store-server bucket modify

12/18/2024 Contributors

Modify an object store server bucket

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

Description

The vserver object-store-server bucket modify command modifies an object store server bucket.

-vserver <Vserver Name> - Vserver Name: This parameter specifies the name of the Vserver for the object store server which you want to modify.
-bucket <TextNoCase> - Object Store Server Bucket Name: This parameter specifies the name of the object store server bucket which you want to modify.
[-versioning-state {disabled|enabled|suspended}] - Object Store Server Versioning State: Use this parameter to specify the state of versioning on the bucket. Note that the versioning state cannot be modified to 'disabled' from any other state.
[-comment <text>] - Object Store Server Bucket Comment: This parameter specifies the text comment for the object store server bucket.
[-size {<integer>[KB|MB|GB|TB|PB]}] - Size of the Bucket: This parameter specifies the size of the object store server bucket.
[-qos-policy-group <text>] - QoS policy group: 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.
[-nas-path <text>] - NAS Path corresponding to the Bucket: This parameter specifies the path to the NAS directory which the bucket maps to.
[-default-retention-period {{<integer> days|years} | none}] - Bucket Default Retention Period: Use this parameter to modify the default-retention-period to be applied on all unlocked objects to be inserted into the bucket.

The following example modifies the comment of the object store server bucket for Vserver vs1.

cluster1::> vserver object-store-server bucket modify -vserver vs1 -bucket testbucket -comment test