interface de ligne de commande IBM Cloud Schematics

Exécutez ces commandes pour travailler avec les espaces de travail IBM Cloud Schematics, les actions, les ressources provisionnées et pour configurer Schematics.

Schematics Les commandes CLI sont spécifiques à chaque région. Ils ne fonctionnent que dans la région/lieu où la CLI de IBM Cloud est configurée pour fonctionner. Vérifiez que l'interface de ligne de commande location et le noeud final url pointent vers la région dans laquelle vous souhaitez créer ou mettre à jour vos espaces de travail et vos actions. Pour plus d'informations sur la localisation et le point de terminaison, voir Où mes informations sont-elles stockées?

Pour exécuter les commandes Schematics, utilisez ibmcloud schematics ou ibmcloud sch.

Avant de commencer

Veillez à maintenir votre CLI à jour afin de pouvoir utiliser les commandes les plus récentes et leurs options. Pour plus d'informations sur les versions actuelles de la ligne de commande, voir Historique des versions de la ligne de commande.

Commandes d'actions

Passez en revue les commandes permettant de créer, de mettre à jour, de lister, de supprimer et de travailler avec vos actions Schematics.

ibmcloud schematics action create

Créer une action pour exécuter un playbook Ansible sur un seul hôte cible ou un groupe d'hôtes cibles. Vous utilisez des protocoles Ansible pour effectuer des opérations de cloud ou installer des logiciels sur des ressources de cloud. Pour tester cette fonctionnalité ou pour commencer, utilisez l'un des sites IBM- Ansible playbooks fournis. Vous pouvez créer une action à l'aide d'un fichier de contenu ou du mode interactif de la commande.

Assurez-vous que les points de terminaison location et url pointent vers la même région lorsque vous créez ou mettez à jour les espaces de travail et les actions. Pour plus d'informations sur l'emplacement et le noeud final, voir Où sont stockées mes informations?.

Syntaxe

ibmcloud schematics action create --name ACTION_NAME [--description DESCRIPTION] --location GEOGRAPHY --resource-group RESOURCE_GROUP [--template GIT_TEMPLATE_REPO] [--playbook-name PLAYBOOK_NAME] [--credential CREDENTIAL_FILE] [--credential-json CREDENTIAL_JSON_FILE] [--bastion BASTION_HOST_IP_ADDRESS] [--bastion-credential-json BASTION_CREDENTIAL_JSON_FILE] [--inventory INVENTORY_ID] [—-inventory-connection-type INVENTORY_CONNECTION_TYPE] [--input INPUT_VARIABLES_LIST] [--input-file INPUT_VARIABLES_FILE_PATH] [--env ENV_VARIABLES_LIST] [--env-file ENV_VARIABLES_FILE_PATH] [--github-token GITHUB_ACCESS_TOKEN] [--output OUTPUT] [--file FILE_NAME ] [--no-prompt]

Options de commande

Les actionsSchematics créent des indicateurs
Indicateur Obligatoire / facultatif Description
--name ou -n Obligatoire Nom unique de l'action.
--description ou -d Facultatif Brève description d'une action.
--location ou -l Obligatoire La zone géographique ou le lieu où vous souhaitez créer l'action, par exemple us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon. La zone géographique ou l'emplacement détermine où s'exécute votre action et où vos données d'action sont stockées. Pour plus d'informations, voir Où sont stockées mes informations ?. Vérifiez que vous pouvez stocker les données dans cet emplacement, car vous ne pouvez pas modifier l'emplacement une fois l'action créée.
--resource-group ou -r Obligatoire Nom du groupe de ressources dans lequel vous souhaitez créer l'action.
--template ou -tr Facultatif URL du référentiel Git où est stocké votre protocole Ansible.
--playbook-name ou --pn Facultatif Nom du protocole Ansible.
--credentials ou -C Facultatif Chemin de fichier vers la clé SSH privée que vous souhaitez utiliser pour accéder à votre hôte cible, par exemple ~/.ssh/id_rsa. La clé SSH doit contenir à la fin des détails de la clé en cas d'appels de ligne de commande ou d'API.
--credential-json ou --cj Facultatif Indiquez le chemin du fichier JSON contenant la charge JSON des données d'identification pour accéder à l'hôte cible.
--bastion ou -b Facultatif Adresse IP de l'hôte bastion.
--bastion-credential-json ou --bj Facultatif Indiquez le chemin d'accès au fichier JSON qui contient la charge JSON des données d'identification de bastion pour accéder à l'hôte du bastion.
--inventory ou -y Facultatif ID de l'inventaire de ressources que vous souhaitez utiliser dans votre action. Pour répertorier les inventaires existants, exécutez la commande ibmcloud schematics inventory list.
--inventory-connection-type ou --it Facultatif Type de connexion d'inventaire. Les valeurs prises en charge sont sshou winrm. La valeur par défaut est SSH. Actuellement, WinRM ne prend en charge que les systèmes Windows avec le site public IPs et ne prend pas en charge l'hôte Bastion.
--input ou --in Facultatif Variables d'entrée de votre action. Les variables d'entrée doivent être entrées en tant que paires clé-valeur, telles que --input mykey=myvalue. Pour spécifier plusieurs variables d'entrée, utilisez plusieurs indicateurs --input dans votre commande. Vous pouvez également stocker vos variables d'entrée dans un fichier et faire référence à ce fichier à l'aide de l'option de commande --input-file.
--input-file ou --if Facultatif Chemin d'accès à un fichier dans lequel vous avez spécifié toutes vos variables d'entrée. Les variables d'entrée doivent être spécifiées en tant que paires clé-valeur au format JSON.
--env ou -e Facultatif Variables d'environnement d'une action. Les variables d'environnement doivent être entrées en tant que paires clé-valeur, telles que --env mykey=myvalue. Pour fournir plusieurs variables d'environnement, utilisez plusieurs indicateurs --env dans votre commande.
--env-file ou -E Facultatif Chemin d'accès à un fichier dans lequel vous avez spécifié toutes les variables d'environnement pour une action. Les variables d'environnement doivent être spécifiées en tant que paires clé-valeur au format JSON.
--github-token ou -g Facultatif Jeton d'accès personnel dans GitHub que vous souhaitez utiliser pour vous connecter à un référentiel GitHub privé. Si vous souhaitez effectuer un clonage à partir du référentiel Git, consultez les extensions de fichier autorisées et bloquées pour le clonage.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--file ou -f Facultatif Chemin d'accès au fichier de contenu JSON contenant la définition de l'action que vous souhaitez créer. Pour plus d'informations, voir Utilisation d'un fichier de contenu.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans mode interactif.

Exemple

ibmcloud schematics action create --name start-vsi --location us-south --resource-group default --template https://github.com/Cloud-Schematics/ansible-is-instance-actions --playbook-name stop-vsi-playbook.yml --input instance_ip=172.4.5.0

Utilisation d'un fichier de contenu

Créez un fichier JSON contenant les détails de l'action que vous souhaitez créer, tels que l'ID, le nom et la description. Ensuite, utilisez l'option de commande --file pour créer votre action à partir de votre fichier de contenu.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<ACTION_NAME>" comme "testaction".

Syntaxe

{
    "name": "<ACTION_NAME>",
    "description": "<DESCRIPTION>",
    "location": "<LOCATION>",
    "resource_group": "<RESOURCE_GROUP>",
    "bastion_connection_type": "ssh",
    "inventory_connection_type": "winrm",
    "source": {
        "source_type" : "git",
        "git" : {
            "git_repo_url": "<YOUR_REPOSITORY>"
        }
    },
    "command_parameter": "<PLAYBOOK_NAME>",
    "bastion": {},
    "bastion_credentials": {
	    "metadata": {}
    },
    "tags": [
        "<ACTION_TAGS>"
    ],
    "source_readme_url": "stringtype",
    "source_type": "GitHub"
}
ibmcloud schematics action create --file <FILE_NAME>

Exemple

ibmcloud schematics action create --file sample.json

Utilisation du mode interactif

Au lieu d'entrer les options de commande ou d'utiliser un fichier de contenu, vous pouvez utiliser le mode interactif de la commande pour créer une action. Par défaut, l'action est créée avec une entrée utilisateur minimale. Pour ajouter des informations supplémentaires à votre action, vous pouvez mettre à jour l'action ultérieurement.

  1. Lancez le mode interactif en exécutant la commande sans options de commande.
    ibmcloud schematics action create
    
  2. Entrez un nom pour votre action et appuyez sur la touche de retour.
  3. Entrez le groupe de ressources dans lequel vous souhaitez créer l'action et appuyez sur la touche de retour.
  4. Entrez l'emplacement où vous souhaitez créer l'action, par exemple us-south, us-east, eu-de ou eu-gb. Appuyez ensuite sur la touche de retour. L'emplacement détermine où s'exécute votre action et où vos données d'action sont stockées. Pour plus d'informations, voir Où sont stockées mes informations ?. Vérifiez que vous pouvez stocker les données dans cet emplacement, car vous ne pouvez pas modifier l'emplacement une fois l'action créée.
  5. Entrez l'URL vers le référentiel GitHub où votre protocole Ansible est stocké. Appuyez ensuite sur la touche de retour.
  6. Le cas échéant, entrez le jeton d'accès personnel que vous souhaitez utiliser pour accéder à votre référentiel GitHub. Appuyez ensuite sur la touche de retour. Si vous souhaitez effectuer un clonage à partir du référentiel Git, consultez les extensions de fichier autorisées et bloquées pour le clonage.
  7. Entrez le nom du protocole Ansible que vous souhaitez exécuter et appuyez sur la touche de retour.
  8. Examinez les détails de l'action qui a été créée pour vous.

ibmcloud schematics action update

Mettez à jour les informations d'une action existante à l'aide de action_id. Vérifiez que l'interface de ligne de commande location et le noeud final url pointent vers la région dans laquelle vous souhaitez créer ou mettre à jour vos espaces de travail et vos actions. Pour plus d'informations sur l'emplacement et le noeud final, voir Où sont stockées mes informations?.

Syntaxe

ibmcloud schematics action update --id ACTION_ID --name ACTION_NAME [--description DESCRIPTION] --location GEOGRAPHY --resource-group RESOURCE_GROUP [--template GIT_TEMPLATE_REPO] [--playbook-name PLAYBOOK_NAME] [--github-token GITHUB_ACCESS_TOKEN] [--credential CREDENTIAL_FILE] [--credential-json CREDENTIAL_JSON_FILE] [--bastion BASTION_HOST_IP_ADDRESS] [--bastion-credential-json BASTION_CREDENTIAL_JSON_FILE] [--inventory INVENTORY_ID] [--inventory-connection-type INVENTORY_CONNECTION_TYPE] [--input INPUT_VARIABLES_LIST] [--input-file INPUT_VARIABLES_FILE_PATH] [--env ENV_VARIABLES_LIST] [--env-file ENV_VARIABLES_FILE_PATH] [--file FILE_NAME] [--no-prompt] [--output OUTPUT]

Options de commande

Indicateurs de mise à jour des actionsSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'une action que vous souhaitez mettre à jour.
--name ou -n Facultatif Nouveau nom unique pour votre action.
--description ou -d Facultatif Brève description d'une action.
--location ou -l Obligatoire Lieux géographiques pris en charge par le service IBM Cloud Schematics tels que us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon.
--resource-group ou -r Obligatoire Nom du groupe de ressources d'une action.
--template ou -tr Facultatif URL du référentiel Git où est stocké votre protocole Ansible.
--playbook-name ou --pn Facultatif Nom du playbook.
--github-token ou -g Facultatif Jeton d'accès personnel dans GitHub que vous souhaitez utiliser pour vous connecter à un référentiel GitHub privé. Si vous souhaitez effectuer un clonage à partir du référentiel Git, consultez les extensions de fichier autorisées et bloquées pour le clonage.
--credentials ou -C Facultatif Chemin de fichier vers la clé SSH privée que vous souhaitez utiliser pour accéder à votre hôte cible, par exemple ~/.ssh/id_rsa. La clé SSH doit contenir à la fin des détails de la clé en cas d'appels de ligne de commande ou d'API.
--credential-json ou --cj Facultatif Indiquez le chemin du fichier JSON contenant la charge JSON des données d'identification pour accéder à l'hôte cible.
--bastion ou -b Facultatif Adresse IP de l'hôte bastion.
--bastion-credential-json ou --bj Facultatif Indiquez le chemin d'accès au fichier JSON qui contient la charge JSON des données d'identification de bastion pour accéder à l'hôte du bastion.
--inventory ou -y Facultatif ID de l'inventaire de ressources que vous souhaitez utiliser dans votre action. Pour répertorier les inventaires existants, exécutez la commande ibmcloud schematics inventory list.
--inventory-connection-type ou --it Facultatif Type de connexion d'inventaire. Les valeurs prises en charge sont sshou winrm. La valeur par défaut est SSH. Actuellement, WinRM ne prend en charge que les systèmes Windows avec le site public IPs et ne prend pas en charge l'hôte Bastion.
--input ou --in Facultatif Variables d'entrée de votre action. Les variables d'entrée doivent être entrées en tant que paires clé-valeur, telles que --input mykey=myvalue. Pour spécifier plusieurs variables d'entrée, utilisez plusieurs indicateurs --input dans votre commande. Vous pouvez également stocker vos variables d'entrée dans un fichier et faire référence à ce fichier dans l'option de commande --input-file.
--input-file ou --if Facultatif Chemin d'accès à un fichier dans lequel vous avez spécifié toutes vos variables d'entrée. Les variables d'entrée doivent être spécifiées en tant que paires clé-valeur au format JSON.
--env ou -e Facultatif Variables d'environnement d'une action. Les variables d'environnement doivent être entrées en tant que paires clé-valeur, telles que --env mykey=myvalue. Pour fournir plusieurs variables d'environnement, utilisez plusieurs indicateurs --env dans votre commande.
--env-file ou -E Facultatif Chemin d'accès à un fichier dans lequel vous avez spécifié toutes les variables d'environnement pour une action. Les variables d'environnement doivent être spécifiées en tant que paires clé-valeur au format JSON.
--file ou -f Facultatif Chemin d'accès au fichier de contenu JSON contenant la définition de l'action à mettre à jour. Pour plus d'informations, voir Utilisation du fichier de contenu. Notez que les paramètres, tels que l'emplacement ou le groupe de ressources, ne peuvent pas être mis à jour une fois l'action créée.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans invite utilisateur.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics action update --id us-south.workspace.101010101 --description "This is my description"

ibmcloud schematics action get

Récupérer les détails d'une action Schematics existante, tels que l'ID de l'action, le nom, l'état, l'heure de création, l'état de chiffrement et le CRN de chiffrement, y compris les valeurs de toutes les variables d'entrée.

Syntaxe

ibmcloud schematics action get --id ACTION_ID [--profile PROFILE] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics actions obtenir des drapeaux
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'une action que vous souhaitez extraire.
--profile ou -p Facultatif Quantité des informations que vous souhaitez extraire. Les valeurs prises en charge sont detailed et summary. La valeur par défaut est summary.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans le mode interactif.

Exemple

ibmcloud schematics action get --id us-south.workspace.101010101 -p summary

ibmcloud schematics action list

Récupérer une liste de toutes les actions définies dans la région IBM Cloud actuelle pour votre compte.

Syntaxe

ibmcloud schematics action list [--limit LIMIT] [--offset OFFSET] [--profile PROFILE] [--output OUTPUT]

Options de commande

Indicateurs de liste d'actions Schematics
Indicateur Obligatoire / facultatif Description
--limit ou -l Facultatif Nombre maximal d'actions que vous souhaitez répertorier. Ce nombre doit être un entier positif compris entre 1 et 200. La valeur par défaut est -1.
--offset ou -m Facultatif Position de l'action dans la liste des actions à partir de laquelle vous souhaitez commencer à répertorier vos actions. Par exemple, si vous avez trois actions dans votre compte et votre région, la commande renvoie ces actions sous la forme d'une liste à trois éléments. Pour extraire toutes les actions, vous devez entrer le numéro de position 0. Pour extraire les actions numéro 2 et 3 et laisser l'action numéro 1 dans cette liste, vous devez entrer le numéro de position 1. La position 1 représente la seconde position dans la liste des actions. Les nombres négatifs ne sont pas pris en charge et sont ignorés.
--profile ou -p Facultatif Quantité des informations renvoyées. Les valeurs prises en charge sont ids et summary. La valeur par défaut est summary.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics action list --profile ids

ibmcloud schematics action delete

Supprimez une action Schematics.

Syntaxe

ibmcloud schematics action delete --id ACTION_ID [--force][--no-prompt]

Options de commande

Schematics actions supprimer les drapeaux
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'une action que vous souhaitez supprimer.
--force ou -f Facultatif Permet de forcer la suppression sans confirmation de l'utilisateur.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans invite utilisateur.

Exemple

ibmcloud schematics action delete --id us-south.workspace.101010101

ibmcloud schematics action upload

Vous pouvez transférer un fichier d'archivage sur bande (.tar) depuis votre système de fichiers local vers une action IBM Cloud Schematics. Entrez le chemin sur votre machine locale où votre fichier .tar est stocké. Créez le fichier .tar de votre référentiel de modèles à l'aide de la commande TAR, avec la commande tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER.

Syntaxe

ibmcloud schematics action upload --id ACTION_ID --file FILE_NAME [--no-prompt] [--output OUTPUT]

Options de commande

Indicateurs de téléchargement des actionsSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'une action que vous souhaitez transférer.
--file ou -f Obligatoire Chemin du fichier TAR à transférer pour une action.
--no-prompt Facultatif Définissez cet indicateur pour arrêter la session de ligne de commande interactive.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics action upload --id us.ACTION.testphase1.2eddf83a --file <FILE_PATH>/mytestactionupload.tar

Commandes de travail d'actions

Passez en revue les commandes permettant de créer, de mettre à jour, de répertorier et de supprimer des travaux sur le site Schematics lorsque vous travaillez avec des actions sur le site Schematics.

ibmcloud schematics job run

Créez un job dans IBM Cloud Schematics pour exécuter le playbook Ansible spécifié par votre action Schematics. Vous pouvez créer un travail à l'aide d'un fichier de contenu ou du mode interactif de la commande.

Syntaxe

ibmcloud schematics job run --command-object COMMAND_OBJECT_TYPE --command-object-id COMMAND_OBJECT_ID --command-name COMMAND_NAME [--playbook-name PLAYBOOK_NAME] [--command-options COMMAND_OPTIONS] [--input INPUT_VARIABLES_LIST] [--input-file INPUT_VARIABLES_FILE_PATH] [--env ENV_VARIABLES_LIST] [--env-file ENV_VARIABLES_FILE_PATH] [--output OUTPUT] [--file FILE_NAME ] [--no-prompt]

Options de commande

Indicateurs d'exécution de travailSchematics
Indicateur Obligatoire / facultatif Description
--command-object ou -c Obligatoire Nom de la ressource d'automatisation Schematics. Actuellement, seul le nom action est pris en charge.
--command-object-id ou -cid Obligatoire L'ID des actions Schematics où vous souhaitez exécuter le travail.
--command-name, ou -n Obligatoire Commande que vous souhaitez exécuter pour votre action. Les valeurs prises en charge sont ansible_playbook_check et ansible_playbook_run.
--playbook-name ou -pn Facultatif Nom du protocole Ansible à exécuter.
--command-options ou -co Facultatif Options de ligne de commande pour la commande.
--input ou --in Facultatif Variables d'entrée d'une action. Cet indicateur peut être défini plusieurs fois et doit être au format --inputs test=testvalue.
--input-file ou --if Facultatif Variables d'entrée pour une action. Indiquez le chemin d'accès au fichier JSON qui contient les variables d'entrée.
--env ou -e Facultatif Variables d'environnement d'une action. Cet indicateur peut être défini plusieurs fois et doit être au format --env-variables test=testvalue.
--env-file ou -E Facultatif Variables d'environnement d'une action. Indiquez le chemin d'accès au fichier JSON qui contient les variables d'environnement.
--result-format ou -f Facultatif Résultat de la sortie de la réponse au format JSON.
--file ou -f Facultatif Chemin d'accès au fichier JSON contenant la définition de la nouvelle tâche.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Si l'action contient le nom du cahier de jeu, vous devez ajouter le nom du cahier de jeu, afin que le nom du cahier de jeu de l'action ait la priorité. Si vous avez besoin de remplacer le nom du protocole dans le travail, vous devrez créer une action avec le nouveau nom de protocole.

Utilisation du fichier de contenu

Vous pouvez fournir un fichier de contenu pour spécifier certains paramètres de la commande job run. Le nom de fichier doit ensuite être transmis à la commande à l'aide de l'option de commande --file.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<COMMAND_OBJECT>" comme "action".

Syntaxe

{
    "command_object": "<COMMAND_OBJECT>",
    "command_object_id": "<COMMAND_OBJECT_ID>",
    "command_name": "<COMMAND_NAME>",
    "command_parameter": "<PLAYBOOK_NAME>"
}

Exemple

{
    "command_object": "action",
    "command_object_id": "us-east.ACTION.Example-11110000011",
    "command_name": "ansible_playbook_check",
    "command_parameter": "site.yml"
}
ibmcloud schematics job run --file sample.json

Utilisation du mode interactif

Au lieu d'entrer les détails de votre travail à l'aide d'options de commande ou d'un fichier de contenu, vous pouvez utiliser le mode interactif pour la commande. Ce mode vous invite à entrer les valeurs requises pour créer un travail dans Schematics.

  1. Entrez la commande permettant de créer le travail sans option de commande.
    ibmcloud schematics job run
    
  2. Lorsque vous êtes invité à Enter command-object>, entrez action et appuyez sur la touche de retour.
  3. Lorsque vous êtes invité à Enter command-object-id>, entrez les détails de l'ID d'action et appuyez sur la touche de retour.
  4. Lorsque vous êtes invité à Enter command-name>, entrez ansible_playbook_run ou ansible_playbook_check, puis appuyez sur la touche de retour.
  5. Vérifiez la sortie de l'interface de ligne de commande pour le travail qui a été créé pour vous.

ibmcloud schematics job update

Créez un travail en copiant les paramètres d'un travail existant et exécutez le travail dans IBM Cloud Schematics.

Syntaxe

ibmcloud schematics job update --id JOB_ID [--output OUTPUT] [--no-prompt]

Options de commande

Indicateurs de mise à jour de travailSchematics
Indicateur Obligatoire / facultatif Description
--id Obligatoire ID d'un travail existant que vous souhaitez copier et exécuter à nouveau.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour créer le travail sans session de ligne de commande interactive.

Exemple

ibmcloud schematics job update --id  us-east.JOB.yourjob_ID_1231

ibmcloud schematics job get

Récupérer les détails d'un travail d'action à l'aide d'un identifiant de travail.

Syntaxe

ibmcloud schematics job get --id JOB_ID [--profile PROFILE] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics indicateurs d'obtention de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de l'ID de travail que vous souhaitez extraire.
--profile ou -p Facultatif Quantité des informations que vous souhaitez extraire. Les valeurs prises en charge sont detailed et summary. La valeur par défaut est summary.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour extraire les détails du travail sans session de ligne de commande interactive.

Exemple

ibmcloud schematics job get --id us-east.JOB.yourjob_ID_1231 --profile detailed

ibmcloud schematics job list

Récupérer une liste de tous les travaux Schematics qui ont été exécutés pour une action Schematics. La commande affiche une liste des travaux dont l'état est in_progress, success ou failed.

Syntaxe

ibmcloud schematics job list --resource-type RESOURCE_TYPE --id RESOURCE_ID [--limit LIMIT] [--offset OFFSET] [--profile PROFILE] [--output OUTPUT] [--all] [--no-prompt]

Options de commande

Indicateurs de liste de travauxSchematics
Indicateur Obligatoire / facultatif Description
--resource-type ou -rt Obligatoire Nom de la ressource Schematics. Seule l'action est prise en charge.
--id ou -i Obligatoire L'ID des actions Schematics pour lesquelles vous souhaitez répertorier les travaux.
--limit ou -l Facultatif Nombre maximal d'espaces de travail qui doivent apparaître dans la liste. Ce nombre doit être un entier positif compris entre 1 et 200. La valeur par défaut est -1.
--offset ou -m Facultatif Position du travail dans la liste des travaux à partir de laquelle vous souhaitez commencer à répertorier vos travaux. Par exemple, si vous disposez de trois travaux dans votre compte, la commande renvoie ces travaux sous la forme d'une liste comportant trois éléments. Pour extraire tous les travaux, vous devez entrer le numéro de position 0. Pour récupérer le travail numéro 2 et 3 et sortir le travail numéro 1 de cette liste, vous devez entrer le poste numéro 1. La position 1 représente le deuxième poste de la liste des travaux. Les nombres négatifs ne sont pas pris en charge et sont ignorés.
--profile ou -p Facultatif Quantité des informations renvoyées. Les valeurs prises en charge sont ids ou summary. La valeur par défaut est summary.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--all ou -A Facultatif Permet de répertorier tous les travaux, y compris les travaux internes Schematics.
--no-prompt Facultatif Définissez cet indicateur pour créer le travail sans session de ligne de commande interactive.

Exemple

ibmcloud schematics job list --resource-type action --id us-south.ACTION.interactive.aaa1a111 --profile ids --output json

ibmcloud schematics job logs

Récupérer les journaux d'un travail d'action Schematics. Pour plus d'informations sur l'affichage des journaux des travaux, voir la section Examen des détails des travaux sur le site Schematics.

Syntaxe

ibmcloud schematics job logs --id JOB_ID [log-prefix] [log-header] [--no-prompt]

Options de commande

Indicateurs des journaux de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID du travail pour lequel vous souhaitez extraire des journaux détaillés.
--log-prefix ou --lp Facultatif Ajoute le préfixe de la commande exécutée dans les journaux du travail.
--log-header ou --lh Facultatif Utilisé pour convertir les en-têtes de commande dans les journaux du travail au format Schematics.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans session de ligne de commande interactive.

Exemple

ibmcloud schematics job logs --id us-east.JOB.yourjob_ID_1231

ibmcloud schematics job delete

Supprimer un travail pour une action Schematics.

Vous ne pouvez pas supprimer ou arrêter un travail en cours d'exécution. Pour supprimer un travail, vous devez attendre qu'il soit terminé.

Syntaxe

ibmcloud schematics job delete --id JOB_ID [--force] [--no-prompt]

Options de commande

Schematics indicateurs de suppression de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID du travail que vous souhaitez supprimer.
--force ou -f Facultatif Permet de forcer la suppression sans confirmation de l'utilisateur.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans session de ligne de commande interactive.

Exemple

ibmcloud schematics job delete --id us-east.JOB.yourjob_ID_1231

Commandes d'agent

ibmcloud schematics agent create

Créer un enregistrement d'agent dans la région Schematics actuellement sélectionnée. Les agents vous aident à exécuter vos tâches Terraform ou Ansible sur votre infrastructure. Pour plus d'informations sur les étapes d'utilisation de la commande create, voir Déploiement d'agents.

Syntaxe

ibmcloud schematics agent create --name AGENT_NAME --location LOCATION --agent-location AGENT_LOCATION --cluster-id CLUSTER_ID --cluster-resource-group CLUSTER_RESOURCE_GROUP --cos-instance-name COS_INSTANCE_NAME --cos-bucket COS_BUCKET --cos-location COS_LOCATION --resource-group RESOURCE_GROUP [--version VERSION] [--infra-type INFRA_TYPE] [--description DESCRIPTION] [--tags TAGS] [--metadata AGENT_METADATA] [--validate] [--deploy] [--file FILE] [--output OUTPUT]

Options de commande

Schematics Indicateurs de création d'agent
Indicateur Obligatoire / facultatif Description
--name ou -n Obligatoire Le nom unique d'un agent. Doit être une description du rôle de l'agent, de l'emplacement et de l'utilisation.
--location ou -l Obligatoire L'emplacement Schematics où l'agent est défini, us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon. Les travaux sont récupérés à cet endroit pour être exécutés.
--agent-location ou --al Obligatoire Libellé descriptif défini par l'utilisateur permettant d'identifier l'emplacement où l'agent est déployé dans l'environnement utilisateur. Il peut s'agir d'une région cloud ou d'un centre de données utilisateur. Par exemple, London MZR.
--cluster-id ou -c Obligatoire L'ID du cluster Kubernetes pour le déploiement d'un agent.
--cluster-resource-group ou --cg Obligatoire Le nom du groupe de ressources des clusters.
--cos-instance-name ou --on Obligatoire Le nom de l'instance COS.
--cos-bucket ou -b Obligatoire L'ID ou le nom du seau COS.
--cos-location ou --ol Obligatoire Emplacement du compartiment COS. Les formats pris en charge sont eu-gb, us-south, etc.
--resource-group ou -g Obligatoire Nom ou ID du groupe de ressources auquel l'agent est associé.
--version ou -v Obligatoire Libellé défini par l'utilisateur spécifiant la version de l'agent. Exemple v1.0.0
--infra-type ou -i Obligatoire Spécifiez le type d'infrastructure de l'agent cible. Les valeurs prises en charge sont ibm-kubernetes, ibm-openshift ou ibm-satellite.
--description ou -d Facultatif Description qui identifie l'utilisation de l'agent, ainsi que les zones réseau et les ressources auxquelles l'agent peut accéder.
--tags ou -t Facultatif Indicateurs d'agent. Vous pouvez répéter l'indicateur plusieurs fois. Les balises permettent une recherche plus rapide et plus facile des ressources liées à l'agent.
--metadata ou --md Facultatif Métadonnées de l'agent. Vous pouvez utiliser l'indicateur plusieurs fois. Par exemple, git:private-git.github.com ou git:gitlab.com. Si elle n'est pas définie, la valeur par défaut est git:github.com.
--validate Facultatif Exécutez la commande validate une fois l'agent créé.
--deploy Facultatif Exécutez la commande deploy sans validation une fois l'agent créé.
--file ou f Facultatif Chemin d'accès au fichier JSON contenant la définition d'un agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent create --name agenttestcli10jan --location us-east --agent-location us-east --version 1.0.0-prega --infra-type ibm_kubernetes --cluster-id clbjrdml00cgremot1k0 --cluster-resource-group Default --cos-instance-name agent-test-cos-standard --cos-bucket agent-test-bucket --cos-location us-east --resource-group Default --description "This agent is created to test for the prod release and COS"

ibmcloud schematics agent delete

Désinstaller un agent. Pour plus d'informations sur les étapes d'utilisation de la commande delete, voir Suppression d'un agent.

Syntaxe

ibmcloud schematics agent delete --id AGENT_ID [--force]

Options de commande

Schematics Indicateurs de suppression d'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--force ou -f Facultatif L'action de la force n'est pas confirmée. Définissez le paramètre --force sur true pour supprimer tous les flux d'agent afin de conserver la destruction parallèle au flux de destruction de l'espace de travail. Par défaut, ce paramètre est fixé à false.

Exemple

ibmcloud schematics agent delete --id <AGENT_ID>

ibmcloud schematics agent deploy

Déployer ou mettre à jour un agent pour forcer le déploiement. Pour plus d'informations sur les étapes d'utilisation de la commande deploy, voir Déploiement de l'agent.

Syntaxe

ibmcloud schematics agent deploy --id AGENT_ID [--force-redploy] [--output OUTPUT]

Options de commande

Schematics Indicateurs de déploiement d'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--force-redeploy ou -fd Facultatif Force le redéploiement d'un agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent deploy --id <AGENT_ID>

ibmcloud schematics agent destroy

Détruire un agent détruit les ressources Cloud associées au déploiement de l'agent d' Schematics.

Syntaxe

ibmcloud schematics agent destroy --id AGENT_ID [--force]

Options de commande

Schematics Indicateurs de destruction d'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--force ou -f Facultatif L'action de la force n'est pas confirmée.

Exemple

ibmcloud schematics agent destroy --id <AGENT_ID>

ibmcloud schematics agent get

Récupérer les détails d'un agent existant tels que l'ID de l'agent, le nom, le statut, la version, l'heure de création, l'état de chiffrement et le CRN de chiffrement, y compris les valeurs de toutes les variables d'entrée. Pour plus d'informations sur les étapes à suivre pour utiliser la commande get, voir afficher un agent

Syntaxe

ibmcloud schematics agent get --id AGENT_ID [--output OUTPUT]

Options de commande

Schematics Indicateurs d'obtention d'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent get --id <AGENT_ID>

ibmcloud schematics agent health

Effectue la validation post-déploiement d'un agent. Pour plus d'informations sur les étapes d'utilisation de la commande de santé de l'agent, voir Santé de l'agent de surveillance.

Syntaxe

ibmcloud schematics agent health --id AGENT_ID [--output OUTPUT]

Options de commande

Schematics Indicateurs de santé de l'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent health --id <AGENT_ID>

ibmcloud schematics agent list

Répertorie les agents définis dans la région Schematics en cours. Pour plus d'informations sur les étapes d'utilisation de la commande list, voir Affichage d'un agent.

Syntaxe

ibmcloud schematics agent list [--location LOCATION] [--limit LIMIT] [--offset OFFSET] [--output OUTPUT_FORMAT]

Options de commande

Schematics Indicateurs de liste d'agents
Indicateur Obligatoire / facultatif Description
--location ou -l Facultatif Lieux géographiques pris en charge par le service IBM Cloud Schematics tels que us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon.
--limit ou -lm Facultatif Nombre maximal d'agents à lister. Ignoré si un nombre négatif est défini. La limite maximale est de 200 (la valeur par défaut est -1).
--offset ou -m Facultatif Décalage dans la liste. Ignoré si un nombre négatif est défini (par défaut : -1)).
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent list --location us-south

ibmcloud schematics agent update

Mettre à jour une configuration d'agent. La mise à jour d'un agent n'entraîne pas la revalidation ou le redéploiement de l'agent. Pour plus d'informations sur les étapes d'utilisation de la commande de mise à jour de l'agent, voir Déploiement de l'agent.

Syntaxe

ibmcloud schematics agent update --id AGENT_ID [--description DESCRIPTION] [--tags TAGS] [--version VERSION] [--metadata AGENT_METADATA] [--file FILE] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics Indicateurs de mise à jour de l'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID d'un agent.
--tags ou -t Facultatif Indicateurs d'agent. Cet indicateur peut être utilisé plusieurs fois et permet de rechercher plus rapidement les ressources liées à l'agent.
--description ou -d Facultatif Brève description d'un agent.
--version value ou -v Facultatif Indiquer la version d'un agent. La version la plus récente disponible est utilisée par défaut.
--metadata Facultatif Métadonnées de l'agent. Vous pouvez utiliser l'indicateur plusieurs fois. Par exemple, git:private-git.github.com ou git:gitlab.com. Si elle n'est pas définie, la valeur par défaut est git:github.com.
--file ou -f Facultatif Chemin d'accès au fichier JSON qui contient la définition de l'agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour mettre à jour un inventaire sans session de ligne de commande interactive.

Exemple

ibmcloud schematics agent update --id <AGENT_ID>

ibmcloud schematics agent validate

Vérifie l'analyse des prérequis qui analyse une configuration d'agent et de cluster avant le déploiement. Pour plus d'informations sur les étapes d'utilisation de la commande validate, voir Déploiement de l'agent.

Syntaxe

ibmcloud schematics agent validate --id AGENT_ID [--output OUTPUT]

Options de commande

Schematics Indicateurs de validation d'agent
Indicateur Obligatoire / facultatif Description
--id Obligatoire L'ID de l'agent.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics agent validate --id AGENT_ID

Commandes de règles d'agent

Schematics (affectation) indiquent à Schematics quel agent il doit utiliser pour exécuter les tâches de l'espace de travail et les tâches d'action dans une zone spécifique du réseau. Chaque agent est associé à au moins une politique permettant d'identifier les tâches à exécuter dans l'emplacement de l'agent. Voir règles d'affectation.

ibmcloud schematics policy create

Créez une politique en utilisant Schematics pour sélectionner un ou plusieurs objets Schematics, tels qu'un espace de travail ou une action, à exécuter sur l'agent cible.

Syntaxe

ibmcloud schematics policy create --name POLICY_NAME --kind POLICY_KIND --location LOCATION --resource-group RESOURCE_GROUP --target-file TARGET_FILE [--description DESCRIPTION] [--tags TAGS] [--output OUTPUT]

Options de commande

Schematics indicateurs de création de règle
Indicateur Obligatoire / facultatif Description
--name ou -n Obligatoire Le nom unique de la politique.
--kind ou -K Obligatoire Type de règle pour la gestion et la détermination de la décision de règle. Le support est agent_assignment_policy.
--location ou -l Facultatif Emplacement géographique du service Schematics où l'agent est défini. Par exemple, us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon. Les travaux sont récupérés à cet emplacement pour le traitement.
--resource-group ou -r Obligatoire Nom ou ID de groupe de ressources pour la règle.
--target-file ou tf Facultatif Chemin du fichier JSON contenant la définition de la règle.
--description ou -d Facultatif Description de la politique Schematics.
--tags ou -t Facultatif Les balises peuvent être utilisées plusieurs fois pour rechercher et localiser des règles d'agent plus rapidement.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Utilisation du fichier de contenu

Vous pouvez fournir un fichier de contenu pour spécifier certains paramètres de la commande policy create. Le nom de fichier doit ensuite être transmis à la commande à l'aide de l'option de commande --target-file.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<SELECTOR_KIND>" comme "ids".

Syntaxe

{
	"target": {
		"selector_kind": "<SELECTOR_KIND>",
		"selector_ids": [
			"<SELECTOR_ID>"
		]
	},
	"parameter": {
		"agent_assignment_policy_parameter": {
			"selector_kind": "<SELECTOR_KIND>",
			"selector_scope": [{
				"kind": "<WORKSPACE>",
				"tags": [
					"dev:<ENVIRONMENT>",
					"demo"
				],
				"resource_groups": [
					"<RESOURCE_GROUP>"
				],
				"locations": [
					"<LOCATION>"
				]
			}]
		}
	}
}

Exemple

{
	"target": {
		"selector_kind": "ids",
		"selector_ids": [
			"demo-agent-one"
		]
	},
	"parameter": {
		"agent_assignment_policy_parameter": {
			"selector_kind": "scoped",
			"selector_scope": [{
				"kind": "workspace",
				"tags": [
					"dev:test",
					"demo"
				],
				"resource_groups": [
					"Default"
				],
				"locations": [
					"us-south"
				]
			}]
		}
	}
}

Exemple

ibmcloud schematics policy create --name policy-101 --kind agent_assignment_policy --location us-south --resource-group Default --target-file ./<PATH>/target.json

ibmcloud schematics policy delete

Supprimer une politique Schematics.

Syntaxe

ibmcloud schematics policy delete --id POLICY_ID [--force]

Options de commande

Indicateurs de suppression de règleSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire L'identifiant de la police.
--force ou -f Facultatif L'action de la force n'est pas confirmée.

Exemple

ibmcloud schematics policy delete --id policy-101.soP.282e

ibmcloud schematics policy get

Récupérer les détails d'une politique Schematics existante en utilisant l'identifiant de la politique.

Syntaxe

ibmcloud schematics policy get --id POLICY_ID [--profile PROFILE] [--output OUTPUT]

Options de commande

Schematics indicateurs d'obtention de règle
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de la politique.
--profile ou -p Facultatif Niveau de détails à renvoyer. Les valeurs valables sont summary, detailed, ou ids. La valeur par défaut est summary.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics policy get --id <POLICY_ID>

ibmcloud schematics policy list

Récupérer une liste de toutes les polices dans la région IBM Cloud pour votre compte.

Syntaxe

ibmcloud schematics policy list [--profile PROFILE] [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]
Schematics Indicateurs de liste de règles
Indicateur Obligatoire / facultatif Description
--profile ou -r Facultatif Le niveau de détails à renvoyer. Les valeurs valides sont summary, detailed et ids. La valeur par défaut est summary.
--limit ou -l Facultatif Nombre maximal de politiques à répertorier. Ignoré si un nombre négatif est défini. Ce nombre doit être un entier positif compris entre 1 et 200. La valeur par défaut est -1.
--offsetou -m Facultatif Décalage dans la liste. Ignoré si un nombre négatif est défini. La valeur par défaut est -1.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics policy list  --profile ids092030

ibmcloud schematics policy update

Mettre à jour une règle existante à l'aide de l'ID de règle.

Syntaxe

ibmcloud schematics policy update --id POLICY_ID [--kind POLICY_KIND] [--description DESCRIPTION] [--resource-group RESOURCE_GROUP] [--tags TAGS] [--file FILE] [--output OUTPUT]
Indicateurs de mise à jour de règleSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de la politique.
--kind ou -k Facultatif Type de règle pour la gestion et la détermination de la décision de règle. Le support est agent_assignment_policy.
--description ou -d Facultatif Description de la politique de personnalisation de Schematics.
--resource-group ou -r Facultatif Nom ou ID de groupe de ressources pour la règle.
--tags ou -t Facultatif Balises de règle. Cet indicateur peut être utilisé plusieurs fois pour rechercher et localiser des règles d'agent plus rapidement.
--file ou -f Facultatif Chemin d'accès au fichier JSON contenant la définition de la politique.
--output ou -o Facultatif Spécifier le format de sortie, seul JSON est pris en charge.

Exemple

ibmcloud schematics policy update --id <AGENT_ID> --description PolicyDescriptionUpdated

Configurer les commandes BYOK ou KYOK

Vous pouvez utiliser vos clés de chiffrement de IBM Key Protect (disponibles en tant que Multi-Tenant pour BYOK ou Dedicated pour KYOK) pour chiffrer et sécuriser vos données stockées sur Schematics. Pour plus d'informations sur la protection des données sensibles dans Schematics, voir la protection de vos données sensibles dans Schematics.

Hyper Protect Crypto Services (HPCS) a été supprimé pour les nouvelles intégrations. Les intégrations HPCS existantes continueront à fonctionner, mais les nouvelles intégrations avec HPCS ne sont plus prises en charge. Pour les nouvelles intégrations, utilisez Key Protect Dedicated pour les capacités de KYOK.

Avant de commencer

Les conditions suivantes doivent être remplies pour que le système de gestion des clés puisse répertorier les instances créées à partir de votre emplacement et de votre région.

Les paramètres de service KMS sont des paramètres ponctuels. Vous devez ouvrir un ticket de support pour mettre à jour les paramètres de KMS.

ibmcloud schematics kms instance ls

Répertorie toutes les instances de service KMS de votre compte IBM Cloud pour rechercher Key Protect ou Hyper Protect Crypto Services à l'aide de l'emplacement où les clés sont créées et du schéma de chiffrement, par exemple KYOK ou BYOK.

Syntaxe

ibmcloud schematics kms instances ls --location LOCATION_NAME --scheme ENCRYPTION_SCHEME [--output OUTPUT]

Options de commande

Schematics Indicateurs de liste KMS
Indicateur Obligatoire / facultatif Description
--location ou -l Obligatoire Définissez le nom de l'emplacement Schematics. Les valeurs prises en charge sont USou EU.
--scheme ou -s Obligatoire Indiquez le schéma de chiffrement. Les valeurs prises en charge sont KYOKou BYOK.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics kms instances ls --location <LOCATION_VALUE> --scheme <SCHEMA_VALUE>

ibmcloud schematics kms enable

Permet d'activer les services KMS pour chiffrer vos données à l'emplacement précisé. Pour plus d'informations sur l'activation des clés gérées par le client pour Schematics, voir l'activation des clés.

Mettez à jour les paramètres de service KMS pour votre emplacement en utilisant le noeud final privé, CRN, le noeud principal CRK et le noeud secondaire CRK. Notez que vous ne pouvez mettre à jour les paramètres KMS qu'une seule fois. Par exemple, si vous utilisez un noeud final d'API pour une zone géographique comme North America, seules les actions créées dans les zones us-south ou us-east sont extraites.

Syntaxe

ibmcloud schematics kms enable --location LOCATION_NAME --scheme ENCRYPTION_SCHEME --group RESOURCE_GROUP --primary_name PRIMARY_KMS_NAME --primary_crn PRIMARY_KEY_CRN --primary_endpoint PRIMARY_KMSPRIVATEENDPOINT [--secondary_name SECONDARY_KMS_NAME][--secondary_crn SECONDARY_KEY_CRN] [--secondary_endpoint SECONDARY_KMSPRIVATEENDPOINT] [--output OUTPUT]

Options de commande

Schematics Indicateurs d'activation KMS
Indicateur Obligatoire / facultatif Description
--location ou -l Obligatoire Définissez le nom de l'emplacement Schematics. Les valeurs prises en charge sont USou EU.
--scheme ou -s Obligatoire Indiquez le schéma de chiffrement. Les valeurs prises en charge sont KYOKou BYOK.
--group ou -g Obligatoire Indiquez le nom du groupe de ressources. La valeur par défaut est Default.
--primary_name ou --pn Obligatoire Indiquez le nom du service KMS principal.
--primary_crn ou --pc Obligatoire Indiquez le nom CRN de la clé principale.
--primary_endpoint ou --pe Obligatoire Indiquez le noeud final privé du service KMS principal.
--secondary_name ou --sn Facultatif Indiquez le nom du service KMS secondaire.
--secondary_crn ou --sc Facultatif Indiquez le nom CRN de la clé secondaire.
--secondary_endpoint ou --se Facultatif Indiquez le noeud final privé du service KMS secondaire.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics kms enable -l <LOCATION_VALUE> -s <SCHEMA_VALUE>> -g Default -pn Key-Protect-south -pc crn:v1:bluemix:public:kms:us-south:lalalalal -pe https://private.us-south.kms.cloud.ibm.com

ibmcloud schematics kms info

Permet d'extraire le service KMS sur le noeud final d'API où se trouve KYOK ou BYOK. Par exemple, si vous utilisez un noeud final d'API pour une zone géographique comme North America, seules les actions créées dans les zones us-south ou us-east sont extraites. Notez que vous devez activer kms instances dans votre compte pour exécuter info en ligne de commande.

Syntaxe

ibmcloud schematics kms info --location LOCATION_NAME [--output OUTPUT]

Options de commande

Schematics Indicateurs d'information KMS
Indicateur Obligatoire / facultatif Description
--location ou -l Obligatoire Définissez le nom de l'emplacement Schematics. Les valeurs prises en charge sont USou EU.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics kms info -l US

Commandes générales

Utilisez ces commandes générales pour obtenir des informations d'aide et de version relatives au plug-in de ligne de commande IBM Cloud Schematics.

ibmcloud schematics help

Affichez les commandes de ligne de commande IBM Cloud Schematics prises en charge.

Syntaxe

ibmcloud schematics help

Options de commande

Indicateurs d'aideSchematics
Indicateur Obligatoire / facultatif Description
--help ou -h Obligatoire Répertorie les commandes prises en charge.
command Facultatif Indiquez le nom de la commande pour extraire les détails de cette commande.

Exemple

ibmcloud schematics help

ibmcloud schematics version

Liste des versions de tous les projets open source pris en charge dans Schematics, tels que IBM Cloud Provider Plug-in for Terraform, Ansible, Helm, et Kubernetes qui sont utilisés pour exécuter les actions Schematics sur les ressources du nuage.

Syntaxe

ibmcloud schematics version [--output OUTPUT]

Options de commande

Indicateurs de version deSchematics
Indicateur Obligatoire / facultatif Description
--output ou -o Facultatif Renvoie la sortie de l'interface de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics version --output json > "<filename.json>"

Commandes inventory

Passez en revue les commandes permettant de créer, de mettre à jour, de lister, de supprimer et de travailler avec vos inventaires IBM Cloud Schematics utilisés avec les actions Schematics.

ibmcloud schematics inventory create

Pour créer un inventaire des ressources dans Schematics et l'utiliser avec une action Ansible, vous pouvez utiliser un fichier de données utiles ou le mode interactif. L'inventaire comprend tous les hôtes cibles sur lesquels vous avez l'intention d'exécuter votre playbook Ansible.

Syntaxe

ibmcloud schematics inventory create --name INVENTORY_NAME [--description DESCRIPTION] [--location GEOGRAPHY] [--resource-group RESOURCE_GROUP] [--connection-type CONNECTION_TYPE] [--bastion-ip-address BASTION_HOST_IP_ADDRESS] [--bastion-credential-json BASTION_CREDENTIAL_JSON_FILE] [--credential-json CREDENTIAL_JSON_FILE] [--inventory-view-json INVENTORY_VIEW_JSON_FILE] [--inventory-ini-file INVENTORY_INI_FILE] [--resource-query RESOURCE_QUERY_ID] [--file FILE_NAME] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics indicateurs de création d'inventaire
Indicateur Obligatoire / facultatif Description
--name ou -n Obligatoire Nom unique d'un inventaire de ressources.
--description ou -d Facultatif Brève description d'un inventaire.
--location ou -l Facultatif L'emplacement où vous souhaitez stocker votre inventaire de ressources, tel que us-south, us-east, eu-de, eu-gb, ca-tor, ou ca-mon.
resource-group ou -r Facultatif Nom du groupe de ressources dans lequel vous souhaitez créer l'action.
--connection-type ou --ct Facultatif Type de connexion à l'inventaire. Prend en charge à la fois ssh et winrm.
--bastion-ip-address ou -b Facultatif Entrez l'adresse IP de l'hôte Bastion.
--bastion-credential-json ou --bj Facultatif Indiquer le chemin du fichier JSON qui contient les informations d'identification de Bastion pour accéder à l'hôte Bastion.
--credential-json ou --cj Facultatif Indiquer le chemin d'accès au fichier JSON contenant les informations d'identification communes permettant d'accéder aux hôtes cibles. La hiérarchie des informations d'identification sur le site Schematics suit l'ordre suivant : Références au niveau de l'hôte (priorité la plus élevée), références au niveau du groupe (priorité suivante) et références communes (priorité la plus basse).
--inventory-view-json ou --inv Facultatif Chemin d'accès au fichier JSON contenant les informations relatives à l'hôte. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--inventories-ini-file ou -y Facultatif Chemin d'accès au fichier d'inventaire des ressources où vous avez spécifié tous les hôtes cible. Le fichier d'inventaire des ressources doit être fourni au format INI. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--resource-query Facultatif Entrez l'ID d'une requête de ressource que vous avez créée. Une requête de ressources permet de construire dynamiquement votre inventaire de ressources en utilisant les ressources Cloud que vous avez créées avec un espace de travail Schematics. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--file ou -f Facultatif Chemin d'accès au fichier JSON dans lequel vous avez spécifié l'inventaire de ressources que vous souhaitez créer.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour créer un inventaire sans session de ligne de commande interactive.

Utilisation du fichier de contenu

Vous pouvez fournir un fichier de contenu pour spécifier certains paramètres de la commande inventory create. Le nom de fichier doit ensuite être transmis à la commande à l'aide de l'option de commande --file.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<INVENTORY_NAME>" comme "myinventory".

Syntaxe d'un inventory_view_example.json

{
"inventory_view": {
        "groups": [
            {
                "name": "g1",
                "vars": [
                    {
                        "name": "varforweb2bvhewbvhei3GGGGG",
                        "value": "varvalueforw2vrehbqiovrybuipqvebipqvrqpbibrv hvprqe",
                        "metadata": {}
                    }
                ],
                "credentials": {
                    "name": "somevalUserG1",
                    "value": "newvalueG1",
                    "metadata": {}
                },
                "hosts": [
                    {
                        "alias": "aliasname",
                        "name": "web1.com",
                        "credential": {
                            "metadata": {}
                        }
                    },
                    {
                        "alias": "web2.com",
                        "name": "web2.com",
                        "credential": {
                            "metadata": {}
                        },
                        "vars": [
                            {
                                "name": "varforweb2",
                                "value": "varvalueforw2vrehbqiovrybuipqvebipqvrqpbibrv hvprqe",
                                "metadata": {}
                            }
                        ]
                    },
                    {
                        "alias": "web3.com",
                        "name": "web3.com",
                        "credential": {
                            "metadata": {}
                        },
                        "vars": [
                            {
                                "name": "varforwe23f",
                                "value": "vqe",
                                "metadata": {}
                            },
                            {
                                "name": "varforweb233333",
                                "value": "varvalueforw2vrehbqcecee",
                                "metadata": {}
                            }
                        ]
                    }
                ]
            },
            {
                "name": "group2",
                "credentials": {
                    "metadata": {}
                },
                "hosts": [
                    {
                        "alias": "group.com1",
                        "name": "group.com1",
                        "credential": {
                            "metadata": {}
                        }
                    },
                    {
                        "alias": "group.com2",
                        "name": "group.com2",
                        "credential": {
                            "metadata": {}
                        }
                    }
                ]
            }
        ]
    }
}

Syntaxe d'un common_credentials_example.json

{
"common_credential": [
        {
            "name": "inventory_username",
            "value": "-----BEGIN RSA PRIVATE KEY-----\nINVENTORY SSH KEY\n-----END RSA PRIVATE KEY-----\n",
            "metadata": {
                "secure": true
            }
        }
    ]
}

Syntaxe d'un bastion_credentials_example.json

{
    "bastion_credential":{
        "name": "root_updated",
        "value": "somevalue_updated",
        "metadata": {}
    }

}
ibmcloud schematics inventory create --file inventory.json

Utilisation du mode interactif

Au lieu d'entrer les détails de votre inventaire à l'aide des options de commande ou d'un fichier de contenu, vous pouvez également utiliser le mode interactif pour la commande. Ce mode vous invite à entrer les valeurs requises pour créer un inventaire dans Schematics.

  1. Entrez la commande permettant de créer l'inventaire sans option de commande.

    ibmcloud schematics inventory create ....
    
  2. Entrez un nom pour votre inventaire et appuyez sur la touche de retour.

  3. Entrez le groupe de ressources dans lequel vous souhaitez créer l'inventaire et appuyez sur la touche de retour.

  4. Saisissez l'emplacement où vous souhaitez créer l'inventaire, par exemple us-south, us-east, eu-de ou eu-gb. Appuyez ensuite sur la touche de retour.

  5. Consultez les détails de l'inventaire qui a été créé.

Exemple

ibmcloud sch inventory create --name test_inv_hosts --description "Testing of Inventory multihost" --location us-south --resource-group Default --connection-type ssh --bastion-ip-address 1.1.0.0 --bastion-credential-json <JSON file path>

ibmcloud schematics inventory delete

Supprimez la définition d'inventaire de ressources à l'aide de l'ID d'inventaire.

Syntaxe

ibmcloud schematics inventory delete --id ACTION_ID [--force][--no-prompt]

Options de commande

Schematics indicateurs de suppression d'inventaire
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'un inventaire que vous souhaitez supprimer.
--force ou -f Facultatif Permet de forcer la suppression sans confirmation de l'utilisateur.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans invite utilisateur.

Exemple

ibmcloud schematics inventory delete --id us-east.INVENTORY.inventoryid12342

ibmcloud schematics inventory get

Récupérer les informations détaillées d'un inventaire existant sur IBM Cloud Schematics en utilisant l'identifiant de l'inventaire.

Syntaxe

ibmcloud schematics inventory get --id ID [--profile PROFILE] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics indicateurs d'obtention d'inventaire
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de l'inventaire des ressources pour lequel vous souhaitez répertorier les informations détaillées.
--profile ou -p Facultatif Quantité des informations que vous souhaitez extraire. Les valeurs prises en charge sont detailed et summary. La valeur par défaut est summary.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour extraire les détails d'un inventaire sans session de ligne de commande interactive.

Exemple

ibmcloud schematics inventory get --id us-east.INVENTORY.inventoryid12342 --output json

ibmcloud schematics inventory list

Récupérer une liste de tous les inventaires Schematics dans la région actuelle pour votre compte.

Syntaxe

ibmcloud schematics inventory list [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]

Options de commande

Indicateurs de liste de travauxSchematics
Indicateur Obligatoire / facultatif Description
--limit ou -l Facultatif Nombre maximal d'inventaires que vous souhaitez répertorier. Ce nombre doit être un entier positif compris entre 1 et 200. La valeur par défaut est -1.
--offset ou -m Facultatif Position de l'inventaire dans la liste des inventaires. Par exemple, si vous disposez de trois inventaires dans votre compte, la commande renvoie ces inventaires sous la forme d'une liste comportant trois éléments. Pour afficher spécifiquement un inventaire inclus dans cette liste, vous devez entrer le numéro de position de l'inventaire dans la liste. Pour répertorier le premier inventaire dans la liste, entrez 0. Pour répertorier le second inventaire, entrez 1 et ainsi de suite. Les nombres négatifs ne sont pas pris en charge et sont ignorés. La valeur par défaut est -1.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.

Exemple

ibmcloud schematics inventory list --output json

ibmcloud schematics inventory update

Mettre à jour un inventaire des ressources existant.

Syntaxe

ibmcloud schematics inventory update  --id ID --name INVENTORY_NAME [--description DESCRIPTION] [--location GEOGRAPHY] [--resource-group RESOURCE_GROUP] [--connection-type CONNECTION_TYPE] [--bastion-ip-address BASTION_HOST_IP_ADDRESS] [--bastion-credential-json BASTION_CREDENTIAL_JSON_FILE] [--credential-json CREDENTIAL_JSON_FILE] [--inventory-view-json INVENTORY_VIEW_JSON_FILE]  [--inventory-ini-file INVENTORY_INI_FILE] [--resource-query RESOURCE_QUERY_ID] [--file FILE_NAME] [--output OUTPUT] [--no-prompt]

Options de commande

Indicateurs de mise à jour de l'inventaireSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Entrez l'ID d'un inventaire de ressources à mettre à jour.
--name ou -n Obligatoire Nom unique d'un inventaire.
--description ou -d Facultatif Brève description d'un inventaire.
--location ou -l Facultatif Les emplacements géographiques pris en charge par le service IBM Cloud Schematics, tels que us-south, us-east, eu-de, eu-gb, ca-tor ou ca-mon.
resource-group ou -r Facultatif Nom du groupe de ressources d'une action.
--connection-type ou --ct Facultatif Type de connexion à l'inventaire. Prend en charge à la fois ssh et winrm.
--bastion-ip-address ou -b Facultatif Entrez l'adresse IP de l'hôte Bastion.
--bastion-credential-json ou --bj Facultatif Indiquer le chemin du fichier JSON qui contient les informations d'identification de Bastion pour accéder à l'hôte Bastion.
--credential-json ou --cj Facultatif Indiquer le chemin d'accès au fichier JSON contenant les informations d'identification communes permettant d'accéder aux hôtes cibles. La hiérarchie des informations d'identification sur le site Schematics suit l'ordre suivant : Références au niveau de l'hôte (priorité la plus élevée), références au niveau du groupe (priorité suivante) et références communes (priorité la plus basse).
--inventory-view-json ou --inv Facultatif Chemin d'accès au fichier JSON contenant les informations relatives à l'hôte. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--inventories-ini-file ou -y Facultatif Chemin du fichier de format INI qui contient les détails de l'hôte. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--resource-query Facultatif Entrez l'ID d'une requête de ressource que vous avez créée. Une requête de ressources permet de construire dynamiquement votre inventaire de ressources en utilisant les ressources Cloud que vous avez créées avec un espace de travail Schematics. Vous devez indiquer le chemin d'accès au fichier --inventories-ini-file, l'ID --resource-query ou --inventory-view-json pour que l'inventaire utilise les détails de l'hôte cible. Le fait de fournir deux ou trois arguments quelconques doit entraîner une erreur.
--file ou -f Facultatif Chemin d'accès au fichier JSON contenant la définition d'un inventaire.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour mettre à jour un inventaire sans session de ligne de commande interactive.

Utilisation du fichier de contenu

Vous pouvez fournir un fichier de contenu pour spécifier certains paramètres de la commande inventory update. Le nom de fichier doit ensuite être transmis à la commande à l'aide de l'option de commande --file.

Syntaxe d'un inventory_view_example.json

{
    "name": "S23",
    "id": "us-south.INVENTORY.S1.66e3f32a",
    "location": "us-south",
    "resource_group": "d2a073de9b834b1cad0eb0a27e6cef36",
    "description": "Updated Description",
    "inventories_ini": "[g1]\naliasname ansible_host=web1.com\nweb2.com\nweb3.com\n[group2]\ngroup.com1\ngroup.com2\n",
    "connection_type": "ssh",
    "common_credential": {
        "name": "somevalUser",
        "value": "newvalue",
        "metadata": {}
    },
    "bastion": {
        "name": "name",
        "host": "hostname"
    },
    "bastion_credential": {
        "metadata": {}
    },
    "inventory_view": {
        "groups": [
            {
                "name": "g1",
                "vars": [
                    {
                        "name": "varforweb2bvhewbvhei3GGGGG",
                        "value": "varvalueforw2vrehbqiovrybuipqvebipqvrqpbibrv hvprqe",
                        "metadata": {}
                    }
                ],
                "credentials": {
                    "name": "somevalUserG1",
                    "value": "newvalueG1",
                    "metadata": {}
                },
                "hosts": [
                    {
                        "alias": "aliasname",
                        "name": "web1.com",
                        "credential": {
                            "metadata": {}
                        }
                    },
                    {
                        "alias": "web2.com",
                        "name": "web2.com",
                        "credential": {
                            "metadata": {}
                        },
                        "vars": [
                            {
                                "name": "varforweb2",
                                "value": "varvalueforw2vrehbqiovrybuipqvebipqvrqpbibrv hvprqe",
                                "metadata": {}
                            }
                        ]
                    },
                    {
                        "alias": "web3.com",
                        "name": "web3.com",
                        "credential": {
                            "metadata": {}
                        },
                        "vars": [
                            {
                                "name": "varforwe23f",
                                "value": "vqe",
                                "metadata": {}
                            },
                            {
                                "name": "varforweb233333",
                                "value": "varvalueforw2vrehbqcecee",
                                "metadata": {}
                            }
                        ]
                    }
                ]
            },
            {
                "name": "group2",
                "credentials": {
                    "metadata": {}
                },
                "hosts": [
                    {
                        "alias": "group.com1",
                        "name": "group.com1",
                        "credential": {
                            "metadata": {}
                        }
                    },
                    {
                        "alias": "group.com2",
                        "name": "group.com2",
                        "credential": {
                            "metadata": {}
                        }
                    }
                ]
            }
        ]
    }
}

Exemple

ibmcloud schematics inventory update  --id us-east.INVENTORY.inventory12312 --name inventoryname600 --description "Short description" --location us-east --resource-group Default --resource-query default.RESOURCEQUERY.string.12121  --output OUTPUT

Example2

ibmcloud sch inventory update --file inventory_view_example.json --id us-south.INVENTORY.S1.66e00002a

Commandes de requête de ressource d'inventaire

Construire dynamiquement des inventaires de ressources d'actions à l'aide de requêtes de ressources. Les requêtes de ressources vous permettent de recueillir des informations sur les hôtes cibles à partir des espaces de travail Schematics. Pour plus d'informations sur les requêtes de ressources et les conditions, voir Création d'inventaires de ressources pour les actions Schematics.

ibmcloud schematics resource query create

Créez une requête de ressource dans IBM Cloud Schematics que vous pouvez utiliser pour générer votre inventaire de ressources. Vous pouvez créer une requête de ressource à l'aide d'un fichier de contenu ou du mode interactif de la commande. Vous pouvez créer des conditions de ressource à l'aide de requêtes de ressource.

Syntaxe

ibmcloud schematics resource-query create --name RESOURCE_QUERY_NAME [--type RESOURCE_QUERY_TYPE] [--query-file QUERY_FILE_PATH] [--file FILE_NAME ] [--output OUTPUT] [--no-prompt]

Options de commande

Indicateurs de création de requête de ressourceSchematics
Indicateur Obligatoire / facultatif Description
--name ou -n Obligatoire Nom unique d'une requête de ressources.
--type ou -t Facultatif Type de ressource que vous souhaitez extraire. Les valeurs prises en charge sont vsi.
--query-file ou -f Facultatif Chemin d'accès au fichier JSON dans lequel vous avez spécifié les détails de votre requête de ressource. Pour obtenir la liste des requêtes prises en charge, voir Requêtes de ressources prises en charge.
--file ou -f Facultatif Chemin d'accès au fichier JSON qui spécifie les détails de la requête de ressource que vous souhaitez créer.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour créer la requête de ressource sans session de ligne de commande interactive.

Utilisation du fichier de contenu

Vous pouvez fournir un fichier de contenu pour spécifier certains paramètres de la commande resource_query create. Le nom de fichier doit ensuite être transmis à la commande à l'aide de l'option de commande --file. Pour obtenir la liste des requêtes de ressource prises en charge, voir Requêtes de ressources prises en charge.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<WORKSPACE_ID" comme us-east.workspace.ID1231.

Syntaxe

[{
    "query_type": "workspaces",
    "query_condition": [
    {
        "name": "workspace-id",
        "value": "<WORKSPACE_ID>",
        "description": "string"
    },
    {
        "name": "resource-name",
        "value": "<RESOURCE_NAME>",
        "description": "string"
    }
    ]
}]

Exemple

[{
    "query_type": "workspaces",
    "query_condition": [
    {
        "name": "workspace-id",
        "value": "us-east.workspace.ID1231",
        "description": "string"
    },
    {
        "name": "resource-name",
        "value": "tf00vpc-pubpriv-frontend-vsi",
        "description": "string"
    }
    ]
}]
ibmcloud schematics resource-query create --name myquery --type vsi --query-file queries.json

Utilisation du mode interactif

Au lieu d'entrer les détails de votre requête de ressource à l'aide des options de commande ou d'un fichier de contenu, vous pouvez utiliser le mode interactif pour la commande. Ce mode vous invite à entrer les valeurs requises pour créer une requête de ressources dans Schematics. Vous pouvez créer des conditions de ressource à l'aide de requêtes de ressource.

  1. Entrez la commande permettant de créer la requête de ressources sans option de commande.
    ibmcloud schematics resource-query create
    
  2. Entrez un nom pour votre requête de ressource et appuyez sur la touche de retour.
  3. Entrez le chemin d'accès à votre fichier de contenu. Pour consulter un exemple de fichier de contenu, voir Utilisation du fichier de contenu. Appuyez ensuite sur la touche de retour.
  4. Examinez les détails de la requête de ressource qui a été créée pour vous.

ibmcloud schematics resource query delete

Supprimez la définition de requête de ressource à l'aide de l'ID de requête de ressource issu du service IBM Cloud Schematics. Notez que vous pouvez supprimer l'emplacement et la région, le groupe de ressources à partir duquel votre inventaire a été créé. Vérifiez également que vos adresses IP se trouvent dans la zone allowlist.

Syntaxe

ibmcloud schematics resource-query delete --id ID [--force] [--no-prompt]

Options de commande

Indicateurs de suppression de requête de ressourceSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID d'une requête de ressource à supprimer.
--force ou -f Facultatif Permet de forcer la suppression sans confirmation de l'utilisateur.
--no-prompt Facultatif Définissez cet indicateur pour exécuter la commande sans invite utilisateur.

Exemple

ibmcloud schematics resource-query  delete --id us-east.INVENTORY.inventoryid12342

ibmcloud schematics resource query get

Extrayez les informations d'une requête de ressource IBM Cloud Schematics existante à l'aide d'un ID de requête de ressource.

Syntaxe

ibmcloud schematics resource-query get --id ID [--profile PROFILE] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics indicateurs d'obtention de requête de ressource
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de la requête de ressource que vous souhaitez extraire.
--profile ou -p Facultatif Quantité des informations que vous souhaitez extraire. Les valeurs prises en charge sont detailed et summary. La valeur par défaut est summary.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour extraire une requête de ressource sans session de ligne de commande interactive.

Exemple

ibmcloud schematics resource-query get --id us-east.INVENTORY.inventoryid12342

ibmcloud schematics resource query list

Récupérer une liste de toutes les requêtes de ressources Schematics dans la région actuelle pour votre compte.

Syntaxe

ibmcloud schematics resource-query list [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]

Options de commande

Indicateurs de liste de requête de ressourceSchematics
Indicateur Obligatoire / facultatif Description
--limit ou -l Facultatif Nombre maximal de requêtes de ressource que vous souhaitez répertorier. Ce nombre doit être un entier positif compris entre 1 et 200. La valeur par défaut est -1.
--offset ou -m Facultatif Position de la requête de ressource dans la liste des requêtes de ressource. Par exemple, si vous disposez de trois requêtes de ressource dans votre compte, la commande renvoie ces requêtes de ressource sous la forme d'une liste comportant trois éléments. Pour afficher une requête de ressource spécifique dans cette liste, vous devez entrer le numéro de position de la requête de ressource dans la liste. Pour répertorier la première requête de ressource dans la liste, entrez 0. Pour répertorier la deuxième requête de ressource, entrez 1 et ainsi de suite. Les nombres négatifs ne sont pas pris en charge et sont ignorés. La valeur par défaut est -1.
--output ou -o Facultatif Spécifier le format des sorties. Seul le format JSON est pris en charge.

Exemple

ibmcloud schematics resource-query list --output listoutput.json

ibmcloud schematics resource query update

La mise à jour ou le remplacement d'une requête de ressources crée une copie d'une requête de ressources et relance une requête de ressources existante en mettant à jour les informations d'une requête de ressources IBM Cloud Schematics existante.

Syntaxe

ibmcloud schematics resource-query update --id ID --name RESOURCE_QUERY_NAME [--type RESOURCE_QUERY_TYPE] [--query-file QUERY_FILE_PATH] [--file FILE_NAME ] [--output OUTPUT] [--no-prompt]

Options de commande

Schematics indicateurs de mise à jour de requête de ressource
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de la requête de ressources.
--name ou -n Obligatoire Nom unique d'une requête de ressources.
--type ou -t Facultatif Le type de la requête de ressource, tels que vsi
--query-file ou -f Facultatif Chemin d'accès au fichier JSON contenant des requêtes.
--file ou -f Facultatif Chemin d'accès au fichier JSON contenant la définition d'un inventaire.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--no-prompt Facultatif Définissez cet indicateur pour créer la requête de ressource sans session de ligne de commande interactive.

Exemple

ibmcloud schematics resource-query  update  --id us-east.INVENTORY.inventory12312 --name inventoryname600 --description "Short description" --location us-east --resource-group Default --resource-query default.RESOURCEQUERY.string.12121

Commandes d'espace de travail

Passez en revue les commandes que vous pouvez utiliser pour créer et utiliser votre espace de travail IBM Cloud Schematics.

ibmcloud schematics workspace action

Récupérer toutes les activités (travaux) d'un espace de travail, y compris l'identifiant de la personne qui a initié l'action, le statut et l'horodatage.

Lorsque vous créez un plan d'exécution Terraform ou que vous appliquez votre modèle Terraform avec Schematics, une action Schematics est automatiquement créée et un identifiant d'action lui est attribué. Vous pouvez utiliser l'ID d'action pour extraire les journaux de cette action à l'aide de la commande ibmcloud schematics logs.

Syntaxe

ibmcloud schematics workspace action --id WORKSPACE_ID [--act-id ACTION_ID] [--output OUTPUT]

Options de commande

Indicateurs d'exécution de l'espace de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous souhaitez extraire des activités. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--act-id ou -a Facultatif Entrez l'ID d'une action à extraire.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics workspace action --id <WORKSPACE_ID>

ibmcloud schematics workspace delete

Supprimez un espace de travail de la région en cours pour votre compte. La suppression de votre espace de travail ne supprime pas les ressources Cloud que vous avez provisionnées avec cet espace de travail. Vous pouvez accéder à vos ressources et les gérer directement à partir du tableau de bord IBM Cloud, mais vous ne pouvez pas utiliser IBM Cloud Schematics pour gérer vos ressources après avoir supprimé l'espace de travail.

Choisissez si vous souhaitez supprimer l'espace de travail et/ou les ressources associées. Cette action ne peut pas être annulée. Si vous supprimez l'espace de travail et conservez les ressources, vous devez gérer les ressources avec la liste des ressources ou l'interface de ligne de commande.

supprimer l'espace de travail et la ressource associée
Action Supprimer l'espace de travail Supprimer toutes les ressources associées
Supprimer l'espace de travail Vrai Faux
Supprimer uniquement les ressources Faux Vrai
Supprimer l'espace de travail et les ressources mises à disposition par l'espace de travail Vrai Vrai
Ressources détruites à l'aide de la ligne de commande ou de la liste de ressources et souhaitez supprimer l'espace de travail Vrai Faux

Syntaxe

ibmcloud schematics workspace delete --id WORKSPACE_ID [--force]

Options de commande

Schematics indicateurs de suppression d'espace de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail que vous souhaitez retirer. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--force ou -f Facultatif Permet de forcer la suppression de votre espace de travail sans invites de l'interface de ligne de commande.

Exemple

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

ibmcloud schematics workspace get

Récupérer les détails d'un espace de travail existant, tels que l'ID de l'espace de travail, le nom, le statut, la version, l'heure de création, l'ID du modèle, l'ID de l'engagement, l'état du chiffrement et le CRN de chiffrement, y compris les valeurs de toutes les variables d'entrée.

Syntaxe

ibmcloud schematics workspace get --id WORKSPACE_ID [--output OUTPUT]

Options de commande

Schematics indicateurs d'obtention d'espace de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous souhaitez extraire des détails. Pour rechercher le Resource ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list pour afficher les instances de service de liste. A partir de votre groupe de ressources, obtenez un Resource ID pour l'indicateur --id.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics workspace get --id <WORKSPACE_ID>

ibmcloud schematics workspace import

Vous pouvez importer une ressource existante avec une adresse de ressource valide dans votre fichier d'état d'espace de travail. Vous devez vous assurer que la ressource n'est importée qu'une seule fois et dans un seul espace de travail. Sinon, vous risquez de voir un comportement indésirable si la ressource est définie dans plusieurs espaces de travail. Consultez la documentation Terraform pour plus de détails sur l'utilisation de la commande import.

Syntaxe

ibmcloud schematics workspace import --id WORKSPACE_ID --options OPTIONS --address ADDRESS --resourceID RESOURCE_ID

Options de commande

Indicateurs d'importation de l'espace de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous voulez importer une instance ou une ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--options ou -o Obligatoire Indicateurs de ligne de commande. Par exemple,-var-file xxxxx/tf.
--address ou -adr Obligatoire Adresse du nom de la ressource à importer.
--resourceID ou -rid Obligatoire ID de la ressource à importer dans le fichier.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Utilisez l'option -options -var-file=schematics.tfvars pour indiquer à Schematics d'importer la ressource avec les variables d'espace de travail enregistrées.

Exemple

ibmcloud schematics workspace import --id WID --address ibm_iam_access_group.accgrp --resourceID AccessGroupId-xxxxxx-xxxx-xxx-xxx-xxxx -o -var-file=schematics.tfvars

ibmcloud schematics workspace list

Répertoriez les espaces de travail de la région en cours de votre compte IBM Cloud et affichez les détails de votre espace de travail. L'espace de travail de liste recherche l'obsolescence dans une boucle en appelant l'API versions à chaque fois pour l'ensemble de l'espace de travail via le cache de fichiers.

Syntaxe

ibmcloud schematics workspace list [--limit LIMIT] [--offset OFFSET] [--output] [--region]

Options de commande

Indicateurs de liste d'espace de travailSchematics
Indicateur Obligatoire / facultatif Description
--limit ou -l Facultatif Nombre maximal d'espaces de travail qui doivent apparaître dans la liste. Le nombre doit être un entier positif de 1 jusqu'à 200 maximum. La valeur par défaut est -1.
--offset ou -m Facultatif Position de l'espace de travail dans la liste d'espaces de travail. Par exemple, si vous disposez de trois espaces de travail dans votre compte, la commande renvoie ces espaces de travail sous la forme d'une liste comportant trois éléments. Pour afficher spécifiquement un espace de travail inclus dans cette liste, vous devez entrer le numéro de position de l'espace de travail dans la liste. Pour répertorier le premier espace de travail de la liste, entrez 0. Pour répertorier le deuxième espace de travail, entrez 1 et ainsi de suite. Les nombres négatifs ne sont pas pris en charge et sont ignorés. La valeur par défaut est -1.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.
--region ou -r Facultatif Spécifiez la région, par exemple eu, us, eu-gb, eu-de, us-south, ou us-east.

Exemple

ibmcloud schematics workspace list --limit <LIMIT_NUMBER> --offset <OFFSET_NUMBER>

ibmcloud schematics workspace new

Créez un espace de travail Schematics qui pointe vers votre modèle Terraform dans GitHub ou GitLab. Si vous souhaitez fournir votre modèle Terraform en téléchargeant un fichier d'archivage sur bande (.tar), vous pouvez créer l'espace de travail sans connexion à un référentiel GitHub, puis utiliser la commande ibmcloud schematics workspace upload pour fournir le modèle.

Schematics ne prend pas en charge le transfert du fichier .tar pour créer un espace de travail.

IBM Cloud Schematics prend en charge 50 demandes d'API par minute, par hôte et par client. L'emplacement peut être la région us-east, us-south, eu-gb ou eu-de. Vous devez attendre avant d'appeler à nouveau la commande.

Pour créer un espace de travail, vous pouvez spécifier vos paramètres d'espace de travail dans un fichier JSON. Assurez-vous que le fichier JSON suit la structure spécifiée dans cette commande. Assurez-vous également que les points de terminaison location et url pointent vers la même région lorsque vous créez ou mettez à jour des espaces de travail et des actions. Pour plus d'informations sur l'emplacement et le noeud final, voir Où sont stockées mes informations?.

IBM Cloud Schematics est en train de supprimer les anciennes versions de Terraform et d'introduire la prise en charge des versions plus récentes de Terraform. Pour plus d'informations, consultez le cycle de dépréciation de Terraform(Schematics) et le calendrier de dépréciation.

Syntaxe

ibmcloud schematics workspace new  --file FILE_NAME  --state STATE_FILE_PATH  [--agent-id AGENT_ID]  [--github-token GITHUB_TOKEN] [--output OUTPUT]

Options de commande

Espace de travailSchematics indicateurs de création
Indicateur Obligatoire / facultatif Description
--file ou -f Obligatoire Chemin d'accès relatif à un fichier JSON présent sur votre machine locale et utilisé pour configuré votre espace de travail. Pour plus d'informations sur l'exemple de fichier JSON détaillé, voir le modèle de création de fichier JSON.
--state Facultatif Chemin relatif d'un fichier d'état Terraform existant sur votre machine locale. Pour créer le fichier d'état Terraform :
1. Affichez le contenu d'un fichier d'état Terraform existant à l'aide de la commande ibmcloud schematics state pull.
2. Copiez le contenu du fichier d'état de la sortie de la ligne de commande dans un fichier de votre machine locale nommé terraform.tfstate.
3. Utilisez le chemin d'accès relatif au fichier dans le paramètre de commande --state. Remarque: L'espace de travail Schematics prend en charge le fichier terraform.tfstate de moins de 2 Mo.
--github-token ou -g Facultatif Entrez les jetons d'accès personnels fonctionnels pour les opérations Git HTTPS. Par exemple, --github-token ${FUNCTIONAL_GIT_KEY}.
--agent-id ou --aid Facultatif ID d'un agent dans lequel votre espace de travail est créé. L'agent vous aide à exécuter les tâches de votre espace de travail sur votre infrastructure. Pour plus d'informations, voir AgentSchematics.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

L'utilisation de la commande Schematics ibmcloud terraform affiche un message d'avertissement et de dépréciation car les alias 'terraform' sont dépréciés. Utilisez "schematics" ou "sch" dans vos commandes.

Créez un modèle de fichier au format JSON

Schematics prend en charge le téléchargement du modèle de modules Terraform à partir du référentiel privé. Pour plus d'informations, voir Prise en charge des modules de téléchargement à partir de l'hôte distant privé.

Vous pouvez créer le fichier JSON comme partagé dans le fichier example.json pour la création de l'espace de travail et transmettre le chemin d'accès au fichier avec le nom de fichier dans l'indicateur --file. Description de tous les paramètres de example.json, comme décrit dans le tableau.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<workspace_name>" comme "testworkspace".

Exemple

{
    "name": "<workspace_name>",
    "type": [
        "<terraform_version>"
    ],
    "location": "<location>",
    "description": "<workspace_description>",
    "tags": [],
    "template_repo": {
        "url": "<github_source_repo_url>"
    },
    "template_data": [
        {
        "folder": ".",
        "type": "<terraform_version>",
        "env_values":[
        {
          "env_key1": "dummy_text"
        },
        {
          "env_key2": "dummy_text"
        }
        ],
        "variablestore": [
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "string",
          "secure": true,
          "description":"<description>"
        },
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "bool",
          "secure": false,
          "description":"<description>"
        },
    {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "list(string);",
          "secure": false,
            "description":"<description>"
        },
    {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "map(number)",
          "secure": false,
          "description":"<description>"
        },
    {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "tuple([string, list(string), number, bool])",
          "secure": false,
          "description":"<description>"
        },
    {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "any",
          "secure": false,
          "description":"<description>"
        }
        ]
    }
    ],
}

Exemple de JSON à télécharger dans un fichier .tar

{
    "name": "<workspace_name>",
    "type": [
        "<terraform_version>"
    ],
    "location": "<location>",
    "description": "<workspace_description>",
    "tags": [],
    "template_repo": {
        "url": "<github_source_repo_url>"
    },
    "template_data": [
        {
        "folder": ".",
        "type": "<terraform_version>",
        "env_values":[
        {
          "env_key1": "dummy_text"
        },
        {
          "env_key2": "dummy_text"
        }
        ],
        "variablestore": [
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "string",
          "secure": true,
	      "description":"<description>"
        },
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "bool",
          "secure": false,
	      "description":"<description>"
        },
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "list(string)",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "map(number)",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "tuple([string, list(string), number, bool])",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "any",
          "secure": false,
	      "description":"<description>"
        }
        ]
    }
    ]
}
Description des composants du fichier JSON
Paramètre Obligatoire / Facultatif Description
workspace_name Facultatif Entrez un nom pour votre espace de travail. La longueur maximale de la limite de caractères est inférieure à 1 Mo. Pour plus d'informations, voir Conception de votre structure d'espace de travail.
terraform_version Facultatif
location Facultatif Saisissez l'emplacement où vous souhaitez créer votre espace de travail. L'emplacement détermine où s'exécutent vos actions Schematics et où sont stockées les données de votre espace de travail. Si vous n'entrez pas d'emplacement, Schematics le détermine en fonction de la région IBM Cloud ciblée. Pour visualiser la région que vous avez ciblée, exécutez ibmcloud target --output json et consultez le champ region. Pour cibler une autre région, lancez ibmcloud target -r <region>. Si vous entrez un emplacement, vérifiez que l'emplacement correspond à la région IBM Cloud que vous avez ciblée.
description Facultatif Saisissez une description de votre espace de travail.
template_repo.url Optionnel Saisissez l'adresse URL vers le référentiel GitHub ou GitLab où sont stockés vos fichiers de configuration Terraform.
template_repo.branch Optionnel Saisissez la branche GitHub ou GitLab où sont stockés vos fichiers de configuration Terraform. Maintenant, dans template_repo, vous pouvez également mettre à jour URL avec d'autres paramètres, comme indiqué dans le bloc.
template_repo.datafolder Facultatif Saisissez le nom du dossier dans le référentiel Git, qui contient le modèle.
template_repo.release Optionnel Entrez la version GitHub ou GitLab qui pointe vers vos fichiers de configuration Terraform.
github_source_repo_url Facultatif Saisissez le lien vers votre référentiel GitHub. Le lien peut pointer vers la branche master, une autre branche ou un sous-répertoire. Si vous choisissez de créer votre espace de travail sans référentiel GitHub, votre espace de travail est créé à l'état de projet. Pour connecter ultérieurement votre espace de travail à un dépôt GitHub, vous devez utiliser la commande ibmcloud schematics workspace update. Si vous prévoyez de fournir votre modèle Terraform en téléchargeant un fichier d'archive sur bande (.tar), laissez le champ URL vide et utilisez la commande ibmcloud schematics workspace upload après avoir créé l'espace de travail. Si vous souhaitez cloner à partir du dépôt Git, consultez les extensions de fichiers autorisées et bloquées pour le clonage.
env_values Facultatif Une liste de variables d'environnement que vous souhaitez appliquer lors de l'exécution d'un script bash ou d'une action Terraform. Cette zone doit être fournie sous forme de liste de paires clé-valeur. Chaque entrée est une carte avec une entrée où key = variable name et value = value. Vous pouvez définir des variables d'environnement pour les offres de catalogue IBM Cloud qui sont mises à disposition à l'aide d'un fichier script bash.
variable_name Optionnel Saisissez le nom de la variable d'entrée que vous avez déclarée dans vos fichiers de configuration Terraform.
variable_type Optionnel Terraform v0.12 supporte string, list, map, bool, number et les types de données complexes tels que list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
variable_value Facultatif Saisissez la valeur sous forme de chaîne pour les types primitifs tels que bool, number, string, et HCL format pour les variables complexes, comme vous l'indiquez dans un fichier .tfvars. Vous devez entrer la chaîne d'échappement au format HCL pour la valeur, comme illustré dans l'exemple. Pour plus d'informations sur la façon de déclarer des variables dans un fichier de configuration Terraform et de fournir une valeur aux schémas, voir Utilisation de variables d'entrée pour personnaliser les ressources. Par exemple
secure Facultatif Attribue la valeur " true " au paramètre secure. Par défaut, ce paramètre est fixé à false.
val1 Facultatif Dans la charge utile, vous pouvez fournir une variable d'environnement qui peut être exécutée dans votre espace de travail pendant la phase de planification, d'application ou de destruction. Les valeurs sont également chiffrées et stockées dans COS.

IBM Cloud Schematics prend en charge la configuration d'une variable d'environnement, telle que TF_PARALLELISM, TF_LOG. Pour plus d'informations sur la liste des variables d'environnement et leur utilisation, voir Liste des variables d'environnement.

Exemple

ibmcloud schematics workspace new --file example.json

ibmcloud schematics refresh

Permet d'effectuer une action d'actualisation IBM Cloud sur votre espace de travail. Une action d'actualisation valide les ressources Cloud de votre compte par rapport à l'état stocké dans le fichier d'état Terraform de votre espace de travail. Si des différences sont trouvées, le fichier d'état Terraform est mis à jour en conséquence.

Syntaxe

ibmcloud schematics refresh --id WORKSPACE_ID [--output OUTPUT]

Options de commande

Schematics indicateurs d'actualisation
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail que vous voulez actualiser et sur lequel vous souhaitez exécuter une action. Pour trouver l'ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics refresh --id myworkspace-a1aa1a1a-a11a-11

ibmcloud schematics state list

Listez les Name, Type, URL, et Taint Status des ressources Cloud qui sont documentées dans votre fichier d'état Terraform (terraform.tfstate).

Taint Status renvoie tainted pour (true) et blank pour (false).

Syntaxe

ibmcloud schematics state list --id WORKSPACE_ID  [--output json]

Options de commande

Indicateurs de liste d'étatSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire L'identifiant unique de l'espace de travail pour lequel vous souhaitez lister les ressources Cloud documentées dans le fichier d'état Terraform. Pour trouver l'ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics state list --id myworkspace-a1aa1a1a-a11a-11

ibmcloud schematics workspace taint

Permet de marquer manuellement une instance ou des ressources comme étant altérées en forçant la recréation des ressources à la prochaine application. L'altération modifie le fichier d'état mais pas l'infrastructure dans votre espace de travail. Lorsque vous exécutez le plan suivant, les modifications s'affichent comme étant recréées, et lors de l'application suivante, la modification est mise en œuvre.

Vous devez exécuter la commande ibmcloud schematics state list pour afficher l'état contaminé de vos ressources. Taint Status renvoie Teinté pour (true) ou Vide pour (false).

Syntaxe

ibmcloud schematics workspace taint --id WORKSPACE_ID [--options OPTIONS]  --address PARAMETER

Options de commande

Schematics indicateurs de tache d'espace de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous voulez recréer l'instance ou la ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--options ou -o Facultatif Indicateur d'option à afficher.
--address ou -adr Obligatoire Entrez l'adresse de la ressource à marquer comme altérée.

Exemple

ibmcloud schematics workspace taint --id myworkspace-lalalalalalala-11 --address null_resource.sleep

ibmcloud schematics workspace untaint

Marque manuellement une instance ou des ressources comme untaint, en forçant les ressources à être restaurées lors de la prochaine application. Lorsque vous exécutez le plan suivant, les modifications apparaissent comme restaurées et lors de l'application suivante, les modifications sont mises en œuvre.

Vous pouvez exécuter la commande ibmcloud schematics state list pour afficher l'état contaminé de vos ressources. Taint Status renvoie Teintée pour (true) ou Vide pour (false).

Syntaxe

ibmcloud schematics workspace untaint --id WORKSPACE_ID [--options OPTIONS]  [--address PARAMETER]

Options de commande

Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous voulez recréer l'instance ou la ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--options ou -o Facultatif Indicateur d'option à afficher.
--address ou -adr Facultatif Saisir l'adresse de la ressource à marquer comme untaint.
{: caption="Schematics workspace untaint indique "caption-side = "top" }

Exemple

ibmcloud schematics workspace untaint --id myworkspace-asdff1a1a-42145-11 --address null_resource.sleep

ibmcloud schematics workspace update

IBM Cloud Schematics est en train de supprimer les anciennes versions de Terraform et d'introduire la prise en charge des versions plus récentes de Terraform. Pour plus d'informations, consultez le cycle de dépréciation de Terraform(Schematics) et le calendrier de dépréciation.

Permet de mettre à jour les détails d'un espace de travail existant, tels que le nom de l'espace de travail, les variables ou l'URL de contrôle des sources. Pour mettre à disposition ou modifier IBM Cloud, voir la commande ibmcloud schematics plan.

IBM Cloud Schematics prend en charge 50 demandes d'API par minute, par hôte et par client. La région peut être us-east, us-south, eu-gb, ou eu-de. Vous devez attendre avant d'appeler à nouveau la commande. Assurez-vous que les points d'extrémité location et url pointent vers la même région lorsque vous créez ou mettez à jour des espaces de travail et des actions. Pour plus d'informations sur l'emplacement et le noeud final, voir Où sont stockées mes informations?.

Si vous avez fourni votre modèle Terraform en téléchargeant un fichier d'archivage sur bande (.tar) et que vous voulez mettre à jour votre modèle, vous devez utiliser la commande ibmcloud schematics workspace upload.

Syntaxe

ibmcloud schematics workspace update --id WORKSPACE_ID [--file FILE_NAME] [--github-token GITHUB_TOKEN] [--pull-latest] [--output OUTPUT]

L'indicateur Pull-latest n'est pas pris en charge pour les espaces de travail créés à l'aide de modèles issus de catalogues IBM Cloud.

Options de commande

indicateurs de mise à jour de l'espace de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous souhaitez mettre à jour l'instance ou la ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--file ou -f Facultatif Chemin d'accès relatif à un fichier JSON présent sur votre machine locale et qui inclut les paramètres mis à jour pour votre espace de travail. Pour plus d'informations sur l'exemple de fichier JSON avec les détails, voir le modèle de mise à jour du fichier JSON.
--github-token ou -g Facultatif Entrez la valeur du jeton GitHub pour accéder au référentiel Git privé.
--pull-latest ou --pl Facultatif Permet d'extraire les dernières modifications depuis votre référentiel GitHub vers l'espace de travail. Lorsque cet indicateur est défini, l'indicateur --file est ignoré.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Mettez à jour le modèle de fichier au format JSON

Vous pouvez créer le code JSON sous forme partagée dans le fichier example.json pour la mise à jour de l'espace de travail et transmettre le chemin du fichier et son nom dans l'indicateur --file. La description de tous les paramètres du fichier example.json est décrite dans le tableau.

Vous devez remplacer les marques de réservation <...> par les valeurs réelles. Par exemple, "<workspace_name>" comme "testworkspace".

example.json:

{
    "name": "<workspace_name>",
    "type": "<terraform_version>",
    "description": "<workspace_description>",
    "tags": [],
    "resource_group": "<resource_group>",
    "workspace_status": {
        "frozen": "<true_or_false>"
    },
    "template_repo": {
        "url": "<source_repo_url>"
    },
    "template_data": [
        {
        "folder": ".",
        "type": "<terraform_version>",
        "env_values":[
        {
           "env_key1": "dummy_text"
        },
        {
           "env_key2": "dummy_text"
        }
        ],
        "variablestore": [
        {
          "name": "<variable_name1>",
          "value": "<variable_value1>",
          "type": "<variable_type1>",
          "secure": true,
	  "use_default": true        },
        {
          "name": "<variable_name2>",
          "value": "<variable_value2>",
          "type": "<variable_type2>",
          "secure": false,
	  "use_default": true
	  }
        ]
    }
    ],
}
IBM Cloud Schematics contenu de mise à jour
Paramètre Obligatoire / facultatif Description
name Facultatif Entrez un nom pour votre espace de travail. Pour plus d'informations, voir Conception de votre structure d'espace de travail. Si vous mettez à jour le nom de l'espace de travail, l'ID de l'espace de travail ne change pas.
type Facultatif Version de Terraform que vous souhaitez utiliser pour exécuter du code Terraform. Entrez terraform_v1.5 pour utiliser Terraform version 1.5, terraform_v1.4 pour utiliser Terraform version 1.4. Par exemple, lorsque vous spécifiez terraform_v1.5, les utilisateurs peuvent avoir un modèle Terraform v1.5.0, v1.5.1 ou v1.5.7, etc. Vérifiez que vos fichiers de configuration Terraform sont compatibles avec la version que vous spécifiez. Il s'agit d'une variable obligatoire. Si la version de Terraform n'est pas spécifiée, Schematics sélectionne par défaut la version de votre modèle.
description Facultatif Entrez des étiquettes que vous souhaitez associer à votre espace de travail. Les étiquettes peuvent vous aider à trouver plus rapidement votre espace de travail.
resource_group Facultatif Entrez le groupe de ressources dans lequel vous souhaitez mettre à disposition votre espace de travail.
workspace_status Facultatif Bloquez ou débloquez un espace de travail. Si un espace de travail est bloqué, il n'est pas possible de le modifier.
template_repo.url Facultatif Entrez l'URL vers le référentiel GitHub ou GitLab dans lequel vos fichiers de configuration Terraform sont stockés.
template_repo.branch Facultatif Entrez la branche GitHub ou GitLab dans laquelle vos fichiers de configuration Terraform sont stockés. Maintenant, dans le référentiel de modèles, vous pouvez également mettre à jour URL avec plus de paramètres comme indiqué dans le bloc.
template_repo.datafolder Facultatif Entrez le nom du dossier dans le référentiel Git, qui contient le modèle.
template_repo.release Facultatif Entrez l'édition GitHub ou GitLab qui pointe vers vos fichiers de configuration Terraform.
github_source_repo_url Facultatif Entrez le lien vers votre référentiel GitHub. Le lien peut pointer vers la branche master, une autre branche ou un sous-répertoire.
template_data.folder Facultatif Entrez le nom de la variable d'entrée que vous avez déclarée dans vos fichiers de configuration Terraform.
template_data.type Facultatif Saisissez le nom du type de variable d'entrée que vous avez déclaré dans vos fichiers de configuration Terraform.
template_data[0].env_values[i].va11 Facultatif Liste des variables d'environnement que vous souhaitez appliquer lors de l'exécution d'un script bash ou d'un travail Terraform. Cette zone doit être fournie sous la forme d'une liste de paires clé-valeur, par exemple, TF_LOG=debug. Chaque entrée est une mappe avec une entrée où key est le nom de la variable d'environnement et la valeur est la valeur.
template_data[0].env_values[i].val2 Facultatif Liste des variables d'environnement que vous souhaitez appliquer lors de l'exécution d'un script bash ou d'un travail Terraform. Cette zone doit être fournie sous la forme d'une liste de paires clé-valeur, par exemple, TF_LOG=debug. Chaque entrée est une mappe avec une entrée où key est le nom de la variable d'environnement et la valeur est la valeur.
template_data[0].env_values_metadata Facultatif Métadonnées des variables d'environnement.
template_data[0].variablestore[i].name Facultatif Entrez le nom de la variable d'entrée que vous avez déclarée dans vos fichiers de configuration Terraform.
template_data[0].variablestore[ii].type Obligatoire Terraform v0.12 prend en charge string, list, map, bool, number et les types de données complexes tels que list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
template_data[0].variablestore[iii].value Facultatif Entrez la valeur sous forme de chaîne pour les types primitifs tels que bool, number, string et utilisez le format HCL pour les variables complexes, que vous fournissez dans un fichier .tfvars. Vous pouvez remplacer les valeurs par défaut de .tfvars en définissant le paramètre use_default à true. Vous devez entrer la chaîne d'échappement au format HCL pour la valeur, comme illustré dans l'exemple. Pour plus d'informations sur la façon de déclarer des variables dans un fichier de configuration Terraform et de fournir des valeurs aux schémas, voir Utilisation de variables d'entrée pour personnaliser les ressources et l'exemple de magasin de variables
template_data[0].variablestore[iv].secure Facultatif Attribuer la valeur "true " au paramètre secure. Par défaut, ce paramètre est fixé à false.
template_data[0].variablestore[v].use_default Facultatif Attribuez la valeur "true" au paramètre use_default pour remplacer le paramètre par défaut .tfvars. Par défaut, ce paramètre est fixé à false.
github_source_repo_url Facultatif Entrez le lien vers votre référentiel GitHub. Le lien peut pointer vers la branche master, une autre branche ou un sous-répertoire.

Exemple de magasin de variables

"variablestore": [
                {
                    "value": "[\n    {\n      internal = 800\n      external = 83009\n      protocol = \"tcp\"\n    }\n  ]",
                    "description": "",
                    "name": "docker_ports",
                    "type": "list(object({\n    internal = number\n    external = number\n    protocol = string\n  }))",
		                "use_default":true
                },

Exemple

ibmcloud schematics workspace update --id myworkspace-a1aa1a1a-a11a-11 --file myfile.json

ibmcloud schematics workspace update variables

IBM Cloud Schematics est en train de supprimer les anciennes versions de Terraform et d'introduire la prise en charge des versions plus récentes de Terraform. Pour plus d'informations, consultez le cycle de dépréciation de Terraform(Schematics) et le calendrier de dépréciation.

Mettre à jour les variables permet de mettre à jour une ou plusieurs variables d'entrée pour un espace de travail existant. Vous ne pouvez pas mettre à jour les variables de métadonnées de l'espace de travail telles que le nom ou l' URL contrôle de source. Pour mettre à disposition ou modifier IBM Cloud, voir la commande ibmcloud schematics plan.

Syntaxe

ibmcloud schematics workspace update-variables --id WORKSPACE_ID --template TEMPLATE_ID --file FILE_NAME [--output OUTPUT]

Options de commande

indicateurs de mise à jour de l'espace de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous souhaitez mettre à jour l'instance ou la ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--file ou -f Obligatoire Le chemin relatif vers un fichier JSON sur votre machine locale qui inclut les paramètres mis à jour pour les variables de votre espace de travail à mettre à jour. Pour plus d'informations sur l'exemple de fichier JSON avec les détails, voir le modèle de mise à jour du fichier JSON.
--template ou -tid Obligatoire Saisissez l'ID du modèle. Utilisez ibmcloud schematics workspace get pour récupérer l'ID du modèle.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple pour les valeurs variables de magasin et d'environnement

exampleupdatevar.json:

{
    "variablestore":
    [
                {
                    "name": "vpc_name",
                    "secure": true,
                    "value": "vpc_name_snsitive_updated",
                    "type": "string",
                    "description": ""
                },
                {
                    "name": "IC_SCHEMATICS_WORKSPACE_ID",
                    "secure": false,
                    "value": "test_updated",
                    "type": "string",
                    "description": ""
                }
    ],
    "env_values":
    [
                {
                    "name": "TF_LOG",
                    "value": "debug_working",
                    "secure": false,
                    "hidden": false
                },
                {
                    "name": "TF_ENV",
                    "value": "test_working",
                    "secure": false,
                    "hidden": false
                }
    ]
}

Exemple

ibmcloud schematics workspace update-variables --id myworkspace-a1aa1a1a-a11a-11 --template myworkspacetemplateid-1000 --file exampleupdatevar.json

ibmcloud schematics workspace upload

Fournissez votre modèle Terraform en téléchargeant un fichier d'archivage sur bande (.tar) dans votre espace de travail Schematics. Le site .tar prend en charge les commandes Cloud Shell.

Avant de commencer, vérifiez que vous avez créé votre espace de travail sans lien vers un référentiel GitHub ou GitLab.

Syntaxe

ibmcloud schematics workspace upload  --id WORKSPACE_ID --file FILE_NAME --template TEMPLATE_ID [--output OUTPUT]

Options de commande

Indicateurs de téléchargement des espaces de travailSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail dans lequel vous souhaitez télécharger le fichier d'archive de bande (.tar). Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--file ou -f Obligatoire Entrez le chemin sur votre machine locale où votre fichier .tar est stocké.
--template ou -tid Obligatoire Identificateur unique du modèle Terraform pour lequel vous souhaitez afficher le contenu du fichier d'état Terraform. Pour trouver l'ID du modèle, exécutez ibmcloud schematics workspace get --id <workspace_ID> et recherchez l'ID de modèle dans la zone Variables de modèle pour: de votre sortie de ligne de commande.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics workspace upload --id myworkspace-a1aa1a1a-a11a-11 --file /Users/myuser/Documents/mytar/vpc.tar --template 25111111-0000-4c

Créez le fichier TAR de votre référentiel de modèles à l'aide de la commande TAR suivante : tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER

Exemple de valeur de variable

"variablestore": [
    {
        "value": "[\n    {\n      internal = 800\n      external = 83009\n      protocol = \"tcp\"\n    }\n  ]",
        "description": "",
        "name": "docker_ports",
        "type": "list(object({\n    internal = number\n    external = number\n    protocol = string\n  }))"
    },
]

Commandes de travail d'espace de travail

Exécuter des opérations d' Schematics, pour créer, mettre à jour et supprimer des ressources Cloud. A l'aide d'une sémantique Terraform familière, planifiez, appliquez et détruisez des espaces de travail Terraform pour gérer le cycle de vie des ressources de cloud.

ibmcloud schematics apply

Lorsque vous appliquez un modèle Terraform d'espace de travail, vos ressources sont approvisionnées, modifiées ou supprimées de IBM Cloud. Les fichiers temporaires créés pendant l'opération d'application peuvent être conservés pour des opérations ultérieures.

Votre espace de travail doit être dans un état Inactif, Actif, Échec ou Arrêté pour effectuer une opération d'application Schematics. Pour plus d'informations sur les états d'espace de travail, voir diagramme d'état de l'espace de travail.

Lorsque vos travaux Terraform sont en cours d'exécution, l'espace de travail est verrouillé et les modifications ne peuvent pas être apportées à votre espace de travail tant que l'exécution n'est pas terminée.

Syntaxe

ibmcloud schematics apply --id WORKSPACE_ID [--target RESOURCE1] [--target RESOURCE2] [--var-file PATH_TO_VARIABLES_FILE] [--force] [--output OUTPUT]

Options de commande

Schematics indicateurs d'application
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail qui pointe vers le modèle Terraform situé dans votre référentiel de contrôle des sources que vous souhaitez appliquer dans IBM Cloud. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--target ou -t Facultatif Permet de cibler la création d'une ressource spécifique de votre fichier de configuration Terraform en entrant l'adresse de la ressource Terraform, par exemple ibm_is_instance.vm1. Toutes les autres ressources définies dans votre fichier de configuration ne sont ni créées ni mises à jour. Pour cibler la création de plusieurs ressources, utilisez la syntaxe suivante: --target <resource1> --target <resource2>. Si l'attribut count est indiqué dans la ressource ciblée et qu'aucun index, par exemple ibm_is_instance.vm1[1], n'est spécifié dans l'adresse de la ressource, toutes les instances qui partagent la même ressource sont ciblées pour la création.
--var-file ou --vf Facultatif Chemin d'accès au fichier terraform.tfvars créé sur votre machine locale. Utilisez ce fichier pour stocker des informations sensibles, telles que la clé ou les données d'identification de l'API IBM Cloud pour vous connecter à l'infrastructure IBM Cloud classique au format <key>=<value>. Les variables doivent être définies sur une seule ligne, par exemple, sous la forme availability_zone_names = ["us-east-1a","us-west-1c"]. Toutes les paires clé-valeur définies dans ce fichier sont automatiquement chargées dans Terraform lorsque vous initialisez l'interface de ligne de commande Terraform. Pour désigner plusieurs fichiers tfvars, spécifiez --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--force ou -f Facultatif Permet de forcer l'exécution de cette commande sans invites utilisateur.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics apply --id myworkspace-a1aa1a1a-a11a-11 --target ibm_is_instance.vm1 --var-file ./terraform.tfvars

ibmcloud schematics destroy

Supprimez les ressources Cloud que vous avez provisionnées à l'aide de votre espace de travail Schematics, même si ces ressources sont actives. Par défaut, la commande énumère toutes les ressources à prévisualiser et reçoit ensuite la confirmation de leur destruction. Si vous utilisez l'indicateur --force or -f dans la commande de destruction, vous ne pouvez pas voir l'aperçu des ressources que vous voulez détruire.

Utilisez cette commande avec précaution. Une fois la commande exécutée, vous ne pouvez plus annuler la suppression de vos ressources Cloud. Si vous avez écrit des données dans le stockage ou les bases de données mis à disposition, veillez à créer une sauvegarde pour conserver vos données

Votre espace de travail doit être à l'état Actif, Echec ou Arrêté pour effectuer une action Schematics destroy.

Syntaxe

ibmcloud schematics destroy --id WORKSPACE_ID [--target RESOURCE1] [--target RESOURCE2] [--force] [--output OUTPUT]

Options de commande

Schematics indicateurs de destruction
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire L'identifiant unique de l'espace de travail qui pointe vers le modèle Terraform dans votre référentiel source qui spécifie les ressources Cloud que vous souhaitez supprimer. Pour trouver l'ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list.
--target ou -t Facultatif Permet de cibler la suppression d'une ressource spécifique en entrant l'adresse de la ressource Terraform, par exemple ibm_is_instance.vm1. Toutes les autres ressources de votre espace de travail restent inchangées. Pour cibler la suppression de plusieurs ressources, utilisez la syntaxe suivante: --target <resource1> --target <resource2>. Si l'attribut count est indiqué dans la ressource ciblée et qu'aucun index, par exemple ibm_is_instance.vm1[1], n'est spécifié dans l'adresse de la ressource, toutes les instances qui partagent la même ressource sont ciblées pour la suppression. Par ailleurs, si la ressource ciblée ne peut être supprimée que si les ressources dépendantes le sont également, par exemple, un cloud privé virtuel peut être supprimé uniquement si le sous-réseau associé est supprimé, toutes les ressources dépendantes seront également ciblées pour la suppression.
--force ou -f Facultatif Permet de forcer l'exécution de cette commande sans invites utilisateur. Vous ne pouvez pas voir l'aperçu des ressources que vous souhaitez détruire.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics destroy --id myworkspace-a1aa1a1a-a11a-11 --target ibm_is_vpc.myvpc

ibmcloud schematics logs

Récupérer les fichiers journaux Terraform pour l'espace de travail Schematics ou pour un ID d'action spécifique de l'espace de travail. Utilisez les fichiers journaux pour identifier et résoudre les problèmes liés au modèle Terraform ou les incidents qui se produisent lors du processus de mise à disposition, de modification ou de suppression des ressources.

Syntaxe

ibmcloud schematics logs --id WORKSPACE_ID [--act-id ACTION_ID]

Options de commande

indicateurs de journauxSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous souhaitez extraire des fichiers journaux Terraform. Pour trouver l'ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list.
--act-id ou -1 Facultatif ID d'une action pour laquelle vous souhaitez extraire des journaux Terraform. Pour obtenir la liste des ID d'action, exécutez la commande ibmcloud schematics workspace action --id WORKSPACE_ID.

Exemple

ibmcloud schematics logs --id myworkspace-a1aa1a1a-a11a-11 --act-id 9876543121abc1234cdst

ibmcloud schematics output

Extrayez les valeurs de sortie Terraform pour l'espace de travail. Vous pouvez définir des valeurs de sortie dans votre modèle Terraform pour inclure les données que vous souhaitez rendre accessibles à d'autres espaces de travail.

Syntaxe

ibmcloud schematics output --id WORKSPACE_ID[--output OUTPUT]

Options de commande

Schematics indicateurs de sortie
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous voulez répertorier les valeurs de sortie Terraform. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics output --id myworkspace3_2-31cf7130-d0c4-4d

ibmcloud schematics plan

Analysez le modèle Terraform dans votre référentiel source et comparez ce modèle aux ressources Cloud déjà déployées. La sortie de la ligne de commande indique les ressources du nuage qui doivent être ajoutées, modifiées, maintenues ou supprimées pour atteindre l'état décrit dans votre fichier de configuration.

Votre espace de travail doit être à l'état Inactif, Actif, Echec ou Arrêté pour effectuer une action Schematics plan.

Lors de la création du plan d'exécution Terraform, vous ne pouvez pas apporter de modifications à votre espace de travail.

Syntaxe

ibmcloud schematics plan --id WORKSPACE_ID [--var-file PATH_TO_VARIABLES_FILE] [--output OUTPUT]

Options de commande

Schematics indicateurs de sortie
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail qui pointe vers le modèle Terraform situé dans votre référentiel source que vous souhaitez analyser. Pour trouver l'ID d'un espace de travail, exécutez la commande ibmcloud schematics workspace list.
--var-file ou --vf Facultatif Chemin d'accès au fichier terraform.tfvars créé sur votre machine locale. Utilisez ce fichier pour stocker des informations sensibles, telles que la clé ou les données d'identification de l'API IBM Cloud pour vous connecter à l'infrastructure IBM Cloud classique au format <key>=<value>. Les variables doivent être définies sur une seule ligne, par exemple, sous la forme availability_zone_names = ["us-east-1a","us-west-1c"]. Toutes les paires clé-valeur définies dans ce fichier sont automatiquement chargées dans Terraform lorsque vous initialisez l'interface de ligne de commande Terraform. Pour désigner plusieurs fichiers tfvars, spécifiez --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--output ou -o Facultatif Renvoie la sortie de ligne de commande au format JSON. Actuellement, seul le format de fichier JSON est pris en charge.

Exemple

ibmcloud schematics plan --id myworkspace-a1aa1a1a-a11a-11

Commandes d'arrêt d'espace de travail

Après avoir appelé un travail d'espace de travail, tel qu'un plan, un apply ou un destroy, vous pouvez arrêter le travail en cours d'exécution ou la mise à disposition des ressources. Lors de l'arrêt ou de l'annulation d'un travail à exécution longue, il est conseillé de vérifier d'abord les journaux de travail pour déterminer si le travail est réellement bloqué et s'il doit être arrêté, ou s'il exécute des opérations à exécution longue qui prennent du temps à s'exécuter.

Schematics offre un certain nombre d'options permettant aux utilisateurs de (gracefully) stop, force-stop ou terminate le travail en cours dans l'ordre de l'immédiateté et de l'impact de l'opération d'arrêt.

Passez en revue les commandes des travaux (gracefully) stop, force-stop ou terminate.

ibmcloud schematics workspace job stop

Arrête un travail d'espace de travail en cours en envoyant un signal d'interruption à Terraform pour mettre fin à l'exécution.

Syntaxe

ibmcloud schematics workspace job stop --id WORKSPACE_ID --job-id JOB_ID [--stop] [--force-stop] [--terminate]

Options de commande

Schematics indicateurs d'arrêt de travail
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID de l'espace de travail à mettre à jour.
--job-id ou --jid Obligatoire ID du travail.
--stop, Facultatif Supprime le travail de la file d'attente.
--force-stop ou --fs Facultatif Envoie un signal d'arrêt à l'exécution de Terraform dans le moteur, et tente également d'arrêter immédiatement l'exécution.
--terminate ou -t Facultatif Force l'arrêt subit du moteur, marque le travail comme arrêté et déverrouille votre espace de travail. Les données ne sont pas sauvegardées avec cet indicateur.

Exemple

ibmcloud schematics workspace job stop --id <WORKSPACE_ID> --stop --job-id <JOB_ID>
ibmcloud schematics workspace job stop --id <WORKSPACE_ID> --force-stop --job-id <JOB_ID>
ibmcloud schematics workspace job stop --id <WORKSPACE_ID> --terminate --job-id <JOB_ID>

Commandes de fichier d'état d'espace de travail

Consultez les commandes que vous pouvez utiliser pour utiliser le fichier d'état Terraform (terraform.tfstate) pour un espace de travail.

Vous pouvez importer un fichier d'état Terraform existant lors de la création de votre espace de travail. Pour plus d'informations, voir la commande ibmcloud workspace new.

ibmcloud schematics state pull

Affichez le contenu du fichier d'état Terraform (terraform.tfstate) pour un modèle Terraform spécifique de votre espace de travail.

Syntaxe

ibmcloud schematics state pull --id WORKSPACE_ID --template TEMPLATE_ID

Options de commande

Schematics indicateurs d'extraction d'état
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID unique de l'espace de travail dans lequel exécuter les commandes.
--template ou --tid Obligatoire Identificateur unique du modèle Terraform pour lequel vous souhaitez afficher le contenu du fichier d'état Terraform. Pour trouver l'ID du modèle, exécutez ibmcloud schematics workspace get --id <workspace_ID> et recherchez l'ID de modèle dans la zone Variables de modèle pour: de votre sortie de ligne de commande.

Exemple

ibmcloud schematics state pull --id myworkspace-a1aa1a1a-a11a-11 --template a1aa11a1-11a1-11

ibmcloud schematics workspace state show

Fournit une sortie lisible d'un état ou d'un plan d'un espace de travail lorsque Terraform le détecte. Vous pouvez utiliser pour garantir l'état en cours et le statut des opérations planifiées. Vous devez utiliser l'ID de l'espace de travail pour extraire les journaux à l'aide de la commande ibmcloud schematics logs.

Syntaxe

ibmcloud schematics workspace state show --id WORKSPACE_ID  --address ADDRESS [--options OPTIONS]

Options de commande

Schematics indicateurs d'extraction d'état
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID unique de l'espace de travail à mettre à jour.
--address ou -adr Obligatoire Entrez l'adresse qui pointe vers une ressource unique dans l'état à afficher.
--options ou -o Facultatif Entrez les indicateurs de ligne de commande.

Exemple

ibmcloud schematics workspace show --id <WORSKPACE_ID> --address <SINGLE_RESOURCE_DETAILS>

ibmcloud schematics workspace state mv

Si vous déplacez l'état d'une ressource dans le fichier d'état. L'espace de travail continue de fonctionner, mais l'opération de planification ou d'application suivante ne trouve pas la ressource ou l'instance dans le fichier d'état. Si aucune modification n'est apportée au modèle, vous pouvez voir la recréation de la ressource lors de l'opération suivante par Terraform.

ibmcloud schematics workspace state mv --id WORKSPACE_ID --source SOURCE  --destination DESTINATION

Options de commande

Indicateurs de déplacement d'étatSchematics
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID unique de l'espace de travail pour lequel vous souhaitez déplacer une instance ou une ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--source ou -s Obligatoire Entrez l'adresse source d'un élément à déplacer.
--destination ou -d Obligatoire Indiquez l'adresse de destination d'un élément.

Exemple

ibmcloud schematics workspace state mv --id <WORKSPACE_ID> -s <ENTER_SOURCE_ADDRESS>> -d <ENTER_DESTINATION_ADDRESS>

ibmcloud schematics workspace state rm

Si vous supprimez l'état d'une ressource ou d'une instance dans le fichier d'état. L'espace de travail continue de fonctionner, mais l'opération de planification ou d'application suivante ne trouve pas la ressource ou l'instance dans le fichier d'état. Si aucune modification n'est apportée au modèle, vous pouvez voir la recréation de la ressource lors de l'opération suivante par Terraform.

ibmcloud schematics workspace state rm --id WORKSPACE_ID [--options OPTIONS] --address PARAMETER

Options de commande

Schematics indicateurs de suppression d'état
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire Identificateur unique de l'espace de travail pour lequel vous voulez supprimer l'instance ou la ressource. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--options ou -o Facultatif Entrez l'indicateur d'option à supprimer.
--address ou -adr Obligatoire Entrez l'adresse de la ressource à marquer comme altérée.

Exemple

ibmcloud schematics workspace state rm --id <WORKSPACE_ID> --address <TAINT_RESOURCE_ADDRESS>

Commandes Terraform de l'espace de travail

Vous pouvez exécuter des commandes Terraform pour manipuler les ressources Cloud et modifier l'état de Schematics.

Les commandes Terraform de l'espace de travail ne sont pas prises en charge dans l'interface utilisateur.

Le tableau récapitule les commandes d'espace de travail Terraform prises en charge.

Récapitulatif des commandes Terraform
Commande Description
show Examiner le plan ou l'état Terraform.
output Lire une sortie d'un fichier d'état Terraform.
import Importer une infrastructure existante dans Terraform.
taint Marquer une ressource pour recréation.
untaint Ne pas marquer une ressource comme étant altérée.
state Commande de gestion avancée des états permettant d'écrire des sous-commandes pour supprimer ou déplacer rm && mv.

Commandes Terraform

Les commandes Terraform sont exécutées à l'aide d'un fichier JSON pour spécifier des entrées.

Syntaxe

ibmcloud schematics workspace commands --id WORKSPACE_ID --file FILE_NAME

Options de commande

Schematics Indicateurs de commandes Terraform
Indicateur Obligatoire / facultatif Description
--id ou -i Obligatoire ID unique de l'espace de travail dans lequel exécuter les commandes. Pour trouver l'ID de votre espace de travail, exécutez la commande ibmcloud schematics workspace list.
--file ou --f Obligatoire Chemin d'accès au fichier JSON contenant la liste des commandes Terraform.

Exemple de charge utile du fichier Test.JSON

{
    "commands": [
    {
        "command": "state show",
        "command_params": "data.template_file.test",
        "command_name": "Test1",
        "command_desc": "Showing state",
        "command_onerror": "continue"
    },
    {
        "command": "taint",
        "command_params": "null_resource.sleep",
        "command_name": "Test2",
        "command_desc": "Marking taint",
        "command_onerror": "continue"
    },
    {
        "command": "untaint",
        "command_params": "null_resource.sleep",
        "command_name": "Test3",
        "command_desc": "Marking untaint",
        "command_onerror": "continue"
    },
    {
        "command": "state list ",
        "command_params": "",
        "command_name": "Test4",
        "command_desc": "Checking state list",
        "command_onerror": "continue"
    },
    {
        "command": "state rm ",
        "command_params": "data.template_file.test",
        "command_name": "Test5",
        "command_desc": "Removing state",
        "command_onerror": "continue"
    }
],
"operation_name": "workspace Command",
"description": "Executing command"
}

Le tableau ci-après fournit la liste des paramètres de clé du fichier JSON relatifs à l'API Commands pour la ligne de commande et l'API.

Liste des paramètres clés
Clé Obligatoire / facultatif Description
command Obligatoire Indiquez la commande. Les commandes prises en charge sont show,taint, untaint, state, import, output.
command_params Obligatoire Paramètres d'adresse pour le nom de la commande pour l'CLI, par exemple le nom de la ressource, le chemin d'accès absolu du nom de fichier. Pour l'API, vous devez envoyer le drapeau d'option et le paramètre d'adresse à command_params.
command_name Obligatoire Nom du bloc de commande.
command_desc Facultatif Texte décrivant le bloc de commande.
command_onError Facultatif Instruction de poursuite ou d'interruption en cas d'erreur dans la commande.
command_dependsOn Facultatif Dépendance sur les commandes précédentes.
command_status Non requis Affiche le statut de la commande exécutée, success ou failure

Exemple

ibmcloud schematics workspace commands --id cli-sleepy-0bedc51f-c344-50 --file /<FILE_PATH>/Test.JSON

Historique des versions de l'interface de ligne de commande

Vous trouverez ci-après un récapitulatif des modifications apportées à chaque version du plug-in d'interface de ligne de commande Schematics. Assurez-vous de tenir votre interface de ligne de commande à jour afin que vous puissiez utiliser toutes les commandes disponibles et leurs options.

Historique des versions de la ligne de commande
Version Date de publication Modifications
1.12.29 27 octobre 2025 Le plugin CLI Schematics introduit des informations d'identification et des variables multi-hôtes lors de la création et de la mise à jour des inventaires. Cette mise à jour rationalise le processus de traitement des détails d'authentification et des paramètres de configuration pour de nombreux systèmes cibles, garantissant une expérience d'automatisation plus efficace et plus sûre.
1.12.28 1er août 2025 Schematics Plugin CLI pour mettre à jour les sous espaces de noms et les sous commandes dans les métadonnées.
1.12.27 31 juillet 2025 Schematics Le plugin CLI permet de cibler la région de Montréal(ca-mon).
1.12.26 07 avril 2025 Schematics Le plugin CLI a amélioré la prévisualisation de la destruction des schémas ibmcloud, a mis à jour l'image de base d'un pipeline, a corrigé nil pointer exception dans les opérations ibmcloud schematics action create, ibmcloud schematics action update, et ibmcloud schematics action get.
1.12.25 10 janvier 2025 Schematics Le plugin CLI supporte la commande CLI ibmcloud schematics workspace update variables pour mettre à jour uniquement les variables d'entrée requises pour un espace de travail existant. Il améliore également la commande de destruction des schémas ibmcloud avec la fonction de prévisualisation pour lister toutes les ressources du travail avec confirmation. L' espace de travail IBM Cloud Schematics, une action et une commande get de l'agent récupèrent le CRN de chiffrement et l'état de chiffrement tel que IBM Default ou BYOK ou KYOK.
1.12.24 8 juillet 2024 Schematics Le plugin CLI corrige le support pour cibler les points de terminaison de Toronto à travers la région 'ca-tor
1.12.23 11 juin 2024 Schematics Le plugin CLI améliore l'affichage du format de fichier 'terraform.tfvars lors de l'utilisation de l'argument '--var-file dans les commandes ibmcloud workspace apply et ibmcloud workspace plan. La prise en charge de la traduction de l'internationalisationI18n) a été mise à jour.
1.12.22 30 mai 2024 Schematics Le plugin CLI prend en charge 'ibmcloud schematics agent destroy pour détruire les ressources de déploiement. Et définissez le paramètre " --force à true pour supprimer tous les flux d'agents afin de maintenir la destruction parallèle au flux de destruction de l'espace de travail.
1.12.21 19 avril 2024 Schematics CLI plugin deprecates '--json flag in all the CLI commands. Nous avons également corrigé le bogue de dépréciation de 'CLI v1.12.20 dans les commandes CLI 'ibmcloud schematics workspace refresh ou plan.
1.12.20 25 mars 2024 Schematics Le plugin CLI supporte Red Hat OpenShift Kubernetes Service.
1.12.18 08 mars 2024 Affichage du message d'avertissement relatif à la dépréciation de Terraform lors des commandes de l'espace de travail utilisant moins de " terraform_v1.5, suppression de la prise en charge de la mise à jour de l'infrastructure de l'agent et correction de l'erreur " index out of range lors de l'utilisation de la commande " ibmcloud schematics state list.
1.12.17 14 février 2024 l'installation du plug-in Schematics prend en charge le Cloud Shell, et la commande 'ibmcloud schematics workspace upload prend désormais en charge les commandes Cloud Shell
1.12.16 7 février 2024 ibmcloud schematics workspace list prend en charge la mise en cache des versions de l'API. les messages de dépréciation terraform_v1.2", " terraform_v1.3 et " terraform_v1.4 sont utilisés pour créer les modèles " ibmcloud schematics workspace new.
1.12.15 24 janvier 2024 Prise en charge du " refresh_token dans la demande " aPI de mise à jour des agents, amélioration de la prise en charge de la version de la commande " mise à jour de l'agent.
1.12.14 10 janvier 2024 Ajout de nouvelles commandes et traductions pour soutenir l'agent et la politique. Les espaces de travail du système figurant dans la liste des espaces de travail sont masqués. Amélioration de l'affichage du travail de l'agent sur la sortie de la commande. Utilisation de l'API " /v1/versions pour les versions de l'agent.
1.12.12 17 septembre 2023 Schematics La création et la mise à jour des agents ont été ajoutées avec un new flag --metadata et une correction de bug pour configurer un délai HTTP pour les requêtes.
1.12.10 22 mai 2023 Schematics Mise à jour de l'agent et correction des bogues de la commande 'agent list pour régler les erreurs d'exécution.
1.12.9 6 avril 2023 Schematics Les commandes CLI de l'agent beta-1 et de la politique sont améliorées pour inclure le '-target-file et le 'output de l'agent plan, de l'agent apply et de l'agent health.
1.12.8 22 mars 2023 les commandes CLI agent "Schematics Agent " beta-1 et 'politique sont disponibles dans les régions 'us-south, 'us-east, 'eu-de, 'eu-gb '.
1.12.7 07 février 2023 Correction d'un bug pour désactiver le 'API_AGENT_ATTACHMENT dans les régions 'us-south, 'us-east, 'eu-de, 'eu-gb '.
1.12.6 30 janvier 2023 Amélioration de la prise en charge des entrées complexes grâce au fichier " yaml Corrections liées à la sortie de l'état, à l'index hors de portée pour la sortie de l'action de l'espace de travail, au problème du jeton d'actualisation pour les longues durées d'exécution et à la panique de l'essoreuse.
1.12.5 18 déc. 2022 Utilisation de la sous-commande et prise en charge de la spécification d'entrées complexes via un fichier YAML local en utilisant l'option " -input-file
1.12.3 18 novembre 2022 Correction de la prise en charge de l'utilisation des sous-commandes 'source type.
1.12.3 3 novembre 2022 Commandes CLI améliorées, avec la dernière mise à jour du SDK, et mise à jour de la commande d'action de l'espace de travail.
1.12.2 11 août 2022 Inclusion du drapeau '--output et corrections de bugs pour les commandes dans le plug-in Schematics v1.12.2 et publication de celui-ci.
1.12.1 26 juillet 2022 Incorporation des commandes de bogues et de corrections dans Schematics
1.12.0 11 juillet 2022 Prise en charge des commandes agents dans Schematics à partir de la ligne de commande.
1.11.1 8 juillet 2022 Prise en charge de la correction du problème de traduction dans Schematics à partir de la ligne de commande.
1.10.0 5 mai 2022 Prise en charge de stop, force-stop et terminate dans Schematics à partir de la ligne de commande.
1.9.0 25 avril 2022 Prise en charge de la détection Drift dans Schematics à partir de la ligne de commande.
1.8.1 17 avril 2022 Corrige le message d'obsolescence pour la sortie Schematics JSON.
1.8.0 13 mars 2022 Permet de transmettre des fichiers " .tfvars et " .json à la commande de planification et d'application. L'utilisation de la commande 'ibmcloud terraform affiche un message d'avertissement. Cette version prend également en charge les points d'extrémité privés Schematics via la ligne de commande et améliore la sortie de la vue tabulaire pour répertorier la ressource provisionnée dans l'espace de travail Schematics
1.7.3 4 mars 2022 Prise en charge de la transmission des fichiers vars à la commande de plan de ligne de commande, affichage commit ID dans la commande ibmcloud schematics workspace get et édition de la description de la commande ibmcloud schematics workspace state show.
1.7.2 17 février 2022 Prend en charge les fichiers binaires de la plateforme Linux™ arm64 et Mac OS arm64. Les correctifs liés au flux stdout/stderr, le fichier TF vars non valide et la traduction sont publiés.
1.7.1 11 février 2022 Prise en charge de la consignation de suivi et ajout des tests d'intégration pour quelques commandes. Correction de la mise à jour de 'env values metadata, panique pour les drapeaux invalides, et 'ibmcloud schematics workspace output command n'est pas disponible.
1.7.0 12 janvier 2022 Affichage du message d'obsolescence de Terraform v11.0 après l'exécution de la commande. Correction de l'alias de ligne de commande. Suppression de l'apparence des chaînes en doublon. Prise en charge du temps global dans le fichier journal.
1.6.2 2 décembre 2021 Prise en charge des traductions en langues non anglaises. Correction de l'application de la commande --var-file et de l'argument des actions --target not setting. Correction d'une vulnérabilité du pipeline.
1.6.1 21 octobre 2021 Prise en charge des actions winrm for Schematics. Ajout des valeurs des options '--inventory-connection-type, '--bastion-credential-json et '--credential-json dans les mises à jour de création et de configuration. Traductions en langues non-anglaises mises à jour pour la ligne de commande. Correction de la duplication de l'affichage de l'argument 'command-object dans le mode interactif 'ibmcloud schematics jobs run
1.6.0 29 septembre 2021 Prise en charge des fichiers binaires linux-ppc64leet linux-s390x. Liste " Terraform v1.0 dans le panneau des détails. Afficher le message de dépréciation 'Terraform v0.11 dans la page de l'espace de travail Schematics La commande de liste de requêtes de ressources renvoie les valeurs sous forme de chaîne vide.
1.5.12 2 septembre 2021 Suppression du message d'état pour l'indicateur --output json .
1.5.11 27 août 2021 Ajout d'un drapeau --pull-latest à la commande existante de mise à jour de l' espace de travail. Problème résolu. Correction des traductions de l'environnement local.
1.5.10 11 août 2021 Prend en charge Terraform v0.15. Correction des traductions de l'environnement local.
1.5.9 13 juillet 2021 Correction des traductions de l'environnement local.
1.5.8 08 juillet 2021 Correction du chemin d'accès à l'API des ensembles de données partagées. Commandes d'ensembles de données partagées désactivées.
1.5.7 04 juin 2021 Commande ibmcloud schematics state list améliorée à afficher sous forme de données tabulaires avec un nouveau statut taint de colonne. Correction de la commande ibmcloud schematics job run avec la description d'indicateur --input . Correction de la commande ibmcloud schematics job run avec la description d'indicateur --output json . Correction de la commande ibmcloud schematics action update avec l'indicateur --credentials et les traductions de l'environnement local.
1.5.6 03 juin 2021 Commande ibmcloud schematics workspace new mise à jour pour prendre en charge Terraform v0.14 et les traductions de l'environnement local.