vserver object-store-server bucket create
Create 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 create
command creates a bucket for the object store server.
Parameters
-vserver <Vserver Name>
- Vserver Name-
This parameter specifies the name of the Vserver for the object store server where the bucket needs to be created. The object store server must already exist.
-bucket <TextNoCase>
- Object Store Server Bucket Name-
This parameter specifies the name of the object store server bucket. Note that the bucket name must not be same as the beginning of the object-store-server name present in the vserver.
[-type {s3|nas}]
- Type of bucket-
This parameter specifies the type of the bucket. The default value is
s3
. [-versioning-state {disabled|enabled|suspended}]
- Object Store Server Versioning State-
Use this parameter to specify the state of versioning on the bucket.
[-comment <text>]
- Object Store Server Bucket Comment-
This optional parameter specifies a text comment for the object store server bucket.
- {
[-aggr-list <aggregate name>,…]
- List of Aggregates for FlexGroup Constituents (privilege: advanced) -
Use this parameter to specify the list of aggregates for the FlexGroup constituents on which the bucket needs to be created. Each entry in the list will create a constituent on the specified aggregate. The root constituent will always be placed on the first aggregate in the list, unless
optimize-aggr-list
is specified astrue
. An aggregate may be specified multiple times to have multiple constituents created on it. This parameter only applies to FlexGroups. [-aggr-list-multiplier <integer>]
- Aggregate List Repeat Count (privilege: advanced)-
Use this parameter to specify the number of FlexGroup constituents to be created.
[-optimize-aggr-list {true|false}]
- Have the System Optimize the Order of the Aggregate List (privilege: advanced)-
Specifies whether to create the constituents of the FlexGroup volume on which the bucket needs to be created, on the aggegates specified in the
aggr-list
in the order they are specified, or whether the system should optimize the ordering of the aggregates. If this value istrue
, the system will optimize the ordering of the aggregates specified in theaggr-list
. If this value isfalse
the order of theaggr-list
will be unchanged. The default value isfalse
. This parameter only applies to FlexGroups. - {
[-used-as-capacity-tier {true|false}]
- Is Used as Capacity Tier -
Use this parameter to specify if the bucket is going to be used for capacity tier.
- |
[-storage-service-level <text>]
- Storage Service Level of the Bucket } -
Use this parameter to specify the storage service level with which the bucket should be created.
[-size {<integer>[KB|MB|GB|TB|PB]}]
- Size of the Bucket-
Use this parameter to specify the size of the FlexGroup volume to be created.
[-exclude-aggr-list <aggregate name>,…]
- List of Aggregates to Exclude During FlexGroup Create-
Use this parameter to specify the list of aggregates to exclude during FlexGroup creation. This parameter is used only when creating bucket for capacity tier use case within the local cluster.
[-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.
[-retention-mode {no-lock|compliance|governance}]
- Bucket Retention Mode-
Use this parameter to specify the retention-mode in which objects within the bucket can be locked.
[-use-mirrored-aggregates {true|false}]
- Use Mirrored Aggregates-
Use this parameter to specify whether mirrored aggregates are selected for the FlexGroup on which the bucket will be created. Only mirrored aggregates are used if this parameter is set to
true
and only unmirrored aggregates are used if this parameter is set tofalse
. The default value istrue
for a MetroCluster configuration and isfalse
for a non-MetroCluster configuration. [-default-retention-period {{<integer> days|years} | none}]
- Bucket Default Retention Period-
Use this parameter to specify the retention-period to be applied on all unlocked objects inserted into the bucket. The retention period can be in years, or days. A period specified for years and days is represented in the ISO-8601 format as "10 years" and "100 days" respectively, for example "10 years" represents a duration of 10 years. The period string must contain only a single time element that is, either years, or days. A duration which combines different periods is not supported, for example "10 years 12 days" is not supported.
Examples
The following example creates an object store server bucket for Vserver vs1 of size 1TB.
cluster1::> vserver object-store-server bucket create -vserver vs1 -bucket testbucket -size 1TB.
The following example creates an object store server bucket for Vserver vs1 of size 1TB using aggr-list.
cluster1::> vserver object-store-server bucket create -vserver vs1 -bucket testbucket -aggr-list aggr1 -size 1TB.