storage aggregate object-store config modify

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 is-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'. For Azure, if the -server is a "blob.core.windows.net" or a "blob.core.usgovcloudapi.net", then a value of -azure-account followed by a period will be added in front of the server.

[-is-ssl-enabled {true|false}] - Is SSL/TLS Enabled

This optional parameter indicates whether a secured SSL/TLS connection will be used during data access to the object store.

[-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 ID for AWS_S3 and SGWS Provider Types

This optional parameter specifies a new access key (access key ID) for the AWS S3 and SGWS object stores.

[-secret-password <text>] - Secret Access Key for AWS_S3 and SGWS Provider Types

This optional parameter specifies a new password (secret access key) for the AWS S3 and SGWS object stores. For an Azure object store see -azure-private-key. If the -access-key is specified but the -secret-password is not then one will be asked to enter the -secret-password without echoing the input.

[-ask-azure-private-key {true|false}] - Ask to Enter the Azure Access Key without Echoing

If this optional parameter is true then one will be asked to enter the -azure-private-key without echoing the input.

[-azure-private-key <text>] - Azure Access Key

This optional parameter specifies a new access key for Azure object store. For other object store providers see secret-password. See also ask-azure-private-key.

[-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.

[-is-certificate-validation-enabled {true|false}] - Is SSL/TLS Certificate Validation Enabled

This optional parameter indicates whether an SSL/TLS certificate of an object store server is validated whenever an SSL/TLS connection to an object store server is established. This parameter is only applicable when is-ssl-enabled is true. It is recommended to keep the default value which is true to make sure that Data ONTAP connects to a trusted object store server, otherwise identities of an object store server are not verified.