CLI de IBM Storage Ceph as a Service
El complemento IBM Storage Ceph as a Service amplía la interfaz de comando (CLI) de IBM Cloud para ofrecerle la posibilidad de ejecutar comandos que realizan diversas operaciones para el servicio, entre las que se incluyen la gestión de volúmenes, hosts, asignaciones, credenciales de objetos y certificados.
Requisitos previos
Para poder utilizar el complemento de la CLI de IBM Storage Ceph as a Service, primero debe instalar la CLI de IBM Cloud, iniciar sesión en la CLI y, a continuación, instalar el complemento de la CLI de software-defined-storage.
Para obtener instrucciones sobre cómo instalar la CLI de « IBM Cloud », consulta la guía « Primeros pasos con la CLI de « IBM Cloud » ».
El complemento es compatible con las plataformas linux64, Windows® y macOS® que se ejecutan en procesadores de 64 bits.
Instala el complemento utilizando el comando « plugin install »:
ibmcloud plugin install software-defined-storage
Una vez instalado el complemento, puedes comprobar que se ha instalado correctamente ejecutando el complemento de almacenamiento definido por software, lo que mostrará la ayuda:
ibmcloud software-defined-storage --help
La salida muestra las instrucciones de uso y los comandos compatibles.
Actualización del complemento
Actualiza el complemento utilizando el comando « plugin update ».
ibmcloud plugin update software-defined-storage
Se descarga la última versión del plug-in y se sustituyen los comandos de servicio del plug-in actual. Si no hay nuevas actualizaciones disponibles, aparece el mensaje No updates are available.
Se te notificará en la comando cuando haya actualizaciones disponibles para la CLI de IBM Cloud y los complementos. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual de todos
los plugins instalados con el mandato ibmcloud plugin list.
Índice de mandatos
Cada operación incluye una explicación de para qué sirve, cómo se utiliza y los parámetros opcionales u obligatorios. A menos que se especifique como opcional, todo parámetro de la lista es obligatorio.
El complemento CLI aún no es compatible con el conjunto completo de funciones disponibles en el almacenamiento definido por software.
almacenamiento definido por software
software-defined-storage- una definición de OpenAPI para la CLI IBM Storage Ceph as a Service en la plataforma IBM Cloud.
ibmcloud software-defined-storage [command] [options]
Alias de software-defined-storage: sds
Almacenamiento en bloques
ibmcloud sds volume-create
Utiliza este comando para crear un nuevo volumen con la capacidad especificada.
ibmcloud sds volume-create --capacity CAPACITY [--name NAME] [--source-snapshot (SOURCE-SNAPSHOT | @SOURCE-SNAPSHOT-FILE) | --source-snapshot-id SOURCE-SNAPSHOT-ID]
Alias de volume-create: volc
Ejemplo: Creación de un nuevo volumen
ibmcloud sds volume-create \
--capacity 10 \
--name my-volume \
--url $sds_endpoint
Ejemplo: Restauración de un volumen a partir de una instantánea
ibmcloud sds volume-create \
--name test-volume-restored \
--source-snapshot-id r134-eda57df4-41f2-48d8-812d-3d81955b6a1a \
--capacity 10 \
--url $sds_endpoint
Al restaurar un volumen a partir de una instantánea, la capacidad debe ser igual o superior a la del volumen original.
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Capacidad del volumen (en gigabytes).
- Distintivo:
--capacity CAPACITY
- Distintivo:
-
Nombre del volumen.
- Distintivo:
--name NAME
Si no especifica un nombre para el nuevo volumen, el sistema genera un nombre que es una lista separada por guiones de palabras seleccionadas al azar.
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
-
La instantánea de origen a partir de la cual se creó este volumen.
- Distintivo:
--source-snapshot
Utilice esta opción si va a crear el volumen a partir de una instantánea.
- Distintivo:
-
Identificador único de instantánea del recurso.
- Distintivo:
--source-snapshot-id
Utilice esta opción si va a crear el volumen a partir de una instantánea.
- Distintivo:
ibmcloud sds volume
Utiliza este comando para obtener información sobre un único volumen.
ibmcloud sds volume --volume-id VOLUME-ID --url string
Alias de volume: vol
Mandato de ejemplo:
ibmcloud sds volume \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El identificador de volumen.
- Distintivo:
--volume-id VOLUME-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds volume-update
Utiliza este comando junto con la nueva información proporcionada en el parámetro «volume patch» para actualizar la capacidad o el nombre del volumen.
En el comando, solo puede cambiar un valor de parámetro a la vez. No se admite más de un cambio en el mismo comando.
ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string
Alias de volume-update: volu
Mandato de ejemplo:
ibmcloud sds volume-update \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--capacity 38 \
--name my-volume-updated \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El identificador de volumen.
- :
--volume-id VOLUME-ID
- :
-
Capacidad del volumen (en gigabytes).
- Distintivo:
--capacity CAPACITY
- Distintivo:
-
Nombre del volumen.
- Distintivo:
--name NAME
- Distintivo:
-
Objeto JSON [opcional] que contiene la información de volumen, como la ruta de un archivo JSON.
- Distintivo:
--volume-patch VOLUME-PATCH
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds volume-delete
Utiliza este comando para eliminar un único volumen.
ibmcloud sds volume-delete --volume-id VOLUME-ID --url string
Alias de volume-delete: vold
Mandato de ejemplo:
ibmcloud sds volume-delete \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El identificador de volumen.
- :
--volume-id VOLUME-ID
- :
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds volumes
Utilice este mandato para listar todos los volúmenes.
ibmcloud sds volumes --help [--limit LIMIT] [--name NAME] --url string
Alias de volumes: vols
Mandato de ejemplo:
ibmcloud sds volumes --help \
--limit 10 \
--name my-volume \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El número de recursos que se deben mostrar en una página. El valor predeterminado es 1. El valor límite máximo es 1000.
- Distintivo:
--limit int
- Distintivo:
-
Filtrar por nombre de la colección de recursos. Puede especificar de 0 a 200 caracteres en la longitud de la cadena.
- Distintivo:
--name string
- Distintivo:
Hosts
ibmcloud sds host-create
Utiliza este comando para crear un nuevo host.
ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string --psk string
Alias de host-create: hstc
Mandato de ejemplo:
ibmcloud sds host-create \
--name my-host \
--nqn nqn.2014-06.org:9345 \
--volume-mappings '[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]' \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Nombre calificado NVMe (NQN) del host configurado en el entorno del cliente. La longitud máxima admitida es de 223 bytes.
- Distintivo:
--nqn NQN
- Distintivo:
-
Nombre del nuevo anfitrión. Asegúrate de que el nuevo nombre sea único.
- Distintivo:
--name NAME
Si no especifica un nombre para el nuevo host, el sistema genera un nombre que es una lista con guiones de palabras seleccionadas al azar.
- Distintivo:
-
PSK para el nuevo host. Las suites de cifrado con clave precompartida de Transport Layer Security ( TLS-PSK) son un conjunto de protocolos criptográficos que proporcionan una comunicación segura basada en claves precompartidas (PSK).
- Distintivo:
--psk string
- Distintivo:
-
El identificador único del volumen que se va a asignar a este host. Debe tener el formato
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Distintivo:
--volume-mappings VOLUME-MAPPINGS
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host
Utiliza este comando para obtener información sobre un único host.
ibmcloud sds host --host-id HOST-ID --url string
Mandato de ejemplo:
ibmcloud sds host \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds hosts
Utiliza este comando para mostrar una lista de todos los hosts.
ibmcloud sds hosts [--limit LIMIT] --url string
Alias de hosts: hsts
Mandato de ejemplo:
ibmcloud sds hosts \
--limit 10 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Número de recursos que se deben mostrar en una página.
- Distintivo:
--limit LIMIT
- Distintivo:
-
Al incluir esta opción, se filtra la colección de recursos por nombre.
- Distintivo:
--name NAME
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-update
Utiliza este comando para actualizar un host.
ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string
Alias de host-update: hstu
Mandato de ejemplo:
ibmcloud sds host-update \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name my-host
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea actualizar
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
[Opcional] Especifique el contenido del parche de combinación JSON para
host_update.- Distintivo:
--host-patch HOST-PATCH
- Distintivo:
-
Nombre del nuevo anfitrión. Asegúrate de que el nuevo nombre sea único.
- Distintivo:
--name NAME
Si no especifica un nombre para el nuevo host, el sistema genera un nombre que es una lista separada por guiones de palabras seleccionadas al azar.
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-mapping-create
Utiliza este comando para asignar un volumen a un host.
ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]
Alias de host-mapping-create: hstmc
Mandato de ejemplo:
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
--url $sds_endpoint
O
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Especifique el ID del host cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Especifique el identificador de volumen único.
- Distintivo:
--volume-id VOLUME-ID
- Distintivo:
-
El identificador único del volumen que se va a asignar a este host. Debe tener el formato
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Distintivo:
--volume VOLUME-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-mappings
Utiliza este comando para ver todas las asignaciones de un host.
ibmcloud sds host-mappings --host-id HOST-ID
Alias de host-mappings: hstms
Mandato de ejemplo:
ibmcloud sds host-mappings \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-mapping
Utiliza este comando para ver la asignación de un único host.
ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Alias de host-mapping: hstm
Mandato de ejemplo:
ibmcloud sds host-mapping \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Identificador único de mapeo de volumen. Este ID se puede encontrar visualizando el volumen asociado o el host contra el que desea completar esta operación.
- Distintivo:
--volume-mapping-id VOLUME-MAPPING_ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-delete
Utiliza este comando para eliminar un host.
ibmcloud sds host-delete --host-id HOST-ID --url string
Alias de host-delete: hstd
Mandato de ejemplo:
ibmcloud sds host-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-mapping-delete
Utiliza este comando para eliminar una asignación de volumen concreta de un host.
ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Alias de host-mapping-delete: hstmd
Mandato de ejemplo:
ibmcloud sds host-mapping-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Identificador único de mapeo de volumen. Este ID se puede encontrar visualizando el volumen asociado o el host contra el que desea completar esta operación.
- Distintivo:
--volume-mapping-id VOLUME-MAPPING_ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds host-mapping-delete-all
Utiliza este comando para eliminar todas las asignaciones de volúmenes asociadas a un host.
ibmcloud sds host-mapping-delete-all --host-id HOST-ID
Alias de host-vol-delete-all: hstmda
Mandato de ejemplo:
ibmcloud sds host-mapping-delete-all \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
ID de anfitrión cuyos detalles desea ver
- Distintivo:
--host-id HOST-ID
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
Almacenamiento de objetos
ibmcloud sds cred-create
Utiliza este comando para actualizar las credenciales de una cuenta de almacenamiento o para crearlas si aún no existen.
ibmcloud sds cred-create --access-key ACCESS-KEY --url string
Alias de cred-create: crc
Mandato de ejemplo:
ibmcloud sds cred-create \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Establece la clave de acceso para la instancia del servicio.
- Distintivo:
--access-key ACCESS-KEY
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cred-delete
Utiliza este comando para eliminar las credenciales de un servicio.
ibmcloud sds cred-delete --access-key ACCESS-KEY --url string
Alias de cred-delete: crd
Mandato de ejemplo:
ibmcloud sds cred-delete \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Establece la clave de acceso para la instancia del servicio.
- Distintivo:
--access-key ACCESS-KEY
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds creds
Utiliza este comando para recuperar las credenciales de una cuenta de almacenamiento concreta.
ibmcloud sds creds --url string
Alias de creds: crl
Mandato de ejemplo:
ibmcloud sds creds \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
- Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cert-types
Utiliza este comando para obtener la lista de tipos de certificados de « SSL » configurados.
ibmcloud sds cert-types --url string
Alias de cert-types: crtt
Mandato de ejemplo:
ibmcloud sds cert-types \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
- Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cert-create
Utiliza este comando para crear un nuevo certificado « SSL » si aún no existe.
ibmcloud sds cert-create --cert CERT --body BODY --url string
Alias de cert-create: crtc
Mandato de ejemplo:
ibmcloud sds cert-create \
--cert s3 \
--body tempdir/test-file.txt \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El cuerpo de la solicitud que contiene el certificado « TLS ». El CLI acepta archivos de certificado en formato
.pem.- Distintivo:
--body BODY
- Distintivo:
-
El tipo de certificado que se va a utilizar en la solicitud. Los valores válidos son: - s3.
- Distintivo:
--cert CERT
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cert-update
Utiliza este comando para actualizar un certificado existente de « SSL ».
ibmcloud sds cert-update --cert CERT --body BODY --url string
Alias de cert-update: crtu
Mandato de ejemplo:
ibmcloud sds cert-update \
--cert s3 \
--body tempdir/test-file.pem \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El cuerpo de la solicitud que contiene el certificado « TLS ». El CLI acepta archivos de certificado en formato
.pem.- Distintivo:
--body BODY
- Distintivo:
-
El tipo de certificado que se va a utilizar en la solicitud. Los valores válidos son: - s3.
- Distintivo:
--cert CERT
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cert
Utiliza este comando para consultar la fecha de caducidad y el estado del certificado « SSL ».
ibmcloud sds cert --cert CERT --url string
Mandato de ejemplo:
ibmcloud sds cert \
--cert s3
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El tipo de certificado que se va a utilizar en la solicitud. Los valores válidos son: - s3.
- Distintivo:
--cert CERT
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
ibmcloud sds cert-delete
Utiliza este comando para eliminar un certificado de SSL.
ibmcloud sds cert-delete --cert CERT --url string
Alias de cert-delete: crtd
Mandato de ejemplo:
ibmcloud sds cert-delete \
--cert s3
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El tipo de certificado que se va a utilizar en la solicitud. Los valores válidos son: - s3.
- Distintivo:
--cert CERT
- Distintivo:
-
Punto final de la API en el formulario de URL.
- Distintivo:
--url string
- Distintivo:
Comandos de instantánea
ibmcloud sds volume-snapshot-create
Utiliza este comando para crear una instantánea de un volumen.
ibmcloud sds volume-snapshot-create [--source-volume (SOURCE-VOLUME | @SOURCE-VOLUME-FILE) | --source-volume-id SOURCE-VOLUME-ID] [--name NAME]
Alias de volume-snapshot-create: vsnapc
Mandato de ejemplo:
ic sds volume-snapshot-create --source-volume-id r134-87a59338-a801-4090-a657-72867fc9ba44
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
El identificador del volumen de bloques donde debe crearse la nueva instantánea.
- Distintivo:
--source-volume-id
- Distintivo:
-
Nombre único para la instantánea. Parámetro opcional.
- Distintivo:
--name
- Distintivo:
ibmcloud sds volume-snapshot
Utiliza este comando para obtener información sobre una única instantánea.
ibmcloud sds volume-snapshot --snap-id SNAP-ID
Alias de volume-snapshot: vsnap
Mandato de ejemplo:
ibmcloud sds volume-snapshot \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
- Identificador de la instantánea cuyos detalles desea recuperar.
- Distintivo:
--snap-id
- Distintivo:
ibmcloud sds volume-snapshots
Utiliza este comando para mostrar una lista de todas las instantáneas.
ibmcloud sds volume-snapshots [--start START] [--limit LIMIT] [--name NAME] [--source-volume-id SOURCE-VOLUME-ID]
Alias de volume-snapshots: vsnaps
Mandato de ejemplo:
ibmcloud sds volume-snapshots \
--start r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--limit 20 \
--name my-host \
--source-volume-id exampleString \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
Los parámetros siguientes son opcionales.
-
Especifica el ID del recurso desde el que se iniciará la página de resultados. Útil para paginar grandes colecciones.
- Distintivo:
--start
- Distintivo:
-
Establece el número máximo de recursos (instantáneas) a devolver por página..
- Distintivo:
--limit
- Distintivo:
-
Filtra los resultados para que sólo incluyan instantáneas cuyo nombre coincida con la cadena proporcionada.
- Distintivo:
--name
- Distintivo:
-
Filtra los resultados para que sólo incluyan instantáneas que pertenezcan al ID de volumen de origen especificado.
- Distintivo:
source-volume-id
- Distintivo:
-
Al listar instantáneas de volumen, esta opción realizará automáticamente varias peticiones para recuperar y mostrar todas las páginas de resultados, de forma que pueda ver la colección completa sin tener que paginar manualmente por los resultados.
- Distintivo:
all-pages
- Distintivo:
ibmcloud sds volume-snapshot-update
Utiliza este comando para actualizar una instantánea.
ibmcloud sds volume-snapshot-update --snap-id SNAP-ID [--snapshot-patch SNAPSHOT-PATCH | @SNAPSHOT-PATCH-FILE]
Alias de volume-snapshot-update: vsnapu
Mandato de ejemplo:
ibmcloud sds volume-snapshot-update \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name snap-2-updated \
--url $sds_endpoint
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
(Obligatorio) Identificador único de la instantánea que desea actualizar.
- Distintivo:
--snap-id
- Distintivo:
-
Especifica el nombre de la instantánea que debe actualizarse.
- Distintivo:
--name
- Distintivo:
-
Proporcione el contenido JSON Merge-Patch para actualizar la instantánea. Puede ser una cadena JSON directamente en el comando o una ruta a un archivo JSON que contenga los datos del parche. Permite actualizar campos específicos de la instantánea.
- Distintivo:
--snapshot-patch
- Distintivo:
ibmcloud sds volume-snapshot-delete
Utiliza este comando para eliminar una única instantánea.
ibmcloud sds volume-snapshot-delete --snap-id SNAP-ID
Alias de volume-snapshot-delete: vsnapd
Mandato de ejemplo:
ibmcloud sds volume-snapshot-delete \
--snap-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Para forzar la ejecución del comando
- Bandera:
-f,--force
- Bandera:
-
Identificador único de la instantánea que deseas eliminar.
- Distintivo:
--snap-id
- Distintivo:
ibmcloud sds volume-snapshots-delete
Utiliza este comando para eliminar todas las instantáneas de un volumen.
ibmcloud sds volume-snapshots-delete [--source-volume-id SOURCE-VOLUME-ID]
Alias de volume-snapshots-delete: vsnapsd
Mandato de ejemplo:
ibmcloud sds volume-snapshots-delete \
--source-volume-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
--url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK
$sds_endpoint es una variable de entorno que apunta al punto final que se le proporcionó cuando se configuró IBM Storage Ceph as a Service. Está en el formulario de " URL ". Por ejemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Puede configurar la variable de entorno ( URL ) una vez y no tener que añadirla para cada comando. Para obtener orientación sobre cómo configurar el URL, consulte Comandos de configuración.
Parámetros que se deben proporcionar:
-
Para forzar la ejecución del comando
- Bandera:
-f,--force
- Bandera:
-
Filtra la operación para que sólo afecte a los recursos (como las instantáneas) que tengan una propiedad
source_volume-idque coincida con el identificador especificado. Se utiliza para dirigir todas las instantáneas a un volumen específico.- Distintivo:
--source-volume-id
- Distintivo:
Mandatos de configuración (config)
Config Command se puede utilizar para controlar o ver la configuración persistente de las opciones globales.
Para controlar o ver las configuraciones persistentes, ejecute el comando ibmcloud sds config junto con las opciones globales para listar, establecer y desestablecer los valores de configuración.
Puede configurar la variable url de tal manera que no necesite utilizar el indicador --url cuando se use con el comando sds.
ibmcloud sds config
Ejemplo para configurar la opción url.
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK
Ejemplo que muestra cómo utilizar el comando sin el conjunto de configuración.
pc@mac ~ % ibmcloud sds volumes --url $endpoint
El ejemplo muestra cómo utilizar el comando con el url configurado.
pc@mac ~ % ibmcloud sds volumes
Opciones de comando de configuración
-
get- Recupera el valor configurado actualmente de una opción. -
list- Recupera todos los valores configurados actualmente establecidos. -
set- Establecer un valor de configuración para una opción. -
unset- Desactivar el valor de configuración de una opción.
ibmcloud sds config get
Utiliza este comando para obtener el valor actualmente establecido para una opción concreta.
Cuando se utiliza la opción Get junto con la opción url, se recupera el valor establecido actualmente para la opción 'url'.
ibmcloud sds config get url
Ver ejemplo de salida.
pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config list
Utiliza este comando para recuperar y visualizar todos los valores configurados actualmente.
ibmcloud sds config list
Ver ejemplo de salida.
pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config set
Utiliza este comando para configurar nuevos valores para una opción concreta.
ibmcloud sds config set [url]
Cuando se utiliza la opción set junto con la opción url, se establece el valor de la opción 'url'.
Véase el ejemplo con la opción " url ".
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config unset
Utiliza este comando para restablecer los valores configurados actualmente para una opción concreta.
ibmcloud sds config unset [url]
Cuando se utiliza la opción unset junto con la opción url, se restablece el valor configurado actualmente para la opción 'url'.
Próximos pasos
Ejecute ibmcloud sds --help para obtener más información sobre los comandos que puede ejecutar.