Secrets Manager Interfaz de línea de comandos (CLI) para la gestión de instancias

Puede utilizar la interfaz de línea comando (CLI) de administración de instancias IBM Cloud® Secrets Manager para administrar su instancia dedicada de Vault Secrets Manager desde la línea comando.

Versión actual: 2.0.7

El plan Vault Dedicated está disponible actualmente en versión beta pública. Las funciones en fase beta se ofrecen con fines de evaluación y prueba, y presentan limitaciones en comparación con las funciones disponibles de forma generalizada.

Antes de empezar

Antes de comenzar, instale la CLI IBM Cloud y luego instale el complemento de la CLI de administración de instancias Secrets Manager ejecutando el siguiente comando :

ibmcloud plugin install secrets-manager-instance-management

Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Mantén tu CLI actualizada para usar los comandos más recientes, de modo que puedas usar los comandos más recientes. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.

Configuración de una instancia de Secrets Manager

Para acceder a la instancia dedicada de Secrets Manager Vault, utiliza una de las siguientes opciones.

Ejecute el mandato 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

Exporta una variable de entorno con el punto final del servicio del plano de control de Secrets Manager: URL.

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

Configure el punto final del servicio en el comando.

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

Sustituye {instance_ID} y {region} por los valores que correspondan a tu instancia del servicio Secrets Manager Vault Dedicated. Para encontrar el URL de punto final específico de la instancia, puede copiarlo de la página Puntos finales en la interfaz de usuario de Secrets Manager. Para obtener más información, consulte Visualización de URL de punto final.

Valores globales

Mandatos

`ibmcloud secrets-manager-instance-management docs`

Abre la documentación del complemento en el navegador web.

ibmcloud secrets-manager-instance-management docs

Ejemplo

ibmcloud secrets-manager-instance-management docs

Opciones

--region (cadena): La región en la que ha suministrado su instancia de Vault Dedicated. Regiones disponibles: us-south, eu-de.
--output (cadena): Elija un formato de salida; puede ser 'json', 'yaml' o 'table'. El valor predeterminado es tabla.
-j, --jmes-query (cadena): Proporcione una consulta JMESPath para personalizar la salida.
--service-url (cadena): Proporcione el URL de punto final base para la API.
-q, --quiet: Suprime los mensajes detallados.
-v, --version: Muestra la versión del complemento.

Ejemplo

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

Este ejemplo solo muestra las opciones globales disponibles para todos comandos y no es un comando válido en sí mismo.

Config

Los parámetros globales también se pueden almacenar en una configuración persistente, de modo que no sea necesario especificarlos manualmente cada vez que se ejecute el complemento. Cada parámetro se puede configurar con el comando config y sus subcomandos.

ibmcloud secrets-manager-instance-management config

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

Establezca un nuevo valor de configuración para una opción específica. Cada subcomando del comando set se corresponde con una opción global. Cada subcomando admite un único argumento: la representación como cadena del valor que se va a almacenar para la opción.

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

Ejemplos

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

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

Imprime el valor actualmente establecido para una opción concreta. Cada subcomando del comando get se corresponde con una opción global.

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

Ejemplos

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

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

Desestablezca el valor establecido actualmente para una opción específica. Cada subcomando del comando unset se corresponde con una opción global.

Los subcomandos disponibles para este servicio son: service-url,.

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

Ejemplos

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

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

Lista todos los valores de configuración establecidos actualmente.

ibmcloud secrets-manager-instance-management config list

Ejemplos

ibmcloud secrets-manager-instance-management config list

Señales

Gestionar tokens de administrador.

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

Genera un token de administrador de Vault para autenticarte en tu clúster de Vault Dedicated. El token tiene una validez de 1 hora y otorga privilegios de administrador. Utilizar únicamente para la configuración inicial y la gestión del clúster; a continuación, revocar inmediatamente.

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

Opciones de comando

--id (cadena)

Secrets Manager ID de instancia. Obligatorio.

La extensión debe ser de caracteres 36. El valor debe coincidir con la expresión regular /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Ejemplo

Solicitud de ejemplo

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

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

Revoque todos los tokens activos de administrador de Vault. Esto invalida inmediatamente todos los tokens de administrador existentes.

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

Opciones de comando

--id (cadena)

Secrets Manager ID de instancia. Obligatorio.

La extensión debe ser de caracteres 36. El valor debe coincidir con la expresión regular /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Ejemplo

Solicitud de ejemplo

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

Instancias

detalles de instancia central adecuados.

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

Consulte los detalles de la instancia del servicio, incluido el estado del clúster, los puntos de conexión y el servicio de gestión de claves.

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

Opciones de comando

--id (cadena)

Secrets Manager ID de instancia. Obligatorio.

La extensión debe ser de caracteres 36. El valor debe coincidir con la expresión regular /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.

Ejemplo

Solicitud de ejemplo

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

Salida de ejemplo

Ejemplo de respuesta de una instancia

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