storage aggregate object-store config modify

Contributors

Modify object store configuration attributes

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

Description

The storage aggregate object-store config modify command is used to update one or more of object store configuration parameters. This command must not be used to reassociate an existing valid object-store configuration to a new object-store or container. The modifiable parameters include object store name, server name, port, access_key, secret-password, ipspace and ssl-enabled.

Parameters

-object-store-name <text> - Object Store Configuration Name

This parameter identifies the configuration to be modified.

[-new-object-store-name <text>] - Object Store Configuration New Name

This optional parameter specifies the new name for the object store configuration.

[-server <Remote InetAddress>] - Fully Qualified Domain Name of the Object Store Server

This optional parameter specifies the new Fully Qualified Domain Name (FQDN) of the same object store server. For Amazon S3, server name must be an AWS regional endpoint in the format s3.amazonaws.com or s3-<region>.amazonaws.com, for example, s3-us-west-2.amazonaws.com. The region of the server and the bucket must match. For more information on AWS regions, refer to 'Amazon documentation on AWS regions and endpoints'.

[-ssl-enabled {true|false}] - SSL/HTTPS Enabled?

This optional parameter can be toggled to indicate whether secured connection should be used for communication with the object store server. Use of SSL certificates is one such method to ensure secure communication.

[-port <integer>] - Port Number of the Object Store

This optional parameter specifies a new port number to connect to the object store server indicated in the -server parameter.

[-access-key <text>] - Access Key

This optional parameter specifies a new access key for the object store.

[-secret-password <text>] - Secret Password

This optional parameter specifies a new password for the object store.

[-ipspace <IPspace>] - IPspace to Use in Order to Reach the Object Store

This optional parameter specifies new ipspace values for the configuration.

[-use-iam-role {true|false}] - Use IAM Role for AWS ONTAP Cloud

This optional parameter specifies whether to enable IAM role for this object store configuration. IAM role can be enabled only if connecting to AWS object store in Data ONTAP Cloud. When using this parameter, -secret-password and -access-key parameters must not be explicitly specified as they will be obtained from Data ONTAP Cloud in AWS using the IAM role.

Examples

The following example modifies two parameters (port number and ssl-enabled) of an object store configuration named my-store:

cluster1::>storage aggregate object-store config modify -object-store-name my-store -port 1235 -ssl-enabled true