Skip to main content

snapmirror object-store config show

Contributors
Suggest changes
PDFs

Display a list of SnapMirror object store configurations

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

Description

The snapmirror 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.

[-vserver <vserver name>] - Vserver Name

If this parameter is specified, the command displays information only about object store configurations which are configured within this vserver.

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

[-usage {data|metadata}] - Object Store Use

Specifies what this objectc store configuration is used for.

[-vsUuid <UUID>] - Vserver UUID

Vserver UUId.

[-config-id <integer>] - Object Store Configuration ID

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

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

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

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 S3 Compatible Provider Types

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

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

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

[-server-side-encryption {none | SSE-S3}] - Encryption of Data at Rest by the Object Store Server (privilege: advanced)

If this parameter is specified, the command displays information only about object store configurations whose server-side encryption matches the specified value.

[-url-style {path-style | virtual-hosted-style}] - URL Style Used to Access S3 Bucket

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

Examples

The following example displays information about all existing object store configurations in the cluster.

cluster1::*> snapmirror object-store config show