IBM Cloud Schematics-Befehlszeilenschnittstelle

Führen Sie diese Befehle aus, um mit IBM Cloud Schematics Arbeitsbereichen, Aktionen und bereitgestellten Ressourcen zu arbeiten und Schematics zu konfigurieren.

Schematics CLI-Befehle sind regionsspezifisch. Sie funktionieren nur in der Region/dem Standort, für den die IBM Cloud CLI konfiguriert ist. Stellen Sie sicher, dass die Befehlszeilenschnittstelle location und der Endpunkt url auf die Region verweisen, in der Sie Ihre Arbeitsbereiche und Aktionen erstellen bzw. aktualisieren wollen. Weitere Informationen zu Standort und Endpunkt finden Sie unter Wo sind meine Daten gespeichert?

Um die Befehle Schematics auszuführen, verwenden Sie ibmcloud schematics oder ibmcloud sch.

Vorbereitende Schritte

Achten Sie darauf, Ihre CLI auf dem neuesten Stand zu halten, damit Sie die aktuell freigegebenen Befehle und ihre Optionen verwenden können. Weitere Informationen zu den aktuellen Versionen der Befehlszeilenversion finden Sie unter "Versionsverlauf der Befehlszeilenversion ".

Aktionsbefehle

Überprüfen Sie die Befehle zum Erstellen, Aktualisieren, Auflisten, Löschen und Arbeiten mit Ihren Schematics Aktionen.

ibmcloud schematics action create

Erstellen Sie eine Aktion zur Ausführung eines Ansible Playbooks auf einem einzelnen Zielhost oder einer Gruppe von Zielhosts. Mit Ansible-Playbooks können Sie Cloudoperationen ausführen oder Software auf Cloudressourcen installieren. Um diese Funktion auszuprobieren oder den Einstieg zu finden, verwenden Sie eine der Seiten IBM-bereitgestellt Ansible playbooks. Sie können eine Aktion mithilfe einer Nutzdatendatei oder des interaktiven Befehlsmodus erstellen.

Stellen Sie sicher, dass der location und der url Endpunkt auf dieselbe Region verweisen, wenn Sie die Arbeitsbereiche und Aktionen erstellen oder aktualisieren. Weitere Informationen zur Position und zum Endpunkt finden Sie unter Wo werden meine Informationen gespeichert?.

Syntax

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]

Befehlsoptionen

Schematics-Aktionen erstellen Flags
Flag Erforderlich / Optional Beschreibung
--name oder -n Erforderlich Ein eindeutiger Name für die Aktion.
--description oder -d Optionale Die kurze Beschreibung für eine Aktion.
--location oder -l Erforderlich Die Geografie oder der Ort, an dem Sie die Aktion erstellen möchten, z. B. us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon. Durch die Region oder den Standort wird festgelegt, wo Ihre Aktion ausgeführt und Ihre Aktionsdaten gespeichert werden. Weitere Informationen finden Sie unter Wo werden meine Informationen gespeichert?. Stellen Sie sicher, dass Sie Daten an dieser Position speichern können, da Sie die Position nach der Erstellung der Aktion nicht ändern können.
--resource-group oder -r Erforderlich Der Name der Ressourcengruppe, in der die Aktion erstellt werden soll.
--template oder -tr Optionale Die URL für das Git-Repository, in dem das Ansible-Playbook gespeichert ist.
--playbook-name oder --pn Optionale Der Name des Ansible-Playbooks.
--credentials oder -C Optionale Der Dateipfad zu dem privaten SSH-Schlüssel, den Sie für den Zugriff auf Ihren Zielhost verwenden möchten, wie z. B. ~/.ssh/id_rsa. Der SSH-Schlüssel sollte bei Befehlszeilen- oder API-Aufrufen am Ende der Schlüsseldetails enthalten.
--credential-json oder --cj Optionale Geben Sie den Pfad der JSON-Datei an, die JSON-Nutzdaten mit Berechtigungsnachweisen für den Zugriff auf den Zielhost enthält.
--bastion oder -b Optionale Die IP-Adresse des Bastionshosts.
--bastion-credential-json oder --bj Optionale Geben Sie den Pfad der JSON-Datei an, die JSON-Nutzdaten mit Bastionsberechtigungsnachweisen für den Zugriff auf den Bastionshost enthält.
--inventory oder -y Optionale Die ID des Ressourcenbestands, den Sie in Ihrer Aktion verwenden möchten. Führen Sie ibmcloud schematics inventory list aus, um vorhandene Bestände aufzulisten.
--inventory-connection-type oder --it Optionale Typ der Bestandsverbindung. Unterstützte Werte: ssh und winrm. Die Voreinstellung ist SSH. Derzeit unterstützt WinRM nur Windows-Systeme mit der öffentlichen IPs und unterstützt keine Bastion-Hosts.
--input oder --in Optionale Die Eingabevariablen für Ihre Aktion. Eingabevariablen müssen als Schlüssel/Wert-Paare eingegeben werden. Beispiel: --input mykey=myvalue. Wenn Sie mehrere Eingabevariablen angeben möchten, verwenden Sie in Ihrem Befehl mehrere Flags des Typs --input. Sie können Ihre Eingabevariablen auch in einer Datei speichern und auf diese Datei in der Befehlsoption --input-file verweisen.
--input-file oder --if Optionale Der Pfad zu einer Datei, in der Sie alle Ihre Eingabevariablen angegeben haben. Eingabevariablen müssen als Schlüssel/Wert-Paare im JSON-Format angegeben werden.
--env oder -e Optionale Die Umgebungsvariablen für die Aktion. Eingabevariablen müssen als Schlüssel/Wert-Paare eingegeben werden. Beispiel: --env mykey=myvalue. Um mehrere Umgebungsvariablen bereitzustellen, verwenden Sie mehrere Flags des Typs --env in Ihrem Befehl.
--env-file oder -E Optionale Der Pfad zu einer Datei, in der Sie alle Umgebungsvariablen für eine Aktion angegeben haben. Umgebungsvariablen müssen als Schlüssel/Wert-Paare im JSON-Format angegeben werden.
--github-token oder -g Optionale Das persönliche Zugriffstoken in GitHub, das Sie verwenden möchten, um eine Verbindung zu einem privaten GitHub-Repository herzustellen. Wenn Sie aus dem Git-Repository klonen wollen, prüfen Sie die zulässigen und blockierten Dateierweiterungen für das Klonen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--file oder -f Optionale Der Pfad zu der JSON-Nutzdatendatei, die die Definition der Aktion enthält, die Sie erstellen möchten. Weitere Informationen finden Sie unter Nutzdatendatei verwenden.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne einen interaktiven Modus auszuführen.

Beispiel

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

Nutzdatendatei verwenden

Erstellen Sie eine JSON-Datei, die die Details für die Aktion enthält, die Sie erstellen möchten, wie z. B. die ID, den Namen und die Beschreibung. Verwenden Sie anschließend die Befehlsoption --file, um Ihre Aktion anhand der Nutzdatendatei zu erstellen.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<ACTION_NAME>" ersetzen durch "testaction".

Syntax

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

Beispiel

ibmcloud schematics action create --file sample.json

Interaktiven Modus verwenden

Anstatt die Befehlsoptionen einzugeben oder eine Nutzdatendatei zu verwenden, können Sie den interaktiven Modus des Befehls verwenden, um eine Aktion zu erstellen. Die Aktion wird standardmäßig mit minimaler Benutzereingabe erstellt. Wenn Sie weitere Informationen zu Ihrer Aktion hinzufügen möchten, können Sie die Aktion zu einem späteren Zeitpunkt aktualisieren.

  1. Starten Sie den interaktiven Modus, indem Sie den Befehl ohne Befehlsoptionen ausführen.
    ibmcloud schematics action create
    
  2. Geben Sie einen Namen für Ihre Aktion ein und drücken Sie die Eingabetaste.
  3. Geben Sie die Ressourcengruppe ein, in der Sie die Aktion erstellen möchten, und drücken Sie die Eingabetaste.
  4. Geben Sie den Standort ein, an dem Sie die Aktion erstellen möchten, wie z. B. us-south, us-east, eu-de oder eu-gb. Drücken Sie anschließend die Eingabetaste. Durch den Standort wird festgelegt, wo Ihre Aktion ausgeführt und Ihre Aktionsdaten gespeichert werden. Weitere Informationen finden Sie unter Wo werden meine Informationen gespeichert?. Stellen Sie sicher, dass Sie Daten an dieser Position speichern können, da Sie die Position nach der Erstellung der Aktion nicht ändern können.
  5. Geben Sie die URL für das GitHub-Repository ein, in dem das Ansible-Playbook gespeichert ist. Drücken Sie anschließend die Eingabetaste.
  6. Geben Sie, falls zutreffend, das persönliche Zugriffstoken ein, das Sie für den Zugriff auf Ihr GitHub-Repository verwenden möchten. Drücken Sie anschließend die Eingabetaste. Wenn Sie aus dem Git-Repository klonen wollen, prüfen Sie die zulässigen und blockierten Dateierweiterungen für das Klonen.
  7. Geben Sie den Namen des Ansible-Playbooks ein, das ausgeführt werden soll, und drücken Sie die Eingabetaste.
  8. Überprüfen Sie die Details der Aktion, die für Sie erstellt wurde.

ibmcloud schematics action update

Aktualisieren Sie die Informationen einer vorhandenen Aktion mithilfe der action_id. Stellen Sie sicher, dass die Befehlszeilenschnittstelle location und der Endpunkt url auf die Region verweisen, in der Sie Ihre Arbeitsbereiche und Aktionen erstellen bzw. aktualisieren wollen. Weitere Informationen zur Position und zum Endpunkt finden Sie unter Wo werden meine Informationen gespeichert?.

Syntax

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]

Befehlsoptionen

Schematics Aktualisierungsflags für Aktionen
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID einer Aktion, die Sie aktualisieren möchten.
--name oder -n Optionale Ein neuer eindeutiger Name für Ihre Aktion.
--description oder -d Optionale Die kurze Beschreibung für eine Aktion.
--location oder -l Erforderlich Geografische Standorte, die vom Dienst IBM Cloud Schematics unterstützt werden, wie us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon.
--resource-group oder -r Erforderlich Ressourcengruppenname für eine Aktion.
--template oder -tr Optionale Die URL für das Git-Repository, in dem das Ansible-Playbook gespeichert ist.
--playbook-name oder --pn Optionale Name des Playbooks.
--github-token oder -g Optionale Das persönliche Zugriffstoken in GitHub, das Sie verwenden möchten, um eine Verbindung zu einem privaten GitHub-Repository herzustellen. Wenn Sie aus dem Git-Repository klonen wollen, prüfen Sie die zulässigen und blockierten Dateierweiterungen für das Klonen.
--credentials oder -C Optionale Der Dateipfad zu dem privaten SSH-Schlüssel, den Sie für den Zugriff auf Ihren Zielhost verwenden möchten, wie z. B. ~/.ssh/id_rsa. Der SSH-Schlüssel sollte bei Befehlszeilen- oder API-Aufrufen am Ende der Schlüsseldetails enthalten.
--credential-json oder --cj Optionale Geben Sie den Pfad der JSON-Datei an, die JSON-Nutzdaten mit Berechtigungsnachweisen für den Zugriff auf den Zielhost enthält.
--bastion oder -b Optionale Die IP-Adresse des Bastionshosts.
--bastion-credential-json oder --bj Optionale Geben Sie den Pfad der JSON-Datei an, die JSON-Nutzdaten mit Bastionsberechtigungsnachweisen für den Zugriff auf den Bastionshost enthält.
--inventory oder -y Optionale Die ID des Ressourcenbestands, den Sie in Ihrer Aktion verwenden möchten. Führen Sie ibmcloud schematics inventory list aus, um vorhandene Bestände aufzulisten.
--inventory-connection-type oder --it Optionale Typ der Bestandsverbindung. Unterstützte Werte: ssh und winrm. Die Voreinstellung ist SSH. Derzeit unterstützt WinRM nur Windows-Systeme mit der öffentlichen IPs und unterstützt keine Bastion-Hosts.
--input oder --in Optionale Die Eingabevariablen für Ihre Aktion. Eingabevariablen müssen als Schlüssel/Wert-Paare eingegeben werden. Beispiel: --input mykey=myvalue. Wenn Sie mehrere Eingabevariablen angeben möchten, verwenden Sie in Ihrem Befehl mehrere Flags des Typs --input. Sie können Ihre Eingabevariablen auch in einer Datei speichern und auf diese Datei in der Befehlsoption --input-file verweisen.
--input-file oder --if Optionale Der Pfad zu einer Datei, in der Sie alle Ihre Eingabevariablen angegeben haben. Eingabevariablen müssen als Schlüssel/Wert-Paare im JSON-Format angegeben werden.
--env oder -e Optionale Die Umgebungsvariablen für die Aktion. Eingabevariablen müssen als Schlüssel/Wert-Paare eingegeben werden. Beispiel: --env mykey=myvalue. Um mehrere Umgebungsvariablen bereitzustellen, verwenden Sie mehrere Flags des Typs --env in Ihrem Befehl.
--env-file oder -E Optionale Der Pfad zu einer Datei, in der Sie alle Umgebungsvariablen für eine Aktion angegeben haben. Umgebungsvariablen müssen als Schlüssel/Wert-Paare im JSON-Format angegeben werden.
--file oder -f Optionale Der Pfad zu der JSON-Nutzdatendatei, die die Definition der zu aktualisierenden Aktion enthält. Weitere Informationen finden Sie unter Nutzdatendatei verwenden. Beachten Sie, dass Parameter, wie z. B. der Standort oder die Ressourcengruppe, nicht aktualisiert werden können, nachdem die Aktion erstellt wurde.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne Benutzereingabeaufforderungen auszuführen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics action get

Abrufen der Details einer bestehenden Schematics Aktion wie Aktions-ID, Name, Status, Erstellungszeit, Verschlüsselungsstatus und Verschlüsselungs-CRN, einschließlich der Werte aller Eingabevariablen.

Syntax

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

Befehlsoptionen

Schematics Aktionen rufen Flags ab
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID einer Aktion, die abgerufen werden soll.
--profile oder -p Optionale Die abzurufende Informationstiefe. Unterstützte Werte: detailed und summary. Der Standardwert ist summary.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne den interaktiven Modus auszuführen.

Beispiel

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

ibmcloud schematics action list

Rufen Sie eine Liste aller Aktionen ab, die in der aktuellen Region IBM Cloud für Ihr Konto definiert sind.

Syntax

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

Befehlsoptionen

Schematics Aktionslistenflags
Flag Erforderlich / Optional Beschreibung
--limit oder -l Optionale Die maximale Anzahl der Aktionen, die Sie auflisten möchten. Die Zahl muss eine positive ganze Zahl zwischen 1 und 200 sein. Der Standardwert ist -1.
--offset oder -m Optionale Die Position der Aktion in der Liste der Aktionen, von der aus Sie Ihre Aktionen auflisten möchten. Wenn Sie zum Beispiel drei Aktionen in Ihrem Konto und Ihrer Region haben, gibt der Befehl diese Aktionen als Liste mit drei Elementen zurück. Um alle Aktionen abzurufen, müssen Sie die Positionsnummer 0 eingeben. Sollen in dieser Liste die zweite und die dritte Aktion abgerufen und die erste Aktion ausgelassen werden, müssen Sie die Positionsnummer 1 eingeben. Positionsnummer 1 stellt die zweite Position in der Liste der Aktionen dar. Negative Zahlen werden nicht unterstützt und somit ignoriert.
--profile oder -p Optionale Die zurückgegebene Informationstiefe. Unterstützte Werte: ids und summary. Der Standardwert ist summary.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

ibmcloud schematics action list --profile ids

ibmcloud schematics action delete

Löscht eine Schematics-Aktion.

Syntax

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

Befehlsoptionen

Schematics Aktionen-Flags löschen
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID einer Aktion, die gelöscht werden soll.
--force oder -f Optionale Erzwingt das Löschen ohne Benutzerbestätigung.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne Benutzereingabeaufforderungen auszuführen.

Beispiel

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

ibmcloud schematics action upload

Sie können eine Bandarchivdatei (.tar) aus Ihrem lokalen Dateisystem in eine IBM Cloud Schematics-Aktion hochladen. Geben Sie den vollständigen Pfad auf Ihrer lokalen Maschine ein, in der die .tar-Datei gespeichert ist. Erstellt die .tar-Datei Ihres Vorlagenrepositorys mithilfe des angegebenen TAR-Befehls tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER.

Syntax

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

Befehlsoptionen

Schematics-Aktionsuploadflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich ID einer Aktion, die hochgeladen werden soll.
--file oder -f Erforderlich Der Pfad der TAR-Datei, die für eine Aktion hochgeladen werden soll.
--no-prompt Optionale Legen Sie dieses Flag fest, um die interaktive Befehlszeilensitzung zu stoppen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

Aktionsjobbefehle

Überprüfen Sie die Befehle zum Erstellen, Aktualisieren, Auflisten und Löschen von Schematics Aufträgen bei der Arbeit mit Schematics Aktionen.

ibmcloud schematics job run

Erstellen Sie einen Job in IBM Cloud Schematics, um das Ansible Playbook auszuführen, das in Ihrer Schematics Aktion angegeben ist. Sie können einen Job mithilfe einer Nutzdatendatei oder des interaktiven Befehlsmodus erstellen.

Syntax

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]

Befehlsoptionen

Schematics-Jobausführungsflags
Flag Erforderlich / Optional Beschreibung
--command-object oder -c Erforderlich Der Name der Schematics-Automatisierungsressource. Derzeit wird nur action unterstützt.
--command-object-id oder -cid Erforderlich Die ID der Schematics Aktionen, bei denen Sie den Auftrag ausführen möchten.
--command-name, oder -n Erforderlich Der Befehl, den Sie für Ihre Aktion ausführen möchten. Unterstützte Werte: ansible_playbook_check und ansible_playbook_run.
--playbook-name oder -pn Optionale Der Name des Ansible-Playbooks, das Sie ausführen wollen.
--command-options oder -co Optionale Die Befehlszeilenoptionen für den Befehl.
--input oder --in Optionale Die Eingabevariablen für eine Aktion. Dieses Flag kann mehrfach gesetzt werden und muss im Format --inputs test=testvalue vorliegen.
--input-file oder --if Optionale Eingabevariablen für eine Aktion. Geben Sie den Pfad der JSON-Datei an, die die Eingabevariablen enthält.
--env oder -e Optionale Die Umgebungsvariablen für die Aktion. Dieses Flag kann mehrfach gesetzt werden und muss im Format --env-variables test=testvalue vorliegen.
--env-file oder -E Optionale Die Umgebungsvariablen für die Aktion. Geben Sie den Pfad der JSON-Datei an, die die Umgebungsvariablen enthält.
--result-format oder -f Optionale Die Ausgabe der Ergebnisantwort im JSON-Format.
--file oder -f Optionale Pfad zu der JSON-Datei, die die Definition des neuen Jobs enthält.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Wenn die Aktion den Namen des Spielbuchs enthält, müssen Sie den Namen des Spielbuchs hinzufügen, damit der Name des Spielbuchs der Aktion Vorrang hat. Wenn Sie den Namen des Playbooks durch den Job überschreiben müssen, müssen Sie eine Aktion mit dem neuen Playbook-Namen erstellen.

Nutzdatendatei verwenden

Sie können eine Nutzdatendatei bereitstellen, um bestimmte Parameter für den Befehl job run anzugeben. Anschließend übergeben Sie den Dateinamen mit der Befehlsoption --file an den Befehl.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<COMMAND_OBJECT>" ersetzen durch "action".

Syntax

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

Beispiel

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

Interaktiven Modus verwenden

Anstatt Ihre Jobdetails über Befehlsoptionen oder eine Nutzdatendatei einzugeben, können Sie den interaktiven Modus für den Befehl verwenden. In diesem Modus werden Sie aufgefordert, die erforderlichen Werte zum Erstellen eines Jobs in Schematics einzugeben.

  1. Geben Sie den Befehl zum Erstellen des Jobs ohne Befehlsoptionen ein.
    ibmcloud schematics job run
    
  2. Wenn Sie zur Eingabe des Befehlsobjekts aufgefordert werden (Enter command-object>), geben Sie action ein und drücken die Eingabetaste.
  3. Wenn Sie zur Eingabe der Befehlsobjekt-ID aufgefordert werden (Enter command-object-id>), geben Sie die Details der Aktions-ID an und drücken die Eingabetaste.
  4. Wenn Sie zur Eingabe des Befehlsnamens aufgefordert werden (Enter command-name>), geben Sie ansible_playbook_run oder ansible_playbook_check ein und drücken die Eingabetaste.
  5. Überprüfen Sie die CLI-Ausgabe für den Job, der für Sie erstellt wurde.

ibmcloud schematics job update

Erstellt einen Job, indem Sie die Einstellungen eines vorhandenen Jobs kopieren und den Job in IBM Cloud Schematics ausführen.

Syntax

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

Befehlsoptionen

Schematics-Jobaktualisierungsflags
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines vorhandenen Jobs, den Sie kopieren und erneut ausführen möchten.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Job ohne interaktive Befehlszeilensitzung zu erstellen.

Beispiel

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

ibmcloud schematics job get

Abrufen der Details eines Aktionsauftrags anhand einer Auftragskennung.

Syntax

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

Befehlsoptionen

Schematics-Jobget-Flags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID des Jobs, die abgerufen werden soll.
--profile oder -p Optionale Die abzurufende Informationstiefe. Unterstützte Werte: detailed und summary. Der Standardwert ist summary.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um Jobdetails ohne interaktive Befehlszeilensitzung abzurufen.

Beispiel

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

ibmcloud schematics job list

Abrufen einer Liste aller Schematics Aufträge, die für eine Schematics Aktion ausgeführt wurden. Der Befehl zeigt eine Liste der Aufträge an, die den Status in_progress, success oder failed haben.

Syntax

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

Befehlsoptionen

Schematics Joblistenflags
Flag Erforderlich / Optional Beschreibung
--resource-type oder -rt Erforderlich Der Name der Schematics-Ressource. Es wird nur action unterstützt.
--id oder -i Erforderlich Die ID der Schematics Aktionen, für die Sie Aufträge auflisten möchten.
--limit oder -l Optionale Die maximale Anzahl der Arbeitsbereiche, die Sie auflisten möchten. Die Zahl muss eine positive ganze Zahl zwischen 1 und 200 sein. Der Standardwert ist -1.
--offset oder -m Optionale Die Position des Jobs in der Liste der Jobs, von der aus Sie Ihre Jobs auflisten möchten. Wenn in Ihrem Konto zum Beispiel drei Jobs vorhanden sind, werden durch den Befehl die folgenden Jobs als Liste mit drei Elementen zurückgegeben. Um alle Jobs abzurufen, müssen Sie die Positionsnummer 0 eingeben. Sollen in dieser Liste der zweite und der dritte Job abgerufen und der erste Job ausgelassen werden, müssen Sie die Positionsnummer 1 eingeben. Positionsnummer 1 stellt die zweite Position in der Liste der Jobs dar. Negative Zahlen werden nicht unterstützt und somit ignoriert.
--profile oder -p Optionale Die zurückgegebene Informationstiefe. Unterstützte Werte sind ids oder summary. Der Standardwert ist summary.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--all oder -A Optionale Listet alle Jobs einschließlich der internen Schematics-Jobs auf.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Job ohne interaktive Befehlszeilensitzung zu erstellen.

Beispiel

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

ibmcloud schematics job logs

Rufen Sie die Protokolle für einen Schematics Aktionsauftrag ab. Weitere Informationen zum Anzeigen von Auftragsprotokollen finden Sie unter Überprüfen der Schematics Auftragsdetails.

Syntax

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

Befehlsoptionen

Schematics Jobprotokollflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID des Jobs, für den Sie detaillierte Protokolle abrufen möchten.
--log-prefix oder --lp Optionale Fügt das Präfix des Befehls hinzu, der in den Jobprotokollen ausgeführt wird.
--log-header oder --lh Optionale Wird verwendet, um Befehlsheader in den Jobprotokollen in das Schematics-Format zu konvertieren.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne interaktive Befehlszeilensitzung auszuführen.

Beispiel

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

ibmcloud schematics job delete

Löscht einen Job für eine Schematics-Aktion.

Sie können einen aktiven Job nicht löschen oder stoppen. Um einen Job zu entfernen, müssen Sie warten, bis der Job abgeschlossen ist.

Syntax

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

Befehlsoptionen

Schematics Joblöschflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID des Jobs, den Sie löschen möchten.
--force oder -f Optionale Zum Erzwingen der Löschung ohne Benutzerbestätigung.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne interaktive Befehlszeilensitzung auszuführen.

Beispiel

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

Agentenbefehle

ibmcloud schematics agent create

Erstellen Sie eine Agentenregistrierung in der aktuell ausgewählten Region Schematics. Agenten helfen Ihnen, Ihre Terraform- oder Ansible-Aufträge in Ihrer Infrastruktur auszuführen. Weitere Informationen zu den Schritten für die Verwendung des Erstellungsbefehls finden Sie unter Agenten implementieren.

Syntax

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]

Befehlsoptionen

Schematics Flags für Agentenerstellung
Flag Erforderlich / Optional Beschreibung
--name oder -n Erforderlich Der eindeutige Name eines Agenten. Muss eine Beschreibung der Agentenrolle, Position und Verwendung enthalten.
--location oder -l Erforderlich Der Schematics Standort, an dem der Agent definiert ist, us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon. Die Aufträge werden an diesem Ort zur Ausführung abgeholt.
--agent-location oder --al Erforderlich Eine beschreibende benutzerdefinierte Bezeichnung, die angibt, wo der Agent in der Benutzerumgebung implementiert wird. Dies kann eine Cloudregion oder ein Benutzerrechenzentrum sein. Beispiel: London MZR.
--cluster-id oder -c Erforderlich Die ID des Kubernetes Clusters für die Bereitstellung eines Agenten.
--cluster-resource-group oder --cg Erforderlich Der Name der Ressourcengruppe des Clusters.
--cos-instance-name oder --on Erforderlich Der Name der COS-Instanz.
--cos-bucket oder -b Erforderlich Die ID oder der Name des COS-Eimers.
--cos-location oder --ol Erforderlich Die Position des COS-Buckets Unterstützte Formate sind eu-gb, us-south usw.
--resource-group oder -g Erforderlich Der Name oder die ID der Ressourcengruppe, der der Agent zugeordnet ist.
--version oder -v Erforderlich Eine benutzerdefinierte Bezeichnung, die die Version des Agenten angibt Beispiel v1.0.0
--infra-type oder -i Erforderlich Geben Sie den Typ der Infrastruktur des Zielagenten an. Unterstützte Werte sind ibm-kubernetes, ibm-openshift und ibm-satellite.
--description oder -d Optionale Eine Beschreibung, die die Agentennutzung sowie die Netzzonen und Ressourcen angibt, auf die der Agent zugreifen kann.
--tags oder -t Optionale Agententags. Sie können das Flag mehrmals wiederholen. Tags ermöglichen eine schnellere und einfachere Suche nach agentenbezogenen Ressourcen
--metadata oder --md Optionale Metadaten des Agenten. Sie können das Flag mehrmals verwenden. Beispiel: git:private-git.github.com oder git:gitlab.com. Wenn nicht eingestellt, ist der Standardwert git:github.com.
--validate Optionale Führen Sie „validate“ nach der Erstellung des Agenten aus.
--deploy Optionale Führen Sie die Bereitstellung ohne Validierung nach der Erstellung des Agenten aus.
--file oder f Optionale Pfad zu einer Datei JSON, die die Definition eines Agenten enthält.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

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

Einen Agenten deinstallieren. Weitere Informationen zu den Schritten für die Verwendung des Löschbefehls finden Sie im Abschnitt Agenten löschen.

Syntax

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

Befehlsoptionen

Schematics Flags zum Löschen von Agenten
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--force oder -f Optionale Die Zwangsmaßnahme ohne Bestätigung. Setzen Sie den Parameter --force auf true, um alle Agentenabläufe zu löschen, damit sie parallel zum Löschablauf im Arbeitsbereich gelöscht werden. Dieser Parameter ist standardmäßig auf false gesetzt.

Beispiel

ibmcloud schematics agent delete --id <AGENT_ID>

ibmcloud schematics agent deploy

Verteilen oder aktualisieren Sie einen Agenten, um die Verteilung zu erzwingen. Weitere Informationen zu den Schritten für die Verwendung des Bereitstellungsbefehls finden Sie unter Agenten implementieren.

Syntax

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

Befehlsoptionen

Schematics Agentenbereitstellungsflags
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--force-redeploy oder -fd Optionale Erneute Implementierung eines Agenten erzwingen.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics agent deploy --id <AGENT_ID>

ibmcloud schematics agent destroy

Die Zerstörung eines Agenten zerstört die Cloud-Ressourcen, die mit der Bereitstellung des Schematics-Agenten verbunden sind.

Syntax

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

Befehlsoptionen

Schematics Löschmarkierungen des Agenten
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--force oder -f Optionale Die Zwangsmaßnahme ohne Bestätigung.

Beispiel

ibmcloud schematics agent destroy --id <AGENT_ID>

ibmcloud schematics agent get

Rufen Sie die Details eines vorhandenen Agenten ab, z. B. Agenten-ID, Name, Status, Version, Erstellungszeit, Verschlüsselungsstatus und Verschlüsselungs-CRN, einschließlich der Werte aller Eingabevariablen. Weitere Informationen zu den Schritten zur Verwendung des Befehls "get" finden Sie unter "Anzeigen eines Agenten "

Syntax

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

Befehlsoptionen

Schematics Agent-Flags abrufen
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics agent get --id <AGENT_ID>

ibmcloud schematics agent health

Führt die Validierung eines Agenten nach der Implementierung durch Weitere Informationen zu den Schritten für die Verwendung des Befehls 'agent health' finden Sie im Abschnitt Agentenstatus überwachen.

Syntax

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

Befehlsoptionen

Schematics Statusflags für Agenten
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics agent health --id <AGENT_ID>

ibmcloud schematics agent list

Listet die in der aktuellen Schematics-Region definierten Agenten auf. Weitere Informationen zu den Schritten für die Verwendung des Befehls 'list' finden Sie unter Agenten anzeigen.

Syntax

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

Befehlsoptionen

Schematics Agentenlistenflags
Flag Erforderlich / Optional Beschreibung
--location oder -l Optionale Geografische Standorte, die vom Dienst IBM Cloud Schematics unterstützt werden, wie us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon.
--limit oder -lm Optionale Maximale Anzahl der aufzulistenden Agenten. Wird ignoriert, wenn eine negative Zahl festgelegt ist. Die Höchstgrenze liegt bei 200 (Standard ist -1).
--offset oder -m Optionale Offset in der Liste. Wird ignoriert, wenn eine negative Zahl eingestellt ist (Standard: -1)).
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics agent list --location us-south

ibmcloud schematics agent update

Agentenkonfiguration aktualisieren. Die Aktualisierung eines Agenten führt nicht zu einer erneuten Validierung oder Bereitstellung des Agenten. Weitere Informationen zu den Schritten für die Verwendung des Agentenaktualisierungsbefehls finden Sie unter Agenten implementieren.

Syntax

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

Befehlsoptionen

Schematics Flags für Agentenaktualisierung
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID eines Agenten.
--tags oder -t Optionale Agententags. Diese Markierung kann mehrfach verwendet werden und beschleunigt die Suche nach agentenbezogenen Ressourcen.
--description oder -d Optionale Kurze Beschreibung eines Agenten.
--version value oder -v Optionale Geben Sie die Version eines Agenten an. Standardmäßig ist die neueste Version verfügbar.
--metadata Optionale Metadaten des Agenten. Sie können das Flag mehrmals verwenden. Beispiel: git:private-git.github.com oder git:gitlab.com. Wenn nicht eingestellt, ist der Standardwert git:github.com.
--file oder -f Optionale Pfad zu der Datei JSON, die die Definition des Agenten enthält.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um einen Bestand ohne interaktive Befehlszeilensitzung zu aktualisieren.

Beispiel

ibmcloud schematics agent update --id <AGENT_ID>

ibmcloud schematics agent validate

Überprüft die Prüfung der Voraussetzungen, die einen Agenten und eine Clusterkonfiguration vor der Implementierung analysiert. Weitere Informationen zu den Schritten für die Verwendung des Validierungsbefehls finden Sie unter Agenten implementieren.

Syntax

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

Befehlsoptionen

Schematics Markierungen für Agentenvalidierung
Flag Erforderlich / Optional Beschreibung
--id Erforderlich Die ID des Agenten.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics agent validate --id AGENT_ID

Befehle für Agentenrichtlinien

Schematics (Zuweisungs-)Richtlinien teilen Schematics mit, welcher Agent für die Ausführung von Arbeitsbereichs- und Aktionsaufträgen in einer bestimmten Netzwerkzone verwendet werden soll. Jedem Agenten ist mindestens eine Richtlinie zugeordnet, um die am Standort des Agenten auszuführenden Aufgaben zu bestimmen. Siehe Zuordnungsrichtlinien.

ibmcloud schematics policy create

Erstellen Sie eine Richtlinie, indem Sie unter Schematics ein oder mehrere Schematics Objekte, wie z. B. einen Arbeitsbereich oder eine Aktion, auswählen, die auf dem Zielagenten ausgeführt werden sollen.

Syntax

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]

Befehlsoptionen

Schematics Flags für Richtlinienerstellung
Flag Erforderlich / Optional Beschreibung
--name oder -n Erforderlich Der eindeutige Name der Richtlinie.
--kind oder -K Erforderlich Richtlinientyp zum Verwalten und Ableiten von Richtlinienentscheidungen. Unterstützt wird agent_assignment_policy.
--location oder -l Optionale Geografischer Standort des Schematics Dienstes, in dem der Agent definiert ist. Zum Beispiel us-south, us-east, eu-de, eu-gb, ca-tor, oder ca-mon. Jobs von diesem Standort werden zur Verarbeitung abgerufen.
--resource-group oder -r Erforderlich Name oder ID der Ressourcengruppe für die Richtlinie.
--target-file oder tf Optionale Der Pfad zur JSON-Datei mit der Definition der Richtlinie.
--description oder -d Optionale Die Beschreibung der Politik Schematics.
--tags oder -t Optionale Tags können mehrfach verwendet werden, um Agentenrichtlinien schneller zu suchen und zu suchen.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Nutzdatendatei verwenden

Sie können eine Nutzdatendatei bereitstellen, um bestimmte Parameter für den Befehl policy create anzugeben. Anschließend übergeben Sie den Dateinamen mit der Befehlsoption --target-file an den Befehl.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<SELECTOR_KIND>" ersetzen durch "ids".

Syntax

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

Beispiel

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

Beispiel

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

Löschen Sie eine Schematics Richtlinie.

Syntax

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

Befehlsoptionen

Schematics Flags für Richtlinienlöschung
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID der Police.
--force oder -f Optionale Die Zwangsmaßnahme ohne Bestätigung.

Beispiel

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

ibmcloud schematics policy get

Abrufen der Details einer bestehenden Schematics Richtlinie anhand der Richtlinien-ID.

Syntax

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

Befehlsoptionen

Schematics-Richtlinienget-Flags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID der Richtlinie.
--profile oder -p Optionale Ebene der zurückzugebenden Details. Gültige Werte sind summary, detailed, oder ids. Die Standardeinstellung ist summary.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

ibmcloud schematics policy get --id <POLICY_ID>

ibmcloud schematics policy list

Rufen Sie eine Liste aller Policen in der Region IBM Cloud für Ihr Konto ab.

Syntax

ibmcloud schematics policy list [--profile PROFILE] [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]
Schematics Richtlinienlistenflags
Flag Erforderlich / Optional Beschreibung
--profile oder -r Optionale Die Ebene der Details, die zurückgegeben werden sollen. Gültige Werte sind summary, detailed und ids. Die Standardeinstellung ist summary.
--limit oder -l Optionale Maximale Anzahl der aufzulistenden Policen. Wird ignoriert, wenn eine negative Zahl festgelegt ist. Die Zahl muss eine positive ganze Zahl zwischen 1 und 200 sein. Der Standardwert ist -1.
--offsetoder -m Optionale Offset in der Liste. Wird ignoriert, wenn eine negative Zahl festgelegt ist. Der Standardwert ist -1.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

ibmcloud schematics policy list  --profile ids092030

ibmcloud schematics policy update

Aktualisiert eine vorhandene Richtlinie mithilfe der Richtlinien-ID.

Syntax

ibmcloud schematics policy update --id POLICY_ID [--kind POLICY_KIND] [--description DESCRIPTION] [--resource-group RESOURCE_GROUP] [--tags TAGS] [--file FILE] [--output OUTPUT]
Schematics Flags für Richtlinienaktualisierung
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID der Richtlinie.
--kind oder -k Optionale Richtlinientyp zum Verwalten und Ableiten von Richtlinienentscheidungen. Unterstützt wird agent_assignment_policy.
--description oder -d Optionale Die Beschreibung der Schematics Anpassungspolitik.
--resource-group oder -r Optionale Name oder ID der Ressourcengruppe für die Richtlinie.
--tags oder -t Optionale Richtlinientags. Dieses Flag kann mehrfach verwendet werden, um Agentenrichtlinien schneller zu suchen.
--file oder -f Optionale Pfad zu der Datei JSON, die die Definition der Richtlinie enthält.
--output oder -o Optionale Geben Sie das Ausgabeformat an, nur JSON wird unterstützt.

Beispiel

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

BYOK- oder KYOK-Befehle konfigurieren

Sie können Ihre Verschlüsselungsschlüssel von IBM Key Protect (verfügbar als Multi-Tenant für BYOK oder Dedicated für KYOK) verwenden, um Ihre in Schematics gespeicherten Daten zu verschlüsseln und zu sichern. Weitere Informationen über den Schutz sensibler Daten in Schematics finden Sie unter Schutz Ihrer sensiblen Daten in Schematics.

Hyper Protect Crypto Services (HPCS) wurde für neue Integrationen veraltet. Bestehende HPCS-Integrationen werden weiterhin funktionieren, aber neue Integrationen mit HPCS werden nicht mehr unterstützt. Für neue Integrationen verwenden Sie Key Protect Dedicated for KYOK capabilities.

Vorbereitende Schritte

Die folgenden Voraussetzungen müssen erfüllt sein, damit das Schlüsselverwaltungssystem die Instanzen auflistet, die von Ihrem spezifischen Standort und Ihrer Region aus erstellt werden.

Die Festlegung der Einstellungen für den Schlüsselmanagementservice (KMS) erfolgt einmalig. Sie müssen ein Support-Ticket öffnen, um die KMS-Einstellungen zu aktualisieren.

ibmcloud schematics kms instance ls

Listet alle KMS-Instanzen Ihres IBM Cloud-Kontos zur Ermittlung Ihres Produkts Key Protect oder Hyper Protect Crypto Services unter Verwendung des Standorts ('location'), an dem Schlüssel erstellt wurden, und des Verschlüsselungsschemas ('scheme') wie KYOK oder BYOK auf.

Syntax

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

Befehlsoptionen

Schematics KMS-Listenflags
Flag Erforderlich / Optional Beschreibung
--location oder -l Erforderlich Legen Sie den Schematics-Standortnamen fest. Unterstützte Werte: US und EU.
--scheme oder -s Erforderlich Geben Sie das Verschlüsselungsschema an. Unterstützte Werte: KYOK und BYOK.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics kms enable

Aktiviert den Schlüsselmanagementservice (KMS) für die Verschlüsselung Ihrer Daten an dem bestimmten Standort. Weitere Informationen zur Aktivierung von kundenverwalteten Schlüsseln für Schematics finden Sie unter Aktivierung von Schlüsseln.

Aktualisieren Sie die KMS-Einstellungen für Ihren Standort, indem Sie Ihren privaten Endpunkt, den CRN (Cloudressourcenname), primären CRK (Kundenrootschlüssel) und den sekundären CRK verwenden. Beachten Sie, dass Sie die KMS-Einstellungen nur einmal aktualisieren können. Wenn Sie zum Beispiel einen API-Endpunkt für eine Ländergruppe (Geografie) wie North America verwenden, werden nur die KMS-Instanzen abgerufen, die in us-south oder us-east erstellt wurden.

Syntax

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]

Befehlsoptionen

Schematics KMS-Aktivierungsflags
Flag Erforderlich / Optional Beschreibung
--location oder -l Erforderlich Legen Sie den Schematics-Standortnamen fest. Unterstützte Werte: US und EU.
--scheme oder -s Erforderlich Geben Sie das Verschlüsselungsschema an. Unterstützte Werte: KYOK und BYOK.
--group oder -g Erforderlich Geben Sie den Ressourcengruppennamen an. Standardwert: Default.
--primary_name oder --pn Erforderlich Geben Sie den primären KMS-Namen an.
--primary_crn oder --pc Erforderlich Geben Sie den Cloudressourcennamen (CRN) für den primären Schlüssel an.
--primary_endpoint oder --pe Erforderlich Geben Sie den privaten Endpunkt für das private KMS an.
--secondary_name oder --sn Optionale Geben Sie den Namen des sekundären KMS an.
--secondary_crn oder --sc Optionale Geben Sie den Cloudressourcennamen (CRN) für den sekundären Schlüssel an.
--secondary_endpoint oder --se Optionale Geben Sie den privaten Endpunkt für das sekundäre KMS an.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

Ruft das Schlüsselmanagementsystem (KMS) über den API-Endpunkt ab, an dem sich Ihr KYOK oder BYOK befindet. Wenn Sie zum Beispiel einen API-Endpunkt für eine Ländergruppe (Geografie) wie North America verwenden, werden nur die KMS-Instanzen abgerufen, die in us-south oder us-east erstellt wurden. Beachten Sie, dass Sie kms instances in Ihrem Konto aktivieren müssen, um die Befehlszeile info auszuführen.

Syntax

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

Befehlsoptionen

Schematics Flags für KMS-Informationen
Flag Erforderlich / Optional Beschreibung
--location oder -l Erforderlich Legen Sie den Schematics-Standortnamen fest. Unterstützte Werte: US und EU.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

ibmcloud schematics kms info -l US

Allgemeine Befehle

Verwenden Sie diese allgemeinen Befehle, um Hilfe und Versionsinformationen zum Plug-in der IBM Cloud Schematics-Befehlszeile zu suchen.

ibmcloud schematics help

Zeigt die unterstützten IBM Cloud Schematics-Befehlszeilenbefehle an.

Syntax

ibmcloud schematics help

Befehlsoptionen

Schematics Hilfe-Flags
Flag Erforderlich / Optional Beschreibung
--help oder -h Erforderlich Listet die unterstützten Befehle auf.
command Optionale Geben Sie den Namen des Befehls an, um die Befehlsdetails abzurufen.

Beispiel

ibmcloud schematics help

ibmcloud schematics version

Listen Sie die Versionen aller unterstützten Open-Source-Projekte in Schematics auf, z. B. IBM Cloud Provider Plug-in for Terraform, Ansible, Helm und Kubernetes, die zur Ausführung von Schematics Aktionen auf Cloud-Ressourcen verwendet werden.

Syntax

ibmcloud schematics version [--output OUTPUT]

Befehlsoptionen

Schematics Versionsflags
Flag Erforderlich / Optional Beschreibung
--output oder -o Optionale Gibt die CLI-Ausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

Bestandsbefehle

Überprüfen Sie die Befehle zum Erstellen, Aktualisieren, Auflisten, Löschen und Arbeiten mit Ihren IBM Cloud Schematics Beständen, die mit Schematics Aktionen verwendet werden.

ibmcloud schematics inventory create

Um ein Ressourceninventar in Schematics zur Verwendung mit einer Ansible Aktion zu erstellen, können Sie entweder eine Nutzlastdatei oder den interaktiven Modus verwenden. Das Inventar umfasst alle Zielhosts, auf denen Sie Ihr Ansible Playbook ausführen möchten.

Syntax

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]

Befehlsoptionen

Schematics-Flags für Bestandserstellung
Flag Erforderlich / Optional Beschreibung
--name oder -n Erforderlich Der eindeutige Name eines Ressourcenbestands.
--description oder -d Optionale Die kurze Beschreibung eines Bestands.
--location oder -l Optionale Der Ort, an dem Sie Ihren Ressourcenbestand speichern möchten, z. B. us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon.
resource-group oder -r Optionale Der Name der Ressourcengruppe, in der die Aktion erstellt werden soll.
--connection-type oder --ct Optionale Typ einer Bestandsverbindung. Unterstützt sowohl ssh als auch winrm.
--bastion-ip-address oder -b Optionale Geben Sie die IP-Adresse des Bastion-Hosts ein.
--bastion-credential-json oder --bj Optionale Geben Sie den Pfad der JSON-Datei an, die die Nutzdaten der Bastion-Anmeldeinformationen für den Zugriff auf den Bastion-Host enthält.
--credential-json oder --cj Optionale Geben Sie den JSON-Dateipfad an, der den gemeinsamen Nutzdateninhalt für den Zugriff auf Zielhosts enthält. Die Hierarchie der Berechtigungsnachweise in Schematics folgt dieser Reihenfolge: Berechtigungsnachweise auf Host-Ebene (höchste Priorität), Berechtigungsnachweise auf Gruppenebene (nächste Priorität) und allgemeine Berechtigungsnachweise (niedrigste Priorität).
--inventory-view-json oder --inv Optionale Pfad zur JSON-Datei, die die Hostdetails enthält. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--inventories-ini-file oder -y Optionale Der Dateipfad zu der Ressourcenbestandsdatei, in der Sie alle Zielhosts angegeben haben. Die Ressourcenbestandsdatei muss im INI-Format angegeben werden. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--resource-query Optionale Geben Sie die ID einer Ressourcenabfrage ein, die Sie erstellt haben. Eine Ressourcenabfrage hilft beim dynamischen Aufbau Ihres Ressourceninventars unter Verwendung der Cloud-Ressourcen, die Sie mit einem Schematics Arbeitsbereich erstellt haben. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--file oder -f Optionale Der Pfad zu der JSON-Datei, in der Sie den Ressourcenbestand angegeben haben, den Sie erstellen möchten.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um einen Bestand ohne interaktive Befehlszeilensitzung zu erstellen.

Nutzdatendatei verwenden

Sie können eine Nutzdatendatei bereitstellen, um bestimmte Parameter für den Befehl inventory create anzugeben. Anschließend übergeben Sie den Dateinamen mit der Befehlsoption --file an den Befehl.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<INVENTORY_NAME>" ersetzen durch "myinventory".

Syntax für eine 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Syntax für eine 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
            }
        }
    ]
}

Syntax für eine bastion_credentials_example.json

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

}
ibmcloud schematics inventory create --file inventory.json

Interaktiven Modus verwenden

Anstatt Ihre Details für den Bestand über Befehlsoptionen oder eine Nutzdatendatei einzugeben, können Sie auch den interaktiven Modus für den Befehl verwenden. In diesem Modus werden Sie aufgefordert, die erforderlichen Werte zum Erstellen eines Bestands in Schematics einzugeben.

  1. Geben Sie den Befehl zum Erstellen des Bestands ohne Befehlsoptionen ein.

    ibmcloud schematics inventory create ....
    
  2. Geben Sie einen Namen für den Bestand ein und drücken Sie die Eingabetaste.

  3. Geben Sie die Ressourcengruppe ein, in der Sie den Bestand erstellen möchten, und drücken Sie die Eingabetaste.

  4. Geben Sie den Ort ein, an dem Sie das Inventar erstellen möchten, z. B. us-south, us-east, eu-de oder eu-gb. Drücken Sie anschließend die Eingabetaste.

  5. Überprüfen Sie die Details zu dem erstellten Bestand.

Beispiel

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

Löschen Sie die Ressourcenbestandsdefinition mit der Bestands-ID.

Syntax

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

Befehlsoptionen

Schematics Markierungen für Bestandslöschung
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID eines Bestands, den Sie löschen möchten.
--force oder -f Optionale Erzwingt das Löschen ohne Benutzerbestätigung.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne Benutzereingabeaufforderungen auszuführen.

Beispiel

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

ibmcloud schematics inventory get

Abrufen detaillierter Informationen über ein vorhandenes IBM Cloud Schematics Inventar unter Verwendung der Inventar-ID.

Syntax

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

Befehlsoptionen

Schematics Flags zum Abrufen des Bestands
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID des Ressourcenbestands, für den detaillierte Informationen aufgelistet werden sollen.
--profile oder -p Optionale Die abzurufende Informationstiefe. Unterstützte Werte: detailed und summary. Der Standardwert ist summary.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um Details eines Bestands ohne interaktive Befehlszeilensitzung abzurufen.

Beispiel

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

ibmcloud schematics inventory list

Rufen Sie eine Liste aller Schematics Bestände in der aktuellen Region für Ihr Konto ab.

Syntax

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

Befehlsoptionen

Schematics Joblistenflags
Flag Erforderlich / Optional Beschreibung
--limit oder -l Optionale Die maximale Anzahl der Bestände, die Sie auflisten möchten. Die Zahl muss eine positive ganze Zahl zwischen 1 und 200 sein. Der Standardwert ist -1.
--offset oder -m Optionale Die Position der Bestände in der Liste der Bestände. Wenn in Ihrem Konto zum Beispiel drei Bestände vorhanden sind, werden durch den Befehl die folgenden Bestände als Liste mit drei Elementen zurückgegeben. Wenn Sie einen bestimmten Bestand in dieser Liste anzeigen möchten, müssen Sie die Positionsnummer eingeben, die der Bestand in der Liste aufweist. Geben Sie 0 ein, um den ersten Bestand in der Liste aufzulisten. Geben Sie 1 ein, um den zweiten Bestand aufzulisten usw. Negative Zahlen werden nicht unterstützt und somit ignoriert. Der Standardwert ist -1.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.

Beispiel

ibmcloud schematics inventory list --output json

ibmcloud schematics inventory update

Aktualisierung eines bestehenden Ressourceninventars.

Syntax

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]

Befehlsoptionen

Schematics Markierungen für Bestandsaktualisierung
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Geben Sie die ID eines Ressourcenbestands ein, den Sie aktualisieren möchten.
--name oder -n Erforderlich Der eindeutige Name des Bestands.
--description oder -d Optionale Die kurze Beschreibung eines Bestands.
--location oder -l Optionale Die vom Dienst IBM Cloud Schematics unterstützten geografischen Standorte, wie us-south, us-east, eu-de, eu-gb, ca-tor oder ca-mon.
resource-group oder -r Optionale Der Name der Ressourcengruppe für eine Aktion.
--connection-type oder --ct Optionale Typ einer Bestandsverbindung. Unterstützt sowohl ssh als auch winrm.
--bastion-ip-address oder -b Optionale Geben Sie die IP-Adresse des Bastion-Hosts ein.
--bastion-credential-json oder --bj Optionale Geben Sie den Pfad der JSON-Datei an, die die Nutzdaten der Bastion-Anmeldeinformationen für den Zugriff auf den Bastion-Host enthält.
--credential-json oder --cj Optionale Geben Sie den JSON-Dateipfad an, der den gemeinsamen Nutzdateninhalt für den Zugriff auf Zielhosts enthält. Die Hierarchie der Berechtigungsnachweise in Schematics folgt dieser Reihenfolge: Berechtigungsnachweise auf Host-Ebene (höchste Priorität), Berechtigungsnachweise auf Gruppenebene (nächste Priorität) und allgemeine Berechtigungsnachweise (niedrigste Priorität).
--inventory-view-json oder --inv Optionale Pfad zur JSON-Datei, die die Hostdetails enthält. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--inventories-ini-file oder -y Optionale Der Dateipfad der INI-Formatdatei, die die Hostdetails enthält. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--resource-query Optionale Geben Sie die ID einer Ressourcenabfrage ein, die Sie erstellt haben. Eine Ressourcenabfrage hilft beim dynamischen Aufbau Ihres Ressourceninventars unter Verwendung der Cloud-Ressourcen, die Sie mit einem Schematics Arbeitsbereich erstellt haben. Sie müssen entweder den Dateipfad --inventories-ini-file, die ID --resource-query oder --inventory-view-json übergeben, damit die Inventur die Zielhostdetails verwenden kann. Die Angabe von zwei oder allen drei Argumenten muss zu einem Fehler führen.
--file oder -f Optionale Der Pfad zu der JSON-Datei, die die Definition eines Bestands enthält.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um einen Bestand ohne interaktive Befehlszeilensitzung zu aktualisieren.

Nutzdatendatei verwenden

Sie können eine Nutzdatendatei bereitstellen, um bestimmte Parameter für den Befehl inventory update anzugeben. Anschließend übergeben Sie den Dateinamen mit der Befehlsoption --file an den Befehl.

Syntax für eine 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Beispiel

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

Abfragebefehle für Bestandsressourcen

Dynamische Erstellung von Ressourcenbeständen für Aktionen mithilfe von Ressourcenabfragen. Mit Hilfe von Ressourcenabfragen können Sie Informationen über den Zielhost aus Schematics Arbeitsbereichen abrufen. Weitere Informationen zu Ressourcenabfragen und Bedingungen finden Sie unter Erstellen von Ressourceninventaren für Schematics Aktionen.

ibmcloud schematics resource query create

Erstellt eine Ressourcenabfrage in IBM Cloud Schematics, die Sie verwenden können, um den Ressourcenbestand zu erstellen. Sie können eine Ressourcenabfrage mithilfe einer Nutzdatendatei oder des interaktiven Befehlsmodus erstellen. Sie können Ressourcenbedingungen mithilfe von Ressourcenabfragen generieren.

Syntax

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]

Befehlsoptionen

Schematics Erstellungsflags für Ressourcenabfrage
Flag Erforderlich / Optional Beschreibung
--name oder -n Erforderlich Der eindeutige Name für eine Ressourcenabfrage.
--type oder -t Optionale Der Typ der Ressource, die abgerufen werden soll. Unterstützte Werte sind vsi.
--query-file oder -f Optionale Der Pfad zu der JSON-Datei, in der Sie die Details Ihrer Ressourcenabfrage angegeben haben. Eine Liste der unterstützten Abfragen finden Sie in Unterstützte Ressourcenabfragen.
--file oder -f Optionale Der Pfad zu der JSON-Datei, in der die Details der Ressourcenabfrage angegeben sind, die Sie erstellen möchten.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um die Ressourcenabfrage ohne interaktive Befehlszeilensitzung zu erstellen.

Nutzdatendatei verwenden

Sie können eine Nutzdatendatei bereitstellen, um bestimmte Parameter für den Befehl resource_query create anzugeben. Anschließend übergeben Sie den Dateinamen mit der Befehlsoption --file an den Befehl. Eine Liste der unterstützten Ressourcenabfragen finden Sie in Unterstützte Ressourcenabfragen.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<WORKSPACE_ID" ersetzen durch us-east.workspace.ID1231.

Syntax

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

Beispiel

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

Interaktiven Modus verwenden

Anstatt Ihre Details für die Ressourcenabfrage über die Befehlsoptionen oder eine Nutzdatendatei einzugeben, können Sie den interaktiven Modus für den Befehl verwenden. In diesem Modus werden Sie aufgefordert, die erforderlichen Werte zum Erstellen einer Ressourcenabfrage in Schematics einzugeben. Sie können Ressourcenbedingungen mithilfe von Ressourcenabfragen generieren.

  1. Geben Sie den Befehl zum Erstellen der Ressourcenabfrage ohne Befehlsoptionen ein.
    ibmcloud schematics resource-query create
    
  2. Geben Sie einen Namen für Ihre Ressourcenabfrage ein und drücken Sie die Eingabetaste.
  3. Geben Sie den Pfad zu Ihrer Nutzdatendatei ein. Eine Beispielnutzdatendatei finden Sie im Abschnitt Nutzdatendatei verwenden. Drücken Sie anschließend die Eingabetaste.
  4. Überprüfen Sie die Details der Ressourcenabfrage, die für Sie erstellt wurde.

ibmcloud schematics resource query delete

Löscht die Ressourcenabfragedefinition unter Verwendung der Ressourcenabfrage-ID aus dem IBM Cloud Schematics-Service. Beachten Sie, dass Sie den Standort/die Region der Ressourcengruppe löschen können, aus der Ihr Bestand erstellt wurde. Stellen Sie außerdem sicher, dass sich Ihre IP-Adressen in der Zulassungsliste befinden.

Syntax

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

Befehlsoptionen

Schematics Löschmarkierungen für Ressourcenabfrage
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID einer Ressourcenabfrage, die gelöscht werden soll.
--force oder -f Optionale Erzwingt das Löschen ohne Benutzerbestätigung.
--no-prompt Optionale Legen Sie dieses Flag fest, um den Befehl ohne Benutzereingabeaufforderungen auszuführen.

Beispiel

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

ibmcloud schematics resource query get

Ruft die Informationen einer vorhandenen IBM Cloud Schematics-Ressourcenabfrage unter Verwendung einer Ressourcenabfrage ab.

Syntax

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

Befehlsoptionen

Schematics-Flags für Ressourcenabfrage
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID der Ressourcenabfrage, die abgerufen werden soll.
--profile oder -p Optionale Die abzurufende Informationstiefe. Unterstützte Werte: detailed und summary. Der Standardwert ist summary.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um eine Ressourcenabfrage ohne interaktive Befehlszeilensitzung abzurufen.

Beispiel

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

ibmcloud schematics resource query list

Rufen Sie eine Liste aller Schematics Ressourcenabfragen in der aktuellen Region für Ihr Konto ab.

Syntax

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

Befehlsoptionen

Schematics-Ressourcenabfragelistenflags
Flag Erforderlich / Optional Beschreibung
--limit oder -l Optionale Die maximale Anzahl der Ressourcenabfragen, die Sie auflisten möchten. Die Zahl muss eine positive ganze Zahl zwischen 1 und 200 sein. Der Standardwert ist -1.
--offset oder -m Optionale Die Position der Ressourcenabfrage in der Liste der Ressourcenabfragen. Wenn in Ihrem Konto zum Beispiel drei Ressourcenabfragen vorhanden sind, werden durch den Befehl die folgenden Ressourcenabfragen als Liste mit drei Elementen zurückgegeben. Wenn Sie einen bestimmte Ressourcenabfrage in dieser Liste anzeigen möchten, müssen Sie die Positionsnummer eingeben, die die Ressourcenabfrage in der Liste aufweist. Geben Sie 0 ein, um die erste Ressourcenabfrage in der Liste aufzulisten. Geben Sie 1 ein, um die zweite Ressourcenabfrage aufzulisten usw. Negative Zahlen werden nicht unterstützt und somit ignoriert. Der Standardwert ist -1.
--output oder -o Optionale Geben Sie das Ausgabeformat an. Nur das Format JSON wird unterstützt.

Beispiel

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

ibmcloud schematics resource query update

Bei der Aktualisierung oder Ersetzung einer Ressourcenabfrage wird eine Kopie der Ressourcenabfrage erstellt und eine vorhandene Ressourcenabfrage wird neu gestartet, indem die Informationen einer vorhandenen IBM Cloud Schematics-Ressourcenabfrage aktualisiert werden.

Syntax

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]

Befehlsoptionen

Schematics Aktualisierungsflags für Ressourcenabfrage
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID der Ressourcenabfrage.
--name oder -n Erforderlich Der eindeutige Name für eine Ressourcenabfrage.
--type oder -t Optionale Der Typ der Ressourcenabfrage, z. B. vsi.
--query-file oder -f Optionale Der Pfad zu der JSON-Datei, die Abfragen enthält.
--file oder -f Optionale Der Pfad zu der JSON-Datei, die die Definition eines Bestands enthält.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--no-prompt Optionale Legen Sie dieses Flag fest, um die Ressourcenabfrage ohne interaktive Befehlszeilensitzung zu erstellen.

Beispiel

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

Arbeitsbereichsbefehle

Sehen Sie sich die Befehle an, mit denen Sie Ihren IBM Cloud Schematics Arbeitsbereich erstellen und bearbeiten können.

ibmcloud schematics workspace action

Abrufen aller Aktivitäten (Aufträge) für einen Arbeitsbereich, einschließlich der Benutzer-ID der Person, die die Aktion ausgelöst hat, des Status und eines Zeitstempels.

Wenn Sie einen Terraform-Ausführungsplan erstellen oder Ihre Terraform-Vorlage mit Schematics anwenden, wird automatisch eine Schematics Aktion erstellt und eine Aktions-ID zugewiesen. Sie können die Aktions-ID verwenden, um die Protokolle dieser Aktion mithilfe des Befehls ibmcloud schematics logs abzurufen.

Syntax

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

Befehlsoptionen

Schematics-Arbeitsbereichsausführungsflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, für den Sie Arbeitsbereichsaktivitäten abrufen möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--act-id oder -a Optionale Geben Sie die ID einer Aktion ein, die abgerufen werden soll.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

ibmcloud schematics workspace action --id <WORKSPACE_ID>

ibmcloud schematics workspace delete

Löscht einen Arbeitsbereich aus der aktuellen Region für Ihr Konto. Die Löschung Ihres Arbeitsbereichs entfernt keine Cloud-Ressourcen, die Sie mit diesem Arbeitsbereich bereitgestellt haben. Sie können über das IBM Cloud-Dashboard direkt auf die Ressourcen zugreifen und mit diesen arbeiten, aber Sie können IBM Cloud Schematics nicht verwenden, um die Ressourcen zu verwalten, nachdem Sie den Arbeitsbereich gelöscht haben.

Entscheiden Sie, ob Sie den Arbeitsbereich, alle zugehörigen Ressourcen oder beides löschen möchten. Diese Aktion kann nicht rückgängig gemacht werden. Wenn Sie den Arbeitsbereich entfernen und die Ressourcen behalten, müssen Sie die Ressourcen mit der Ressourcenliste oder der Befehlszeilenschnittstelle verwalten.

Arbeitsbereich und zugehörige Ressource löschen
Aktion Arbeitsbereich löschen Alle zugehörigen Ressourcen löschen
Arbeitsbereich löschen Wahr Falsch
Nur Ressourcen löschen Falsch Wahr
Arbeitsbereich und die durch den Arbeitsbereich bereitgestellten Ressourcen löschen Wahr Wahr
Ressourcen über die Befehlszeile oder Ressourcenliste vernichtet und Arbeitsbereich soll gelöscht werden Wahr Falsch

Syntax

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

Befehlsoptionen

Schematics-Arbeitsbereichslöschmarkierungen
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, den Sie entfernen möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--force oder -f Optionale Erzwingt das Löschen des Arbeitsbereichs ohne Eingabeaufforderungen der Befehlszeile.

Beispiel

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

ibmcloud schematics workspace get

Rufen Sie die Details eines vorhandenen Arbeitsbereichs ab, z. B. Arbeitsbereich-ID, Name, Status, Version, Erstellungszeit, Vorlagen-ID, Commit-ID, Verschlüsselungsstatus und Verschlüsselungs-CRN, einschließlich der Werte aller Eingabevariablen.

Syntax

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

Befehlsoptionen

Schematics-Arbeitsbereich-Flags abrufen
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, für den die Details abgerufen werden sollen. Wenn Sie die Resource ID eines Arbeitsbereichs suchen möchten, führen Sie den Befehl ibmcloud schematics workspace list aus, damit die Liste der Serviceinstanzen angezeigt wird. Rufen Sie von Ihrer Ressourcengruppe aus eine Resource ID für das Flag --id ab.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

ibmcloud schematics workspace get --id <WORKSPACE_ID>

ibmcloud schematics workspace import

Sie können eine vorhandene Ressource mit einer gültigen Ressourcenadresse in Ihre Arbeitsbereichsstatusdatei importieren. Sie müssen sicherstellen, dass die Ressource nur einmal in einen einzelnen Arbeitsbereich importiert wird. Andernfalls können Sie unerwünschtes Verhalten feststellen, wenn die Ressource in mehreren Arbeitsbereichen definiert ist. Details zur Verwendung des Befehls import finden Sie in der Terraform-Dokumentation.

Syntax

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

Befehlsoptionen

Schematics-Importflags für Arbeitsbereich
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, in den Sie eine Instanz oder Ressource importieren möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--options oder -o Erforderlich Die Befehlszeilenflags. Beispiel: -var-file xxxxx/tf.
--address oder -adr Erforderlich Gibt den Namen der Ressource an, die Sie importieren möchten.
--resourceID oder -rid Erforderlich Gibt die Ressourcen-ID an, die Sie in der Datei importieren müssen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Verwenden Sie die Option -options -var-file=schematics.tfvars, um Schematics anzuweisen, die Ressource mit den gespeicherten Arbeitsbereichsvariablen zu importieren.

Beispiel

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

Listet die Arbeitsbereiche für die aktuelle Region Ihres IBM Cloud-Kontos auf und zeigt die Details für Ihren Arbeitsbereich an. Listet die Arbeitsbereichsprüfungen auf die Nichtweiterverwendung in einer Schleife auf, indem die API versions jedes Mal für den gesamten Arbeitsbereich über den Dateicache aufgerufen wird.

Syntax

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

Befehlsoptionen

Schematics-Arbeitsbereichslistenflags
Flag Erforderlich / Optional Beschreibung
--limit oder -l Optionale Die maximale Anzahl der Arbeitsbereiche, die Sie auflisten möchten. Die Zahl muss eine positive ganze Zahl größer-gleich 1 (maximal 200) sein. Der Standardwert ist -1.
--offset oder -m Optionale Die Position des Arbeitsbereichs in der Liste der Arbeitsbereiche. Wenn in Ihrem Konto zum Beispiel drei Arbeitsbereiche vorhanden sind, werden durch den Befehl die folgenden Arbeitsbereiche als Liste mit drei Elementen zurückgegeben. Wenn Sie einen bestimmten Arbeitsbereich in dieser Liste anzeigen möchten, müssen Sie die Positionsnummer eingeben, die der Arbeitsbereich in der Liste aufweist. Geben Sie 0 ein, um den ersten Arbeitsbereich in der Liste aufzulisten. Geben Sie 1 ein, um den zweiten Arbeitsbereich aufzulisten usw. Negative Zahlen werden nicht unterstützt und somit ignoriert. Der Standardwert ist -1.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.
--region oder -r Optionale Geben Sie die Region an, z. B. eu, us, eu-gb, eu-de, us-south oder us-east.

Beispiel

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

ibmcloud schematics workspace new

Erstellen Sie einen Schematics Arbeitsbereich, der auf Ihre Terraform-Vorlage in GitHub oder GitLab verweist. Wenn Sie Ihre Terraform-Vorlage durch Hochladen einer Bandarchivdatei (.tar) bereitstellen möchten, können Sie den Arbeitsbereich ohne eine Verbindung zu einem GitHub-Repository erstellen und anschließend den Befehl ibmcloud schematics workspace upload verwenden, um die Vorlage bereitzustellen.

Schematics unterstützt nicht die Übergabe der Datei .tar zum Erstellen eines Arbeitsbereichs.

IBM Cloud Schematics unterstützt 50 API-Anforderungen pro Minute, pro Host und pro Kunde. Der Standort kann us-east, us-south, eu-gb oder eu-de sein. Sie müssen warten, bevor Sie den Befehl erneut aufrufen.

Wenn Sie einen Arbeitsbereich erstellen möchten, können Sie die Arbeitsbereichseinstellungen in einer JSON-Datei angeben. Stellen Sie sicher, dass die JSON-Datei der diesem Befehl zugrunde liegenden Struktur entspricht. Stellen Sie außerdem sicher, dass der location und der url Endpunkt auf dieselbe Region verweisen, wenn Sie Arbeitsbereiche und Aktionen erstellen oder aktualisieren. Weitere Informationen zur Position und zum Endpunkt finden Sie unter Wo werden meine Informationen gespeichert?.

IBM Cloud Schematics veraltet ältere Versionen von Terraform und führt Unterstützung für neuere Terraform-Versionen ein. Weitere Informationen finden Sie unter Schematics Terraform deprecation lifecycle und dem Deprecation Schedule.

Syntax

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

Befehlsoptionen

Schematics-Arbeitsbereichsmarkierungen erstellen
Flag Erforderlich / Optional Beschreibung
--file oder -f Erforderlich Der relative Pfad zu einer JSON-Datei auf Ihrer lokalen Maschine, die zum Konfigurieren Ihres Arbeitsbereichs verwendet wird. Weitere Informationen über die JSON-Beispieldatei mit den Details finden Sie unter JSON-Datei erstellen Vorlage.
--state Optionale Der relative Pfad zu einer vorhandenen Terraform-Statusdatei auf Ihrer lokalen Maschine. So erstellen Sie die Terraform-Statusdatei:
1. Zeigen Sie den Inhalt einer vorhandenen Terraform-Statusdatei mit dem Befehl ibmcloud schematics state pull an.
2. Kopieren Sie den Inhalt der Statusdatei von der Kommandozeilenausgabe in eine Datei auf Ihrem lokalen Rechner mit dem Namen terraform.tfstate.
3. Verwenden Sie den relativen Pfad zu der Datei im Befehlsparameter --state. Hinweis Der Arbeitsbereich Schematics unterstützt die Datei terraform.tfstate mit weniger als 2 MB.
--github-token oder -g Optionale Geben Sie die funktionalen persönlichen Zugriffstokens für HTTPS-Git-Operationen ein. Beispiel: --github-token ${FUNCTIONAL_GIT_KEY}.
--agent-id oder --aid Optionale Die ID eines Agenten, auf dem Ihr Arbeitsbereich erstellt wird Der Agent unterstützt Sie bei der Ausführung Ihrer Workspace-Aufträge in Ihrer Infrastruktur. Weitere Informationen finden Sie unter Schematics Agent.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Die Verwendung des Befehls Schematics ibmcloud terraform zeigt eine Warnung und eine Verwerfungsmeldung an, da der Alias 'terraform' veraltet ist. Verwenden Sie "schematics" oder "sch" in Ihren Befehlen.

Dateivorlage im JSON-Format erstellen

Schematics unterstützt das Herunterladen der Terraform-Modulvorlage aus dem privaten Repository. Weitere Informationen finden Sie unter Unterstützung für das Herunterladen von Modulen vom privaten fernen Host.

Sie können die JSON-Datei, die in der Datei example.json für die Erstellung des Arbeitsbereichs gemeinsam genutzt wird, erstellen und den Dateipfad mit dem Dateinamen im Flag --file übergeben. Die Beschreibung aller Parameter von example.json finden Sie in der Tabelle.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<workspace_name>" ersetzen durch "testworkspace".

Beispiel

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

Beispiel für JSON zum Hochladen in eine .tar Datei

{
    "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>"
        }
        ]
    }
    ]
}
Beschreibung der Komponenten der JSON-Datei
Parameter Erforderlich/Optional Beschreibung
workspace_name Optional Geben Sie einen Namen für Ihren Arbeitsbereich ein. Die maximale Zeichenlänge ist auf weniger als 1 MB gesetzt. Weitere Informationen finden Sie unter Arbeitsbereichsstruktur entwerfen.
terraform_version Die Terraform-Version, die Sie zum Ausführen Ihres Terraform-Codes verwenden möchten. Geben Sie terraform_v1.5 ein, um die Terraform-Version 1.5 zu verwenden,terraform_v1.4, um die Terraform-Version 1.4 zu verwenden, und entsprechend terraform_v1.4. Wenn Sie beispielsweise terraform_v1.5 angeben, bedeutet dies, dass Benutzer über eine Vorlage von Terraform v1.5.0, v1.5.1 oder v1.5.7 verfügen können. Stellen Sie sicher, dass Ihre Terraform-Konfigurationsdateien mit der von Ihnen angegebenen Terraform-Version kompatibel sind. Diese Variable ist erforderlich. Wenn die Terraform-Version nicht angegeben wird, wählt Schematics standardmäßig die Version aus Ihrer Vorlage aus. Schematics unterstützt Terraform_v1.x und plant auch, nach der Veröffentlichung von 30 to 45 days von HashiCorp Configuration Language (HCL) Releases zur Verfügung zu stellen.
location Optional Geben Sie den Ort an, an dem Sie Ihren Arbeitsbereich erstellen möchten. Der Standort bestimmt, wo Ihre Schematics-Aktionen ausgeführt werden und wo Ihre Arbeitsbereichsdaten gespeichert werden. Wenn Sie keinen Standort eingeben, bestimmt Schematics den Standort aufgrund der IBM Cloud-Region, die Sie als Ziel ausgewählt haben. Um die Region anzuzeigen, die Sie als Ziel ausgewählt haben, führen Sie den Befehl ibmcloud target --output json aus und sehen Sie sich das Feld region an. Um eine andere Region zu wählen, führen Sie ibmcloud target -r <region> aus. Wenn Sie einen Standort eingeben, müssen Sie sicherstellen, dass er mit der IBM Cloud-Region übereinstimmt, die Sie als Ziel angegeben haben.
description Optional Geben Sie eine Beschreibung für Ihren Arbeitsbereich ein.
template_repo.url Optional Geben Sie die URL zum GitHub oder GitLab Repository ein, in dem Ihre Terraform-Konfigurationsdateien gespeichert sind.
template_repo.branch Optional Geben Sie die Verzweigung GitHub oder GitLab an, in der Ihre Terraform-Konfigurationsdateien gespeichert sind. In template_repo können Sie nun auch URL mit weiteren Parametern aktualisieren, wie im Block gezeigt.
template_repo.datafolder Optional Geben Sie den Namen des Ordners im Git Repository an, der die Vorlage enthält.
template_repo.release Optional Geben Sie die Version GitHub oder GitLab ein, die auf Ihre Terraform-Konfigurationsdateien verweist.
github_source_repo_url Optional Geben Sie den Link zu Ihrem GitHub Repository ein. Vom Link kann auf die Verzweigung master, eine andere Verzweigung oder ein Unterverzeichnis verwiesen werden. Wenn Sie sich dafür entschieden haben, Ihren Arbeitsbereich ohne ein GitHub-Repository zu erstellen, wird Ihr Arbeitsbereich mit dem Status Entwurf erstellt. Wenn Sie Ihren Arbeitsbereich zu einem späteren Zeitpunkt mit einem GitHub-Repository verbinden möchten, müssen Sie den Befehl ibmcloud schematics workspace update verwenden. Wenn Sie beabsichtigen, die Terraform-Vorlage durch Hochladen einer Bandarchivdatei (.tar) bereitzustellen, lassen Sie die URL leer und verwenden Sie nach dem Erstellen des Arbeitsbereichs den Befehl ibmcloud schematics workspace upload. Wenn Sie aus dem Git Repository klonen wollen, sehen Sie sich die erlaubten und blockierten Dateierweiterungen für das Klonen an.
env_values Optional Eine Liste von Umgebungsvariablen, die Sie während der Ausführung eines Bash-Skripts oder einer Terraform-Aktion anwenden möchten. Dieses Feld muss als Liste mit Schlüssel/Wert-Paaren angegeben werden. Jeder Eintrag ist eine Karte mit einem Eintrag auf key = variable name und value = value. Sie können Umgebungsvariablen für Angebote des IBM Cloud-Katalogs definieren, die mithilfe von Bash-Script-Dateien eingerichtet werden.
variable_name Optional Geben Sie den Namen für die Eingabevariable ein, die Sie in Ihren Terraform-Konfigurationsdateien deklariert haben.
variable_type Optional Terraform v0.12 unterstützt string, list, map, bool, number und komplexe Datentypen wie list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
variable_value Optional Geben Sie den Wert als Zeichenkette für die primitiven Typen wie bool, number, string und HCL für die komplexen Variablen ein, wie Sie es in einer .tfvars Datei angeben. Sie müssen für den Wert eine Zeichenfolge mit Escapezeichen des HCL-Formats eingeben (siehe Beispiel). Weitere Informationen darüber, wie man Variablen in einer Terraform-Konfigurationsdatei deklariert und Schemata mit Werten versieht, finden Sie unter Verwendung von Eingabevariablen zur Anpassung von Ressourcen. Beispiel:
secure Optional Setzen Sie den Parameter secure auf true. Standardmäßig ist dieser Parameter auf false gesetzt.
val1 Optional In der Nutzlast können Sie eine Umgebungsvariable angeben, die in Ihrem Arbeitsbereich während der Plan-, Anwendungs- oder Zerstörungsphase ausgeführt werden kann. Darüber hinaus werden die Werte verschlüsselt und in COS gespeichert.

IBM Cloud Schematics unterstützt die Konfiguration von Umgebungsvariablen wie TF_PARALLELISM, TF_LOG. Weitere Informationen über die Liste der Umgebungsvariablen und ihre Verwendung finden Sie unter Liste der Umgebungsvariablen.

Beispiel

ibmcloud schematics workspace new --file example.json

ibmcloud schematics refresh

Führt eine IBM Cloud-Aktualisierungsaktion für Ihren Arbeitsbereich aus. Eine Refresh-Aktion validiert die Cloud-Ressourcen in Ihrem Konto anhand des Zustands, der in der Terraform-Zustandsdatei Ihres Arbeitsbereichs gespeichert ist. Wenn Unterschiede festgestellt werden, wird die Terraform-Statusdatei entsprechend aktualisiert.

Syntax

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

Befehlsoptionen

Schematics Aktualisierungsflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, für den Sie eine Aktion aktualisieren und ausführen möchten. Um die ID eines Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics state list

Listen Sie die Name, Type, URL und Taint Status der Cloud-Ressourcen auf, die in Ihrer Terraform-Zustandsdatei dokumentiert sind (terraform.tfstate).

Taint Status gibt tainted für (wahr) oder leer für (falsch) zurück.

Syntax

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

Befehlsoptionen

Schematics Statuslistenflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Der eindeutige Bezeichner des Arbeitsbereichs, für den Sie die Cloud-Ressourcen auflisten möchten, die in der Terraform-Statusdatei dokumentiert sind. Um die ID eines Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics workspace taint

Markiert eine Instanz oder Ressourcen manuell als Taint; bei der nächsten Anwendung wird eine erneute Erstellung der Ressourcen erzwungen. Ein Taint ändert die Statusdatei, nicht jedoch die Infrastruktur in Ihrem Arbeitsbereich. Bei der nächsten Planung werden die Änderungen als neu erstellt angezeigt, und bei der nächsten Anwendung wird die Änderung umgesetzt.

Sie müssen den Befehl ibmcloud schematics state list ausführen, um den Status 'tainted' Ihrer Ressourcen anzuzeigen. Taint Status gibt tainted (true) oder leer (false) zurück.

Syntax

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

Befehlsoptionen

Schematics Taint-Flags des Arbeitsbereichs
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, für den Sie die Instanz oder Ressource erneut erstellen möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--options oder -o Optionale Geben Sie das Flag der Option ein, die Sie anzeigen möchten.
--address oder -adr Erforderlich Geben Sie die Adresse der Ressource ein, die als Taint markiert werden soll.

Beispiel

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

ibmcloud schematics workspace untaint

Markiert eine Instanz oder Ressourcen manuell als untaint und erzwingt so die Wiederherstellung der Ressourcen bei der nächsten Anwendung. Bei der nächsten Planung werden die Änderungen als wiederhergestellt angezeigt, und bei der nächsten Anwendung wird die Änderung umgesetzt.

Sie können den Befehl ibmcloud schematics state list ausführen, um den Status 'tainted' Ihrer Ressourcen anzuzeigen. Taint Status gibt tainted (true) oder leer (false) zurück.

Syntax

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

Befehlsoptionen

Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, für den Sie die Instanz oder Ressource erneut erstellen möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--options oder -o Optionale Geben Sie das Flag der Option ein, die Sie anzeigen möchten.
--address oder -adr Optionale Geben Sie die Adresse der Ressource ein, die als untaint markiert werden soll.
{: caption="Schematics workspace untaint flags "caption-side = "top"}

Beispiel

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

ibmcloud schematics workspace update

IBM Cloud Schematics veraltet ältere Versionen von Terraform und führt Unterstützung für neuere Terraform-Versionen ein. Weitere Informationen finden Sie unter Schematics Terraform deprecation lifecycle und dem Deprecation Schedule.

Aktualisiert die Details für einen vorhandenen Arbeitsbereich, zum Beispiel den Arbeitsbereichsnamen, die Variablen oder die URL für die Quellcodeverwaltung. Informationen zum Bereitstellen oder Ändern von IBM Cloud finden Sie mithilfe des Befehls ibmcloud schematics plan.

IBM Cloud Schematics unterstützt 50 API-Anforderungen pro Minute, pro Host und pro Kunde. Die Region kann us-east, us-south, eu-gb, oder eu-de sein. Sie müssen warten, bevor Sie den Befehl erneut aufrufen. Stellen Sie sicher, dass der location und der url Endpunkt auf dieselbe Region verweisen, wenn Sie Arbeitsbereiche und Aktionen erstellen oder aktualisieren. Weitere Informationen zur Position und zum Endpunkt finden Sie unter Wo werden meine Informationen gespeichert?.

Wenn Sie die Terraform-Vorlage durch Hochladen einer Bandarchivdatei (.tar) bereitgestellt haben und die Vorlage aktualisieren möchten, müssen Sie den Befehl ibmcloud schematics workspace upload verwenden.

Syntax

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

Das Flag Pull-latest wird für Arbeitsbereiche, die unter Verwendung von Vorlagen aus IBM Cloud Katalogen erstellt wurden, nicht unterstützt.

Befehlsoptionen

Schematics Aktualisierungsflags für Arbeitsbereich
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, in dem Sie die Instanz oder Ressource aktualisieren möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--file oder -f Optionale Der relative Pfad zu einer JSON-Datei auf Ihrer lokalen Maschine, die die aktualisierten Parameter für Ihren Arbeitsbereich beinhaltet. Weitere Informationen über die JSON-Beispieldatei mit den Details finden Sie unter JSON-Datei-Updatevorlage.
--github-token oder -g Optionale Geben Sie den GitHub-Tokenwert für den Zugriff auf das private Git-Repository ein.
--pull-latest oder --pl Optionale Ziehen Sie die neuesten Änderungen aus Ihrem GitHub-Repository in den Arbeitsbereich. Wenn dieses Flag gesetzt ist, wird das Flag --file ignoriert.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Dateivorlage im JSON-Format aktualisieren

Sie können die JSON-Datei, die in der Datei example.json für die Aktualisierung des Arbeitsbereichs gemeinsam genutzt wird, erstellen und den Dateipfad mit dem Dateinamen im Flag --file übergeben. Die Beschreibung aller Parameter von 'example.json' finden Sie in der Tabelle.

Sie müssen die Platzhalter <...> durch die tatsächlichen Werte ersetzen. Zum Beispiel "<workspace_name>" ersetzen durch "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 Nutzdaten aktualisieren
Parameter Erforderlich / Optional Beschreibung
name Optionale Geben Sie einen Namen für Ihren Arbeitsbereich ein. Weitere Informationen finden Sie unter Arbeitsbereichsstruktur entwerfen. Wenn Sie den Namen des Arbeitsbereichs aktualisieren, ändert sich die ID des Arbeitsbereichs nicht.
type Optionale Die Terraform-Version, die zum Ausführen des Terraform-Codes verwendet werden soll. Geben Sie terraform_v1.5 ein, um Terraform Version 1.5zu verwenden, terraform_v1.4 um Terraform Version 1.4zu verwenden. Wenn Sie beispielsweise terraform_v1.5 angeben, bedeutet dies, dass Benutzer über eine Vorlage von Terraform v1.5.0, v1.5.1 oder v1.5.7 verfügen können. Stellen Sie sicher, dass Ihre Terraform-Konfigurationsdateien mit der von Ihnen angegebenen Terraform-Version kompatibel sind. Diese Variable ist erforderlich. Wenn die Terraform-Version nicht angegeben wird, wählt Schematics standardmäßig die Version aus Ihrer Vorlage.
description Optionale Geben Sie Tags ein, die Sie Ihrem Arbeitsbereich zuordnen möchten. Tags können Ihnen helfen, Ihren Arbeitsplatz schneller zu finden.
resource_group Optionale Geben Sie die Ressourcengruppe ein, in der Ihr Arbeitsbereich bereitgestellt werden soll.
workspace_status Optionale Blockieren Sie einen Arbeitsbereich bzw. heben Sie die Blockierung auf. Wenn ein Arbeitsbereich blockiert ist, werden Änderungen an dem Arbeitsbereich inaktiviert.
template_repo.url Optionale Geben Sie die URL zu dem GitHub- oder GitLab-Repository ein, in dem die Terraform-Konfigurationsdateien gespeichert sind.
template_repo.branch Optionale Geben Sie den GitHub- oder GitLab-Zweig ein, in dem die Terraform-Konfigurationsdateien gespeichert sind. Im Vorlagen-Repository können Sie nun auch URL mit weiteren Parametern aktualisieren, wie im Block gezeigt.
template_repo.datafolder Optionale Geben Sie den Namen des Ordners im Git-Repository ein, der die Vorlage enthält.
template_repo.release Optionale Geben Sie das GitHub- oder GitLab-Release ein, das auf die Terraform-Konfigurationsdateien zeigt.
github_source_repo_url Optionale Geben Sie den Link zu Ihrem GitHub-Repository ein. Vom Link kann auf die Verzweigung master, eine andere Verzweigung oder ein Unterverzeichnis verwiesen werden.
template_data.folder Optionale Geben Sie den Namen für die Eingabevariable ein, die Sie in Ihren Terraform-Konfigurationsdateien deklariert haben.
template_data.type Optionale Geben Sie den Namen für den Typ der Eingabevariablen ein, den Sie in Ihren Terraform-Konfigurationsdateien deklariert haben.
template_data[0].env_values[i].va11 Optionale Eine Liste der Umgebungsvariablen, die Sie während der Ausführung eines Bash-Scripts oder Terraform-Jobs anwenden möchten. Dieses Feld muss als Liste von Schlüssel/Wert-Paaren angegeben werden, z. B. TF_LOG=debug. Jeder Eintrag ist eine Zuordnung mit einem Eintrag, wobei Schlüssel der Name der Umgebungsvariablen und Wert ist.
template_data[0].env_values[i].val2 Optionale Eine Liste der Umgebungsvariablen, die Sie während der Ausführung eines Bash-Scripts oder Terraform-Jobs anwenden möchten. Dieses Feld muss als Liste von Schlüssel/Wert-Paaren angegeben werden, z. B. TF_LOG=debug. Jeder Eintrag ist eine Zuordnung mit einem Eintrag, wobei Schlüssel der Name der Umgebungsvariablen und Wert ist.
template_data[0].env_values_metadata Optionale Metadaten für Umgebungsvariablen.
template_data[0].variablestore[i].name Optionale Geben Sie den Namen für die Eingabevariable ein, die Sie in Ihren Terraform-Konfigurationsdateien deklariert haben.
template_data[0].variablestore[ii].type Erforderlich Terraform v0.12 unterstützt string, list, map, bool, number und komplexe Datentypen wie list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
template_data[0].variablestore[iii].value Optionale Geben Sie den Wert als Zeichenfolge für die primitiven Typen wie bool, number (Zahl) und string (Zeichenfolge) ein und im HCL-Format für die komplexen Variablen, wie bei der Angabe in einer .tfvars-Datei. Sie können die Standardwerte von .tfvars überschreiben, indem Sie den Parameter use_default als true festlegen. Sie müssen für den Wert eine Zeichenfolge mit Escapezeichen des HCL-Formats eingeben (siehe Beispiel). Weitere Informationen darüber, wie man Variablen in einer Terraform-Konfigurationsdatei deklariert und Werte für Schemata bereitstellt, finden Sie unter Verwendung von Eingabevariablen zur Anpassung von Ressourcen und Beispiel für den Variablenspeicher
template_data[0].variablestore[iv].secure Optionale Setzen Sie den Parameter secure auf true. Dieser Parameter ist standardmäßig auf false gesetzt.
template_data[0].variablestore[v].use_default Optionale Setzen Sie den Parameter use_default auf true, um den .tfvars-Standardparameter zu überschreiben. Dieser Parameter ist standardmäßig auf false gesetzt.
github_source_repo_url Optionale Geben Sie den Link zu Ihrem GitHub-Repository ein. Vom Link kann auf die Verzweigung master, eine andere Verzweigung oder ein Unterverzeichnis verwiesen werden.

Beispiel für Variablenspeicher

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

Beispiel

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

ibmcloud schematics workspace update variables

IBM Cloud Schematics veraltet ältere Versionen von Terraform und führt Unterstützung für neuere Terraform-Versionen ein. Weitere Informationen finden Sie unter Schematics Terraform deprecation lifecycle und dem Deprecation Schedule.

Mit "Variablen aktualisieren" können Sie eine oder mehrere Eingabevariablen für einen vorhandenen Arbeitsbereich aktualisieren. Sie können die Metadatenvariablen des Arbeitsbereichs wie Name oder URL der Quellcodeverwaltung nicht aktualisieren. Informationen zum Bereitstellen oder Ändern von IBM Cloud finden Sie mithilfe des Befehls ibmcloud schematics plan.

Syntax

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

Befehlsoptionen

Schematics Aktualisierungsflags für Arbeitsbereich
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, in dem Sie die Instanz oder Ressource aktualisieren möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--file oder -f Erforderlich Der relative Pfad zu einer JSON-Datei auf Ihrem lokalen Rechner, die die aktualisierten Parameter für Ihre zu aktualisierenden Arbeitsbereichsvariablen enthält. Weitere Informationen über die JSON-Beispieldatei mit den Details finden Sie unter JSON-Datei-Updatevorlage.
--template oder -tid Erforderlich Geben Sie die Vorlagen-ID ein. Verwenden Sie den Arbeitsbereich "ibmcloud schematics workspace get ", um die Vorlagen-ID abzurufen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel für variable Speicher- und Umgebungswerte

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
                }
    ]
}

Beispiel

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

ibmcloud schematics workspace upload

Stellt die Terraform-Vorlage durch Hochladen einer Bandarchivdatei (.tar) auf Ihrem Schematics-Arbeitsbereich bereit. Die .tar unterstützt die Befehle Cloud Shell.

Stellen Sie zuvor sicher, dass Sie den Arbeitsbereich erstellt haben, ohne eine Verbindung zu einem GitHub- oder GitLab-Repository herzustellen.

Syntax

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

Befehlsoptionen

Schematics-Upload-Flags für Arbeitsbereiche
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, in den Sie Ihre Bandarchivdatei (.tar) hochladen wollen. Führen Sie den Befehl ibmcloud schematics workspace list aus, um die ID Ihres Arbeitsbereichs zu ermitteln.
--file oder -f Erforderlich Geben Sie den vollständigen Pfad auf Ihrer lokalen Maschine ein, in der die .tar-Datei gespeichert ist.
--template oder -tid Erforderlich Die eindeutige Kennung der Terraform-Vorlage, für die der Inhalt der Terraform-Statusdatei angezeigt werden soll. Führen Sie den Befehl ibmcloud schematics workspace get --id <workspace_ID> aus, um die ID der Vorlage zu ermitteln. Die ID wird im Feld template Variables for: der Befehlszeilenausgabe angezeigt.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

Erstellt die TAR-Datei Ihres Vorlagenrepositorys mithilfe des angegebenen TAR-Befehls tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER

Beispiel für den Variablenwert

"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  }))"
    },
]

Arbeitsbereichsjobbefehle

Führen Sie Schematics-Vorgänge aus, um Cloud-Ressourcen zu erstellen, zu aktualisieren und zu löschen. Mithilfe der vertrauten Terraform-Semantik können Sie Terraform-Arbeitsbereiche planen, anwenden und löschen, um den Lebenszyklus von Cloudressourcen zu verwalten.

ibmcloud schematics apply

Wenn Sie eine Terraform-Vorlage für einen Arbeitsbereich anwenden, werden Ihre Ressourcen bereitgestellt, geändert oder von IBM Cloud entfernt. Temporäre Dateien, die während des Anwendungsvorgangs erstellt werden, können für zukünftige Vorgänge beibehalten werden.

Ihr Arbeitsbereich muss sich in einem inaktiven, aktiven, fehlgeschlagenen oder gestoppten Zustand befinden, um einen Schematics Anwendungsvorgang durchzuführen. Weitere Informationen zu Arbeitsbereichsstatus finden Sie im Abschnitt Arbeitsbereichsstatusdiagramm.

Während die Terraform-Jobs ausgeführt werden, wird der Arbeitsbereich gesperrt und Änderungen können erst nach Abschluss der Ausführung an Ihrem Arbeitsbereich vorgenommen werden.

Syntax

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

Befehlsoptionen

Schematics Flags anwenden
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, von dem auf die Terraform-Vorlage im Repository für die Quellcodeverwaltung verwiesen wird, die Sie in IBM Cloud anwenden möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--target oder -t Optionale Geben Sie die Erstellung einer bestimmten Ressource Ihrer Terraform-Konfigurationsdatei durch Eingabe der Terraform-Ressourcenadresse an, z. B. ibm_is_instance.vm1. Alle anderen Ressourcen, die in Ihrer Konfigurationsdatei definiert sind, werden nicht erstellt oder aktualisiert. Wenn Sie mehrere Ressourcen erstellen möchten, verwenden Sie die folgende Syntax: --target <resource1> --target <resource2>. Wenn die Zielressource das Attribut count angibt und in der Ressourcenadresse kein Index angegeben wird, z. B. ibm_is_instance.vm1[1], werden alle Instanzen, die sich einen Ressourcennamen teilen, als Ziel für die Erstellung anvisiert.
--var-file oder --vf Optionale Der Dateipfad zur Datei terraform.tfvars, die Sie auf Ihrer lokalen Maschine erstellt haben. Mit dieser Datei können Sie sensible Informationen wie den IBM Cloud-API-Schlüssel oder Berechtigungsnachweise speichern, die zum Herstellen der Verbindung zur klassischen Infrastruktur von IBM Cloud im Format <key>=<value> erforderlich sind. Variablen müssen im einzeiligen Format definiert werden, z. B. als availability_zone_names = ["us-east-1a","us-west-1c"]. Alle Schlüssel/Wert-Paare, die in dieser Datei definiert sind, werden automatisch in Terraform geladen, wenn Sie die Befehlszeilenschnittstelle von Terraform initialisieren. Um mehrere tfvars-Dateien anzugeben, geben Sie --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2 an.
--force oder -f Optionale Erzwingt die Ausführung dieses Befehls ohne Benutzereingabeaufforderungen.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics destroy

Entfernen Sie Cloud-Ressourcen, die Sie über Ihren Schematics Arbeitsbereich bereitgestellt haben, auch wenn diese Ressourcen aktiv sind. Standardmäßig listet der Befehl alle Ressourcen auf, die in der Vorschau angezeigt werden sollen, und erhält dann eine Bestätigung zum Löschen. Wenn Sie die Option "flag" von --force or -f im Befehl "destroy" verwenden, können Sie keine Vorschau der Ressourcen anzeigen, die Sie löschen möchten.

Gehen Sie beim Verwenden dieses Befehls vorsichtig vor. Nachdem Sie den Befehl ausgeführt haben, können Sie die Entfernung Ihrer Cloud-Ressourcen nicht mehr rückgängig machen. Wenn Sie Daten in bereitgestellten Speicher oder Datenbanken geschrieben haben, stellen Sie sicher, dass Sie eine Sicherung erstellen, um Ihre Daten persistent zu speichern.

Ihr Arbeitsbereich muss sich im Status Aktiv, Fehlgeschlagen oder Gestoppt befinden, um eine Schematics-Löschaktion auszuführen.

Syntax

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

Befehlsoptionen

Schematics Löschflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Der eindeutige Bezeichner des Arbeitsbereichs, der auf die Terraform-Vorlage in Ihrem Quell-Repository verweist, die die Cloud-Ressourcen angibt, die Sie entfernen möchten. Um die ID eines Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--target oder -t Optionale Geben Sie die Löschung einer bestimmten Ressource durch Eingabe der Terraform-Ressourcenadresse an, z. B. ibm_is_instance.vm1. Alle anderen Ressourcen in Ihrem Arbeitsbereich bleiben unverändert. Verwenden Sie die folgende Syntax, um die Löschung mehrerer Ressourcen als Ziel zu definieren: --target <resource1> --target <resource2>. Wenn die Zielressource das Attribut count angibt und in der Ressourcenadresse kein Index angegeben wird, z. B. ibm_is_instance.vm1[1], werden alle Instanzen, die sich einen Ressourcennamen teilen, als Ziel für die Löschung anvisiert. Außerdem werden alle abhängigen Ressourcen ebenfalls für die Löschung anvisiert, falls die Zielressource nur dann gelöscht werden kann, wenn auch abhängige Ressourcen gelöscht werden; so kann beispielsweise eine VPC nur dann gelöscht werden, wenn das angeschlossene Teilnetz gelöscht wird.
--force oder -f Optionale Erzwingt die Ausführung dieses Befehls ohne Benutzereingabeaufforderungen. Sie können keine Vorschau der Ressourcen anzeigen, die Sie löschen möchten.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics logs

Rufen Sie die Terraform-Protokolldateien für Schematics workspace oder eine bestimmte Workspace-Action-ID ab. Verwenden Sie die Protokolldateien, um Probleme mit Terraform-Vorlagen oder Probleme, die beim Bereitstellungs-, Änderungs- oder Löschprozess für Ressourcen auftreten, zu beheben.

Syntax

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

Befehlsoptionen

Schematics Protokollflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, für den Sie Terraform-Protokolldateien abrufen möchten. Um die ID eines Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--act-id oder -1 Optionale Die ID der Aktion, für die Sie Terraform-Protokolle abrufen möchten. Zum Suchen nach einer Liste mit Aktions-IDs führen Sie den Befehl ibmcloud schematics workspace action --id WORKSPACE_ID aus.

Beispiel

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

ibmcloud schematics output

Rufen Sie die Terraform-Ausgabewerte für den Arbeitsbereich ab. Sie können in Ihrer Terraform-Vorlage Ausgabewerte definieren, die Daten enthalten, die Sie anderen Arbeitsbereichen zugänglich machen wollen.

Syntax

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

Befehlsoptionen

Schematics Ausgabeflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, für den Sie Terraform-Ausgabewerte auflisten möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

ibmcloud schematics plan

Scannen Sie die Terraform-Vorlage in Ihrem Quell-Repository und vergleichen Sie diese Vorlage mit den Cloud-Ressourcen, die bereits bereitgestellt wurden. Die Befehlszeilenausgabe zeigt die Cloud-Ressourcen, die hinzugefügt, geändert, beibehalten oder entfernt werden müssen, um den in Ihrer Konfigurationsdatei beschriebenen Zustand zu erreichen.

Ihr Arbeitsbereich muss sich im Status Inaktiv, Aktiv, Fehlgeschlagen oder Gestoppt befinden, um eine Schematics-Planaktion auszuführen.

Während der Erstellung des Terraform-Ausführungsplans sind keinerlei Änderungen an Ihrem Arbeitsbereich möglich.

Syntax

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

Befehlsoptionen

Schematics Ausgabeflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige Kennung des Arbeitsbereichs, von dem auf die Terraform-Vorlage im Quellenrepository verwiesen wird, die Sie scannen möchten. Um die ID eines Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--var-file oder --vf Optionale Der Dateipfad zur Datei terraform.tfvars, die Sie auf Ihrer lokalen Maschine erstellt haben. Mit dieser Datei können Sie sensible Informationen wie den IBM Cloud-API-Schlüssel oder Berechtigungsnachweise speichern, die zum Herstellen der Verbindung zur klassischen Infrastruktur von IBM Cloud im Format <key>=<value> erforderlich sind. Variablen müssen im einzeiligen Format definiert werden, z. B. als availability_zone_names = ["us-east-1a","us-west-1c"]. Alle Schlüssel/Wert-Paare, die in dieser Datei definiert sind, werden automatisch in Terraform geladen, wenn Sie die Befehlszeilenschnittstelle von Terraform initialisieren. Um mehrere tfvars-Dateien anzugeben, geben Sie --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2 an.
--output oder -o Optionale Gibt die Befehlszeilenausgabe im JSON-Format zurück. Gegenwärtig wird nur das Dateiformat JSON unterstützt.

Beispiel

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

Stoppbefehle für Arbeitsbereiche

Nach dem Aufrufen eines Arbeitsbereichsjobs wie plan, apply oder destroy können Sie den aktiven Job oder die Bereitstellung von Ressourcen stoppen. Beim Stoppen oder Abbrechen eines Jobs mit langer Laufzeit ist es ratsam, zuerst die Jobprotokolle zu überprüfen, um festzustellen, ob der Job tatsächlich blockiert ist und gestoppt werden muss, oder ob er Operationen mit langer Laufzeit ausführt, deren Ausführung einige Zeit in Anspruch nimmt.

Schematics bietet eine Reihe von Optionen, mit denen der Benutzer den laufenden Auftrag in der Reihenfolge der Unmittelbarkeit und der Auswirkung des Stoppvorgangs (gracefully) stop, force-stop oder terminate stoppen kann.

Überprüfen Sie die Befehle für (gracefully) stop-, force-stop-oder terminate-Jobs.

ibmcloud schematics workspace job stop

Stoppt einen laufenden Workspace-Job, indem es ein Interrupt-Signal an Terraform sendet, um die Ausführung zu beenden.

Syntax

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

Befehlsoptionen

Schematics Jobstoppflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID des Arbeitsbereichs, der aktualisiert werden soll.
--job-id oder --jid Erforderlich Die Job-ID des Jobs.
--stop, Optionale Entfernt den Auftrag aus der Warteschlange.
--force-stop oder --fs Optionale Sendet ein Kill-Signal an die Terraform-Ausführung in der Engine, versucht auch, die Ausführung sofort zu stoppen.
--terminate oder -t Optionale Die Beendigung der Engine wird erzwungen, der Job wird als gestoppt gekennzeichnet und Ihr Arbeitsbereich wird entsperrt. Die Daten werden mit diesem Kennzeichen nicht gespeichert.

Beispiel

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>

Befehle für Arbeitsbereichsstatusdateien

Der folgende Abschnitt enthält Informationen zu den Befehlen, die Sie für die Arbeit mit der Terraform-Statusdatei (terraform.tfstate) für einen Arbeitsbereich verwenden können.

Sie können während der Erstellung Ihres Arbeitsbereichs eine bereits vorhandene Terraform-Statusdatei importieren. Weitere Informationen finden Sie im Abschnitt zum Befehl ibmcloud workspace new.

ibmcloud schematics state pull

Zeigt den Inhalt der Terraform-Statusdatei (terraform.tfstate) für eine bestimmte Terraform-Vorlage Ihres Arbeitsbereichs an.

Syntax

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

Befehlsoptionen

Schematics Status-Pull-Flags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID Kennung des Arbeitsbereichs, für den Sie die Befehle ausführen wollen.
--template oder --tid Erforderlich Die eindeutige Kennung der Terraform-Vorlage, für die der Inhalt der Terraform-Statusdatei angezeigt werden soll. Führen Sie den Befehl ibmcloud schematics workspace get --id <workspace_ID> aus, um die ID der Vorlage zu ermitteln. Die ID wird im Feld template Variables for: der Befehlszeilenausgabe angezeigt.

Beispiel

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

ibmcloud schematics workspace state show

Stellt die lesbare Ausgabe eines Arbeitsbereichsstatus oder -plans bereit, wie er von Terraform angezeigt wird. Mit diesem Befehl können Sie den aktuellen Status und den Status geplanter Operationen sicherstellen. Sie müssen die Arbeitsbereichs-ID verwenden, um die Protokolle mit dem Befehl ibmcloud schematics logs abzurufen.

Syntax

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

Befehlsoptionen

Schematics Status-Pull-Flags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des zu aktualisierenden Arbeitsbereichs.
--address oder -adr Erforderlich Geben Sie die Adresse ein, die auf eine einzelne Ressource im anzuzeigenden Status verweist.
--options oder -o Optionale Geben Sie die Befehlszeilenflags ein.

Beispiel

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

ibmcloud schematics workspace state mv

Wenn Sie den Status für eine Ressource in der Statusdatei verschieben. Der Arbeitsbereich funktioniert weiterhin, aber die nächste Plan-oder Anwendungsoperation findet die Ressource oder Instanz nicht in der Statusdatei. Wenn keine Änderungen an der Vorlage vorgenommen werden, können Sie die Neuerstellung der Ressource bei der nächsten Operation mit Terraform anzeigen.

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

Befehlsoptionen

Schematics Statusverschiebungs-Flags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, für den eine Instanz oder Ressource verschoben werden soll. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--source oder -s Erforderlich Geben Sie die Quellenadresse eines zu verschiebenden Elements ein.
--destination oder -d Erforderlich Geben Sie die Zieladresse eines Elements an.

Beispiel

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

ibmcloud schematics workspace state rm

Wenn Sie den Status für eine Ressource oder Instanz in der Statusdatei entfernen. Der Arbeitsbereich funktioniert weiterhin, aber die nächste Plan-oder Anwendungsoperation findet die Ressource oder Instanz nicht in der Statusdatei. Wenn keine Änderungen an der Vorlage vorgenommen werden, können Sie die Neuerstellung der Ressource bei der nächsten Operation mit Terraform anzeigen.

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

Befehlsoptionen

Schematics Statusmarkierungen entfernen
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die eindeutige ID des Arbeitsbereichs, in dem Sie die Instanz oder Ressource entfernen möchten. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--options oder -o Optionale Geben Sie das Flag der Option ein, die Sie entfernen möchten.
--address oder -adr Erforderlich Geben Sie die Adresse der Ressource ein, die als Taint markiert werden soll.

Beispiel

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

Terraform-Befehle für Arbeitsbereiche

Sie können Terraform-Befehle ausführen, um Cloud-Ressourcen zu manipulieren und den Status von Schematics zu ändern.

Terraform-Befehle für Arbeitsbereiche werden in der Benutzerschnittstelle nicht unterstützt.

Die Tabelle enthält eine Zusammenfassung der unterstützten Terraform-Arbeitsbereichsbefehle.

Zusammenfassung der Terraform-Befehle
Befehl Beschreibung
show Überprüft den Terraform-Status oder -Plan.
output Liest die Ausgabe einer Terraform-Statusdatei.
import Importiert eine vorhandene Infrastruktur in Terraform.
taint Markiert eine Ressource für die Wiederherstellung.
untaint Ressource soll nicht als Taint markiert werden.
state Ein Befehl für die erweiterte Statusverwaltung zum Schreiben von Unterbefehlen, um rm && mv zu entfernen oder zu verschieben.

Terraform-Befehle

Terraform-Befehle werden mithilfe einer JSON-Datei ausgeführt, um Eingaben anzugeben.

Syntax

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

Befehlsoptionen

Schematics Terraform-Befehlsflags
Flag Erforderlich / Optional Beschreibung
--id oder -i Erforderlich Die ID Kennung des Arbeitsbereichs, für den Sie die Befehle ausführen wollen. Um die ID Ihres Arbeitsbereichs zu finden, führen Sie den Befehl ibmcloud schematics workspace list aus.
--file oder --f Erforderlich Der Pfad zu der JSON-Datei, die die Liste der Terraform-Befehle enthält.

Beispiel für die Nutzlast der Datei 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"
}

Die folgende Tabelle enthält die Liste der Schlüsselparameter der JSON-Datei für die API Commands für die Befehlszeile und die API bereit.

Liste der Schlüsselparameter
Schlüssel Erforderlich / Optional Beschreibung
command Erforderlich Gibt den Befehl an. Die unterstützten Befehle sind show, taint, untaint, state, import, output.
command_params Erforderlich Die Adressparameter für den Befehlsnamen für die CLI, wie z. B. der Ressourcenname, der absolute Pfad des Dateinamens. Für API müssen Sie das Optionskennzeichen und den Adressparameter in command_params senden.
command_name Erforderlich Der Name für den Befehlsblock.
command_desc Optionale Der Text, der den Befehlsblock beschreibt.
command_onError Optionale Anweisung, ob fortgesetzt oder abgebrochen werden soll, wenn im Befehl ein Fehler enthalten ist.
command_dependsOn Optionale Abhängigkeit von den vorherigen Befehlen.
command_status Nicht erforderlich Zeigt den Status nach Ausführung der Befehle an, entweder success oder failure

Beispiel

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

Versionsprotokoll der Befehlszeilenschnittstelle (CLI)

In diesem Abschnitt finden Sie eine Zusammenfassung der Änderungen für die einzelnen Versionen des Schematics-Plug-ins. Achten Sie darauf, dass Ihre Befehlszeilenschnittstelle (CLI) auf dem neuesten Stand ist, sodass Sie alle verfügbaren Befehle und deren Optionen verwenden können.

Versionsgeschichte der Befehlszeile
Version Freigabedatum Änderungen
1.12.29
  1. Oktober 2025
Schematics CLI-Plugin führt Multihost-Anmeldeinformationen und Variablen bei der Erstellung und Aktualisierung von Inventaren ein. Mit diesem Update wird der Prozess der Handhabung von Authentifizierungsdetails und Konfigurationseinstellungen für zahlreiche Zielsysteme rationalisiert, was eine effizientere und sicherere Automatisierungserfahrung gewährleistet.
1.12.28
  1. August 2025
Schematics CLI-Plugin zur Aktualisierung von Subnamespaces und Subcommands in den Metadaten.
1.12.27
  1. Juli 2025
Schematics Das CLI-Plugin unterstützt die Zielregion Montreal(ca-mon).
1.12.26
  1. April 2025
Schematics Das CLI-Plugin hat die Vorschau für die Zerstörung von ibmcloud-Schaltplänen verbessert, ein Pipeline-Basis-Image aktualisiert und nil pointer exception in den Operationen ibmcloud schematics action create, ibmcloud schematics action update und ibmcloud schematics action get behoben.
1.12.25
  1. Januar 2025
Schematics CLI-Plugin unterstützt IBM-Cloud-Schemata-Workspace-Update-Variablen CLI-Befehl zum Aktualisieren nur der erforderlichen Eingabevariablen für einen vorhandenen Workspace. Es verbessert auch den Befehl "ibmcloud schematics destroy" mit der Vorschaufunktion, um alle Job-Ressourcen mit Bestätigung aufzulisten. Der Arbeitsbereich {{site.data.keyword.bplong_notm }}, eine Aktion und ein Agent rufen Befehle ab, um die Verschlüsselungs-CRN und den Verschlüsselungsstatus wie IBM Default oder BYOK oder KYOK Details abzurufen.
1.12.24
  1. Juli 2024
Schematics CLI-Plugin behebt die Unterstützung für Toronto-Endpunkte durch die Region ' ca-tor.
1.12.23
  1. Juni 2024
Schematics CLI-Plugin verbessert die Anzeige des Dateiformats ' terraform.tfvars bei der Verwendung des Arguments ' --var-file im Befehl ibmcloud workspace apply und ibmcloud workspace plan. Die Unterstützung für die InternationalisierungsübersetzungI18n) wurde aktualisiert.
1.12.22
  1. Mai 2024
Schematics CLI-Plugin unterstützt ' ibmcloud schematics agent destroy zur Zerstörung der Bereitstellungsressourcen. Setzen Sie den Parameter " --force auf "true", um alle Agentenflüsse zu löschen und die Zerstörung parallel zum Arbeitsbereich-Zerstörungsfluss zu halten.
1.12.21
  1. April 2024
Schematics CLI-Plugin veraltet das Flag " --json in allen CLI-Befehlen. Außerdem wurde der Fehler bei der Veraltung von " CLI v1.12.20 in den CLI-Befehlen " ibmcloud schematics workspace refresh und "plan" behoben.
1.12.20
  1. März 2024
Schematics CLI-Plugin unterstützt Red Hat OpenShift Kubernetes Service.
1.12.18
  1. März 2024
Anzeige der Terraform-Warnmeldung bei Workspace-Befehlen, die weniger als ' terraform_v1.5 verwenden. Die Unterstützung für die Aktualisierung der Agenteninfrastruktur wurde entfernt, und der ' index out of range-Fehler bei Verwendung des ' ibmcloud schematics state list-Befehls wurde behoben.
1.12.17
  1. Februar 2024
{{{site.data.keyword.bpshort}} Plug-in-Installation unterstützt Cloud Shell, und der Befehl ' ibmcloud schematics workspace upload unterstützt jetzt die Cloud Shell.
1.12.16
  1. Februar 2024
ibmcloud schematics workspace list unterstützt die Zwischenspeicherung für API-Versionen. terraform_v1.2, " terraform_v1.3 und " terraform_v1.4 werden für die Erstellung der " ibmcloud schematics workspace new ausgefüllt.
1.12.15 24 Januar 2024 Unterstützung für ' refresh_token in der API-Anforderung für die Agentenaktualisierung, verbesserte Versionsunterstützung für den Befehl zur Agentenaktualisierung.
1.12.14
  1. Januar 2024
Es wurden neue Befehle und Übersetzungen zur Unterstützung des Agenten und der Richtlinie hinzugefügt. Die System-Workspaces aus der Ausgabe des Workspace-Listen-Befehls werden ausgeblendet. Die Anzeige der Agentenaufträge in der Befehlsausgabe wurde verbessert. Verwendung der API " /v1/versions für die Agentenversionen.
1.12.12
  1. September 2023
Schematics Agent erstellen und aktualisieren hinzugefügt mit einem new flag --metadata und eine Fehlerkorrektur zur Konfiguration einer HTTP für Anfragen.
1.12.10
  1. Mai 2023
Schematics Agentenaktualisierung und Fehlerbehebung beim Befehl ' agent list, um die Laufzeitfehler zu beheben.
1.12.9
  1. April 2023
Schematics Die CLI-Befehle für Agent beta-1 und Richtlinien wurden erweitert, um den " -target-file und den " output " von agent plan, agent apply und agent health einzubeziehen.
1.12.8
  1. März 2023
Schematics Agent beta-1 und CLI-Befehle für Richtlinien sind in den Regionen ' us-south, ' us-east, ' eu-de und ' eu-gb verfügbar.
1.12.7
  1. Februar 2023
Fehlerbehebung zur Deaktivierung von ' API_AGENT_ATTACHMENT in den Bereichen ' us-south, ' us-east, ' eu-de, ' eu-gb.
1.12.6
  1. Januar 2023
Verbesserte Unterstützung komplexer Eingaben durch die Datei " yaml. Korrekturen im Zusammenhang mit der Statusausgabe, Index außerhalb des Bereichs für die Ausgabe von Arbeitsbereich-Aktionen, Aktualisierungs-Token-Problem bei langen Laufzeiten und Korrekturen von Spinner-Panik.
1.12.5
  1. Dezember 2022
Die Verwendung von Unterbefehlen und die Unterstützung für die Angabe komplexer Eingaben über eine lokale YAML-Datei mittels der Option " -input-file.
1.12.3
  1. November 2022
Unterstützung für die Verwendung von Unterbefehlen ' source type behoben.
1.12.3
  1. November 2022
Verbesserte CLI-Befehle, mit dem neuesten SDK-Update und dem Update des Arbeitsbereich-Aktionsbefehls.
1.12.2
  1. August 2022
Das ' --output-Flag und Fehlerkorrekturen für die Befehle wurden in das Plug-in Schematics v1.12.2 aufgenommen und veröffentlicht.
1.12.1
  1. Juli 2022
Einarbeitung der Bugs und Korrekturen von Befehlen in Schematics.
1.12.0
  1. Juli 2022
Unterstützung für agents Befehle in Schematics von der Kommandozeile aus.
1.11.1
  1. Juli 2022
Unterstützung zur Behebung des Übersetzungsproblems in Schematics aus der Kommandozeile.
1.10.0
  1. Mai 2022
Unterstützung für stop, force-stop und terminate in Schematics über die Befehlszeile (CLI).
1.9.0
  1. April 2022
Unterstützung für Drift-Erkennung in Schematics über die Befehlszeile (CLI).
1.8.1
  1. April 2022
Korrigiert die Anzeigenachricht über die Einstellung der Unterstützung von Aliasnamen für die JSON-Ausgabe von Schematics.
1.8.0
  1. März 2022
Unterstützt die Übergabe von ' .tfvars und ' .json Dateien an den Planungs- und Anwendungsbefehl. Bei der Verwendung des Befehls ' ibmcloud terraform wird eine Warnmeldung angezeigt. Die Version unterstützt auch private Schematics Endpunkte über die Befehlszeile und verbessert die Ausgabe der tabellarischen Ansicht, um die bereitgestellten Ressourcen im Schematics Arbeitsbereich aufzulisten.
1.7.3
  1. März 2022
Die Übergabe von vars-Dateien an den Befehlszeilenbefehl 'plan' wird unterstützt, commit ID wird im Befehl ibmcloud schematics workspace get angezeigt und die Beschreibung des Befehls ibmcloud schematics workspace state show wurde überarbeitet.
1.7.2 17 Februar 2022 Unterstützt Binärdateien von Linux™ arm64 und Mac OS arm64. Korrekturen für stdout/stderr-Datenstrom, ungültige TF vars-Datei und Übersetzung werden freigegeben.
1.7.1
  1. Februar 2022
Traceprotokollierung wird unterstützt und Integrationstests für einige Befehle hinzugefügt. Korrekturen zur Aktualisierung von " env values metadata, Panik bei ungültigen Flags, und " ibmcloud schematics workspace output command ist nicht verfügbar.
1.7.0
  1. Januar 2022
Die Nachricht über die Einstellung der Unterstützung für Terraform v11.0 wird nach der Befehlsausführung angezeigt. Korrektur des Befehlszeilenalias. Erscheinen der doppelten Zeichenfolgen entfernt. Globale Zeit in der Protokolldatei wird unterstützt.
1.6.2
  1. Dezember 2021
Unterstützung nicht englischer Übersetzungen. --var-file im Befehl 'apply ' und Aktionsargument --target not setting korrigiert. Behebung einer Sicherheitslücke in der Pipeline.
1.6.1 21 Oktober 2021 winrm wird für Schematics-Aktionen unterstützt. Die Optionswerte ' --inventory-connection-type, ' --bastion-credential-json und ' --credential-json wurden zu den Aktualisierungen von create und config hinzugefügt. Nicht englische Übersetzungen für die Befehlszeile wurden aktualisiert. Die doppelte Anzeige des Arguments " command-object im interaktiven Modus " ibmcloud schematics jobs run wurde korrigiert.
1.6.0 29 September 2021 Unterstützung für linux-ppc64le- und linux-s390x-Binärdateien. Listet " Terraform v1.0 im Detailbereich auf. Anzeige der ' Terraform v0.11 Verwerfungsmeldung in Schematics Arbeitsbereichsseite. Rückgabe einer leeren Zeichenfolge bei Befehl 'resource-query list' korrigiert.
1.5.12
  1. September 2021
Statusnachricht für das Flag --output json unterdrücken.
1.5.11
  1. August 2021
Ein Flag --pull-latest wurde zum bestehenden Befehl zur Aktualisierung des Arbeitsbereichs hinzugefügt. Problem behoben. Die Übersetzungen der Ländereinstellung wurden korrigiert.
1.5.10
  1. August 2021
Unterstützt Terraform v0.15. Übersetzungen der Ländereinstellung wurden korrigiert.
1.5.9
  1. Juli 2021
Übersetzungen der Ländereinstellung wurden korrigiert.
1.5.8
  1. Juli 2021
Der API-Pfad für gemeinsam genutzte Datensätze wurde korrigiert. Deaktivierte Befehle für gemeinsam genutzte Datensätze.
1.5.7
  1. Juni 2021
Befehl ibmcloud schematics state list wurde erweitert und zeigt jetzt Tabellendaten mit dem Status taint in einer neuen Spalte an. Befehl ibmcloud schematics job run wurde mit der Beschreibung des Flags --input korrigiert. Befehl ibmcloud schematics job run wurde mit der Beschreibung des Flags --output json korrigiert. Befehl ibmcloud schematics action update wurde mit dem Flag --credentials und den Übersetzungen der Ländereinstellung korrigiert.
1.5.6
  1. Juni 2021
Der Befehl ibmcloud schematics workspace new wurde aktualisiert, so dass er Terraform v0.14 und die Übersetzungen der Ländereinstellung unterstützt.