security key-manager external azure create-config
Suggest changes
PDFs
Create an inactive Azure Key Vault configuration
Availability: This command is available to cluster and Vserver administrators at the admin privilege level.
Description
This command creates an Azure Key Vault (AKV) configuration which can be enabled on a Vserver.
Parameters
-vserver <Vserver Name>- Vserver-
The name of the Vserver.
-config-name <text>- Configuration name-
The name of the configuration.
-client-id <text>- Application (Client) ID of Deployed Azure Application-
The ID of the client.
-tenant-id <text>- Directory (Tenant) ID of Deployed Azure Application-
The ID of the tenant.
-name {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…}- Deployed Azure Key Vault DNS Name-
The DNS name of the deployed AKV .
-key-id {scheme://(hostname|IPv4 Address|'['IPv6 Address']')…}- Key Identifier of AKV Key Encryption Key-
The ID of the key.
[-oauth-host <text>]- Open Authorization Host Name-
The hostname of the OAuth server.
[-authentication-method <AKV Authentication Method>]- Authentication Method for Azure Application-
Use this parameter to specify the authentication method.
[-port <integer>]- Authorization Server and Vault's Port Number-
Use this parameter to specify the port of the deployed AKV.
[-vault-host <text>]- AKV Host's Subdomain-
Use this parameter to specify the AKV vault host.
[-verify {true|false}]- Verify Identity of AKV?-
Use this parameter to specify whether to verify the identity of AKV.
[-verify-host {true|false}]- Verify Identity of AKV's Hostname?-
Use this parameter to specify whether to verify the identity of AKV hostname.
[-verify-ip {true|false}]- Verify Identity of AKV's IP Address?-
Use this parameter to specify whether to verify the identity of AKV ip address.
[-proxy-type {http|https}]- Proxy Type-
Use this parameter to specify the proxy type.
[-proxy-host <text>]- Proxy Host-
Use this parameter to specify the proxy host.
[-proxy-port <integer>]- Proxy Port-
Use this parameter to specify the proxy port.
[-proxy-username <text>]- Proxy Username-
Use this parameter to specify the proxy username.
[-proxy-password <text>]- Proxy Password-
Use this parameter to specify the proxy password.
[-timeout <integer>]- Azure Key Vault Connection Timeout in Seconds-
Use this parameter to specify the timeout, in seconds, for attempting to connect to the deployed AKV.
Examples
The example below creates a configuration on a node with the following details: Configuration name: sampleConfig, Client ID: client1, Tenant ID: tenant1, Deployed AKV name: https://samplevault.vault.azure.net, Key ID: https://samplevault.vault.azure.net/keys/key1/keyversion, OAuth Host: https://sampleoauth.net, for Vserver vsTest.
cluster-1::> security key-manager external azure create-config -config-name sampleConfig -client-id client1 -tenant-id tenant1 -name https://samplevault.vault.azure.net -key-id https://samplevault.vault.azure.net/keys/key1/keyversion -oauth-host https://sampleoauth.net -vserver vsTest