Secrets Manager CLI zur Instanzverwaltung

Sie können die Befehlszeilenschnittstelle (CLI) zur Instanzverwaltung von IBM Cloud® Secrets Manager verwenden, um Ihre Secrets Manager Vault Dedicated-Instanz über die Befehlszeile zu verwalten.

Aktuelle Version: 2.0.7

Der Vault Dedicated-Tarif ist derzeit als öffentliche Beta-Version verfügbar. Beta-Funktionen werden zu Evaluierungs- und Testzwecken bereitgestellt und weisen im Vergleich zu allgemein verfügbaren Funktionen Einschränkungen auf.

Vorbereitende Schritte

Bevor Sie beginnen, installieren Sie die IBM Cloud-CLI und anschließend das Secrets Manager-Instanzverwaltungs-CLI-Plug-in, indem Sie den folgenden Befehl ausführen:

ibmcloud plugin install secrets-manager-instance-management

Sie werden über die Befehlszeile benachrichtigt, wenn Aktualisierungen für die IBM Cloud-CLI und -Plug-ins verfügbar sind. Halten Sie Ihre CLI auf dem neuesten Stand, um die neuesten Befehle nutzen zu können. Sie können die aktuelle Version aller installierten Plug-ins anzeigen, indem Sie den Befehl ibmcloud plugin list ausführen.

Einrichtung einer Secrets Manager-Instanz

Um die Secrets Manager-Vault-Dedicated-Instanz anzusprechen, verwenden Sie eine der folgenden Optionen.

Führen Sie den Befehl ibmcloud secrets-manager-instance-management config set aus.

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

Exportieren Sie eine Umgebungsvariable mit dem Endpunkt Ihres Secrets Manager-Control-Plane-Dienstes: URL.

export SECRETS_MANAGER_INSTANCE_MANAGEMENT_URL=https://{instance_ID}.{region}.secrets-manager.cloud.ibm.com

Legen Sie den Service-Endpunkt im Befehl fest.

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

Ersetzen Sie {instance_ID} und {region} durch die Werte, die für Ihre Instanz des Secrets Manager Vault Dedicated-Dienstes gelten. Um die Endpunkt-URL zu finden, die für Ihre Instanz spezifisch ist, können Sie sie von der Seite Endpunkte in der Benutzerschnittstelle von Secrets Manager kopieren. Weitere Informationen finden Sie unter Endpunkt-URLs anzeigen.

Globals

Befehle

`ibmcloud secrets-manager-instance-management docs`

Öffnet die Plug-in-Dokumentation im Webbrowser.

ibmcloud secrets-manager-instance-management docs

Beispiel

ibmcloud secrets-manager-instance-management docs

Optionen

--region (Zeichenkette): Die Region, in der Sie Ihre Vault Dedicated Instance bereitgestellt haben. Verfügbare Regionen: us-south, eu-de.
--output (Zeichenkette): Wählen Sie ein Ausgabeformat - Sie können "json", "yaml" oder "table" wählen. Standardmäßig ist table eingestellt.
-j, --jmes-query (Zeichenkette): JMESPath-Abfrage zur Anpassung der Ausgabe angeben.
--service-url (Zeichenkette): Basisendpunkt-URL für API angeben.
-q, --quiet: Unterdrückt Nachrichten mit ausführlichen Informationen.
-v, --version: Gibt die Plug-in-Version aus.

Beispiel

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

Dieses Beispiel veranschaulicht lediglich die globalen Optionen, die für alle Unterbefehle verfügbar sind, und ist selbst kein gültiger Befehl.

Konfiguration

Globale Parameter können ebenfalls in einer persistenten Konfiguration gespeichert werden, sodass sie nicht bei jedem Aufruf des Plug-ins manuell angegeben werden müssen. Jeder Parameter kann mit dem Befehl config und dessen Unterbefehlen konfiguriert werden.

ibmcloud secrets-manager-instance-management config

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

Legt einen neuen Konfigurationswert für eine bestimmte Option fest. Jeder Unterbefehl des Befehls set ist einer globalen Option zugeordnet. Jeder Unterbefehl akzeptiert ein einzelnes Argument, nämlich die Zeichenfolgendarstellung des Werts, der für die Option gespeichert werden soll.

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

Beispiele

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

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

Den aktuell eingestellten Wert für eine bestimmte Option ausdrucken. Jeder Unterbefehl des Befehls get ist einer globalen Option zugeordnet.

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

Beispiele

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

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

Hebt die Festlegung des aktuell festgelegten Werts für eine bestimmte Option auf. Jeder Unterbefehl des Befehls unset ist einer globalen Option zugeordnet.

Die für diesen Dienst verfügbaren Unterbefehle sind: service-url,.

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

Beispiele

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

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

Listet alle aktuell festgelegten Konfigurationswerte auf.

ibmcloud secrets-manager-instance-management config list

Beispiele

ibmcloud secrets-manager-instance-management config list

Tokens

Verwalten Sie Admin-Token.

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

Generieren Sie ein Vault-Admin-Token zur Authentifizierung bei Ihrem Vault Dedicated-Cluster. Das Token ist 1 Stunde lang gültig und gewährt Administratorrechte. Nur für die Ersteinrichtung und die Clusterverwaltung verwenden, anschließend sofort widerrufen.

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

Befehlsoptionen

--id (Zeichenkette)

Secrets Manager Instanz-ID. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss dem regulären Ausdruck entsprechen /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Beispiel

Beispielanforderung

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

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

Alle aktiven Vault-Admin-Token widerrufen. Dadurch werden alle bestehenden Admin-Token sofort ungültig.

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

Befehlsoptionen

--id (Zeichenkette)

Secrets Manager Instanz-ID. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss dem regulären Ausdruck entsprechen /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Beispiel

Beispielanforderung

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

Instanzen

Instanz abzurufen.

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

Rufen Sie Details zur Service-Instanz ab, darunter den Cluster-Status, Endpunkte und den Schlüsselverwaltungsdienst.

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

Befehlsoptionen

--id (Zeichenkette)

Secrets Manager Instanz-ID. Erforderlich.

Die Länge muss 36 Zeichen betragen. Der Wert muss dem regulären Ausdruck entsprechen /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Beispiel

Beispielanforderung

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

Beispielausgabe

Beispiel für eine Instanzenantwort

{
  "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"
  }
}