CLI IBM Cloud Schematics

Eseguire questi comandi per lavorare con gli spazi di lavoro IBM Cloud Schematics, le azioni, le risorse approvvigionate e configurare Schematics.

Schematics I comandi CLI sono specifici per ogni regione. Funzionano solo nella regione/località in cui la CLI IBM Cloud è configurata per funzionare. Assicurati che la CLI location e l'endpoint url puntino alla region in cui vuoi creare o aggiornare i tuoi spazi di lavoro e le tue azioni. Per ulteriori informazioni sulla posizione e sull'endpoint, vedere Dove sono archiviate le mie informazioni?

Per eseguire i comandi di Schematics, utilizzare ibmcloud schematics o ibmcloud sch.

Prima di iniziare

  • Configura la tua CLI .
  • Installa il plug-in Schematics.

Assicurati di mantenere la tua CLI aggiornata in modo da poter utilizzare i comandi rilasciati correnti e le loro opzioni. Per ulteriori informazioni sulle release della versione della riga comandi corrente, consultare Cronologia della versione della riga comandi.

Comandi di azioni

Esaminare i comandi per creare, aggiornare, elencare, eliminare e lavorare con le azioni di Schematics.

ibmcloud schematics action create

Creare un'azione per eseguire un playbook Ansible su un singolo host di destinazione o su un gruppo di host di destinazione. Si utilizzano i playbook di Ansible per eseguire operazioni sul cloud o installare software sulle risorse del cloud. Per provare questa funzionalità o per iniziare, utilizzare uno dei playbook IBM Ansible forniti. È possibile creare un'azione utilizzando un file di payload o la modalità interattiva del comando.

Assicurarsi che l'endpoint location e url puntino alla stessa regione quando si creano o si aggiornano le azioni e gli spazi di lavoro. Per ulteriori informazioni sull'ubicazione e sull'endpoint, vedi Dove sono archiviate le mie informazioni?.

Sintassi

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]

Opzioni comando

Schematics azioni create flags
Indicatore Obbligatorio / Facoltativo Descrizione
--name oppure -n Obbligatorio Un nome unico per l'azione.
--description oppure -d Facoltativo La descrizione breve di un'azione.
--location oppure -l Obbligatorio La geografia o la località in cui si vuole creare l'azione, come us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. L'area geografica o l'ubicazione determina dove viene eseguita l'azione e dove vengono archiviati i dati dell'azione. Per ulteriori informazioni, consultare la sezione Dove sono archiviate le mie informazioni. Assicurarsi di poter memorizzare i dati in questa ubicazione poiché non è possibile modificare l'ubicazione dopo la creazione dell'azione.
--resource-group oppure -r Obbligatorio Il nome del gruppo di risorse in cui si vuole creare l'azione.
--template oppure -tr Facoltativo L' URL del repository Git in cui è memorizzato il playbook di Ansible.
--playbook-name oppure --pn Facoltativo Il nome del playbook Ansible.
--credentials oppure -C Facoltativo Il percorso file della chiave SSH privata che vuoi utilizzare per accedere al tuo host di destinazione, come ad esempio ~/.ssh/id_rsa. La chiave SSH deve contenere alla fine dei dettagli della chiave in caso di chiamate della riga di comando o dell'API.
--credential-json oppure --cj Facoltativo Fornire il percorso del file JSON che contiene il payload JSON delle credenziali per accedere all'host di destinazione.
--bastion oppure -b Facoltativo L'indirizzo IP dell'host bastione.
--bastion-credential-json oppure --bj Facoltativo Fornire il percorso del file JSON che contiene il payload JSON della credenziale bastion per accedere all'host bastion.
--inventory oppure -y Facoltativo L'ID dell'inventario di risorse che vuoi utilizzare nella tua azione. Per elencare gli inventari esistenti, eseguire ibmcloud schematics inventory list.
--inventory-connection-type oppure --it Facoltativo Tipo di connessione all'inventario. I valori supportati sono ssh, o winrm. L'impostazione predefinita è SSH. Attualmente, WinRM supporta solo i sistemi Windows con il sito pubblico IPs e non supporta l'host Bastion.
--input oppure --in Facoltativo Le variabili di input per la tua azione. Le variabili di input devono essere immesse come coppie chiave - valore, ad esempio --input mykey=myvalue. Per specificare più variabili di input, utilizzare più indicatori --input nel comando. È anche possibile memorizzare le variabili di input in un file e fare riferimento a questo file utilizzando l'opzione del comando --input-file.
--input-file oppure --if Facoltativo Il percorso di un file in cui sono state specificate tutte le variabili di input. Le variabili di input devono essere specificate come coppie chiave - valore in formato JSON.
--env oppure -e Facoltativo Le variabili di ambiente per un'azione. Le variabili di ambiente devono essere immesse come coppie chiave - valore, come --env mykey=myvalue. Per fornire più variabili di ambiente, utilizza più indicatori --env nel comando.
--env-file oppure -E Facoltativo Il percorso di un file in cui sono state specificate tutte le variabili di ambiente per un'azione. Le variabili di ambiente devono essere specificate come coppie chiave - valore in formato JSON.
--github-token oppure -g Facoltativo Il token di accesso personale in GitHub che vuoi utilizzare per la connessione a un repository GitHub privato. Se vuoi clonare dal repository Git vedi le estensioni file consentite e bloccate per la clonazione.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--file oppure -f Facoltativo Il percorso del file di payload JSON che contiene la definizione dell'azione che vuoi creare. Per ulteriori informazioni, vedi Utilizzo di un file di payload.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza una modalità interattiva.

Esempio

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

Utilizzo di un file di payload

Crea un file JSON che includa i dettagli per l'azione che vuoi creare, come l'ID, il nome e la descrizione. Utilizza quindi l'opzione di comando --file per creare la tua azione dal tuo file di payload.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<ACTION_NAME>" come "testaction".

Sintassi

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

Esempio

ibmcloud schematics action create --file sample.json

Utilizzo della modalità interattiva

Invece di immettere le opzioni del comando o utilizzare un file di payload, è possibile utilizzare la modalità interattiva del comando per creare un'azione. Per impostazione predefinita, l'azione viene creata con un input utente minimo. Per aggiungere ulteriori informazioni alla tua azione, puoi aggiornare l'azione in un secondo momento.

  1. Avviare la modalità interattiva eseguendo il comando senza opzioni di comandi.
    ibmcloud schematics action create
  2. Immettere un nome per l'azione e premere il tasto Invio.
  3. Immettere il gruppo di risorse in cui si desidera creare l'azione e premere il tasto Invio.
  4. Immettere l'ubicazione in cui si desidera creare l'azione, ad esempio us-south, us-east, eu-de o eu-gb. Quindi, premere il tasto Invio. L'ubicazione determina dove viene eseguita l'azione e dove vengono memorizzati i dati dell'azione. Per ulteriori informazioni, consultare Dove sono memorizzate le informazioni?. Assicurarsi di poter memorizzare i dati in questa ubicazione poiché non è possibile modificare l'ubicazione dopo la creazione dell'azione.
  5. Inserire l' URL del repository GitHub in cui è memorizzato il playbook di Ansible. Quindi, premere il tasto Invio.
  6. Se applicabile, immetti il token di accesso personale che vuoi utilizzare per accedere al tuo repository GitHub. Quindi, premere il tasto Invio. Se vuoi clonare dal repository Git vedi le estensioni file consentite e bloccate per la clonazione.
  7. Immettere il nome del playbook Ansible che si desidera eseguire e premere il tasto Invio.
  8. Esamina i dettagli dell'azione che è stata creata per te.

ibmcloud schematics action update

Aggiornare le informazioni di un'azione esistente utilizzando action_id. Assicurati che la CLI location e l'endpoint url puntino alla region in cui vuoi creare o aggiornare i tuoi spazi di lavoro e le tue azioni. Per ulteriori informazioni sull'ubicazione e sull'endpoint, vedi Dove sono archiviate le mie informazioni?.

Sintassi

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]

Opzioni comando

Schematics indicatori di aggiornamento azioni
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID di un'azione che vuoi aggiornare.
--name oppure -n Facoltativo Un nuovo nome univoco per l'azione.
--description oppure -d Facoltativo La descrizione breve di un'azione.
--location oppure -l Obbligatorio Luoghi geografici supportati dal servizio IBM Cloud Schematics come us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon.
--resource-group oppure -r Obbligatorio Nome del gruppo di risorse per un'azione.
--template oppure -tr Facoltativo L' URL del repository Git in cui è memorizzato il playbook di Ansible.
--playbook-name oppure --pn Facoltativo Nome del playbook.
--github-token oppure -g Facoltativo Il token di accesso personale in GitHub che vuoi utilizzare per la connessione a un repository GitHub privato. Se vuoi clonare dal repository Git vedi le estensioni file consentite e bloccate per la clonazione.
--credentials oppure -C Facoltativo Il percorso file della chiave SSH privata che vuoi utilizzare per accedere al tuo host di destinazione, come ~/.ssh/id_rsa. La chiave SSH deve contenere alla fine dei dettagli della chiave in caso di chiamate della riga di comando o dell'API.
--credential-json oppure --cj Facoltativo Fornire il percorso del file JSON che contiene il payload JSON delle credenziali per accedere all'host di destinazione.
--bastion oppure -b Facoltativo L'indirizzo IP dell'host bastione.
--bastion-credential-json oppure --bj Facoltativo Fornire il percorso del file JSON che contiene il payload JSON della credenziale bastion per accedere all'host bastion.
--inventory oppure -y Facoltativo L'ID dell'inventario di risorse che vuoi utilizzare nella tua azione. Per elencare gli inventari esistenti, eseguire ibmcloud schematics inventory list.
--inventory-connection-type oppure --it Facoltativo Tipo di connessione all'inventario. I valori supportati sono ssh, o winrm. L'impostazione predefinita è SSH. Attualmente, WinRM supporta solo i sistemi Windows con il sito pubblico IPs e non supporta l'host Bastion.
--input oppure --in Facoltativo Le variabili di input per la tua azione. Le variabili di input devono essere immesse come coppie chiave - valore, ad esempio --input mykey=myvalue. Per specificare più variabili di input, utilizzare più indicatori --input nel comando. È anche possibile memorizzare le variabili di input in un file e fare riferimento a questo file nell'opzione del comando --input-file.
--input-file oppure --if Facoltativo Il percorso di un file in cui sono state specificate tutte le variabili di input. Le variabili di input devono essere specificate come coppie chiave - valore in formato JSON.
--env oppure -e Facoltativo Le variabili di ambiente per un'azione. Le variabili di ambiente devono essere immesse come coppie chiave - valore, come --env mykey=myvalue. Per fornire più variabili di ambiente, utilizza più indicatori --env nel comando.
--env-file oppure -E Facoltativo Il percorso di un file in cui sono state specificate tutte le variabili di ambiente per un'azione. Le variabili di ambiente devono essere specificate come coppie chiave - valore in formato JSON.
--file oppure -f Facoltativo Percorso del file payload JSON contenente la definizione dell'azione da aggiornare. Per ulteriori informazioni, vedi Utilizzo del file di payload. Tieni presente che i parametri, come l'ubicazione o il gruppo di risorse, non possono essere aggiornati dopo la creazione dell'azione.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza richieste utente.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics action get

Recupera i dettagli di un'azione Schematics esistente, come l'ID dell'azione, il nome, lo stato, l'ora di creazione, lo stato di crittografia e il CRN di crittografia, compresi i valori di tutte le variabili di input.

Sintassi

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

Opzioni comando

Schematics azioni get flags
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID di un'azione che si desidera recuperare.
--profile oppure -p Facoltativo La profondità delle informazioni che si desidera richiamare. I valori supportati sono detailed e summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza la modalità interattiva.

Esempio

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

ibmcloud schematics action list

Recupera un elenco di tutte le azioni definite nella regione corrente di IBM Cloud per il proprio account.

Sintassi

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

Opzioni comando

Schematics indicatori elenco azioni
Indicatore Obbligatorio / Facoltativo Descrizione
--limit oppure -l Facoltativo Il numero massimo di azioni che si desidera elencare. Il numero deve essere un numero intero positivo compreso tra 1 e 200. Il valore predefinito è -1.
--offset oppure -m Facoltativo La posizione dell'azione nell'elenco di azioni da cui si desidera iniziare a elencare le azioni. Ad esempio, se si hanno tre azioni nell'account e nella regione, il comando restituisce queste azioni come un elenco con tre elementi. Per richiamare tutte le azioni, è necessario immettere la posizione numero 0. Per richiamare le azioni numero 2 e 3 e tralasciare l'azione numero 1 in questo elenco, è necessario immettere il numero posizione 1. La posizione numero 1 rappresenta la seconda posizione nell'elenco delle azioni. I numeri negativi non sono supportati e vengono ignorati.
--profile oppure -p Facoltativo La profondità delle informazioni restituite. I valori supportati sono ids e summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

ibmcloud schematics action list --profile ids

ibmcloud schematics action delete

Cancellare un'azione di Schematics.

Sintassi

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

Opzioni comando

Schematics azioni elimina indicatori
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID di un'azione che si desidera eliminare.
--force oppure -f Facoltativo Forza l'eliminazione senza conferma utente.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza richieste utente.

Esempio

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

ibmcloud schematics action upload

È possibile caricare un file di archivio su nastro (.tar) dal file system locale a un'azione IBM Cloud Schematics. Immettere il percorso file completo sulla macchina locale in cui è memorizzato il file .tar. Crea il .tar file del tuo repository di template utilizzando il TAR comando fornito tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER.

Sintassi

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

Opzioni comando

Schematics azioni carica indicatori
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio ID di un'azione che si desidera caricare.
--file oppure -f Obbligatorio Percorso del file TAR da caricare per un'azione.
--no-prompt Facoltativo Impostare questo indicatore per arrestare la sessione della riga comandi interattiva.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

Comandi lavoro azioni

Rivedere i comandi per creare, aggiornare, elencare ed eliminare i lavori Schematics quando si lavora con le azioni Schematics.

ibmcloud schematics job run

Creare un lavoro in IBM Cloud Schematics per eseguire il playbook Ansible specificato dall'azione Schematics. È possibile creare un lavoro utilizzando un file di payload o la modalità interattiva del comando.

Sintassi

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]

Opzioni comando

Schematics indicatori di esecuzione lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--command-object oppure -c Obbligatorio Il nome della risorsa di automazione Schematics. Attualmente è supportato solo action.
--command-object-id oppure -cid Obbligatorio L'ID delle azioni Schematics in cui vuoi eseguire il lavoro.
--command-name, oppure -n Obbligatorio Il comando che vuoi eseguire per la tua azione. I valori supportati sono ansible_playbook_check e ansible_playbook_run.
--playbook-name oppure -pn Facoltativo Il nome del playbook Ansible che si desidera eseguire.
--command-options oppure -co Facoltativo Le opzioni della riga comandi per il comando.
--input oppure --in Facoltativo Le variabili di input per un'azione. Questo indicatore può essere impostato più volte e deve avere un formato --inputs test=testvalue.
--input-file oppure --if Facoltativo Variabili di input per un'azione. Fornire il percorso del file JSON che contiene le variabili di input.
--env oppure -e Facoltativo Le variabili di ambiente per un'azione. Questo indicatore può essere impostato più volte e deve avere un formato --env-variables test=testvalue.
--env-file oppure -E Facoltativo Le variabili di ambiente per un'azione. Fornire il percorso del file JSON che contiene le variabili d'ambiente.
--result-format oppure -f Facoltativo L'output della risposta del risultato in formato JSON.
--file oppure -f Facoltativo Percorso del file JSON che contiene la definizione del nuovo lavoro.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Se l'azione contiene il nome del playbook, è necessario aggiungere il nome del playbook, in modo che il nome del playbook dell'azione abbia la precedenza. Se è necessario sovrascrivere il nome del playbook tramite il lavoro, è necessario creare un'azione con il nuovo nome del playbook.

Utilizzo del file payload

È possibile fornire un file di payload per specificare determinati parametri per il comando job run. Quindi, si passa il nome file al comando utilizzando l'opzione del comando --file.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<COMMAND_OBJECT>" come "azione".

Sintassi

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

Esempio

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

Utilizzo della modalità interattiva

Invece di immettere i dettagli del lavoro utilizzando le opzioni del comando o un file di payload, è possibile utilizzare la modalità interattiva per il comando. In questa modalità viene richiesto di inserire i valori richiesti per creare un lavoro in Schematics.

  1. Immettere il comando per creare il job senza alcuna opzione di comando.
    ibmcloud schematics job run
  2. Quando richiesto da Enter command-object>, immettere action e premere il tasto Invio.
  3. Quando richiesto da Enter command-object-id>, immettere i dettagli dell'ID azione e premere il tasto di ritorno.
  4. Quando viene richiesto di Enter command-name>, immettere ansible_playbook_run o ansible_playbook_check e premere il tasto di ritorno.
  5. Esamina l'output della CLI per il lavoro che è stato creato per te.

ibmcloud schematics job update

Creare un lavoro copiando le impostazioni di un lavoro esistente ed eseguire il lavoro in IBM Cloud Schematics.

Sintassi

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

Opzioni comando

Schematics indicatori di aggiornamento lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un processo esistente che si desidera copiare ed eseguire nuovamente.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--no-prompt Facoltativo Impostare questo indicatore per creare il lavoro senza una sessione di riga comandi interattiva.

Esempio

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

ibmcloud schematics job get

Richiamare i dettagli di un lavoro azioni utilizzando un ID lavoro.

Sintassi

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

Opzioni comando

Schematics indicatori di richiamo lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID del lavoro che si desidera recuperare.
--profile oppure -p Facoltativo La profondità delle informazioni che si desidera richiamare. I valori supportati sono detailed e summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--no-prompt Facoltativo Impostare questo indicatore per recuperare i dettagli del lavoro senza una sessione della riga comandi interattiva.

Esempio

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

ibmcloud schematics job list

Recupera un elenco di tutti i lavori Schematics eseguiti per un'azione Schematics. Il comando visualizza un elenco di lavori con lo stato in_progress, success o failed.

Sintassi

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

Opzioni comando

Schematics indicatori elenco lavori
Indicatore Obbligatorio / Facoltativo Descrizione
--resource-type oppure -rt Obbligatorio Il nome della risorsa Schematics. È supportato solo action.
--id oppure -i Obbligatorio L'ID delle azioni Schematics per cui vuoi elencare i lavori.
--limit oppure -l Facoltativo Il numero massimo di spazi di lavoro che desideri elencare. Il numero deve essere un numero intero positivo compreso tra 1 e 200. Il valore predefinito è -1.
--offset oppure -m Facoltativo La posizione del lavoro nell'elenco dei lavori da cui si desidera iniziare ad elencare i lavori. Ad esempio, se nell'account sono presenti tre lavori, il comando restituisce questi lavori come un elenco con tre elementi. Per richiamare tutti i lavori, è necessario immettere il numero posizione 0. Per richiamare il lavoro numero 2 e 3 e lasciare il lavoro numero 1 in questo elenco, è necessario immettere il numero di posizione 1. La posizione numero 1 rappresenta la seconda posizione nell'elenco dei lavori. I numeri negativi non sono supportati e vengono ignorati.
--profile oppure -p Facoltativo La profondità delle informazioni restituite. I valori supportati sono ids o summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--all oppure -A Facoltativo Elenca tutti i lavori inclusi i lavori interni Schematics.
--no-prompt Facoltativo Impostare questo indicatore per creare il lavoro senza una sessione di riga comandi interattiva.

Esempio

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

ibmcloud schematics job logs

Recupera i registri di un lavoro di azione Schematics. Per ulteriori informazioni sulla visualizzazione dei registri dei lavori, vedere Esame dei dettagli del lavoro Schematics.

Sintassi

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

Opzioni comando

Schematics indicatori log lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID del lavoro per il quale si desidera recuperare i registri dettagliati.
--log-prefix oppure --lp Facoltativo Aggiunge il prefisso del comando eseguito nei registri dei lavori.
--log-header oppure --lh Facoltativo Utilizzato per convertire le intestazioni dei comandi nei registri dei lavori nel formato Schematics.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza una sessione di riga comandi interattiva.

Esempio

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

ibmcloud schematics job delete

Elimina un lavoro per un'azione Schematics.

Non è possibile eliminare o arrestare un lavoro in esecuzione. Per rimuovere un lavoro, è necessario attenderne il completamento.

Sintassi

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

Opzioni comando

Schematics indicatori eliminazione lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID del lavoro che si desidera eliminare.
--force oppure -f Facoltativo Per forzare l'eliminazione senza la conferma dell'utente.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza una sessione di riga comandi interattiva.

Esempio

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

Comandi agent

ibmcloud schematics agent create

Crea la registrazione di un agente nella regione Schematics attualmente selezionata. Gli agenti aiutano a eseguire i lavori Terraform o Ansible sulla vostra infrastruttura. Per ulteriori informazioni sui passi per l'utilizzo del comando di creazione, consultare Distribuzione degli agent.

Sintassi

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]

Opzioni comando

Schematics Indicatori di creazione agent
Indicatore Obbligatorio / Facoltativo Descrizione
--name oppure -n Obbligatorio Il nome univoco di un agent. Deve essere descrittivo del ruolo, della posizione e dell'uso dell'agent.
--location oppure -l Obbligatorio La posizione Schematics in cui sono definiti gli agenti, us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. I lavori vengono prelevati da questa postazione per essere eseguiti.
--agent-location oppure --al Obbligatorio Un'etichetta descrittiva definita dall'utente per identificare dove viene distribuito l'agent nell'ambiente utente. Potrebbe essere una regione cloud o un data center utente. Ad esempio, London MZR.
--cluster-id oppure -c Obbligatorio L'ID del cluster Kubernetes per la distribuzione di un agente.
--cluster-resource-group oppure --cg Obbligatorio Il nome del gruppo di risorse del cluster.
--cos-instance-name oppure --on Obbligatorio Il nome dell'istanza COS.
--cos-bucket oppure -b Obbligatorio L'ID o il nome del bucket COS.
--cos-location oppure --ol Obbligatorio L'ubicazione del bucket COS. I formati supportati sono eu-gb, us-south e così via.
--resource-group oppure -g Obbligatorio Nome o ID del gruppo di risorse a cui è associato l'agente.
--version oppure -v Obbligatorio Un'etichetta definita dall'utente che specifica la versione dell'agent. Esempio v1.0.0
--infra-type oppure -i Obbligatorio Specificare il tipo di infrastruttura agente di destinazione. I valori supportati sono ibm-kubernetes, ibm-openshift o ibm-satellite.
--description oppure -d Facoltativo Una descrizione che identifica l'utilizzo dell'agente e le zone di rete e le risorse a cui l'agente può accedere.
--tags oppure -t Facoltativo Tag agent. È possibile ripetere l'indicatore più volte. I tag consentono una ricerca più rapida e semplice per le risorse relative all'agent.
--metadata oppure --md Facoltativo Metadati dell'agent. È possibile utilizzare l'indicatore più volte. Ad esempio, git:private-git.github.com o git:gitlab.com. Se non è impostato, il valore predefinito è git:github.com.
--validate Facoltativo Eseguire l'operazione di convalida dopo aver creato l'agent.
--deploy Facoltativo Eseguire l'operazione di distribuzione senza convalidare, dopo aver creato l'agent.
--file oppure f Facoltativo Percorso di un file JSON contenente la definizione di un agente.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

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

Disinstallare un agent. Per ulteriori informazioni sui passaggi per utilizzare il comando delete, consultare eliminazione di un agente.

Sintassi

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

Opzioni comando

Schematics Indicatori di eliminazione agent
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--force oppure -f Facoltativo L'azione di forza senza conferma. Impostare il parametro --force su true per eliminare tutti i flussi dell'agent per mantenere la distruzione parallela al flusso di distruzione dello spazio di lavoro. Per impostazione predefinita, questo parametro è impostato su false.

Esempio

ibmcloud schematics agent delete --id <AGENT_ID>

ibmcloud schematics agent deploy

Distribuire o aggiornare un agente per forzare la distribuzione. Per ulteriori informazioni sulla procedura per utilizzare il comando di distribuzione, consultare Distribuzione dell'agent.

Sintassi

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

Opzioni comando

Indicatori di distribuzione dell'agent Schematics
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--force-redeploy oppure -fd Facoltativo Forza la ridistribuzione di un Agent.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics agent deploy --id <AGENT_ID>

ibmcloud schematics agent destroy

Distruggere un agente distrugge le risorse cloud associate alla distribuzione dell'agente Schematics.

Sintassi

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

Opzioni comando

Schematics Indicatori di eliminazione agent
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--force oppure -f Facoltativo L'azione di forza senza conferma.

Esempio

ibmcloud schematics agent destroy --id <AGENT_ID>

ibmcloud schematics agent get

Recupera i dettagli di un agente esistente, come ID agente, Nome, Stato, Versione, Ora di creazione, Stato di crittografia e CRN di crittografia, compresi i valori di tutte le variabili di input. Per ulteriori informazioni sui passaggi per l'utilizzo del comando get, vedere Visualizzazione di un agente

Sintassi

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

Opzioni comando

Schematics Indicatori di acquisizione agent
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics agent get --id <AGENT_ID>

ibmcloud schematics agent health

Esegue la convalida post - distribuzione di un agente. Per ulteriori informazioni sulla procedura per utilizzare il comando di integrità dell'agent, consultare Integrità dell'agent di monitoraggio.

Sintassi

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

Opzioni comando

Schematics Indicatori di integrità agent
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics agent health --id <AGENT_ID>

ibmcloud schematics agent list

Elenca gli agent definiti nell'area Schematics corrente. Per ulteriori informazioni sulla procedura per utilizzare il comando list, consultare Visualizzazione di un agent.

Sintassi

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

Opzioni comando

Schematics Indicatori elenco agent
Indicatore Obbligatorio / Facoltativo Descrizione
--location oppure -l Facoltativo Luoghi geografici supportati dal servizio IBM Cloud Schematics come us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon.
--limit oppure -lm Facoltativo Numero massimo di agent da elencare. Ignorato se viene impostato un numero negativo. Il limite massimo è 200 (il valore predefinito è -1).
--offset oppure -m Facoltativo Offset in elenco. Ignorato se viene impostato un numero negativo (default: -1)).
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics agent list --location us-south

ibmcloud schematics agent update

Aggiornare una configurazione dell'agente. L'aggiornamento di un agente non comporta una nuova convalida o una nuova distribuzione dell'agente. Per ulteriori informazioni sulla procedura per utilizzare il comando di aggiornamento dell'agent, consultare Distribuzione dell'agente.

Sintassi

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

Opzioni comando

Indicatori di aggiornamento dell'agente Schematics
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID di un agente.
--tags oppure -t Facoltativo Tag agent. Questo flag può essere usato più volte e consente di cercare più rapidamente le risorse relative all'agente.
--description oppure -d Facoltativo Breve descrizione di un agente.
--version value oppure -v Facoltativo Specificare la versione di un agente. Il valore predefinito è l'ultima versione disponibile.
--metadata Facoltativo Metadati dell'agent. È possibile utilizzare l'indicatore più volte. Ad esempio, git:private-git.github.com o git:gitlab.com. Se non è impostato, il valore predefinito è git:github.com.
--file oppure -f Facoltativo Percorso del file JSON che contiene la definizione dell'agente.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.
--no-prompt Facoltativo Impostare questo indicatore per aggiornare un inventario senza una sessione di riga comandi interattiva.

Esempio

ibmcloud schematics agent update --id <AGENT_ID>

ibmcloud schematics agent validate

Verifica la scansione dei prerequisiti che analizza una configurazione di agent e cluster prima della distribuzione. Per ulteriori informazioni sulla procedura per l'utilizzo del comando di convalida, consultare distribuzione dell'agente.

Sintassi

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

Opzioni comando

Indicatori di convalida agent Schematics
Indicatore Obbligatorio / Facoltativo Descrizione
--id Obbligatorio L'ID dell'agente.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics agent validate --id AGENT_ID

Comandi della politica degli agenti

Schematics (assegnazione) indicano a Schematics l'agente da utilizzare per l'esecuzione dei lavori dell'area di lavoro e delle azioni in una zona di rete specifica. A ogni agente è associata almeno una politica per identificare i lavori da eseguire nella posizione degli agenti. Vedere politiche di assegnazione.

ibmcloud schematics policy create

Creare un criterio utilizzando Schematics per selezionare uno o più oggetti Schematics, come un'area di lavoro o un'azione, da eseguire sull'agente di destinazione.

Sintassi

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]

Opzioni comando

Schematics indicatori di creazione politica
Indicatore Obbligatorio / Facoltativo Descrizione
--name oppure -n Obbligatorio Il nome univoco del criterio.
--kind oppure -K Obbligatorio Tipo di politica per la gestione e la derivazione della decisione di politica. Il supporto è agent_assignment_policy.
--location oppure -l Facoltativo Posizione geografica del servizio Schematics in cui è definito l'agente. Ad esempio, us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. I lavori vengono prelevati da questa ubicazione per l'elaborazione.
--resource-group oppure -r Obbligatorio Nome o ID del gruppo di risorse per la politica.
--target-file oppure tf Facoltativo Percorso del file JSON contenente la definizione della politica.
--description oppure -d Facoltativo La descrizione della politica di Schematics.
--tags oppure -t Facoltativo Le tag possono essere utilizzate più volte per ricercare e individuare più rapidamente le politiche dell'agent.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Utilizzo del file payload

È possibile fornire un file di payload per specificare determinati parametri per il comando policy create. Quindi, si passa il nome file al comando utilizzando l'opzione del comando --target-file.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<SELECTOR_KIND>" come "ids".

Sintassi

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

Esempio

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

Esempio

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

Eliminare un criterio Schematics.

Sintassi

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

Opzioni comando

Schematics indicatori di eliminazione della politica
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID della polizza.
--force oppure -f Facoltativo L'azione di forza senza conferma.

Esempio

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

ibmcloud schematics policy get

Recupera i dettagli di un criterio esistente di Schematics utilizzando l'ID del criterio.

Sintassi

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

Opzioni comando

Schematics indicatori get della politica
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio ID della politica.
--profile oppure -p Facoltativo Livello dei dettagli da restituire. I valori validi sono summary, detailed, o ids. L'impostazione predefinita è summary.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

ibmcloud schematics policy get --id <POLICY_ID>

ibmcloud schematics policy list

Recupera un elenco di tutte le polizze dell'area IBM Cloud per il proprio account.

Sintassi

ibmcloud schematics policy list [--profile PROFILE] [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]
Schematics Indicatori elenco politiche
Indicatore Obbligatorio / Facoltativo Descrizione
--profile oppure -r Facoltativo Il livello di dettaglio da restituire. I valori validi sono summary, detailed e ids. L'impostazione predefinita è summary.
--limit oppure -l Facoltativo Numero massimo di politiche da elencare. Ignorato se viene impostato un numero negativo. Il numero deve essere un numero intero positivo compreso tra 1 e 200. Il valore predefinito è -1.
--offsetoppure -m Facoltativo Offset in elenco. Ignorato se viene impostato un numero negativo. Il valore predefinito è -1.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

ibmcloud schematics policy list  --profile ids092030

ibmcloud schematics policy update

Aggiornare una politica esistente utilizzando l'ID politica.

Sintassi

ibmcloud schematics policy update --id POLICY_ID [--kind POLICY_KIND] [--description DESCRIPTION] [--resource-group RESOURCE_GROUP] [--tags TAGS] [--file FILE] [--output OUTPUT]
Schematics indicatori di aggiornamento della politica
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio ID della politica.
--kind oppure -k Facoltativo Tipo di politica per la gestione e la derivazione della decisione di politica. Il supporto è agent_assignment_policy.
--description oppure -d Facoltativo Descrizione della politica di personalizzazione di Schematics.
--resource-group oppure -r Facoltativo Nome o ID del gruppo di risorse per la politica.
--tags oppure -t Facoltativo Tag di politica. Questo indicatore può essere utilizzato più volte per ricercare e individuare più rapidamente le politiche agent.
--file oppure -f Facoltativo Percorso del file JSON contenente la definizione del criterio.
--output oppure -o Facoltativo Specificare il formato di uscita; è supportato solo JSON.

Esempio

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

Configurare i comandi BYOK o KYOK

È possibile utilizzare le chiavi di crittografia di IBM Key Protect (disponibili come Multi-Tenant per BYOK o Dedicated per KYOK) per crittografare e proteggere i dati archiviati in Schematics. Per ulteriori informazioni su come proteggere i dati sensibili in Schematics, vedere Protezione dei dati sensibili in Schematics.

Hyper Protect Crypto Services (HPCS) è stato deprecato per le nuove integrazioni. Le integrazioni HPCS esistenti continueranno a funzionare, ma le nuove integrazioni con HPCS non sono più supportate. Per le nuove integrazioni, utilizzare Key Protect Dedicato per le funzionalità KYOK.

Prima di iniziare

Affinché il sistema di gestione delle chiavi elenchi le istanze create a partire dalla vostra specifica località e regione, è necessario garantire i seguenti prerequisiti.

L'impostazione KMS è una singola impostazione. Devi aprire un ticket di supporto per aggiornare le impostazioni KMS.

ibmcloud schematics kms instance ls

Elenca tutte le istanze KMS dell'account IBM Cloud per trovare Key Protect o Hyper Protect Crypto Services utilizzando la posizione in cui vengono create le chiavi e lo schema di crittografia come KYOK, o BYOK.

Sintassi

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

Opzioni comando

Schematics Indicatori elenco KMS
Indicatore Obbligatorio / Facoltativo Descrizione
--location oppure -l Obbligatorio Imposta il nome ubicazione Schematics. I valori supportati sono US, o EU.
--scheme oppure -s Obbligatorio Specificare lo schema di codifica. I valori supportati sono KYOK, o BYOK.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics kms enable

Abilitare KMS per crittografare i dati nell'ubicazione specifica. Per ulteriori informazioni sull'abilitazione delle chiavi gestite dal cliente per Schematics, vedi abilitazione delle chiavi.

Aggiorna le impostazioni KMS per la tua ubicazione utilizzando il tuo endpoint privato, CRN, primario CRK e secondario CRK. Notare che è possibile aggiornare le impostazioni KMS solo una volta. Ad esempio, se utilizzi un endpoint API per un'area geografica, come North America, vengono richiamati solo quelli creati in us-south o us-east.

Sintassi

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]

Opzioni comando

Schematics Indicatori di abilitazione KMS
Indicatore Obbligatorio / Facoltativo Descrizione
--location oppure -l Obbligatorio Imposta il nome ubicazione Schematics. I valori supportati sono US, o EU.
--scheme oppure -s Obbligatorio Specificare lo schema di codifica. I valori supportati sono KYOK, o BYOK.
--group oppure -g Obbligatorio Specificare il nome del gruppo di risorse. Il valore predefinito è Default.
--primary_name oppure --pn Obbligatorio Specificare il nome del KMS primario.
--primary_crn oppure --pc Obbligatorio Specificare il nome CRN della chiave primaria.
--primary_endpoint oppure --pe Obbligatorio Specificare l'endpoint privato KMS primario.
--secondary_name oppure --sn Facoltativo Specificare il nome KMS secondario.
--secondary_crn oppure --sc Facoltativo Specificare il CRN della chiave secondaria.
--secondary_endpoint oppure --se Facoltativo Specificare l'endpoint privato KMS secondario.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

Richiama il KMS sull'endpoint API di cui disponi KYOK o BYOK. Ad esempio, se utilizzi un endpoint API per un'area geografica, come North America, vengono richiamati solo quelli creati in us-south o us-east. Nota che devi attivare kms instances nel tuo account per eseguire la riga di comando info.

Sintassi

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

Opzioni comando

Schematics Indicatori informazioni KMS
Indicatore Obbligatorio / Facoltativo Descrizione
--location oppure -l Obbligatorio Imposta il nome ubicazione Schematics. I valori supportati sono US, o EU.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

ibmcloud schematics kms info -l US

Comandi generali

Utilizzate questi comandi generali per trovare informazioni sulla guida e sulla versione del plug-in a riga di comando IBM Cloud Schematics.

ibmcloud schematics help

Visualizzare i comandi della riga di comando IBM Cloud Schematics supportati.

Sintassi

ibmcloud schematics help

Opzioni comando

Schematics indicatori della guida
Indicatore Obbligatorio / Facoltativo Descrizione
--help oppure -h Obbligatorio Elenca i comandi supportati.
command Facoltativo Specificare il nome del comando per richiamare i dettagli del comando.

Esempio

ibmcloud schematics help

ibmcloud schematics version

Elencare le versioni di tutti i progetti open source supportati in Schematics, come IBM Cloud Provider Plug-in for Terraform, Ansible, Helm e Kubernetes che vengono utilizzati per eseguire azioni Schematics su risorse Cloud.

Sintassi

ibmcloud schematics version [--output OUTPUT]

Opzioni comando

Schematics indicatori di versione
Indicatore Obbligatorio / Facoltativo Descrizione
--output oppure -o Facoltativo Restituisce l'output della CLI in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

Comandi di inventario

Esaminare i comandi per creare, aggiornare, elencare, cancellare e lavorare con gli inventari di IBM Cloud Schematics utilizzati con le azioni di Schematics.

ibmcloud schematics inventory create

Per creare un inventario di risorse in Schematics da usare con un'azione di Ansible, si può usare un file di payload o la modalità interattiva. L'inventario include tutti gli host di destinazione su cui si intende eseguire il playbook Ansible.

Sintassi

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]

Opzioni di comando

Schematics indicatori di creazione inventario
Indicatore Obbligatorio / Facoltativo Descrizione
--name oppure -n Obbligatorio Il nome univoco di un inventario di risorse.
--description oppure -d Facoltativo La descrizione breve di un inventario.
--location oppure -l Facoltativo La posizione in cui si vuole memorizzare l'inventario delle risorse, come us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon.
resource-group oppure -r Facoltativo Il nome del gruppo di risorse in cui si vuole creare l'azione.
--connection-type oppure --ct Facoltativo Tipo di connessione all'inventario. Supporta sia ssh che winrm.
--bastion-ip-address oppure -b Facoltativo Inserire l'indirizzo IP dell'host Bastion.
--bastion-credential-json oppure --bj Facoltativo Fornire il percorso del file JSON che contiene il payload delle credenziali Bastion per accedere all'host Bastion.
--credential-json oppure --cj Facoltativo Fornire il percorso del file JSON contenente il payload delle credenziali comuni per l'accesso agli host di destinazione. La gerarchia delle credenziali in Schematics segue questo ordine: Credenziali a livello di host (priorità massima), credenziali a livello di gruppo (priorità successiva) e credenziali comuni (priorità minima).
--inventory-view-json oppure --inv Facoltativo Percorso del file JSON che contiene i dettagli dell'host. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--inventories-ini-file oppure -y Facoltativo Il percorso del file di inventario delle risorse in cui sono stati specificati tutti gli host di destinazione. Il file di inventario delle risorse deve essere fornito in formato INI. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--resource-query Facoltativo Immettere l'ID di una query della risorsa creata. Una query delle risorse aiuta a costruire dinamicamente il tuo inventario delle risorse utilizzando le risorse cloud che hai creato con un'area di lavoro di Schematics. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--file oppure -f Facoltativo Il percorso del file JSON in cui è stato specificato l'inventario delle risorse che si desidera creare.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.
--no-prompt Facoltativo Impostare questo indicatore per creare un inventario senza una sessione della riga comandi interattiva.

Utilizzo del file payload

È possibile fornire un file di payload per specificare determinati parametri per il comando inventory create. Quindi, si passa il nome file al comando utilizzando l'opzione del comando --file.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<INVENTORY_NAME>" come "myinventory".

Sintassi per un elemento 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Sintassi per un elemento 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
            }
        }
    ]
}

Sintassi per un elemento bastion_credentials_example.json

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

}

ibmcloud schematics inventory create --file inventory.json

Utilizzo della modalità interattiva

Invece di immettere i tuoi dettagli di inventario utilizzando le opzioni di comando o un file di payload, puoi anche utilizzare la modalità interattiva per il comando. In questa modalità viene richiesto di inserire i valori richiesti per creare un inventario in Schematics.

  1. Immettere il comando per creare l'inventario senza alcuna opzione di comando.

    ibmcloud schematics inventory create ....

  2. Immettere un nome per l'inventario e premere il tasto Invio.

  3. Immettere il gruppo di risorse in cui si desidera creare l'inventario e premere il tasto Invio.

  4. Immettere la posizione in cui si desidera creare l'inventario, ad esempio us-south, us-east, eu-de, o eu-gb. Quindi, premere il tasto Invio.

  5. Esaminare i dettagli dell'inventario che è stato creato.

Esempio

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

Eliminare la definizione di inventario delle risorse utilizzando l'ID inventario.

Sintassi

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

Opzioni comando

Schematics indicatori di eliminazione inventario
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID di un inventario che si desidera eliminare.
--force oppure -f Facoltativo Forza l'eliminazione senza conferma utente.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza richieste utente.

Esempio

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

ibmcloud schematics inventory get

Recupera le informazioni dettagliate di un inventario IBM Cloud Schematics esistente utilizzando l'ID dell'inventario.

Sintassi

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

Opzioni comando

Schematics indicatori di acquisizione inventario
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID dell'inventario di risorse per il quale si desidera elencare informazioni dettagliate.
--profile oppure -p Facoltativo La profondità delle informazioni che si desidera richiamare. I valori supportati sono detailed e summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.
--no-prompt Facoltativo Impostare questo indicatore per richiamare i dettagli di un inventario senza una sessione della riga comandi interattiva.

Esempio

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

ibmcloud schematics inventory list

Recupera un elenco di tutti gli inventari di Schematics nella regione corrente per il proprio account.

Sintassi

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

Opzioni comando

Schematics indicatori elenco lavori
Indicatore Obbligatorio / Facoltativo Descrizione
--limit oppure -l Facoltativo Il numero massimo di inventari che si desidera elencare. Il numero deve essere un numero intero positivo compreso tra 1 e 200. Il valore predefinito è -1.
--offset oppure -m Facoltativo La posizione dell'inventario nell'elenco degli inventari. Ad esempio, se nel conto sono presenti tre inventari, il comando restituisce questi inventari come un elenco con tre elementi. Per visualizzare un inventario specifico in questo elenco, è necessario inserire il numero di posizione che l'inventario ha nell'elenco. Per elencare il primo inventario nell'elenco, immettere 0. Per elencare il secondo inventario, immettere 1 e così via. I numeri negativi non sono supportati e vengono ignorati. Il valore predefinito è -1.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.

Esempio

ibmcloud schematics inventory list --output json

ibmcloud schematics inventory update

Aggiornare un inventario delle risorse esistente.

Sintassi

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]

Opzioni comando

Schematics indicatori di aggiornamento inventario
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio Inserire l'ID dell'inventario delle risorse che si desidera aggiornare.
--name oppure -n Obbligatorio Il nome univoco di un inventario.
--description oppure -d Facoltativo La descrizione breve di un inventario.
--location oppure -l Facoltativo Le località geografiche supportate dal servizio IBM Cloud Schematics, come us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon.
resource-group oppure -r Facoltativo Il nome del gruppo di risorse per un'azione.
--connection-type oppure --ct Facoltativo Tipo di connessione all'inventario. Supporta sia ssh che winrm.
--bastion-ip-address oppure -b Facoltativo Inserire l'indirizzo IP dell'host Bastion.
--bastion-credential-json oppure --bj Facoltativo Fornire il percorso del file JSON che contiene il payload delle credenziali Bastion per accedere all'host Bastion.
--credential-json oppure --cj Facoltativo Fornire il percorso del file JSON contenente il payload delle credenziali comuni per l'accesso agli host di destinazione. La gerarchia delle credenziali in Schematics segue questo ordine: Credenziali a livello di host (priorità massima), credenziali a livello di gruppo (priorità successiva) e credenziali comuni (priorità minima).
--inventory-view-json oppure --inv Facoltativo Percorso del file JSON che contiene i dettagli dell'host. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--inventories-ini-file oppure -y Facoltativo Percorso del file in formato INI che contiene i dettagli dell'host. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--resource-query Facoltativo Immettere l'ID di una query della risorsa creata. Una query delle risorse aiuta a costruire dinamicamente il tuo inventario delle risorse utilizzando le risorse cloud che hai creato con un'area di lavoro di Schematics. È necessario passare il percorso del file --inventories-ini-file, l'ID --resource-query o --inventory-view-json affinché l'inventario utilizzi i dettagli dell'host di destinazione. Se si forniscono due o tutti e tre gli argomenti, si deve lanciare un errore.
--file oppure -f Facoltativo Percorso del file JSON contenente la definizione di un inventario.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.
--no-prompt Facoltativo Impostare questo indicatore per aggiornare un inventario senza una sessione di riga comandi interattiva.

Utilizzo del file payload

È possibile fornire un file di payload per specificare determinati parametri per il comando inventory update. Quindi, si passa il nome file al comando utilizzando l'opzione del comando --file.

Sintassi per un elemento 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Esempio

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

Comandi di query delle risorse di inventario

Creare dinamicamente gli inventari delle risorse delle azioni utilizzando le query delle risorse. Le query sulle risorse consentono di raccogliere informazioni sull'host di destinazione dagli spazi di lavoro di Schematics. Per ulteriori informazioni sulle query e le condizioni delle risorse, vedere Creazione di inventari di risorse per le azioni di Schematics.

ibmcloud schematics resource query create

Creare una query di risorse in IBM Cloud Schematics da utilizzare per costruire l'inventario delle risorse. È possibile creare una query di risorsa utilizzando un file di payload o la modalità interattiva del comando. Puoi creare condizioni di risorsa utilizzando le query di risorsa.

Sintassi

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]

Opzioni comando

Schematics indicatori di creazione query risorsa
Indicatore Obbligatorio / Facoltativo Descrizione
--name oppure -n Obbligatorio Il nome univoco per una query di risorsa.
--type oppure -t Facoltativo Il tipo di risorsa che si desidera recuperare. I valori supportati sono vsi.
--query-file oppure -f Facoltativo Il percorso del file JSON in cui hai specificato i dettagli della tua query della risorsa. Per trovare un elenco di query supportate, consultare Query di risorse supportate.
--file oppure -f Facoltativo Il percorso del file JSON che specifica i dettagli della query della risorsa che si desidera creare.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--no-prompt Facoltativo Impostare questo indicatore per creare la query della risorsa senza una sessione della riga comandi interattiva.

Utilizzo del file payload

È possibile fornire un file di payload per specificare determinati parametri per il comando resource_query create. Quindi, si passa il nome file al comando utilizzando l'opzione del comando --file. Per un elenco di query di risorse supportate, consultare Query di risorse supportate.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<WORKSPACE_ID" come us-east.workspace.ID1231.

Sintassi

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

Esempio

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

Utilizzo della modalità interattiva

Invece di immettere i dettagli della query della risorsa utilizzando le opzioni del comando o un file di payload, è possibile utilizzare la modalità interattiva per il comando. Questa modalità richiede di inserire i valori richiesti per creare una query di risorse in Schematics. Puoi creare condizioni di risorsa utilizzando le query di risorsa.

  1. Immettere il comando per creare la query della risorsa senza alcuna opzione di comando.
    ibmcloud schematics resource-query create
  2. Immettere un nome per la query della risorsa e premere il tasto Invio.
  3. Immettere il percorso del file payload. Per un file payload di esempio, consultare Utilizzo del file payload. Quindi, premere il tasto Invio.
  4. Esaminare i dettagli della query della risorsa che è stata creata per l'utente.

ibmcloud schematics resource query delete

Eliminare la definizione della query della risorsa utilizzando l'ID della query della risorsa dal servizio IBM Cloud Schematics. Notare che è possibile eliminare l'ubicazione e la regione, il gruppo di risorse da cui è stato creato l'inventario. Inoltre, assicurati che i tuoi indirizzi IP siano nell'allowlist.

Sintassi

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

Opzioni comando

Schematics indicatori di eliminazione query risorsa
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID di una query di risorsa che si desidera eliminare.
--force oppure -f Facoltativo Forza l'eliminazione senza conferma utente.
--no-prompt Facoltativo Impostare questo indicatore per eseguire il comando senza richieste utente.

Esempio

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

ibmcloud schematics resource query get

Recupera le informazioni di una query di risorse esistente su IBM Cloud Schematics utilizzando un ID di query di risorse.

Sintassi

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

Opzioni comando

Schematics indicatori di richiamo della query della risorsa
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID della query di risorse che si desidera recuperare.
--profile oppure -p Facoltativo La profondità delle informazioni che si desidera richiamare. I valori supportati sono detailed e summary. Il valore predefinito è summary.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.
--no-prompt Facoltativo Impostare questo indicatore per richiamare una query della risorsa senza una sessione della riga comandi interattiva.

Esempio

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

ibmcloud schematics resource query list

Recupera un elenco di tutte le query di risorse Schematics nella regione corrente per il proprio account.

Sintassi

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

Opzioni comando

Schematics indicatori dell'elenco di query delle risorse
Indicatore Obbligatorio / Facoltativo Descrizione
--limit oppure -l Facoltativo Il numero massimo di query di risorse che si desidera elencare. Il numero deve essere un numero intero positivo compreso tra 1 e 200. Il valore predefinito è -1.
--offset oppure -m Facoltativo La posizione della query risorsa nell'elenco di query risorsa. Ad esempio, se nell'account sono presenti tre query di risorse, il comando restituisce queste query di risorse come un elenco con tre elementi. Per vedere una specifica query di risorse in questo elenco, è necessario inserire il numero di posizione che la query di risorse ha nell'elenco. Per elencare la prima query della risorsa nell'elenco, immettere 0. Per elencare la seconda query della risorsa, immettere 1 e così via. I numeri negativi non sono supportati e vengono ignorati. Il valore predefinito è -1.
--output oppure -o Facoltativo Specifica il formato dell'output. È supportato solo il formato JSON.

Esempio

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

ibmcloud schematics resource query update

Aggiorna o sostituisci una query di risorse crea una copia di una query di risorse e rilancia una query di risorse esistente aggiornando le informazioni di una query di risorse esistente IBM Cloud Schematics.

Sintassi

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]

Opzioni comando

Schematics indicatori di aggiornamento della query della risorsa
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID della query della risorsa.
--name oppure -n Obbligatorio Il nome univoco per una query di risorsa.
--type oppure -t Facoltativo Il tipo di query della risorsa. come vsi
--query-file oppure -f Facoltativo Il percorso del file JSON contenente le query.
--file oppure -f Facoltativo Percorso del file JSON contenente la definizione di un inventario.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--no-prompt Facoltativo Impostare questo indicatore per creare la query della risorsa senza una sessione della riga comandi interattiva.

Esempio

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

Comandi dello spazio di lavoro

Esaminare i comandi che si possono usare per creare e lavorare con l'area di lavoro IBM Cloud Schematics.

ibmcloud schematics workspace action

Recupera tutte le attività (lavori) per un'area di lavoro, compreso l'ID utente della persona che ha avviato l'azione, lo stato e un timestamp.

Quando si crea un piano di esecuzione Terraform o si applica il modello Terraform con Schematics, viene creata automaticamente un'azione Schematics e le viene assegnato un ID azione. È possibile utilizzare l'ID dell'azione per recuperare i log di questa azione utilizzando il comando ibmcloud schematics logs comando.

Sintassi

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

Opzioni comando

Schematics indicatori di esecuzione dello spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro per cui desideri richiamare le attività dello spazio di lavoro. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--act-id oppure -a Facoltativo Immetti l'ID di un'azione che desideri richiamare.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

ibmcloud schematics workspace action --id <WORKSPACE_ID>

ibmcloud schematics workspace delete

Elimina uno spazio di lavoro dalla regione corrente per il tuo account. L'eliminazione dell'area di lavoro non rimuove le risorse Cloud che sono state fornite con questa area di lavoro. Puoi accedere alle tue risorse e utilizzarle direttamente dal dashboard IBM Cloud, ma non puoi utilizzare IBM Cloud Schematics per gestire le tue risorse una volta eliminato lo spazio di lavoro.

Decidere se si desidera eliminare lo spazio di lavoro, qualsiasi risorsa associata o entrambi. Questa azione non può essere annullata. Se si rimuove l'area di lavoro e si mantengono le risorse, è necessario gestire le risorse con l'elenco delle risorse o con la CLI.

elimina spazio di lavoro e risorsa associata
Azione Elimina spazio di lavoro Elimina tutte le risorse associate
Elimina area di lavoro True False
Elimina solo risorse False True
Elimina lo spazio di lavoro e le risorse fornite dallo spazio di lavoro True True
Risorse eliminate utilizzando la riga comandi o l'elenco di risorse e si desidera eliminare lo spazio di lavoro True False

Sintassi

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

Opzioni comando

Schematics indicatori di eliminazione spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro che desideri rimuovere. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--force oppure -f Facoltativo Forzare l'eliminazione dell'area di lavoro senza richiedere l'intervento della riga di comando.

Esempio

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

ibmcloud schematics workspace get

Recupera i dettagli di un'area di lavoro esistente, come l'ID dell'area di lavoro, il nome, lo stato, la versione, l'ora di creazione, l'ID del modello, l'ID dell'impegno, lo stato della crittografia e il CRN della crittografia, compresi i valori di tutte le variabili di input.

Sintassi

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

Opzioni comando

Schematics indicatori get
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro, per cui desideri richiamare i dettagli. Per trovare il Resource ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list per visualizzare le istanze del servizio elenco. Dal tuo gruppo di risorse ottieni un Resource ID per l'indicatore --id.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

ibmcloud schematics workspace get --id <WORKSPACE_ID>

ibmcloud schematics workspace import

È possibile importare una risorsa esistente con un indirizzo di risorsa valido nel file di stato dello spazio di lavoro. È necessario assicurarsi che la risorsa venga importata solo una volta e in un unico workspace. In caso contrario, è possibile che venga visualizzato un comportamento indesiderato se la risorsa è definita in più aree di lavoro. Esamina la documentazione Terraform per dettagli su come utilizzare il comando import.

Sintassi

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

Opzioni comando

Schematics indicatori importazione workspace
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro per il quale si desidera importare un'istanza o una risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--options oppure -o Obbligatorio Gli indicatori della riga comandi. Ad esempio -var-file xxxxx/tf.
--address oppure -adr Obbligatorio Fornire l'indirizzo del nome risorsa che si desidera importare.
--resourceID oppure -rid Obbligatorio Fornire l'ID risorsa necessario per l'importazione nel file.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Utilizza l'opzione -options -var-file=schematics.tfvars per indicare a Schematics di importare la risorsa con le variabili dello spazio di lavoro salvate.

Esempio

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

Elenca gli spazi di lavoro per l'area corrente del tuo account IBM Cloud e mostra i dettagli per il tuo spazio di lavoro. Elenca i controlli dello spazio di lavoro per l'obsolescenza in un loop richiamando l'API versions ogni volta per tutto lo spazio di lavoro tramite la cache dei file.

Sintassi

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

Opzioni comando

Schematics indicatori elenco spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--limit oppure -l Facoltativo Il numero massimo di spazi di lavoro che desideri elencare. Il numero deve essere un intero positivo a partire da 1; il massimo è 200. Il valore predefinito è -1.
--offset oppure -m Facoltativo La posizione dello spazio di lavoro nell'elenco degli spazi di lavoro. Ad esempio, se hai tre spazi di lavoro nel tuo account, il comando restituisce questi spazi di lavoro sotto forma di elenco con tre elementi. Per visualizzare uno spazio di lavoro specifico in questo elenco, devi immettere il numero di posizione che ha nell'elenco. Per elencare il primo spazio di lavoro nell'elenco, immettere 0. Per elencare il secondo spazio di lavoro, immettere 1 e così via. I numeri negativi non sono supportati e vengono ignorati. Il valore predefinito è -1.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.
--region oppure -r Facoltativo Specificare la regione, ad esempio eu, us, eu-gb, eu-de, us-south, o us-east.

Esempio

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

ibmcloud schematics workspace new

Crea uno spazio di lavoro Schematics che punti al tuo template Terraform in GitHub o GitLab. Se vuoi fornire il tuo modello Terraform caricando un file di archivio nastro (.tar), puoi creare lo spazio di lavoro senza una connessione a un repository GitHub e quindi utilizzare il comando ibmcloud schematics workspace upload per fornire il modello.

Schematics non supporta il passaggio del file .tar per creare un'area di lavoro.

IBM Cloud Schematics supporta 50 richieste API al minuto, per host e per cliente. L'ubicazione può essere la regione us-east, us-south, eu-gb o eu-de. È necessario attendere prima di richiamare nuovamente il comando.

Per creare uno spazio di lavoro, è possibile specificare le impostazioni dello spazio di lavoro in un file JSON. Accertati che il file JSON segua la struttura come delineato in questo comando. Assicurati inoltre che location e l'endpoint url puntino alla stessa regione quando crei o aggiorni spazi di lavoro e azioni. Per ulteriori informazioni sull'ubicazione e sull'endpoint, vedi Dove sono archiviate le mie informazioni?.

IBM Cloud Schematics sta deprecando le vecchie versioni di Terraform e introducendo il supporto per le nuove versioni di Terraform. Per ulteriori informazioni, consultare il ciclo di vita della deprecazione di Schematics Terraform e il Programma di deprecazione.

Sintassi

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

Opzioni comando

Schematics indicatori di creazione dello spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--file oppure -f Obbligatorio Il percorso relativo a un file JSON nella tua macchina locale,utilizzato per configurare il tuo spazio di lavoro.. Per ulteriori informazioni sul file JSON di esempio con i dettagli, consultare JSON file create template.
--state Facoltativo Il percorso relativo a un file di stato Terraform esistente sulla macchina locale. Per creare il file di stato Terraform:
1. Mostra il contenuto di un file di stato Terraform esistente utilizzando il comando ibmcloud schematics state pull.
2. Copiare il contenuto del file di stato dall'output della riga comandi in un file sulla macchina locale denominato terraform.tfstate.
3. Utilizzare il percorso relativo al file nel parametro del comando --state. Nota Lo spazio di lavoro Schematics supporta il file terraform.tfstate inferiore a 2 MB.
--github-token oppure -g Facoltativo Inserire i token di accesso personali funzionali per le operazioni HTTPS Git. Ad esempio, --github-token ${FUNCTIONAL_GIT_KEY}.
--agent-id oppure --aid Facoltativo L'ID di un agent in cui viene creata l'area di lavoro. L'agente aiuta a eseguire i lavori dello spazio di lavoro sulla propria infrastruttura. Per ulteriori informazioni, vedi Schematics Agent.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

L'uso del comando Schematics ibmcloud terraform mostra un messaggio di avvertimento e di deprecazione in quanto Alias 'terraform' sono deprecati. Usate "schemi" o "sch" nei vostri comandi.

Crea template file in formato JSON

Schematics supporta il download del modello di moduli Terraform dal repository privato. Per ulteriori informazioni, consultare Supporto per scaricare i moduli dall'host remoto privato.

È possibile creare il file JSON come condiviso nel file example.json per creare lo spazio di lavoro e passare il percorso file insieme al nome file nell'indicatore --file. La descrizione di tutti i parametri di example.json come descritto nella tabella.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<workspace_name>" come "testworkspace".

Esempio

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

Esempio di JSON per il caricamento in un file .tar

{
    "name": "<workspace_name>",
    "type": [
        "<terraform_version>"
    ],
    "location": "<location>",
    "description": "<workspace_description>",
    "tags": [],
    "template_repo": {
        "url": "<github_source_repo_url>"
    },
    "template_data": [
        {
        "folder": ".",
        "type": "<terraform_version>",
        "env_values":[
        {
          "env_key1": "dummy_text"
        },
        {
          "env_key2": "dummy_text"
        }
        ],
        "variablestore": [
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "string",
          "secure": true,
	      "description":"<description>"
        },
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "bool",
          "secure": false,
	      "description":"<description>"
        },
        {
          "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "list(string)",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "map(number)",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "tuple([string, list(string), number, bool])",
          "secure": false,
	      "description":"<description>"
        },
	    {
	      "name": "<variable_name_x>",
          "value": "<variable_value_x>",
          "type": "any",
          "secure": false,
	      "description":"<description>"
        }
        ]
    }
    ]
}
Descrizione dei componenti del file JSON
Parametro Obbligatorio / Facoltativo Descrizione
workspace_name Opzionale Inserire un nome per l'area di lavoro. La lunghezza massima del limite di caratteri è impostata su meno di 1 MB. Per ulteriori informazioni, vedere Progettazione della struttura dell'area di lavoro
terraform_version Facoltativo La versione di Terraform che vuoi usare per eseguire il codice Terraform. Inserire terraform_v1.5 per utilizzare la versione di Terraform 1.5,terraform_v1.4 per utilizzare la versione di Terraform 1.4 e, analogamente, terraform_v1.4. Ad esempio, quando specifichi terraform_v1.5 significa che gli utenti possono avere un modello di Terraform v1.5.0, v1.5.1 o v1.5.7, così via. Assicurati che i tuoi file di configurazione Terraform siano compatibili con la versione Terraform che specifichi. È una variabile obbligatoria. Se la versione di Terraform non è specificata, per impostazione predefinita, Schematics seleziona la versione del modello. Schematics supporta Terraform_v1.x e prevede anche di rendere disponibili le release dopo 30 to 45 days il rilascio di HashiCorp Configuration Language (HCL).
location Facoltativo Immettere l'ubicazione in cui si desidera creare lo spazio di lavoro. La posizione determina dove vengono eseguite le azioni di Schematics e dove vengono memorizzati i dati dell'area di lavoro. Se non si inserisce una località, Schematics determina la località in base alla regione IBM Cloud che è stata selezionata. Per visualizzare la regione di destinazione, eseguire ibmcloud target --output json e consultare il campo region. Per specificare una regione diversa, eseguire ibmcloud target -r <region>. Se si inserisce una località, assicurarsi che questa corrisponda alla regione di IBM Cloud che si è scelto di visitare.
description Opzionale Inserire una descrizione per l'area di lavoro.
template_repo.url Facoltativo Inserire l'indirizzo URL del repository GitHub o GitLab dove sono memorizzati i file di configurazione di Terraform.
template_repo.branch Facoltativo Inserire il ramo GitHub o GitLab dove sono memorizzati i file di configurazione di Terraform. Ora, in template_repo, è possibile aggiornare URL con altri parametri, come mostrato nel blocco.
template_repo.datafolder Facoltativo Inserire il nome della cartella del repository Git che contiene il modello.
template_repo.release Opzionale Inserire la release GitHub o GitLab che punta ai file di configurazione di Terraform.
github_source_repo_url Facoltativo Inserite il link al vostro repository GitHub. Il collegamento può puntare al ramo master, a un ramo diverso o a una sottodirectory. Se si sceglie di creare l'area di lavoro senza un repository GitHub, l'area di lavoro viene creata con uno stato di bozza. Per collegare l'area di lavoro a un repository GitHub in un secondo momento, è necessario usare il comando ibmcloud schematics workspace update. Se si intende fornire il modello Terraform caricando un file di archivio a nastro (.tar), lasciare vuoto URL e usare il comando ibmcloud schematics workspace upload dopo aver creato l'area di lavoro. Se si vuole clonare dal repository Git, vedere le estensioni dei file consentite e bloccate per la clonazione.
env_values Facoltativo Un elenco di variabili di ambiente che vuoi applicare durante l'esecuzione di uno script bash o di un'azione Terraform. Questo campo deve essere fornito come un elenco di coppie chiave - valore. Ogni voce è una mappa con una voce dove key = variable name e value = value. È possibile definire le variabili d'ambiente per le offerte del catalogo IBM Cloud che vengono fornite utilizzando i file di script bash.
variable_name Facoltativo Immettere il nome per la variabile di input dichiarata nei file di configurazione Terraform.
variable_type Facoltativo Terraform v0.12 supporta string, list, map, bool, number e tipi di dati complessi come list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
variable_value Facoltativo Immettere il valore come stringa per i tipi primitivi come il formato bool, number, string e HCL per le variabili complesse, come fornito in un file .tfvars. È necessario immettere una stringa di escape del formato HCL per il valore, come mostrato nell'esempio. Per ulteriori informazioni su come dichiarare le variabili in un file di configurazione Terraform e fornire un valore agli schemi, vedi Utilizzo delle variabili di input per personalizzare le risorse. Ad esempio
secure Facoltativo Impostare il parametro secure su true. Per impostazione predefinita, questo parametro è impostato su false.
val1 Facoltativo Nel payload è possibile fornire una variabile di ambiente che può essere eseguita nello spazio di lavoro durante la fase di pianificazione, applicazione o distruzione. Anche i valori sono codificati e memorizzati in COS.

IBM Cloud Schematics supporta l'impostazione di variabili d'ambiente come TF_PARALLELISM, TF_LOG. Per ulteriori informazioni sull'elenco delle variabili di ambiente e sul loro utilizzo, consulta Elenco delle variabili di ambiente.

Esempio

ibmcloud schematics workspace new --file example.json

ibmcloud schematics refresh

Eseguire un'azione di aggiornamento di IBM Cloud sull'area di lavoro. Un'azione di aggiornamento convalida le risorse cloud nel tuo account rispetto allo stato memorizzato nel file di stato Terraform del tuo spazio di lavoro. Se vengono trovate delle differenze, il file di stato Terraform viene aggiornato di conseguenza.

Sintassi

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

Opzioni comando

Schematics
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro per cui si desidera aggiornare ed eseguire un'azione. Per trovare l'ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics state list

Elenca le risorse cloud ( Name, Type, URL e Taint Status ) documentate nel tuo file di stato Terraform (terraform.tfstate).

Taint Status restituisce tainted per (true) o blank per (false).

Sintassi

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

Opzioni comando

Schematics indicatori elenco stato
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per la quale si desidera elencare le risorse cloud documentate nel file di stato di Terraform. Per trovare l'ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics workspace taint

Contrassegna manualmente un'istanza o le risorse come contaminate, forzando la ricreazione delle risorse alla successiva applicazione. Taint modifica il file di stato, ma non l'infrastruttura nello spazio di lavoro. Quando si esegue il piano successivo, le modifiche vengono visualizzate come ricreate e nella successiva applicazione la modifica viene implementata.

È necessario eseguire il comando ibmcloud schematics state list per visualizzare lo stato tainted delle risorse. Taint Status restituisce tainted per (true) o blank per (false).

Sintassi

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

Opzioni comando

Schematics indicatori taint workspace
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per cui si vuole ricreare l'istanza o la risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--options oppure -o Facoltativo Immettere l'indicatore di opzione che si desidera visualizzare.
--address oppure -adr Obbligatorio Immettere l'indirizzo della risorsa da contrassegnare come taint.

Esempio

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

ibmcloud schematics workspace untaint

Contrassegna manualmente un'istanza o le risorse come untaint, forzando il ripristino delle risorse alla successiva applicazione. Quando si esegue il piano successivo, le modifiche vengono visualizzate come ripristinate e nella successiva applicazione la modifica viene implementata.

È possibile eseguire il comando ibmcloud schematics state list per visualizzare lo stato tainted delle risorse. Taint Status restituisce tainted per (true) o blank per (false).

Sintassi

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

Opzioni comando

Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per cui si vuole ricreare l'istanza o la risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--options oppure -o Facoltativo Immettere l'indicatore di opzione che si desidera visualizzare.
--address oppure -adr Facoltativo Immettere l'indirizzo della risorsa da contrassegnare come untaint.
{: caption="Schematics workspace untaint flag "caption - side = "top"}

Esempio

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

ibmcloud schematics workspace update

IBM Cloud Schematics sta deprecando le vecchie versioni di Terraform e introducendo il supporto per le nuove versioni di Terraform. Per ulteriori informazioni, consultare il ciclo di vita della deprecazione di Schematics Terraform e il Programma di deprecazione.

Aggiorna i dettagli di uno spazio di lavoro esistente, ad esempio il nome dello spazio di lavoro, le variabili o l'URL di controllo origine. Per eseguire il provisioning o la modifica di IBM Cloud, vedere il comando ibmcloud schematics plan il comando.

IBM Cloud Schematics supporta 50 richieste API al minuto, per host e per cliente. La regione può essere us-east, us-south, eu-gb o eu-de. È necessario attendere prima di richiamare nuovamente il comando. Accertarsi che l'endpoint location e url puntino alla stessa regione quando si creano o si aggiornano le azioni e gli spazi di lavoro. Per ulteriori informazioni sull'ubicazione e sull'endpoint, vedi Dove sono archiviate le mie informazioni?.

Se hai fornito il tuo modello Terraform caricando un file di archivio nastro (.tar) e vuoi aggiornare il tuo modello, devi utilizzare il comando ibmcloud schematics workspace upload.

Sintassi

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

Pull-latest non è supportato per gli spazi di lavoro creati utilizzando i modelli dei cataloghi IBM Cloud.

Opzioni comando

Schematics indicatori di aggiornamento dello spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per la quale si desidera aggiornare l'istanza o la risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--file oppure -f Facoltativo Il percorso relativo di un file JSON nella tua macchina locale che include i parametri aggiornati per il tuo workspace. Per ulteriori informazioni sul file JSON di esempio con i dettagli, vedi Template di aggiornamento del file JSON.
--github-token oppure -g Facoltativo Inserire il valore del token GitHub per accedere al repository privato Git.
--pull-latest oppure --pl Facoltativo Estrarre le ultime modifiche dal repository GitHub nell'area di lavoro. Se questo flag è impostato, il flag --file viene ignorato.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Aggiorna template file in formato JSON

Puoi creare il JSON come condiviso nel file example.json per l'aggiornamento dello spazio di lavoro e passare il percorso file insieme al nome file nell'indicatore --file. La descrizione di tutti i parametri di example.json è descritta nella tabella.

È necessario sostituire i segnaposto di <...> con i valori reali. Ad esempio, "<workspace_name>" come "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 aggiorna payload
Parametro Obbligatorio / Facoltativo Descrizione
name Facoltativo Immetti un nome per il tuo spazio di lavoro. Per ulteriori informazioni, vedi Progettazione della struttura del tuo spazio di lavoro. Se si aggiorna il nome dello spazio di lavoro, l'ID dello spazio di lavoro non cambia.
type Facoltativo La versione Terraform che vuoi utilizzare per eseguire il tuo codice Terraform. Immettere terraform_v1.5 per utilizzare Terraform versione 1.5, terraform_v1.4 per utilizzare Terraform versione 1.4. Ad esempio, quando specifichi terraform_v1.5 significa che gli utenti possono avere un modello di Terraform v1.5.0, v1.5.1 o v1.5.7, così via. Assicurati che i tuoi file di configurazione Terraform siano compatibili con la versione Terraform che specifichi. È una variabile obbligatoria. Se non viene specificata la versione Terraform, per impostazione predefinita, Schematics seleziona la versione dal template.
description Facoltativo Immettere le tag che si desidera associare al proprio workspace. I tag possono aiutarti a trovare il tuo spazio di lavoro più velocemente.
resource_group Facoltativo Immetti il gruppo di risorse in cui vuoi eseguire il provisioning del tuo spazio di lavoro.
workspace_status Facoltativo Bloccare o sbloccare uno spazio di lavoro. Se uno spazio di lavoro è bloccato, le modifiche allo spazio di lavoro sono disabilitate.
template_repo.url Facoltativo Inserire l' URL del repository GitHub o GitLab in cui sono memorizzati i file di configurazione di Terraform.
template_repo.branch Facoltativo Immetti il ramo GitHub o GitLab dove sono memorizzati i tuoi file di configurazione Terraform. Ora, nel repository dei template, è possibile aggiornare l' URL con altri parametri, come mostrato nel blocco.
template_repo.datafolder Facoltativo Immettere il nome della cartella nel repository Git, che contiene il template.
template_repo.release Facoltativo Immetti la release GitHub o GitLab che punta ai file di configurazione Terraform.
github_source_repo_url Facoltativo Immetti il link al tuo repository GitHub. Il collegamento può puntare al ramo master, a un ramo diverso o a una sottodirectory.
template_data.folder Facoltativo Inserire il nome della variabile di input dichiarata nei file di configurazione di Terraform.
template_data.type Facoltativo Inserire il nome del tipo di variabile di input dichiarato nei file di configurazione di Terraform.
template_data[0].env_values[i].va11 Facoltativo Un elenco di variabili di ambiente che si desidera applicare durante l'esecuzione di uno script bash o di un lavoro Terraform. Questo campo deve essere fornito come un elenco di coppie chiave - valore, ad esempio TF_LOG=debug. Ogni voce è una mappa con una voce dove chiave è il nome della variabile di ambiente e il valore è il valore.
template_data[0].env_values[i].val2 Facoltativo Un elenco di variabili di ambiente che si desidera applicare durante l'esecuzione di uno script bash o di un lavoro Terraform. Questo campo deve essere fornito come un elenco di coppie chiave - valore, ad esempio TF_LOG=debug. Ogni voce è una mappa con una voce dove chiave è il nome della variabile di ambiente e il valore è il valore.
template_data[0].env_values_metadata Facoltativo Metadati delle variabili di ambiente.
template_data[0].variablestore[i].name Facoltativo Inserire il nome della variabile di input dichiarata nei file di configurazione di Terraform.
template_data[0].variablestore[ii].type Obbligatorio Terraform v0.12 supporta string, list, map, bool, number e tipi di dati complessi quali list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
template_data[0].variablestore[iii].value Facoltativo Immettere il valore come stringa per i tipi primitivi come bool, number, string e il formato HCL per le variabili complesse, come fornito in un file .tfvars. È possibile sovrascrivere i valori predefiniti di .tfvars impostando il parametro use_default come true. È necessario immettere una stringa di escape del formato HCL per il valore, come mostrato nell'esempio. Per ulteriori informazioni su come dichiarare le variabili in un file di configurazione Terraform e fornire un valore agli schemi, vedi Utilizzo delle variabili di input per personalizzare le risorse e esempio di archivio variabili
template_data[0].variablestore[iv].secure Facoltativo Impostare il parametro secure su true. Per impostazione predefinita, questo parametro è impostato su false.
template_data[0].variablestore[v].use_default Facoltativo Impostare il parametro use_default su true per sovrascrivere il parametro .tfvars predefinito. Per impostazione predefinita, questo parametro è impostato su false.
github_source_repo_url Facoltativo Immetti il link al tuo repository GitHub. Il collegamento può puntare al ramo master, a un ramo diverso o a una sottodirectory.

Esempio per archivio variabili

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

Esempio

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

ibmcloud schematics workspace update variables

IBM Cloud Schematics sta deprecando le vecchie versioni di Terraform e introducendo il supporto per le nuove versioni di Terraform. Per ulteriori informazioni, consultare il ciclo di vita della deprecazione di Schematics Terraform e il Programma di deprecazione.

Aggiorna variabili consente di aggiornare una o più variabili di input per un'area di lavoro esistente. Non è possibile aggiornare le variabili dei metadati dell'area di lavoro, come il nome o l' URL del controllo sorgente. Per eseguire il provisioning o la modifica di IBM Cloud, vedere il comando ibmcloud schematics plan il comando.

Sintassi

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

Opzioni comando

Schematics indicatori di aggiornamento dello spazio di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per la quale si desidera aggiornare l'istanza o la risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--file oppure -f Obbligatorio Il percorso relativo a un file JSON sul computer locale che include i parametri aggiornati per le variabili dello spazio di lavoro da aggiornare. Per ulteriori informazioni sul file JSON di esempio con i dettagli, vedi Template di aggiornamento del file JSON.
--template oppure -tid Obbligatorio Inserire l'ID del modello. Usare ibmcloud schematics workspace get per recuperare l'ID del modello.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio per valori variabili di memoria e ambiente

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

Esempio

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

ibmcloud schematics workspace upload

Fornire il modello Terraform caricando un file di archivio a nastro (.tar) nel proprio spazio di lavoro Schematics. .tar supporta i comandi di Cloud Shell.

Prima di iniziare, assicurarsi di aver creato il proprio spazio di lavoro senza un collegamento a un repository GitHub o GitLab.

Sintassi

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

Opzioni comando

Schematics indicatori di caricamento degli spazi di lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro in cui si desidera caricare il file di archivio nastro (.tar). Per trovare l'ID del tuo workspace, esegui il comando ibmcloud schematics workspace list.
--file oppure -f Obbligatorio Immettere il percorso file completo sulla macchina locale in cui è memorizzato il file .tar.
--template oppure -tid Obbligatorio L'identificativo univoco del modello Terraform per cui si desidera visualizzare il contenuto del file di stato Terraform. Per trovare l'ID del modello, eseguire ibmcloud schematics workspace get --id <workspace_ID> e trovare l'ID del modello nel campo Variabili del modello per: dell'output della riga comandi.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

Crea il file TAR del tuo repository di template utilizzando il TAR comando fornito tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER

Esempio del valore della variabile

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

Comandi lavoro area di lavoro

Eseguire operazioni di cloud computing ( Schematics ), per creare, aggiornare ed eliminare risorse cloud. Utilizzando la semantica Terraform familiare, pianifica, applica e distruggi gli spazi di lavoro Terraform per gestire il ciclo di vita delle risorse cloud.

ibmcloud schematics apply

Quando si applica un modello Terraform dell'area di lavoro, le risorse vengono approvvigionate, modificate o rimosse da IBM Cloud. I file temporanei creati durante l'operazione di applicazione possono essere conservati per operazioni future.

Per eseguire un'operazione di applicazione Schematics, l'area di lavoro deve trovarsi in uno stato Inattivo, Attivo, Fallito o Arrestato. Per ulteriori informazioni sugli stati del workspace, consultare Diagramma di stato del workspace.

Mentre i tuoi lavori Terraform sono in esecuzione, lo spazio di lavoro è bloccato e non è possibile apportare modifiche al tuo spazio di lavoro fino a quando l'esecuzione non è completa.

Sintassi

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

Opzioni comando

Schematics indicatori apply
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro che punta al modello Terraform nel repository di controllo origine che vuoi applicare in IBM Cloud. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--target oppure -t Facoltativo Specifica la creazione di una risorsa specifica del tuo file di configurazione Terraform immettendo l'indirizzo della risorsa Terraform, come ibm_is_instance.vm1. Tutte le altre risorse definite nel file di configurazione non vengono create o aggiornate. Per indirizzare la creazione di più risorse, utilizzare la sintassi seguente: --target <resource1> --target <resource2>. Se la risorsa di destinazione specifica l'attributo count e nessun indice viene specificato nell'indirizzo della risorsa, ad esempio ibm_is_instance.vm1[1], tutte le istanze che condividono lo stesso nome di risorsa vengono destinate alla creazione.
--var-file oppure --vf Facoltativo Il percorso file del file terraform.tfvars creato sulla macchina locale. Utilizza questo file per archiviare le informazioni sensibili, come la chiave API o le credenziali IBM Cloud per la connessione all'infrastruttura classica IBM Cloud nel formato <key>=<value>. Le variabili devono essere definite in formato a riga singola, ad esempio, come availability_zone_names = ["us-east-1a","us-west-1c"]. Tutte le coppie di valori chiave definite in questo file vengono caricate automaticamente in Terraform quando si inizializza la CLI Terraform. Per specificare più file tfvars, specificare --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--force oppure -f Facoltativo Forza l'esecuzione di questo comando senza richiedere l'intervento dell'utente.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics destroy

Rimuovere le risorse Cloud di cui si è fatto il provisioning utilizzando l'area di lavoro Schematics, anche se queste risorse sono attive. Per impostazione predefinita, il comando elenca tutte le risorse da visualizzare in anteprima e poi riceve la conferma di distruggere. Se si usa il flag --force or -f nel comando destroy, non è possibile vedere l'anteprima delle risorse che si vogliono distruggere.

usa questo comando con cautela. Dopo aver eseguito il comando, non è possibile annullare la rimozione delle risorse Cloud. Se hai scritto i dati nella memoria o nei database di cui è stato eseguito il provisioning, assicurati di creare un backup per rendere persistenti i tuoi dati

Per eseguire un'azione di distruzione Schematics, l'area di lavoro deve trovarsi in uno stato Attivo, Fallito o Arrestato.

Sintassi

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

Opzioni comando

Schematics indicatori di eliminazione
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro che punta al modello Terraform nel repository di origine che specifica le risorse Cloud che si desidera rimuovere. Per trovare l'ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list.
--target oppure -t Facoltativo Specifica l'eliminazione di una risorsa specifica immettendo l'indirizzo della risorsa Terraform, ad esempio ibm_is_instance.vm1. Tutte le altre risorse nello spazio di lavoro rimangono invariate. Per specificare l'eliminazione di più risorse, utilizzare la seguente sintassi: --target <resource1> --target <resource2>. Se la risorsa di destinazione specifica l'attributo count e nessun indice viene specificato nell'indirizzo della risorsa, ad esempio ibm_is_instance.vm1[1], tutte le istanze che condividono lo stesso nome di risorsa vengono destinate all'eliminazione. Inoltre, se la risorsa di destinazione può essere eliminata solo se le risorse dipendenti vengono eliminate, ad esempio un VPC può essere eliminato solo se viene eliminata la sottorete collegata, anche tutte le risorse dipendenti vengono destinate all'eliminazione.
--force oppure -f Facoltativo Forza l'esecuzione di questo comando senza richiedere l'intervento dell'utente. Non è possibile vedere l'anteprima delle risorse che si desidera distruggere.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics logs

Recupera i file di log di Terraform per lo spazio di lavoro Schematics o per uno specifico ID di azione dello spazio di lavoro. Utilizza i file di log per risolvere i problemi del modello Terraform o i problemi che si verificano durante il processo di provisioning, modifica o eliminazione delle risorse.

Sintassi

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

Opzioni comando

Schematics indicatori di log
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro per cui desideri richiamare i file di log Terraform. Per trovare l'ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list.
--act-id oppure -1 Facoltativo L'ID di un'azione per cui desideri richiamare i log Terraform. Per trovare un elenco degli ID delle azioni, eseguire il comando ibmcloud schematics workspace action --id WORKSPACE_ID.

Esempio

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

ibmcloud schematics output

Richiama i valori di output Terraform per lo spazio di lavoro. È possibile definire valori di output nel modello Terraform per includere i dati che si desidera rendere accessibili ad altri spazi di lavoro.

Sintassi

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

Opzioni comando

Schematics indicatori di emissione
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dello spazio di lavoro per il quale si desidera elencare i valori di output di Terraform. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

ibmcloud schematics plan

Esaminare il modello Terraform nel repository di origine e confrontare questo modello con le risorse Cloud già distribuite. L'output della riga di comando mostra le risorse Cloud che devono essere aggiunte, modificate, mantenute o rimosse per raggiungere lo stato descritto nel file di configurazione.

Per eseguire un'azione del piano Schematics, l'area di lavoro deve trovarsi in uno stato Inattivo, Attivo, Fallito o Arrestato.

Durante la creazione del piano di esecuzione Terraform, non puoi apportare alcuna modifica al tuo spazio di lavoro.

Sintassi

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

Opzioni comando

Schematics indicatori di emissione
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificativo univoco dello spazio di lavoro che punta al modello Terraform del tuo repository di controllo origine che vuoi scansionare. Per trovare l'ID di uno spazio di lavoro, eseguire il comando ibmcloud schematics workspace list.
--var-file oppure --vf Facoltativo Il percorso file del file terraform.tfvars creato sulla macchina locale. Utilizza questo file per archiviare le informazioni sensibili, come la chiave API o le credenziali IBM Cloud per la connessione all'infrastruttura classica IBM Cloud nel formato <key>=<value>. Le variabili devono essere definite in formato a riga singola, ad esempio, come availability_zone_names = ["us-east-1a","us-west-1c"]. Tutte le coppie di valori chiave definite in questo file vengono caricate automaticamente in Terraform quando si inizializza la CLI Terraform. Per specificare più file tfvars, specificare --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--output oppure -o Facoltativo Restituisce l'output della riga comandi in formato JSON. Attualmente è supportato solo il formato file JSON.

Esempio

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

Comandi di arresto dell'area di lavoro

Dopo aver richiamato un lavoro dello spazio di lavoro, come un plan, un apply o un destroy, è possibile arrestare il lavoro in esecuzione o arrestare il provisioning delle risorse. Quando si arresta o si annulla un lavoro di lunga durata, è consigliabile prima controllare i log del lavoro per determinare se il lavoro è effettivamente bloccato e deve essere arrestato o se sta eseguendo operazioni di lunga durata che richiedono tempo per essere completate.

Schematics offre una serie di opzioni che consentono agli utenti di (gracefully) stop, force-stop, o terminate il lavoro in esecuzione, in ordine di immediatezza e di impatto dell'operazione di arresto.

Esaminare i comandi per i lavori (gracefully) stop, force-stop o terminate.

ibmcloud schematics workspace job stop

Arresta un lavoro in corso nello spazio di lavoro inviando un segnale di interruzione a Terraform per terminare l'esecuzione.

Sintassi

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

Opzioni comando

Schematics indicatori di arresto lavoro
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID spazio di lavoro da aggiornare.
--job-id oppure --jid Obbligatorio L'ID del lavoro.
--stop, Facoltativo Rimuove il lavoro dalla coda in sospeso.
--force-stop oppure --fs Facoltativo Invia un segnale di uccisione all'esecuzione di Terraform nel motore, tentando anche di interrompere immediatamente l'esecuzione.
--terminate oppure -t Facoltativo Interrompe bruscamente il motore, contrassegna il lavoro come arrestato e sblocca lo spazio di lavoro. I dati non vengono salvati utilizzando questo indicatore.

Esempio

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>

Comandi file di stato dello spazio di lavoro

Esamina i comandi che puoi utilizzare per gestire il file di stato Terraform (terraform.tfstate) per uno spazio di lavoro.

Puoi importare un file di stato Terraform esistente durante la creazione dello spazio di lavoro. Per ulteriori informazioni, consultare il comando ibmcloud workspace new.

ibmcloud schematics state pull

Mostra il contenuto del file di stato Terraform (terraform.tfstate) per uno specifico template Terraform dello spazio di lavoro.

Sintassi

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

Opzioni comando

Schematics indicatori di pull dello stato
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID univoco dello spazio di lavoro in cui si desidera eseguire i comandi.
--template oppure --tid Obbligatorio L'identificativo univoco del modello Terraform per cui si desidera visualizzare il contenuto del file di stato Terraform. Per trovare l'ID del modello, eseguire ibmcloud schematics workspace get --id <workspace_ID> e trovare l'ID del modello nel campo Variabili del modello per: dell'output della riga comandi.

Esempio

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

ibmcloud schematics workspace state show

Fornisce l'output leggibile da uno stato o un piano di uno spazio di lavoro come lo vede Terraform. È possibile utilizzare per garantire lo stato corrente e lo stato delle operazioni pianificate. Devi utilizzare l'ID dello spazio di lavoro per recuperare i log utilizzando il comando ibmcloud schematics logs.

Sintassi

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

Opzioni comando

Schematics indicatori di pull dello stato
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID univoco dell'area di lavoro da aggiornare.
--address oppure -adr Obbligatorio Inserire l'indirizzo che punta a una singola risorsa nello stato da mostrare.
--options oppure -o Facoltativo Immettere gli indicatori della riga comandi.

Esempio

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

ibmcloud schematics workspace state mv

Se si sposta lo stato per una risorsa all'interno del file di stato. Lo spazio di lavoro continua a funzionare, ma la successiva operazione di piano o di applicazione non troverà la risorsa o l'istanza nel file di stato. Se non vengono apportate modifiche al modello, è possibile visualizzare la ricreazione della risorsa nella successiva operazione di Terraform.

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

Opzioni comando

Schematics indicatori di spostamento stato
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID univoco dello spazio di lavoro per cui si desidera spostare un'istanza o una risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--source oppure -s Obbligatorio Immettere l'indirizzo di origine di un elemento da spostare.
--destination oppure -d Obbligatorio Fornire l'indirizzo di destinazione di un elemento.

Esempio

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

ibmcloud schematics workspace state rm

Se si rimuove lo stato per una risorsa o istanza all'interno del file di stato. Lo spazio di lavoro continua a funzionare, ma la successiva operazione di piano o di applicazione non troverà la risorsa o l'istanza nel file di stato. Se non vengono apportate modifiche al modello, è possibile visualizzare la ricreazione della risorsa nella successiva operazione di Terraform.

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

Opzioni comando

Indicatori di rimozione stato Schematics
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'identificatore univoco dell'area di lavoro per la quale si desidera rimuovere l'istanza o la risorsa. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--options oppure -o Facoltativo Immettere l'indicatore di opzione che si desidera rimuovere.
--address oppure -adr Obbligatorio Immettere l'indirizzo della risorsa da contrassegnare come taint.

Esempio

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

Comandi Terraform dello spazio di lavoro

È possibile eseguire i comandi di Terraform per manipolare le risorse Cloud e modificare lo stato di Schematics.

I comandi Terraform dello spazio di lavoro non vengono supportati nella IU.

La tabella fornisce il riepilogo dei comandi dello spazio di lavoro Terraform supportati.

Riepilogo comandi Terraform
Comando Descrizione
show Esamina lo stato o il piano Terraform.
output Legge un output da un file di stato Terraform.
import Importa un'infrastruttura esistente in Terraform.
taint Contrassegnare una risorsa per la ricreazione.
untaint Non contrassegnare una risorsa come contaminata.
state Un comando di gestione dello stato avanzato per scrivere sottocomandi per rimuovere o spostare rm && mv.

Comandi Terraform

I comandi Terraform vengono eseguiti utilizzando un file JSON per specificare gli input.

Sintassi

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

Opzioni comando

Schematics Indicatori comandi Terraform
Indicatore Obbligatorio / Facoltativo Descrizione
--id oppure -i Obbligatorio L'ID univoco dello spazio di lavoro in cui si desidera eseguire i comandi. Per trovare l'ID dell'area di lavoro, eseguire il comando ibmcloud schematics workspace list.
--file oppure --f Obbligatorio Percorso del file JSON contenente l'elenco dei comandi di Terraform.

Payload di esempio del file 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"
}

La tabella fornisce l'elenco di parametri chiave del file JSON per l'API Commands, per la riga di comando e l'API.

Elenco dei parametri chiave
Chiave Obbligatorio / Facoltativo Descrizione
command Obbligatorio Fornire il comando. I comandi supportati sono show,taint, untaint, state, import, output.
command_params Obbligatorio I parametri di indirizzo per il nome comando per CLI, come il nome risorsa, percorso assoluto del nome file. Per API, devi inviare l'indicatore dell'opzione e il parametro dell'indirizzo in command_params.
command_name Obbligatorio Il nome del blocco di comando.
command_desc Facoltativo Il testo per descrivere il blocco di comando.
command_onError Facoltativo Istruzione di continuare o interrompere in caso di errore nel comando.
command_dependsOn Facoltativo Dipendenza dai precedenti comandi.
command_status Non richiesto Visualizza lo stato del comando eseguito, success o failure

Esempio

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

Cronologia versione CLI

Trovate un riepilogo delle modifiche per ogni versione del plug-in Schematics CLI. Assicuratevi di mantenere aggiornata la vostra CLI in modo da poter utilizzare tutti i comandi disponibili e le relative opzioni.

Cronologia delle versioni a riga di comando
Versione Data di rilascio Modifiche
1.12.29 27 ottobre 2025 Il plugin CLI Schematics introduce credenziali e variabili multihost durante la creazione e l'aggiornamento degli inventari. Questo aggiornamento semplifica il processo di gestione dei dettagli di autenticazione e delle impostazioni di configurazione per numerosi sistemi di destinazione, garantendo un'esperienza di automazione più efficiente e sicura.
1.12.28 1° agosto 2025 Schematics Plugin CLI per aggiornare gli spazi dei nomi secondari e i sottocomandi nei metadati.
1.12.27 31 luglio 2025 Schematics Il plugin CLI supporta la regione di Montreal(ca-mon).
1.12.26 07 aprile 2025 Schematics Il plugin CLI ha migliorato l'anteprima di ibmcloud schematics destroy, ha aggiornato l'immagine di base di una pipeline, ha corretto nil pointer exception nelle operazioni ibmcloud schematics action create, ibmcloud schematics action update e ibmcloud schematics action get.
1.12.25 10 gennaio 2025 Schematics Il plugin CLI supporta il comando CLI di aggiornamento delle variabili dello spazio di lavoro ibmcloud schematics per aggiornare solo le variabili di input richieste per uno spazio di lavoro esistente. Inoltre, migliora il comando ibmcloud schematics destroy con la funzione di anteprima per elencare tutte le risorse del lavoro con conferma. I comandi IBM Cloud Schematics spazio di lavoro, un'azione e un agente get recuperano il CRN di crittografia e lo stato di crittografia, come i dettagli di IBM Default o BYOK o KYOK.
1.12.24 8 luglio 2024 Schematics Il plugin CLI corregge il supporto per la destinazione degli endpoint di Toronto attraverso la regione 'ca-tor.
1.12.23 11 giugno 2024 Schematics Il plugin CLI migliora la visualizzazione del formato del file 'terraform.tfvars durante l'uso dell'argomento '--var-file nei comandi ibmcloud workspace apply e ibmcloud workspace plan. Il supporto per la traduzione dell'internazionalizzazioneI18n) è stato aggiornato.
1.12.22 30 maggio 2024 Schematics Il plugin CLI supporta 'ibmcloud schematics agent destroy per distruggere le risorse di distribuzione. E impostare il parametro '--force su true per eliminare tutti i flussi di agenti e mantenere la distruzione parallela al flusso destroy dello spazio di lavoro.
1.12.21 19 aprile 2024 Schematics Il plugin CLI depreca il flag '--json in tutti i comandi CLI. È stato inoltre risolto il problema della deprecazione di 'CLI v1.12.20 nei comandi CLI 'ibmcloud schematics workspace refresh o plan.
1.12.20 25 marzo 2024 Schematics Il plugin CLI supporta Red Hat OpenShift Kubernetes Service.
1.12.18 08 marzo 2024 Visualizzazione del messaggio di avviso di deprecazione di Terraform durante i comandi dell'area di lavoro che utilizzano meno di 'terraform_v1.5, rimozione del supporto per l'aggiornamento dell'infrastruttura dell'agente e correzione dell'errore 'index out of range con il comando 'ibmcloud schematics state list.
1.12.17 14 febbraio 2024 l'installazione del plug-in Schematics supporta Cloud Shell e il comando 'ibmcloud schematics workspace upload ora supporta i comandi di Cloud Shell.
1.12.16 7 febbraio 2024 ibmcloud schematics workspace list supporta la cache per le versioni dell'API. i messaggi di deprecazione terraform_v1.2, 'terraform_v1.3, 'terraform_v1.4 sono popolati per creare i modelli 'ibmcloud schematics workspace new.
1.12.15 24 gennaio 2024 Supporto per 'refresh_token nella richiesta API di aggiornamento dell'agente, migliorato il supporto della versione per il comando di aggiornamento dell'agente.
1.12.14 10 gennaio 2024 Aggiunti nuovi comandi e traduzioni per supportare l'agente e i criteri. Gli spazi di lavoro del sistema, nell'output del comando Elenco spazi di lavoro, sono nascosti. Miglioramento della visualizzazione del lavoro dell'agente sull'output del comando. Utilizzo dell'API '/v1/versions per le versioni dell'agente.
1.12.12 17 settembre 2023 Schematics Creazione e aggiornamento dell'agente aggiunti con un new flag --metadata e una correzione di bug per configurare un timeout HTTP per la richiesta.
1.12.10 22 maggio 2023 Schematics Aggiornamento dell'agente e correzione dei bug del comando 'agent list per impostare gli errori di runtime.
1.12.9 6 aprile 2023 Schematics I comandi CLI dell'agente beta-1 e dei criteri sono stati migliorati per includere il '-target-file e il 'output di agent plan, agent apply e agent health.
1.12.8 22 mar 2023 i comandi CLI Schematics Agente 'beta-1 e 'politica sono disponibili nelle regioni 'us-south, 'us-east, 'eu-de, 'eu-gb.
1.12.7 07 febbraio 2023 Correzione del bug per disabilitare il 'API_AGENT_ATTACHMENT nelle regioni 'us-south, 'us-east, 'eu-de, 'eu-gb.
1.12.6 30 gennaio 2023 Supporto migliorato per l'input complesso tramite il file " yaml. Correzioni relative all'output di stato, all'indice fuori intervallo per l'output dell'azione dello spazio di lavoro, al problema del token di aggiornamento per l'esecuzione prolungata e alle correzioni del panico dello spinner.
1.12.5 18 dicembre 2022 L'uso del sottocomando e il supporto per specificare input complessi attraverso un file YAML locale utilizzando l'opzione '-input-file.
1.12.3 18 novembre 2022 Supporto fisso dell'uso del sottocomando 'source type.
1.12.3 3 novembre 2022 Comandi CLI migliorati, con l'ultimo aggiornamento dell'SDK, e aggiornamento del comando di azione dell'area di lavoro.
1.12.2 11 agosto 2022 Incluso il flag '--output e correzioni di bug per i comandi nel plug-in Schematics v1.12.2 e rilasciato.
1.12.1 26 luglio 2022 Incorporati i comandi di bug e correzioni in Schematics.
1.12.0 11 luglio 2022 Supporto per i comandi 'agents in Schematics da riga di comando.
1.11.1 8 luglio 2022 Supporto per risolvere il problema di traduzione in Schematics da riga di comando.
1.10.0 5 maggio 2022 Supporto per 'stop, 'force-stop e 'terminate in Schematics da riga di comando.
1.9.0 25 aprile 2022 Supporto per il rilevamento di 'Drift in Schematics da riga di comando.
1.8.1 17 aprile 2022 Corregge il messaggio di visualizzazione della deprecazione degli alias per il Schematics Per l'output JSON.
1.8.0 13 marzo 2022 Supporta il passaggio dei file '.tfvars e '.json al comando di pianificazione e applicazione. L'uso del comando 'ibmcloud terraform visualizza un messaggio di avvertimento. La versione supporta anche gli endpoint privati Schematics tramite riga di comando e migliora l'output della vista tabellare per elencare la risorsa fornita nello spazio di lavoro Schematics.
1.7.3 4 marzo 2022 Supporta il passaggio di file 'vars al comando di pianificazione della riga di comando, la visualizzazione di 'commit ID nel comando 'ibmcloud schematics workspace get e la modifica della descrizione del comando 'ibmcloud schematics workspace state show.
1.7.2 17 febbraio 2022 Supporta i binari delle piattaforme Linux™ arm64 e Mac OS arm64. Sono state rilasciate le correzioni relative al flusso 'stdout/stderr, al file 'TF vars non valido e alla traduzione.
1.7.1 11 febbraio 2022 Supporto per la registrazione delle tracce e aggiunta di test di integrazione per alcuni comandi. Correzioni per l'aggiornamento di 'env values metadata, panico per flag non validi e 'ibmcloud schematics workspace output command non disponibile.
1.7.0 12 gennaio 2022 Visualizza il messaggio di deprezzamento di Terraform v11.0 dopo l'esecuzione del comando. Correggere gli alias della riga di comando. Eliminare l'aspetto delle stringhe duplicate. Supporta l'ora globale nel file di log.
1.6.2 2 dicembre 2021 Supporto per traduzioni non in inglese. Correggere l'applicazione del comando '--var-file e dell'argomento azioni '--target not setting. Correggere una vulnerabilità della pipeline.
1.6.1 21 ottobre 2021 Supporta 'winrm per le azioni Schematics. Aggiunto il valore delle opzioni '--inventory-connection-type, '--bastion-credential-json e '--credential-json agli aggiornamenti di creazione e configurazione. Aggiornate le traduzioni non in inglese per la riga di comando. Corretta la visualizzazione della duplicazione dell'argomento 'command-object nella modalità interattiva 'ibmcloud schematics jobs run.
1.6.0 29 settembre 2021 Supporto per i binari 'linux-ppc64le e 'linux-s390x. Elenca 'Terraform v1.0 nel pannello dei dettagli. Visualizzare il messaggio di deprezzamento 'Terraform v0.11 nella pagina dell'area di lavoro Schematics. Corretto il comando di interrogazione dell'elenco di risorse che restituisce i valori come stringa vuota.
1.5.12 02 settembre 2021 Sopprime il messaggio di stato per il flag '--output json.
1.5.11 27 agosto 2021 Aggiunto un flag '--pull-latest al comando di aggiornamento dell'area di lavoro esistente. Problema risolto. Corrette le traduzioni dei locali.
1.5.10 11 agosto 2021 Supporta 'Terraform v0.15. Traduzioni locali corrette.
1.5.9 13 luglio 2021 Traduzioni locali corrette.
1.5.8 08 luglio 2021 Corretto il percorso API dei set di dati condivisi. Comandi disabilitati per i set di dati condivisi.
1.5.7 04 giugno 2021 Miglioramento del comando 'ibmcloud schematics state list per la visualizzazione come dati tabellari con una nuova colonna di stato 'taint. Corretto il comando 'ibmcloud schematics job run con la descrizione del flag '--input. Corretto il comando 'ibmcloud schematics job run con la descrizione del flag '--output json. Corretto il comando 'ibmcloud schematics action update con il flag '--credentials e le traduzioni locali.
1.5.6 03 giugno 2021 Aggiornato il comando 'ibmcloud schematics workspace new per supportare 'Terraform v0.14 e le traduzioni locali.