Skip to main content

security key-manager external azure show

Contributors
Suggest changes
PDFs

Display Azure Key Vaults configuration

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

Description

This command displays the Azure Key Vault (AKV) configuration for a given Vserver.

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

If you specify this parameter, then the command displays only the AKV configuration for the given Vserver.

[-config-name <text>] - Configuration Name

If you specify this parameter, then the command displays only the AKV configurations with the given configuration name.

[-enabled {true|false}] - Is This Azure Key Vault Configuration Enabled?

If you specify this parameter, then the command displays only the AKV configurations with the given enabled value.

[-client-id <text>] - Application (Client) ID of Deployed Azure Application

If you specify this parameter, then the command displays only the AKV configuration with the given client id.

[-tenant-id <text>] - Directory (Tenant) ID of Deployed Azure Application

If you specify this parameter, then the command displays only the AKV configuration with the given tenant id.

[-name {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…​}] - Deployed Azure Key Vault DNS Name

If you specify this parameter, then the command displays only the AKV configuration with the given key vault name.

[-state {available|not-responding|unknown}] - Azure Key Vault Cluster State

If you specify this parameter, then the command displays only the AKV configuration with the given state. The state can be either available or unknown.

[-key-id {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…​}] - Key Identifier of AKV Key Encryption Key

If you specify this parameter, then the command displays only the AKV configuration with the given key id.

[-unavailable-nodes <text>] - Names of Unavailable Nodes

If you specify this parameter, then the command displays only the AKV configuration with the given unavailable-nodes.

[-authentication-method <AKV Authentication Method>] - AKV Authentication Method

If you specify this parameter, then the command displays only the AKV configurations with the given authentication method.

Examples

The following example lists all Vservers with AKV configuration.

cluster-1::>security key-manager external azure show
          Vserver: vs0
      Config Name: default
          Enabled: true
        Client ID: client1
        Tenant ID: tenant1
           Key ID: https://vault.azure.net/keys/key1/9a2b8c1f7e6d5430e5f4a1b69d87c2e2
   Authentication: client_secret
             Name: https://vault.azure.net
            State: unknown
Unavailable Nodes: node-1,node-2