Secrets Manager Interface de ligne de commande (CLI) de gestion des instances

Vous pouvez utiliser l'interface de ligne de commande (CLI) de gestion des instances d' IBM Cloud® Secrets Manager pour gérer votre instance Secrets Manager Vault Dedicated à partir de la ligne de commande.

Version actuelle: 2.0.7

L'offre Vault Dedicated est actuellement disponible en version bêta publique. Les fonctionnalités en version bêta sont fournies à des fins d'évaluation et de test et présentent des limitations par rapport aux fonctionnalités disponibles pour le grand public.

Avant de commencer

Avant de commencer, installez l'interface de ligne de commande IBM Cloud, puis installez le plug-in de gestion d'instance Secrets Manager en exécutant la commande suivante :

ibmcloud plugin install secrets-manager-instance-management

Vous êtes averti sur la ligne de commande lorsque des mises à jour de l'interface de ligne de commande et des plug-ins IBM Cloud sont disponibles. Veillez à maintenir votre interface CLI à jour afin de pouvoir utiliser les commandes les plus récentes. Vous pouvez afficher la version actuelle de tous les plug-ins installés en exécutant la commande ibmcloud plugin list.

Cibler une instance d' Secrets Manager

Pour cibler l'instance dédiée d' Secrets Manager, utilisez l'une des options suivantes.

Exécutez la commande ibmcloud secrets-manager-instance-management config set.

ibmcloud secrets-manager-instance-management config set service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

Exportez une variable d'environnement contenant le point de terminaison de votre service de plan de contrôle Secrets Manager URL.
```
export SECRETS_MANAGER_INSTANCE_MANAGEMENT_URL=https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com
```

Définissez le point de terminaison du service dans la commande.

ibmcloud secrets-manager-instance-management instance --service-url https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

Remplacez {instance_ID} et {region} par les valeurs correspondant à votre instance du service Vault Dedicated d' Secrets Manager. Pour trouver l'URL de point d'extrémité spécifique à votre instance, vous pouvez la copier à partir de la page Noeuds finaux de l'interface utilisateur Secrets Manager. Pour plus d'informations, voir Affichage de vos URL de noeud final.

Paramètres globaux

Commandes

`ibmcloud secrets-manager-instance-management docs`

Ouvre la documentation du plug-in dans le navigateur Web.

ibmcloud secrets-manager-instance-management docs

Exemple

ibmcloud secrets-manager-instance-management docs

Options

--region (chaîne de caractères): Région où vous avez mis à disposition votre instance dédiée Vault. Régions disponibles : us-south, eu-de.
--output (chaîne de caractères): Choisir un format de sortie : 'json', 'yaml' ou 'table'. La valeur par défaut est table.
-j, --jmes-query (chaîne de caractères): Indiquer une requête JMESPath pour personnaliser la sortie.
--service-url (chaîne de caractères): Indiquer l'URL de noeud final de base pour l'API.
-q, --quiet: Supprimer les messages prolixes.
-v, --version: Affiche la version du plug-in.

Exemple

ibmcloud secrets-manager-instance-management \
    --region=us-south \
    --output=json \
    --jmes-query="[:10]" \
    --service-url="https://myservice.cloud.ibm.com" \
    --quiet

Cet exemple illustre uniquement les options globales disponibles pour toutes les sous-commandes et ne constitue pas une commande valide en soi.

Config

Les paramètres globaux peuvent également être enregistrés dans une configuration persistante afin de ne pas avoir à les spécifier manuellement à chaque fois que le plug-in est appelé. Chaque paramètre peut être configuré à l'aide de la commande config et de ses sous-commandes.

ibmcloud secrets-manager-instance-management config

`ibmcloud secrets-manager-instance-management config set`

Définissez une nouvelle valeur de configuration pour une option spécifique. Chaque sous-commande de la commande set correspond à une option globale. Chaque sous-commande accepte un seul argument : la représentation sous forme de chaîne de caractères de la valeur à enregistrer pour l'option.

ibmcloud secrets-manager-instance-management config set <option> <value>

Exemples

ibmcloud secrets-manager-instance-management config set service-url \
    'https://{region}.secrets-manager.cloud.ibm.com'

`ibmcloud secrets-manager-instance-management config get`

Imprimer la valeur actuellement définie pour une option spécifique. Chaque sous-commande de la commande get correspond à une option globale.

ibmcloud secrets-manager-instance-management config get <option>

Exemples

ibmcloud secrets-manager-instance-management config get service-url

`ibmcloud secrets-manager-instance-management config unset`

Annulez la définition de la valeur actuellement définie pour une option spécifique. Chaque sous-commande de la commande unset correspond à une option globale.

Les sous-commandes disponibles pour ce service sont : service-url,.

ibmcloud secrets-manager-instance-management config unset <option>

Exemples

ibmcloud secrets-manager-instance-management config unset service-url

`ibmcloud secrets-manager-instance-management config list`

Répertoriez toutes les valeurs de configuration actuellement définies.

ibmcloud secrets-manager-instance-management config list

Exemples

ibmcloud secrets-manager-instance-management config list

Jetons

Gérer les jetons d'administration.

`ibmcloud secrets-manager-instance-management admin-token-create`

Générez un jeton d'administrateur Vault pour vous authentifier sur votre cluster Vault Dedicated. Le jeton est valable pendant 1 heure et confère des privilèges d'administrateur. À utiliser uniquement pour la configuration initiale et la gestion du cluster, puis à révoquer immédiatement.

ibmcloud secrets-manager-instance-management admin-token-create --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Options de commande

--id (chaîne de caractères)

Secrets Manager ID d’instance. Obligatoire.

La longueur doit être de caractères 36. La valeur doit correspondre à l'expression régulière /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Exemple

Exemple de demande

ibmcloud secrets-manager-instance-management admin-token-create --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

`ibmcloud secrets-manager-instance-management admin-tokens-delete`

Révoquez tous les jetons d'administrateur Vault actifs. Cela invalide immédiatement tous les jetons d'administration existants.

ibmcloud secrets-manager-instance-management admin-tokens-delete --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Options de commande

--id (chaîne de caractères)

Secrets Manager ID d’instance. Obligatoire.

La longueur doit être de caractères 36. La valeur doit correspondre à l'expression régulière /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Exemple

Exemple de demande

ibmcloud secrets-manager-instance-management admin-tokens-delete --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

Instances

de l'instance centrale.

`ibmcloud secrets-manager-instance-management instance-details`

Obtenir les détails de l'instance de service, notamment l'état du cluster, les points de terminaison et le service de gestion des clés.

ibmcloud secrets-manager-instance-management instance-details --id ID [--region REGION] [-j, --jmes-query JMES-QUERY] [--output OUTPUT] [-q, --quiet]

Options de commande

--id (chaîne de caractères)

Secrets Manager ID d’instance. Obligatoire.

La longueur doit être de caractères 36. La valeur doit correspondre à l'expression régulière /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Exemple

Exemple de demande

ibmcloud secrets-manager-instance-management instance-details --id bfc50c2e-d66d-4f37-9ccf-9713f8325b39

Exemple de sortie

Exemple de réponse d’une instance

{
  "id" : "12345678-abcd-1234-abcd-1234567890ab",
  "name" : "Example Instance",
  "href" : "https://us-south.secrets-manager.cloud.ibm.com/v2/instances/12345678-abcd-1234-abcd-1234567890ab",
  "instance_crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a1b2c3d4e5f61234567890abcdef1234:12345678-abcd-1234-abcd-1234567890ab::",
  "plan" : "dedicated",
  "vault_cluster" : {
    "status" : "healthy",
    "version" : "1.21.2+ent.hsm"
  },
  "endpoints" : {
    "public" : {
      "vault_api" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    },
    "private" : {
      "vault_api" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud",
      "vault_ui" : "https://private.12345678-abcd-1234-abcd-1234567890ab.us-south.secrets-manager.appdomain.cloud/ui"
    }
  },
  "encryption" : {
    "mode" : "customer_managed",
    "provider" : "key_protect",
    "key_crn" : "crn:v1:bluemix:public:kms:us-south:a/a1b2c3d4e5f61234567890abcdef1234:abcd1234-ab12-ab12-ab12-abcdef123456:key:12ab34cd-12ab-12ab-12ab-123456abcdef"
  }
}