Interface de ligne de commande IBM Storage Ceph as a Service
Le plug-in IBM Storage Ceph as a Service étend l'interface de ligne de commande (CLI) IBM Cloud pour vous donner la possibilité d'exécuter des commandes qui effectuent diverses opérations pour le service, y compris, mais sans s'y limiter, la gestion des volumes, des hôtes, des mappages, des informations d'identification des objets et des certificats.
Prérequis
Avant de pouvoir utiliser le plug-in CLI IBM Storage Ceph as a Service, vous devez d'abord installer le CLI IBM Cloud, vous connecter au CLI, puis installer le plug-in CLI software-defined-storage. Pour savoir comment installer
l'interface CLI d' IBM Cloud, consultez la section « Premiers pas avec l'interface CLI d' IBM Cloud ».
Ce plug-in est compatible avec les plateformes linux64, Windows® et macOS® fonctionnant sur des processeurs 64 bits.
Installez le plug-in à l'aide de la commande « plugin install » :
ibmcloud plugin install software-defined-storage
Une fois le plug-in installé, vous pouvez vérifier l'installation en exécutant le plug-in « software-defined-storage », qui affichera l'aide suivante :
ibmcloud software-defined-storage --help
Le résultat affiche les instructions d'utilisation et la liste des commandes prises en charge.
Mise à jour du plug-in
Mettez à jour le plug-in à l'aide de la commande « plugin update ».
ibmcloud plugin update software-defined-storage
La dernière version du plug-in est téléchargée et remplace vos commandes de service de plug-in actuelles. Si aucune nouvelle mise à jour n'est disponible, le message No updates are available s'affiche.
Vous êtes averti via la ligne de commande lorsque des mises à jour de l'interface CLI d' IBM Cloud et de ses plug-ins sont disponibles. Veillez à garder votre interface de ligne de commande à jour afin de pouvoir utiliser les dernières commandes.
Vous pouvez afficher la version actuelle de tous les plug-ins installés en exécutant la commande ibmcloud plugin list.
Index de commande
Chaque opération est accompagnée d'une explication décrivant son fonctionnement, son utilisation, ainsi que les paramètres facultatifs ou obligatoires. Tous les paramètres répertoriés sont obligatoires, sauf ceux mentionnés comme étant facultatifs.
Le plug-in CLI ne prend pas encore en charge l'ensemble des fonctionnalités disponibles dans le stockage défini par logiciel.
stockage défini par logiciel
software-defined-storage- une définition de OpenAPI pour le CLI de IBM Storage Ceph as a Service sur la plate-forme IBM Cloud.
ibmcloud software-defined-storage [command] [options]
Alias d' software-defined-storage: sds
Stockage par blocs
ibmcloud sds volume-create
Utilisez cette commande pour créer un nouveau volume de la capacité indiquée.
ibmcloud sds volume-create --capacity CAPACITY [--name NAME] [--source-snapshot (SOURCE-SNAPSHOT | @SOURCE-SNAPSHOT-FILE) | --source-snapshot-id SOURCE-SNAPSHOT-ID]
Alias d' volume-create: volc
Exemple : Création d'un nouveau volume
ibmcloud sds volume-create \
--capacity 10 \
--name my-volume \
--url $sds_endpoint
Exemple : restauration d'un volume à partir d'un instantané
ibmcloud sds volume-create \
--name test-volume-restored \
--source-snapshot-id r134-eda57df4-41f2-48d8-812d-3d81955b6a1a \
--capacity 10 \
--url $sds_endpoint
Lors de la restauration d'un volume à partir d'un instantané, la capacité doit être égale ou supérieure à celle du volume d'origine.
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Capacité du volume (en gigaoctets).
- Indicateur :
--capacity CAPACITY
- Indicateur :
-
Nom du volume.
- Indicateur :
--name NAME
Si vous ne spécifiez pas de nom pour le nouveau volume, le système génère un nom qui est une liste de mots sélectionnés de manière aléatoire.
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
-
L'instantané source à partir duquel ce volume a été créé.
- Indicateur :
--source-snapshot
Utilisez cette option si vous créez le volume à partir d'un instantané.
- Indicateur :
-
Identifiant unique d'instantané de la ressource.
- Indicateur :
--source-snapshot-id
Utilisez cette option si vous créez le volume à partir d'un instantané.
- Indicateur :
ibmcloud sds volume
Utilisez cette commande pour obtenir des informations sur un volume donné.
ibmcloud sds volume --volume-id VOLUME-ID --url string
Alias d' volume: vol
Exemple de commande :
ibmcloud sds volume \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
L'identifiant du volume.
- Indicateur :
--volume-id VOLUME-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds volume-update
Utilisez cette commande avec les nouvelles informations fournies dans le paramètre « volume patch » pour mettre à jour la capacité ou le nom du volume.
Vous ne pouvez modifier qu'une seule valeur de paramètre à la fois dans la commande. Il n'est pas possible d'effectuer plusieurs modifications dans la même commande.
ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string
Alias d' volume-update: volu
Exemple de commande :
ibmcloud sds volume-update \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--capacity 38 \
--name my-volume-updated \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
L'identifiant du volume.
- :
--volume-id VOLUME-ID
- :
-
Capacité du volume (en gigaoctets).
- Indicateur :
--capacity CAPACITY
- Indicateur :
-
Nom du volume.
- Indicateur :
--name NAME
- Indicateur :
-
Objet JSON [facultatif] contenant les informations de volume, telles que le chemin d'accès à un fichier JSON.
- Indicateur :
--volume-patch VOLUME-PATCH
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds volume-delete
Utilisez cette commande pour supprimer un seul volume.
ibmcloud sds volume-delete --volume-id VOLUME-ID --url string
Alias d' volume-delete: vold
Exemple de commande :
ibmcloud sds volume-delete \
--volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
L'identifiant du volume.
- :
--volume-id VOLUME-ID
- :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds volumes
Cette commande permet d'afficher la liste de tous les volumes.
ibmcloud sds volumes --help [--limit LIMIT] [--name NAME] --url string
Alias d' volumes: vols
Exemple de commande :
ibmcloud sds volumes --help \
--limit 10 \
--name my-volume \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Nombre de ressources à afficher sur une page. La valeur par défaut est 1. La valeur limite maximale est de 1 000.
- Indicateur :
--limit int
- Indicateur :
-
Filtrer par nom dans la collection de ressources. Vous pouvez spécifier une longueur de chaîne de 0 à 200 caractères.
- Indicateur :
--name string
- Indicateur :
Hôtes
ibmcloud sds host-create
Utilisez cette commande pour créer un nouvel hôte.
ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string --psk string
Alias d' host-create: hstc
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Nom qualifié NVMe (NQN) de l'hôte configuré dans l'environnement du client. La longueur maximale prise en charge est de 223 octets.
- Indicateur :
--nqn NQN
- Indicateur :
-
Nom du nouvel hôte. Assurez-vous que le nouveau nom soit unique.
- Indicateur :
--name NAME
Si vous ne spécifiez pas de nom pour le nouvel hôte, le système génère un nom qui est une liste de mots sélectionnés au hasard et séparés par des tirets.
- Indicateur :
-
PSK pour le nouvel hôte. Les suites de chiffrement Transport Layer Security à clé pré-partagée ( TLS-PSK) constituent un ensemble de protocoles cryptographiques qui assurent une communication sécurisée basée sur des clés pré-partagées (PSK).
- Indicateur :
--psk string
- Indicateur :
-
L'identifiant unique du volume à mapper sur cet hôte. Doit être sous la forme
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Indicateur :
--volume-mappings VOLUME-MAPPINGS
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host
Utilisez cette commande pour obtenir des informations détaillées sur un hôte donné.
ibmcloud sds host --host-id HOST-ID --url string
Exemple de commande :
ibmcloud sds host \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds hosts
Utilisez cette commande pour afficher la liste de tous les hôtes.
ibmcloud sds hosts [--limit LIMIT] --url string
Alias d' hosts: hsts
Exemple de commande :
ibmcloud sds hosts \
--limit 10 \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Nombre de ressources à afficher sur une page.
- Indicateur :
--limit LIMIT
- Indicateur :
-
L'inclusion de cette option filtre la collection de ressources par nom.
- Indicateur :
--name NAME
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-update
Utilisez cette commande pour mettre à jour un hôte.
ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string
Alias d' host-update: hstu
Exemple de commande :
ibmcloud sds host-update \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name my-host
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez mettre à jour les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
[Facultatif] Spécifiez le contenu du patch de fusion JSON pour
host_update.- Indicateur :
--host-patch HOST-PATCH
- Indicateur :
-
Nom du nouvel hôte. Assurez-vous que le nouveau nom soit unique.
- Indicateur :
--name NAME
Si vous ne spécifiez pas de nom pour le nouvel hôte, le système génère un nom qui est une liste de mots choisis au hasard et séparés par des tirets.
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-mapping-create
Utilisez cette commande pour associer un volume à un hôte.
ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]
Alias d' host-mapping-create: hstmc
Exemple de commande :
ibmcloud sds host-mapping-create \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
--url $sds_endpoint
Ou
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Indiquez l'ID de l'hôte dont vous souhaitez consulter les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
Spécifiez l'identifiant unique du volume.
- Indicateur :
--volume-id VOLUME-ID
- Indicateur :
-
L'identifiant unique du volume à mapper sur cet hôte. Doit être sous la forme
[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}].- Indicateur :
--volume VOLUME-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-mappings
Utilisez cette commande pour afficher toutes les correspondances d'hôte pour un hôte donné.
ibmcloud sds host-mappings --host-id HOST-ID
Alias d' host-mappings: hstms
Exemple de commande :
ibmcloud sds host-mappings \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-mapping
Utilisez cette commande pour afficher le mappage d'un seul hôte.
ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Alias d' host-mapping: hstm
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
Identifiant unique de mappage de volume. Cet identifiant peut être trouvé en consultant le volume associé ou l'hôte sur lequel vous souhaitez effectuer cette opération.
- Indicateur :
--volume-mapping-id VOLUME-MAPPING_ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-delete
Utilisez cette commande pour supprimer un hôte.
ibmcloud sds host-delete --host-id HOST-ID --url string
Alias d' host-delete: hstd
Exemple de commande :
ibmcloud sds host-delete \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-mapping-delete
Utilisez cette commande pour supprimer un seul mappage de volume d'un hôte.
ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID
Alias d' host-mapping-delete: hstmd
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
Identifiant unique de mappage de volume. Cet identifiant peut être trouvé en consultant le volume associé ou l'hôte sur lequel vous souhaitez effectuer cette opération.
- Indicateur :
--volume-mapping-id VOLUME-MAPPING_ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds host-mapping-delete-all
Utilisez cette commande pour supprimer tous les mappages de volumes associés à un hôte.
ibmcloud sds host-mapping-delete-all --host-id HOST-ID
Alias d' host-vol-delete-all: hstmda
Exemple de commande :
ibmcloud sds host-mapping-delete-all \
--host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
ID hôte dont vous souhaitez afficher les détails
- Indicateur :
--host-id HOST-ID
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
Object Storage
ibmcloud sds cred-create
Utilisez cette commande pour mettre à jour les informations d'identification d'un compte de stockage ou pour les créer si elles n'existent pas.
ibmcloud sds cred-create --access-key ACCESS-KEY --url string
Alias d' cred-create: crc
Exemple de commande :
ibmcloud sds cred-create \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Définit la clé d'accès de l'instance du service.
- Indicateur :
--access-key ACCESS-KEY
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cred-delete
Utilisez cette commande pour supprimer les informations d'identification d'un service.
ibmcloud sds cred-delete --access-key ACCESS-KEY --url string
Alias d' cred-delete: crd
Exemple de commande :
ibmcloud sds cred-delete \
--access-key mytestkey
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Définit la clé d'accès de l'instance du service.
- Indicateur :
--access-key ACCESS-KEY
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds creds
Utilisez cette commande pour récupérer les informations d'identification d'un compte de stockage spécifique.
ibmcloud sds creds --url string
Alias d' creds: crl
Exemple de commande :
ibmcloud sds creds \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
- API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cert-types
Utilisez cette commande pour afficher la liste des types de certificats « SSL » configurés.
ibmcloud sds cert-types --url string
Alias d' cert-types: crtt
Exemple de commande :
ibmcloud sds cert-types \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
- API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cert-create
Utilisez cette commande pour créer un nouveau certificat « SSL » s'il n'en existe pas encore.
ibmcloud sds cert-create --cert CERT --body BODY --url string
Alias d' cert-create: crtc
Exemple de commande :
ibmcloud sds cert-create \
--cert s3 \
--body tempdir/test-file.txt \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Le corps de la requête contenant le certificat « TLS ». Le CLI accepte les fichiers de certificat au format
.pem.- Indicateur :
--body BODY
- Indicateur :
-
Le type de certificat à utiliser dans la demande. Les valeurs autorisées sont les suivantes : - s3.
- Indicateur :
--cert CERT
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cert-update
Utilisez cette commande pour mettre à jour un certificat « SSL » existant.
ibmcloud sds cert-update --cert CERT --body BODY --url string
Alias d' cert-update: crtu
Exemple de commande :
ibmcloud sds cert-update \
--cert s3 \
--body tempdir/test-file.pem \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Le corps de la requête contenant le certificat « TLS ». Le CLI accepte les fichiers de certificat au format
.pem.- Indicateur :
--body BODY
- Indicateur :
-
Le type de certificat à utiliser dans la demande. Les valeurs autorisées sont les suivantes : - s3.
- Indicateur :
--cert CERT
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cert
Utilisez cette commande pour obtenir la date d'expiration et le statut du certificat « SSL ».
ibmcloud sds cert --cert CERT --url string
Exemple de commande :
ibmcloud sds cert \
--cert s3
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Le type de certificat à utiliser dans la demande. Les valeurs autorisées sont les suivantes : - s3.
- Indicateur :
--cert CERT
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
ibmcloud sds cert-delete
Utilisez cette commande pour supprimer un certificat « SSL ».
ibmcloud sds cert-delete --cert CERT --url string
Alias d' cert-delete: crtd
Exemple de commande :
ibmcloud sds cert-delete \
--cert s3
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Le type de certificat à utiliser dans la demande. Les valeurs autorisées sont les suivantes : - s3.
- Indicateur :
--cert CERT
- Indicateur :
-
API Endpoint dans le formulaire URL.
- Indicateur :
--url string
- Indicateur :
Commandes d'instantanés
ibmcloud sds volume-snapshot-create
Utilisez cette commande pour créer un instantané d'un volume.
ibmcloud sds volume-snapshot-create [--source-volume (SOURCE-VOLUME | @SOURCE-VOLUME-FILE) | --source-volume-id SOURCE-VOLUME-ID] [--name NAME]
Alias d' volume-snapshot-create: vsnapc
Exemple de commande :
ic sds volume-snapshot-create --source-volume-id r134-87a59338-a801-4090-a657-72867fc9ba44
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
L'identifiant du volume de blocs où le nouvel instantané doit être créé.
- Indicateur :
--source-volume-id
- Indicateur :
-
Nom unique pour l'instantané. Paramètre facultatif.
- Indicateur :
--name
- Indicateur :
ibmcloud sds volume-snapshot
Utilisez cette commande pour obtenir les détails d'un instantané spécifique.
ibmcloud sds volume-snapshot --snap-id SNAP-ID
Alias d' volume-snapshot: vsnap
Exemple de commande :
ibmcloud sds volume-snapshot \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
- Identifiant de l'instantané pour lequel vous souhaitez récupérer les détails.
- Indicateur :
--snap-id
- Indicateur :
ibmcloud sds volume-snapshots
Utilisez cette commande pour afficher la liste de tous les instantanés.
ibmcloud sds volume-snapshots [--start START] [--limit LIMIT] [--name NAME] [--source-volume-id SOURCE-VOLUME-ID]
Alias d' volume-snapshots: vsnaps
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
Les paramètres suivants sont facultatifs :
-
Spécifie l'identifiant de la ressource à partir duquel la page de résultats doit être lancée. Utile pour paginer dans les grandes collections.
- Indicateur :
--start
- Indicateur :
-
Définit le nombre maximum de ressources (instantanés) à renvoyer par page....
- Indicateur :
--limit
- Indicateur :
-
Filtre les résultats pour n'inclure que les instantanés dont le nom correspond à la chaîne fournie.
- Indicateur :
--name
- Indicateur :
-
Filtre les résultats pour n'inclure que les instantanés appartenant à l'ID du volume source spécifié.
- Indicateur :
source-volume-id
- Indicateur :
-
Lors de l'établissement de la liste des instantanés de volume, cette option effectuera automatiquement plusieurs requêtes pour récupérer et afficher toutes les pages de résultats, afin que vous puissiez voir l'ensemble de la collection sans avoir à parcourir manuellement les résultats.
- Indicateur :
all-pages
- Indicateur :
ibmcloud sds volume-snapshot-update
Utilisez cette commande pour mettre à jour un instantané.
ibmcloud sds volume-snapshot-update --snap-id SNAP-ID [--snapshot-patch SNAPSHOT-PATCH | @SNAPSHOT-PATCH-FILE]
Alias d' volume-snapshot-update: vsnapu
Exemple de commande :
ibmcloud sds volume-snapshot-update \
--snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
--name snap-2-updated \
--url $sds_endpoint
$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
(Obligatoire) L'identifiant unique de l'instantané que vous souhaitez mettre à jour.
- Indicateur :
--snap-id
- Indicateur :
-
Spécifie le nom de l'instantané qui doit être mis à jour.
- Indicateur :
--name
- Indicateur :
-
Fournir le contenu JSON du Merge-Patch pour la mise à jour de l'instantané. Il peut s'agir d'une chaîne JSON directement dans la commande ou d'un chemin d'accès à un fichier JSON contenant les données du correctif. Cela vous permet de mettre à jour des champs spécifiques de l'instantané.
- Indicateur :
--snapshot-patch
- Indicateur :
ibmcloud sds volume-snapshot-delete
Utilisez cette commande pour supprimer un seul instantané.
ibmcloud sds volume-snapshot-delete --snap-id SNAP-ID
Alias d' volume-snapshot-delete: vsnapd
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Pour forcer l'exécution de la commande
- Drapeau :
-f,--force
- Drapeau :
-
Identifiant unique de l'instantané que vous souhaitez supprimer.
- Indicateur :
--snap-id
- Indicateur :
ibmcloud sds volume-snapshots-delete
Utilisez cette commande pour supprimer tous les instantanés d'un volume.
ibmcloud sds volume-snapshots-delete [--source-volume-id SOURCE-VOLUME-ID]
Alias d' volume-snapshots-delete: vsnapsd
Exemple de commande :
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 est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1.
Vous pouvez définir l' URL e une fois et ne plus avoir à l'ajouter à chaque commande. Pour savoir comment définir l' URL, consultez la section Commandes de configuration.
Paramètres à fournir :
-
Pour forcer l'exécution de la commande
- Drapeau :
-f,--force
- Drapeau :
-
Filtre l'opération pour qu'elle n'affecte que les ressources (telles que les instantanés) dont la propriété
source_volume-idcorrespond à l'identifiant spécifié. Permet de cibler tous les instantanés d'un volume spécifique.- Indicateur :
--source-volume-id
- Indicateur :
Commandes de configuration
Config La commande peut être utilisée pour contrôler ou afficher la configuration persistante des options globales.
Pour contrôler ou visualiser les configurations persistantes, exécutez la commande ibmcloud sds config avec les options globales pour lister, définir et annuler les valeurs de configuration.
Vous pouvez définir la variable d'environnement " url " de telle sorte que vous n'ayez pas besoin d'utiliser l'indicateur " --url " lorsque vous utilisez la commande " sds ".
ibmcloud sds config
Exemple de configuration de l'option url.
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK
Exemple montrant comment utiliser la commande sans le jeu de configuration.
pc@mac ~ % ibmcloud sds volumes --url $endpoint
L'exemple montre comment utiliser la commande avec l' url.
pc@mac ~ % ibmcloud sds volumes
Options de la commande config
-
get- Récupère la valeur actuellement définie d'une option. -
list- Récupère toutes les valeurs actuellement configurées. -
set- Définir une valeur de configuration pour une option. -
unset- Supprimer la valeur de configuration d'une option.
ibmcloud sds config get
Utilisez cette commande pour récupérer la valeur actuellement définie pour une option spécifique.
Lorsque l'option ' Get ' est utilisée avec l'option ' url ', la valeur actuellement définie pour l'option 'url' est récupérée.
ibmcloud sds config get url
Voir l'exemple de sortie.
pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config list
Utilisez cette commande pour récupérer et afficher toutes les valeurs de configuration actuellement définies.
ibmcloud sds config list
Voir l'exemple de sortie.
pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config set
Utilisez cette commande pour définir de nouvelles valeurs pour une option spécifique.
ibmcloud sds config set [url]
Lorsque l'option ' set ' est utilisée avec l'option ' url ', la valeur de l'option 'url' est définie.
Voir l'exemple avec l'option « url ».
pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
ibmcloud sds config unset
Utilisez cette commande pour réinitialiser les valeurs actuellement configurées pour une option spécifique.
ibmcloud sds config unset [url]
Lorsque l'option ' unset ' est utilisée avec l'option ' url ', la valeur actuellement configurée pour l'option 'url' est réinitialisée.
Etapes suivantes
Exécutez ibmcloud sds --help pour plus d'informations sur les commandes que vous pouvez exécuter.