Skip to main content
A newer release of this product is available.

storage aggregate object-store config show

Contributors
Suggest changes
PDFs

Display a list of object store configurations

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

Description

The storage aggregate object-store config show command displays information about all existing object store configurations in the cluster.

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.

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

If this parameter is specified, the command displays information only about object store configurations whose name matches the specified names.

[-object-store-uuid <UUID>] - UUID of the Object Store Configuration

If this parameter is specified, the command displays information only about object store configurations whose UUID matches the specified UUID values.

[-provider-type <providerType>] - Type of the Object Store Provider

If this parameter is specified, the command displays information only about object store configurations whose provider type matches the specified value.

[-auth-type <object_store_auth_type>] - Authentication Used to Access the Object Store

If this parameter is specified, the command displays information only about object store configurations whose authentication type matches the specified value.

[-cap-url <text>] - URL to Request Temporary Credentials for C2S Account

If this parameter is specified, the command displays information only about object store configurations whose CAP URL matches the specified value.

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

If this parameter is specified, the command displays information only about object store configurations whose server name matches the specified value. The server name is specified as a Fully Qualified Domain Name (FQDN).

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

If this parameter is specified, the command displays information only about object store configurations whose status about the use of secured communication over the network matches the specified value.

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

If this parameter is specified, the command displays information only about object store configurations whose port numbers matches the specified value.

[-container-name <text>] - Data Bucket/Container Name Used in S3 Requests

If this parameter is specified, the command displays information only about object store configurations whose container name matches the specified value. Data ONTAP uses this container name or object store data bucket while accessing data from the object store.

[-access-key <text>] - Access Key ID for AWS_S3 and SGWS Provider Types

If this parameter is specified, the command displays information only about AWS S3, SGWS and IBM COS object store configurations whose access key matches the specified value. Data ONTAP requires the access key for authorized access to the object store.

[-azure-account <text>] - Azure Account

If this parameter is specified, the command displays information only about Azure object store configurations whose account matches the specified value. Data ONTAP requires the Azure account for authorized access to the Azure object store.

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

If this parameter is specified, the command displays information only about object store configurations whose IPspace matches the specified value. Data ONTAP uses the IPspace value to connect to the object store.

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

If this parameter is specified, the command displays information only about object store configurations whose IAM role status flag matches the specified value. The -iam-role and `-use-iam-role ` parameters are relevant only in the context of AWS object store and indicates whether IAM role must be used for accessing it. The IAM credentials can be obtained only through AWS Cloud Volumes ONTAP.

[-iam-role <text>] - IAM Role for AWS Cloud Volumes ONTAP

If this parameter is specified, the command displays information only about object store configurations whose IAM (Identity and Access Management) role matches the specified value.

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

If this parameter is specified, the command displays information only about object store configurations whose status about the validation of SSL/TLS certificate matches the specified value.

Examples

The following example displays all available object store configuration in the cluster:

cluster1::>storage aggregate object-store config show