CLI do IBM Cloud Schematics

Execute esses comandos para trabalhar com IBM Cloud Schematics espaços de trabalho, ações, recursos provisionados e configurar Schematics.

Schematics Os comandos da CLI são específicos da região. Eles operam somente na região/localidade em que a CLI do IBM Cloud está configurada para funcionar. Assegure-se de que a CLI location e o terminal url estejam apontando para a região na qual você deseja criar ou atualizar suas áreas de trabalho e ações.. Para obter mais informações sobre localização e endpoint, consulte Onde minhas informações são armazenadas?

Para executar os comandos do site Schematics, use ibmcloud schematics ou ibmcloud sch.

Antes de Iniciar

Configure sua CLI.
Instale o Plug-in do Schematics.

Certifique-se de manter sua CLI atualizada para que possa usar os comandos liberados atualmente e suas opções. Para obter mais informações sobre as versões atuais da linha de comando, consulte Histórico de versões da linha de comando.

Comandos de Ações

Analise os comandos para criar, atualizar, listar, excluir e trabalhar com as ações do site Schematics.

`ibmcloud schematics action create`

Crie uma ação para executar um playbook Ansible em um único host de destino ou em um grupo de hosts de destino. Você usa playbooks do Ansible para executar operações de nuvem ou instalar software em recursos em nuvem. Para experimentar esse recurso ou para começar, use um dos sites IBM- Ansible playbooks fornecidos. É possível criar uma ação usando um arquivo de carga útil ou o modo interativo do comando.

Certifique-se de que o location e o ponto de extremidade url estejam apontando para a mesma região quando você criar ou atualizar os espaços de trabalho e as ações. Para obter mais informações sobre localização e terminal, consulte Onde estão armazenadas minhas informações?.

Sintaxe

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]

Opções de comando

Schematics ações criam sinalizações
Sinalize	Obrigatório / Opcional	Descrição
`--name` ou `-n`	Obrigatório	Um nome exclusivo para a ação.
`--description` ou `-d`	Opcional	A descrição curta para uma ação.
`--location` ou `-l`	Obrigatório	A geografia ou o local onde você deseja criar a ação, como `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor`, ou `ca-mon`. A geografia ou o local determina onde a sua ação é executada e onde os seus dados de ação são armazenados. Para obter mais informações, consulte Onde as minhas informações são armazenadas?. Certifique-se
de poder armazenar dados neste local, já que não será possível mudar o local após a ação ser criada.
`--resource-group` ou `-r`	Obrigatório	O nome do grupo de recursos onde você deseja criar a ação.
`--template` ou `-tr`	Opcional	A URL para o repositório Git onde o seu playbook do Ansible está armazenado.
`--playbook-name` ou `--pn`	Opcional	O nome do playbook do Ansible.
`--credentials` ou `-C`	Opcional	O caminho de arquivo para a chave SSH privada que você deseja usar para acessar o seu host de destino, como `~/.ssh/id_rsa`. A chave SSH deve conter no final dos detalhes da chave em caso de chamadas de linha de comandos ou de API.
`--credential-json` ou `--cj`	Opcional	Forneça o caminho do arquivo JSON que contém carga útil JSON de credencial para acessar o host de destino.
`--bastion` ou `-b`	Opcional	O endereço IP do host bastion.
`--bastion-credential-json` ou `--bj`	Opcional	Forneça o caminho do arquivo JSON que contém carga útil JSON de credencial bastion para acessar o host bastion.
`--inventory` ou `-y`	Opcional	O ID do inventário de recurso que você deseja usar em sua ação. Para listar inventários existentes, execute `ibmcloud schematics inventory list`.
`--inventory-connection-type` ou `--it`	Opcional	Tipo de conexão de inventário. Os valores suportados são `ssh` ou `winrm`. O padrão é `SSH`. Atualmente, o `WinRM` é compatível apenas com o sistema Windows com o `IPs` público e não é compatível com o host do Bastion.
`--input` ou `--in`	Opcional	As variáveis de entrada para a sua ação. As variáveis de entrada devem ser inseridas como pares chave-valor, como `--input mykey=myvalue`. Para especificar diversas variáveis de entrada, use várias sinalizações `--input` em seu comando. Também é possível armazenar as suas variáveis de entrada em um arquivo e fazer referência a este arquivo usando a opção de comando `--input-file`.
`--input-file` ou `--if`	Opcional	O caminho para um arquivo onde você especificou todas as suas variáveis de entrada. As variáveis de entrada devem ser especificadas como pares chave-valor em formato JSON.
`--env` ou `-e`	Opcional	As variáveis de ambiente para uma ação. As variáveis de ambiente devem ser inseridas como pares chave-valor, como `--env mykey=myvalue`. Para fornecer diversas variáveis de ambiente, use várias sinalizações `--env` em seu comando.
`--env-file` ou `-E`	Opcional	O caminho para um arquivo onde você especificou todas as variáveis de ambiente para uma ação. As variáveis de ambiente devem ser especificadas como pares chave-valor em formato JSON.
`--github-token` ou `-g`	Opcional	O token de acesso pessoal no GitHub que você deseja usar para se conectar a um repositório do GitHub privado. Para fazer a clonagem do repositório Git, consulte as extensões de arquivo permitidas e bloqueadas para isso.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--file` ou `-f`	Opcional	O caminho para o arquivo de carga útil JSON contendo a definição da ação que você deseja criar. Para obter mais informações, consulte Usando um arquivo de carga útil.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem um modo interativo.

Exemplo

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

Usando um arquivo de carga útil

Crie um arquivo JSON que inclua os detalhes para a ação que você deseja criar, como o ID, o nome e a descrição. Em seguida, use a opção de comando --file para criar a sua ação por meio do seu arquivo de carga útil.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<ACTION_NAME>" como "testaction".

Sintaxe

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

Exemplo

ibmcloud schematics action create --file sample.json

Usando o modo interativo

Em vez de entrar nas opções de comando ou usar um arquivo de carga útil, é possível usar o modo interativo do comando para criar uma ação. Por padrão, a ação é criada com mínima entrada do usuário. Para incluir mais informações em sua ação, será possível atualizar a ação posteriormente.

Inicie o modo interativo executando o comando sem opções de comando.
```
ibmcloud schematics action create
```
Insira um nome para a sua ação e pressione a tecla de retorno.
Insira o grupo de recursos onde deseja criar a ação e pressione a tecla de retorno.
Insira o local no qual deseja criar a ação, como us-south, us-east, eu-de ou eu-gb. Em seguida, pressione a tecla de retorno. O local determina onde a sua ação é executada e onde os seus dados de ação são armazenados. Para obter mais informações, consulte Onde as minhas informações são armazenadas?. Certifique-se de poder armazenar dados neste local, já que não será possível mudar o local após a ação ser criada.
Insira a URL para o repositório do GitHub onde seu playbook do Ansible está armazenado. Em seguida, pressione a tecla de retorno.
Se aplicável, insira o token de acesso pessoal que você deseja usar para acessar o seu repositório do GitHub. Em seguida, pressione a tecla de retorno. Para fazer a clonagem do repositório Git, consulte as extensões de arquivo permitidas e bloqueadas para isso.
Insira o nome do playbook do Ansible que você deseja executar e pressione a tecla de retorno.
Revise os detalhes da ação que foi criada para você.

`ibmcloud schematics action update`

Atualize as informações de uma ação existente usando o action_id Assegure-se de que a CLI location e o terminal url estejam apontando para a região na qual você deseja criar ou atualizar suas áreas de trabalho e ações.. Para obter mais informações sobre local e terminal, consulte Onde minhas informações são armazenadas?.

Sintaxe

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]

Opções de comando

Sinalizadores de atualização de ações do Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de uma ação que você deseja atualizar.
`--name` ou `-n`	Opcional	Um novo nome exclusivo para a sua ação.
`--description` ou `-d`	Opcional	A descrição curta para uma ação.
`--location` ou `-l`	Obrigatório	Localizações geográficas suportadas pelo serviço IBM Cloud Schematics, como `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor` ou `ca-mon`.
`--resource-group` ou `-r`	Obrigatório	Nome do grupo de recursos para uma Ação.
`--template` ou `-tr`	Opcional	A URL para o repositório Git onde o seu playbook do Ansible está armazenado.
`--playbook-name` ou `--pn`	Opcional	Nome do playbook.
`--github-token` ou `-g`	Opcional	O token de acesso pessoal no GitHub que você deseja usar para se conectar a um repositório do GitHub privado. Para fazer a clonagem do repositório Git, consulte as extensões de arquivo permitidas e bloqueadas para isso.
`--credentials` ou `-C`	Opcional	O caminho de arquivo para a chave SSH privada que você deseja usar para acessar o seu host de destino, como `~/.ssh/id_rsa`. A chave SSH deve conter no final dos detalhes da chave em caso de chamadas de linha de comandos ou de API.
`--credential-json` ou `--cj`	Opcional	Forneça o caminho do arquivo JSON que contém carga útil JSON de credencial para acessar o host de destino.
`--bastion` ou `-b`	Opcional	O endereço IP do host bastion.
`--bastion-credential-json` ou `--bj`	Opcional	Forneça o caminho do arquivo JSON que contém carga útil JSON de credencial bastion para acessar o host bastion.
`--inventory` ou `-y`	Opcional	O ID do inventário de recurso que você deseja usar em sua ação. Para listar inventários existentes, execute `ibmcloud schematics inventory list`.
`--inventory-connection-type` ou `--it`	Opcional	Tipo de conexão de inventário. Os valores suportados são `ssh` ou `winrm`. O padrão é `SSH`. Atualmente, o `WinRM` é compatível apenas com o sistema Windows com o `IPs` público e não é compatível com o host do Bastion.
`--input` ou `--in`	Opcional	As variáveis de entrada para a sua ação. As variáveis de entrada devem ser inseridas como pares chave-valor, como `--input mykey=myvalue`. Para especificar diversas variáveis de entrada, use várias sinalizações `--input` em seu comando. Também é possível armazenar as suas variáveis de entrada em um arquivo e fazer referência a este arquivo usando a opção de comando `--input-file`.
`--input-file` ou `--if`	Opcional	O caminho para um arquivo onde você especificou todas as suas variáveis de entrada. As variáveis de entrada devem ser especificadas como pares chave-valor em formato JSON.
`--env` ou `-e`	Opcional	As variáveis de ambiente para uma ação. As variáveis de ambiente devem ser inseridas como pares chave-valor, como `--env mykey=myvalue`. Para fornecer diversas variáveis de ambiente, use várias sinalizações `--env` em seu comando.
`--env-file` ou `-E`	Opcional	O caminho para um arquivo onde você especificou todas as variáveis de ambiente para uma ação. As variáveis de ambiente devem ser especificadas como pares chave-valor em formato JSON.
`--file` ou `-f`	Opcional	Caminho para o arquivo de carga útil JSON contendo a definição da ação para atualização. Para obter mais informações, consulte Usando o arquivo de carga útil. Observe que parâmetros, como o local ou o grupo de recursos não poderão ser atualizados após a criação da ação.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem prompts do usuário.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics action get`

Recupere os detalhes de uma ação existente no site Schematics, como ID da ação, nome, status, hora de criação, status de criptografia e CRN de criptografia, incluindo os valores de todas as variáveis de entrada.

Sintaxe

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

Opções de comando

As ações do Schematics obtêm sinalizações
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de uma ação que você deseja recuperar.
`--profile` ou `-p`	Opcional	A profundidade de informações que você deseja recuperar. Os valores suportados são `detailed` e `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem o modo interativo.

Exemplo

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

`ibmcloud schematics action list`

Recupere uma lista de todas as ações definidas na região IBM Cloud atual de sua conta.

Sintaxe

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

Opções de comando

Sinalizações da lista de ações do Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--limit` ou `-l`	Opcional	O número máximo de ações que você deseja listar. O número deve ser um número inteiro positivo entre 1 e 200. O valor padrão é `-1`.
`--offset` ou `-m`	Opcional	A posição da ação na lista de ações de onde você deseja começar a listar as suas ações. Por exemplo, se você tiver três ações em sua conta e região, o comando retornará essas ações como uma lista com três elementos. Para recuperar todas as ações, deve-se inserir a posição número 0. Para recuperar ações número 2 e 3 e deixar de fora a ação número 1 nesta lista, deve-se inserir a posição número 1. A posição número 1 representa a segunda posição na lista de ações. Números negativos não são suportados e são ignorados.
`--profile` ou `-p`	Opcional	A profundidade das informações que são retornadas. Os valores suportados são `ids` e `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

ibmcloud schematics action list --profile ids

`ibmcloud schematics action delete`

Excluir uma ação do Schematics.

Sintaxe

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

Opções de comando

Sinalizadores de exclusão de ações Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de uma ação que você deseja excluir.
`--force` ou `-f`	Opcional	Forçar a exclusão sem confirmação do usuário.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem prompts do usuário.

Exemplo

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

`ibmcloud schematics action upload`

É possível fazer upload de um archive tar (.tar) do seu sistema de arquivos local para uma ação do IBM Cloud Schematics. Insira o caminho de arquivo completo na máquina local em que o arquivo .tar é armazenado. Crie o arquivo .tar de seu repositório de modelo usando o comando TAR fornecido tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER.

Sintaxe

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

Opções de comando

Schematics sinalizações de upload de ações
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	ID de uma ação que você deseja fazer upload.
`--file` ou `-f`	Obrigatório	Caminho do arquivo `TAR` para fazer upload para uma ação.
`--no-prompt`	Opcional	Configure esta sinalização para parar a sessão de linha de comandos interativa.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

Comandos da Tarefa de Ações.

Analise os comandos para criar, atualizar, listar e excluir trabalhos do Schematics ao trabalhar com ações do Schematics.

`ibmcloud schematics job run`

Crie um trabalho em IBM Cloud Schematics para executar o playbook Ansible especificado por sua ação Schematics. É possível criar uma tarefa usando um arquivo de carga útil ou o modo interativo do comando.

Sintaxe

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]

Opções de comando

Schematics bandeiras de execução de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--command-object` ou `-c`	Obrigatório	O nome do recurso de automação do Schematics. Atualmente, apenas `action` é suportada.
`--command-object-id` ou `-cid`	Obrigatório	O ID das ações do site Schematics em que você deseja executar o trabalho.
`--command-name,` ou `-n`	Obrigatório	O comando que você deseja executar para a sua ação. Os valores suportados são `ansible_playbook_check` e `ansible_playbook_run`.
`--playbook-name` ou `-pn`	Opcional	O nome do playbook do Ansible que você deseja executar.
`--command-options` ou `-co`	Opcional	As opções da linha de comandos para o comando.
`--input` ou `--in`	Opcional	As variáveis de entrada para uma ação. Esse sinalizador pode ser definido várias vezes e deve estar em um formato `--inputs test=testvalue`.
`--input-file` ou `--if`	Opcional	Variáveis de entrada para uma ação. Forneça o caminho do arquivo JSON que contém variáveis de entrada.
`--env` ou `-e`	Opcional	As variáveis de ambiente para uma ação. Esse sinalizador pode ser definido várias vezes e deve estar em um formato `--env-variables test=testvalue`.
`--env-file` ou `-E`	Opcional	As variáveis de ambiente para uma ação. Forneça o caminho do arquivo JSON que contém as variáveis de ambiente.
`--result-format` ou `-f`	Opcional	A saída de resposta de resultado em formato JSON.
`--file` ou `-f`	Opcional	Caminho para o arquivo JSON contendo a definição da nova tarefa.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Se a ação contiver o nome do manual, você precisará adicionar o nome do manual, para que o nome do manual da ação tenha precedência. Se for necessário substituir o nome do playbook por meio da tarefa, será preciso criar uma ação com o novo nome.

Usando o arquivo de carga útil

É possível fornecer um arquivo de carga útil para especificar certos parâmetros para o comando job run. Em seguida, você transmite o nome do arquivo para o comando usando a opção de comando --file.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<COMMAND_OBJECT>" como "ação".

Sintaxe

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

Exemplo

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

Usando o modo interativo

Em vez de inserir os seus detalhes da tarefa usando opções de comando ou um arquivo de carga útil, é possível usar o modo interativo para o comando. Este modo solicita que você insira os valores necessários para criar uma tarefa no Schematics.

Insira o comando para criar a tarefa sem nenhuma opção de comando.
```
ibmcloud schematics job run
```
Quando solicitado a Enter command-object>, insira action e pressione a tecla de retorno.
Quando solicitado a Enter command-object-id>, insira os detalhes do identificador de ação e pressione a tecla de retorno.
Quando solicitado a Enter command-name>, insira ansible_playbook_run ou ansible_playbook_check e pressione a tecla de retorno.
Revise a saída da CLI para a tarefa que foi criada para você.

`ibmcloud schematics job update`

Crie uma tarefa copiando as configurações de uma tarefa existente e execute a tarefa em IBM Cloud Schematics.

Sintaxe

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

Opções de comando

Schematics sinalizadores de atualização de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	O ID de uma tarefa existente que você deseja copiar e executar novamente.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para criar a tarefa sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics job get`

Recupere os detalhes de um trabalho de ações usando um ID de trabalho.

Sintaxe

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

Opções de comando

Schematics sinalizadores de obtenção de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da tarefa que você deseja recuperar.
`--profile` ou `-p`	Opcional	A profundidade de informações que você deseja recuperar. Os valores suportados são `detailed` e `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para recuperar detalhes da tarefa sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics job list`

Recupere uma lista de todos os trabalhos do Schematics que foram executados para uma ação do Schematics. O comando exibe uma lista de trabalhos com o status in_progress, success, ou failed.

Sintaxe

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

Opções de comando

Schematics bandeiras de lista de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--resource-type` ou `-rt`	Obrigatório	O nome do recurso do Schematics. Apenas `action` é suportada.
`--id` ou `-i`	Obrigatório	A ID das ações do site Schematics para as quais você deseja listar trabalhos.
`--limit` ou `-l`	Opcional	O número máximo de áreas de trabalho que você deseja listar. O número deve ser um número inteiro positivo entre 1 e 200. O valor padrão é `-1`.
`--offset` ou `-m`	Opcional	A posição da tarefa na lista de tarefas de onde você deseja começar a listar as suas tarefas. Por exemplo, se você tiver três tarefas em sua conta, o comando retornará essas tarefas como uma lista com três elementos. Para recuperar todas as tarefas, deve-se inserir a posição número 0. Para recuperar a tarefa número 2 e 3 e deixar de fora a tarefa número 1 nesta lista, deve-se inserir a posição número 1. A posição número 1 representa a segunda posição na lista de tarefas. Números negativos não são suportados e são ignorados.
`--profile` ou `-p`	Opcional	A profundidade das informações que são retornadas. Os valores suportados são `ids` ou `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--all` ou `-A`	Opcional	Lista todas as tarefas incluindo as tarefas internas do Schematics.
`--no-prompt`	Opcional	Configure esta sinalização para criar a tarefa sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics job logs`

Recupere os registros de um trabalho de ação Schematics. Para obter mais informações sobre a visualização de registros de tarefas, consulte Revisão dos detalhes da tarefa Schematics.

Sintaxe

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

Opções de comando

Schematics tarefas de logs de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da tarefa para o qual você deseja recuperar logs detalhados.
`--log-prefix` ou `--lp`	Opcional	Inclui o prefixo de comando executado nos logs da tarefa.
`--log-header` ou `--lh`	Opcional	Usado para converter cabeçalhos de comando nos logs da tarefa no formato do Schematics.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics job delete`

Excluir uma tarefa para uma ação do Schematics.

Não é possível excluir ou parar uma tarefa em execução. Para remover uma tarefa, deve-se esperar a tarefa ser concluída.

Sintaxe

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

Opções de comando

Schematics bandeiras de exclusão de emprego
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da tarefa que você deseja excluir.
`--force` ou `-f`	Opcional	Para forçar a exclusão sem confirmação do usuário.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem uma sessão de linha de comandos interativa.

Exemplo

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

Comandos de agentes..

`ibmcloud schematics agent create`

Crie um registro de agente na região Schematics atualmente selecionada. Os agentes ajudam a executar os trabalhos do Terraform ou do Ansible em sua infraestrutura. Para obter mais informações sobre as etapas para usar o comando de criação, consulte implementando agentes

Sintaxe

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]

Opções de comando

Schematics Sinalizações de criação do agente
Sinalize	Obrigatório / Opcional	Descrição
`--name` ou `-n`	Obrigatório	O nome exclusivo de um agente. Deve ser descritivo da função, local e uso do agente.
`--location` ou `-l`	Obrigatório	O local Schematics onde o agente está definido, `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor`, ou `ca-mon`. Os trabalhos são retirados desse local para execução.
`--agent-location` ou `--al`	Obrigatório	Um rótulo descritivo definido pelo usuário para identificar onde o agente é implementado em um ambiente do usuário Isso pode ser uma região Cloud ou um data center do usuário. Por exemplo, `London MZR`.
`--cluster-id` ou `-c`	Obrigatório	A ID do cluster Kubernetes para a implantação de um Agente.
`--cluster-resource-group` ou `--cg`	Obrigatório	O nome do grupo de recursos dos clusters.
`--cos-instance-name` ou `--on`	Obrigatório	O nome da instância COS.
`--cos-bucket` ou `-b`	Obrigatório	A ID ou o nome do bucket COS.
`--cos-location` ou `--ol`	Obrigatório	O local do depósito do COS O formato suportado é `eu-gb`, `us-south`, etc.
`--resource-group` ou `-g`	Obrigatório	Nome ou ID do grupo de recursos ao qual o agente está associado.
`--version` ou `-v`	Obrigatório	Um rótulo definido pelo usuário que especifica a versão do agente Exemplo `v1.0.0`
`--infra-type` ou `-i`	Obrigatório	Especifique o tipo de infraestrutura do agente de destino. Os valores suportados são `ibm-kubernetes`, `ibm-openshift` ou `ibm-satellite`..
`--description` ou `-d`	Opcional	Uma descrição que identifica o uso do agente e as zonas de rede e os recursos que o agente pode acessar.
`--tags` ou `-t`	Opcional	Tags de agente. É possível repetir o sinalizador várias vezes As tags permitem uma procura mais rápida e mais fácil por recursos relacionados ao agente.
`--metadata` ou `--md`	Opcional	Metadados do agente. É possível usar o sinalizador várias vezes Por exemplo, `git:private-git.github.com` ou `git:gitlab.com`. Se não for definido, o padrão é `git:github.com`.
`--validate`	Opcional	Execute a ação 'validate', após criar o agente.
`--deploy`	Opcional	Execute ação 'deploy' sem validar, depois de criar o agente.
`--file` ou `f`	Opcional	Caminho para um arquivo `JSON` que contém a definição de um agente.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

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`

Desinstale um agente Para obter mais informações sobre as etapas para usar o comando de exclusão, consulte excluindo um agente

Sintaxe

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

Opções de comando

Schematics Sinalizadores de exclusão do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--force` ou `-f`	Opcional	A ação de força sem confirmação. Configure o parâmetro `--force` como true para excluir todos os fluxos do agente para manter a destruição paralela para o fluxo de destruição da área de trabalho Por padrão, esse parâmetro é configurado como false.

Exemplo

ibmcloud schematics agent delete --id <AGENT_ID>

`ibmcloud schematics agent deploy`

Implante ou atualize um agente para forçar a implantação. Para obter mais informações sobre as etapas para usar o comando deploy, consulte agente de implementação.

Sintaxe

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

Opções de comando

Sinalizadores de implementação do agente Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--force-redeploy` ou `-fd`	Opcional	Forçar reimplementações de um Agente
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics agent deploy --id <AGENT_ID>

`ibmcloud schematics agent destroy`

Destruir um agente destrói os recursos da nuvem associados à implementação do agente Schematics.

Sintaxe

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

Opções de comando

Schematics Sinalizadores de destruição do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--force` ou `-f`	Opcional	A ação de força sem confirmação.

Exemplo

ibmcloud schematics agent destroy --id <AGENT_ID>

`ibmcloud schematics agent get`

Recupere os detalhes de um agente existente, como ID do agente, Nome, Status, Versão, Hora de criação, Status de criptografia e CRN de criptografia, incluindo os valores de todas as variáveis de entrada. Para obter mais informações sobre as etapas para usar o comando get, consulte Exibição de um agente

Sintaxe

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

Opções de comando

Schematics Sinalizações de obtenção do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics agent get --id <AGENT_ID>

`ibmcloud schematics agent health`

Executa a validação pós-implementação de um agente. Para obter mais informações sobre as etapas para usar o comando de funcionamento do agente, consulte Funcionamento do agente de monitoramento.

Sintaxe

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

Opções de comando

Schematics Sinalizações de funcionamento do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics agent health --id <AGENT_ID>

`ibmcloud schematics agent list`

Lista os agentes definidos na região atual do Schematics Para obter mais informações sobre as etapas para usar o comando list, consulte exibindo um agente..

Sintaxe

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

Opções de comando

Schematics Os sinalizadores da lista de agentes
Sinalize	Obrigatório / Opcional	Descrição
`--location` ou `-l`	Opcional	Localizações geográficas suportadas pelo serviço IBM Cloud Schematics, como `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor` ou `ca-mon`.
`--limit` ou `-lm`	Opcional	O número máximo de agentes a serem listados. Ignorado se um número negativo for configurado. O limite máximo é 200, (o padrão é -1).
`--offset` ou `-m`	Opcional	Deslocamento na lista. Ignorado se um número negativo for definido (padrão: -1)).
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics agent list --location us-south

`ibmcloud schematics agent update`

Atualizar uma configuração do agente. A atualização de um agente não revalida nem reimplementa seu agente. Para obter mais informações sobre as etapas para usar o comando de atualização do agente, consulte implementando o agente

Sintaxe

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

Opções de comando

Schematics Sinalizadores de atualização do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID de um agente.
`--tags` ou `-t`	Opcional	Tags de agente. Esse sinalizador pode ser usado várias vezes e pesquisar mais rapidamente os recursos relacionados ao agente.
`--description` ou `-d`	Opcional	Breve descrição de um agente.
`--version value` ou `-v`	Opcional	Especifique a versão de um agente. O padrão é a versão mais recente disponível.
`--metadata`	Opcional	Metadados do agente. É possível usar o sinalizador várias vezes Por exemplo, `git:private-git.github.com` ou `git:gitlab.com`. Se não for definido, o padrão é `git:github.com`.
`--file` ou `-f`	Opcional	Caminho para o arquivo `JSON` que contém a definição do agente.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.
`--no-prompt`	Opcional	Configure esta sinalização para atualizar um inventário sem uma sessão de linha de comandos interativa.

Exemplo

ibmcloud schematics agent update --id <AGENT_ID>

`ibmcloud schematics agent validate`

Verifica a varredura de pré-requisitos que analisa uma configuração de agente e de cluster antes de implementar Para obter mais informações sobre as etapas para usar o comando validate, consulte implementando agente.

Sintaxe

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

Opções de comando

Schematics Sinalizadores de validação do agente
Sinalize	Obrigatório / Opcional	Descrição
`--id`	Obrigatório	A ID do agente.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics agent validate --id AGENT_ID

Comandos de política de agentes..

Schematics (atribuição) informam ao Schematics qual agente ele deve usar para executar trabalhos de espaço de trabalho e ação em uma zona de rede específica. Cada agente tem pelo menos uma política associada a ele para identificar os trabalhos a serem executados no local dos agentes. Consulte Políticas de Designação

`ibmcloud schematics policy create`

Crie uma política usando Schematics para selecionar um ou mais objetos Schematics, como um espaço de trabalho ou uma ação, a serem executados no agente de destino.

Sintaxe

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]

Opções de comando

Schematics sinalizadores de criação de política
Sinalize	Obrigatório / Opcional	Descrição
`--name` ou `-n`	Obrigatório	O nome exclusivo da política.
`--kind` ou `-K`	Obrigatório	Tipo de política para gerenciar e derivar a decisão de política. O site suportado é `agent_assignment_policy`.
`--location` ou `-l`	Opcional	Localização geográfica do serviço Schematics onde o agente está definido. Por exemplo, `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor`, ou `ca-mon`. As tarefas são selecionadas neste local para processamento.
`--resource-group` ou `-r`	Obrigatório	Nome ou ID do grupo de recursos para a política.
`--target-file` ou `tf`	Opcional	Caminho para o arquivo JSON contendo a definição da política.
`--description` ou `-d`	Opcional	A descrição da política Schematics.
`--tags` ou `-t`	Opcional	As identificações podem ser usadas várias vezes para procurar e localizar políticas do agente mais rapidamente
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Usando o arquivo de carga útil

É possível fornecer um arquivo de carga útil para especificar certos parâmetros para o comando policy create. Em seguida, você transmite o nome do arquivo para o comando usando a opção de comando --target-file.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<SELECTOR_KIND>" como "ids".

Sintaxe

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

Exemplo

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

Exemplo

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`

Excluir uma política de Schematics.

Sintaxe

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

Opções de comando

Sinalizadores de exclusão de política Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da política.
`--force` ou `-f`	Opcional	A ação de força sem confirmação.

Exemplo

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

`ibmcloud schematics policy get`

Recupere os detalhes de uma política Schematics existente usando o ID da política.

Sintaxe

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

Opções de comando

Sinalizadores de obtenção da política Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	ID da política.
`--profile` ou `-p`	Opcional	Nível dos detalhes a serem retornados. Os valores válidos são `summary`, `detailed`, ou `ids`. O padrão é `summary`.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

ibmcloud schematics policy get --id <POLICY_ID>

`ibmcloud schematics policy list`

Recupere uma lista de todas as apólices na região IBM Cloud para sua conta.

Sintaxe

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

Schematics Sinalizadores da lista de políticas
Sinalize	Obrigatório / Opcional	Descrição
`--profile` ou `-r`	Opcional	O nível de detalhes a serem retornados. Os valores válidos são `summary`, `detailed` e `ids`. O padrão é `summary`.
`--limit` ou `-l`	Opcional	Número máximo de políticas a serem listadas. Ignorado se um número negativo for configurado. O número deve ser um número inteiro positivo entre 1 e 200. O valor padrão é `-1`.
`--offset`ou `-m`	Opcional	Deslocamento na lista. Ignorado se um número negativo for configurado. O valor padrão é `-1`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

ibmcloud schematics policy list  --profile ids092030

`ibmcloud schematics policy update`

Atualizar uma política existente usando o ID de política.

Sintaxe

ibmcloud schematics policy update --id POLICY_ID [--kind POLICY_KIND] [--description DESCRIPTION] [--resource-group RESOURCE_GROUP] [--tags TAGS] [--file FILE] [--output OUTPUT]

Sinalizadores de atualização de política Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	ID da política.
`--kind` ou `-k`	Opcional	Tipo de política para gerenciar e derivar a decisão de política. O site suportado é `agent_assignment_policy`.
`--description` ou `-d`	Opcional	A descrição da política de personalização do site Schematics.
`--resource-group` ou `-r`	Opcional	Nome ou ID do grupo de recursos para a política.
`--tags` ou `-t`	Opcional	Tags de política. Esse sinalizador pode ser usado várias vezes para procurar e localizar políticas do agente mais rapidamente
`--file` ou `-f`	Opcional	Caminho para o arquivo `JSON` que contém a definição da política.
`--output` ou `-o`	Opcional	Especifique o formato de saída, somente `JSON` é compatível.

Exemplo

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

Configurar comandos BYOK ou KYOK

Você pode usar suas chaves de criptografia do site IBM Key Protect (disponível como Multi-Tenant para BYOK ou Dedicated para KYOK) para criptografar e proteger seus dados armazenados no site Schematics. Para obter mais informações sobre como proteger dados confidenciais em Schematics, consulte como proteger seus dados confidenciais em Schematics.

Hyper Protect Crypto Services (HPCS) foi preterido para novas integrações. As integrações HPCS existentes continuarão a funcionar, mas não há mais suporte para novas integrações com o HPCS. Para novas integrações, use Key Protect Dedicated para os recursos do KYOK.

Antes de Iniciar

Os pré-requisitos a seguir devem ser garantidos para que o sistema de gerenciamento de chaves liste a instância criada a partir de seu local e região específicos.

Você deve ter seu BYOK ou KYOK. Para criar chaves IBM Key Protect, consulte criar instância Key Protect. Escolha Multi-Tenant para BYOK ou Dedicated para a implementação do KYOK.
É necessário incluir chave raiz em serviços do Schematics.
É necessário configurar a autorização de serviço para serviço para integrar o BYOK e o KYOK no serviço do Schematics.

A configuração do KMS é uma configuração única. Você precisa abrir um tíquete de suporte para atualizar as configurações do KMS.

`ibmcloud schematics kms instance ls`

Lista todas as instâncias do KMS de sua conta da IBM Cloud para localizar o seu Key Protect ou o Hyper Protect Crypto Services usando o seu local no qual as chaves são criadas e o esquema criptografado como KYOK ou BYOK.

Sintaxe

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

Opções de comando

Schematics Sinalizadores de lista de KMS
Sinalize	Obrigatório / Opcional	Descrição
`--location` ou `-l`	Obrigatório	Configure o nome do local do Schematics. Os valores suportados são `US` ou `EU`.
`--scheme` ou `-s`	Obrigatório	Especifique o esquema de criptografia. Os valores suportados são `KYOK` ou `BYOK`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics kms enable`

Ative o KMS para criptografar os seus dados no local específico. Para obter mais informações sobre como ativar as chaves gerenciadas pelo cliente para Schematics, consulte Ativação de chaves.

Atualize as configurações do KMS para a sua localização, usando o seu terminal privado, CRN, CRK primário e CRK secundário. Observe que você pode atualizar as configurações do KMS apenas uma vez. Por exemplo, se você usar um terminal de API para uma geografia, como North America, apenas aqueles criados em us-south ou us-east serão recuperados.

Sintaxe

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]

Opções de comando

Schematics KMS ativar sinalizadores
Sinalize	Obrigatório / Opcional	Descrição
`--location` ou `-l`	Obrigatório	Configure o nome do local do Schematics. Os valores suportados são `US` ou `EU`.
`--scheme` ou `-s`	Obrigatório	Especifique o esquema de criptografia. Os valores suportados são `KYOK` ou `BYOK`.
`--group` ou `-g`	Obrigatório	Especifique o nome do grupo de recursos. O valor padrão é `Default`.
`--primary_name` ou `--pn`	Obrigatório	Especifique o nome do KMS primário.
`--primary_crn` ou `--pc`	Obrigatório	Especifique o nome do CRN da chave primária.
`--primary_endpoint` ou `--pe`	Obrigatório	Especifique o terminal privado do KMS primário.
`--secondary_name` ou `--sn`	Opcional	Especifique o nome do KMS secundário.
`--secondary_crn` ou `--sc`	Opcional	Especifique o CRN de chave secundária.
`--secondary_endpoint` ou `--se`	Opcional	Especifique o terminal privado do KMS secundário.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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`

Recupere o KMS no terminal de API no qual você tem o seu KYOK ou BYOK. Por exemplo, se você usar um terminal de API para uma geografia, como North America, apenas aqueles criados em us-south ou us-east serão recuperados. Observe que é necessário habilitar kms instances em sua conta para executar a linha de comando info.

Sintaxe

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

Opções de comando

Schematics Sinalizadores de informações do KMS
Sinalize	Obrigatório / Opcional	Descrição
`--location` ou `-l`	Obrigatório	Configure o nome do local do Schematics. Os valores suportados são `US` ou `EU`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

ibmcloud schematics kms info -l US

Comandos gerais

Use estes comandos gerais para localizar informações de ajuda e versão para o plug-in da linha de comandos do IBM Cloud Schematics.

`ibmcloud schematics help`

Visualize os comandos da linha de comandos do IBM Cloud Schematics suportados.

Sintaxe

ibmcloud schematics help

Opções de comando

Schematics ajudam bandeiras
Sinalize	Obrigatório / Opcional	Descrição
`--help` ou `-h`	Obrigatório	Lista os comandos suportados.
`command`	Opcional	Especifique o nome do comando para buscar os detalhes do comando.

Exemplo

ibmcloud schematics help

`ibmcloud schematics version`

Liste as versões de todos os projetos de código aberto compatíveis em Schematics, como IBM Cloud Provider Plug-in for Terraform, Ansible, Helm e Kubernetes, que são usados para executar as ações de Schematics nos recursos da nuvem.

Sintaxe

ibmcloud schematics version [--output OUTPUT]

Opções de comando

Schematics sinalizadores de versão
Sinalize	Obrigatório / Opcional	Descrição
`--output` ou `-o`	Opcional	Retorna a saída da CLI em formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

Comandos de inventário

Revise os comandos para criar, atualizar, listar, excluir e trabalhar com os inventários do IBM Cloud Schematics usados com as ações do Schematics.

`ibmcloud schematics inventory create`

Para criar um inventário de recursos em Schematics para uso com uma ação Ansible, você pode usar um arquivo de carga útil ou o modo interativo. O inventário inclui todos os hosts de destino em que você pretende executar o playbook Ansible.

Sintaxe

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]

Opções de comando

Schematics inventário criar flags
Sinalize	Obrigatório / Opcional	Descrição
`--name` ou `-n`	Obrigatório	O nome exclusivo de um inventário de recurso.
`--description` ou `-d`	Opcional	A descrição simples de um inventário.
`--location` ou `-l`	Opcional	O local onde você deseja armazenar o inventário de recursos, como `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor`, ou `ca-mon`.
`resource-group` ou `-r`	Opcional	O nome do grupo de recursos onde você deseja criar a ação.
`--connection-type` ou `--ct`	Opcional	Tipo de uma conexão de inventário. Suporta os sites `ssh` e `winrm`.
`--bastion-ip-address` ou `-b`	Opcional	Digite o endereço IP do host do Bastion.
`--bastion-credential-json` ou `--bj`	Opcional	Forneça o caminho do arquivo JSON que contém a carga útil da credencial do Bastion para acessar o host do Bastion.
`--credential-json` ou `--cj`	Opcional	Forneça o caminho do arquivo JSON que contém a carga útil da credencial comum para acessar os hosts de destino. A hierarquia de credenciais em Schematics segue esta ordem: Credenciais em nível de host (prioridade mais alta), credenciais em nível de grupo (prioridade seguinte) e credenciais comuns (prioridade mais baixa).
`--inventory-view-json` ou `--inv`	Opcional	Caminho para o arquivo JSON que contém os detalhes do host. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--inventories-ini-file` ou `-y`	Opcional	O caminho de arquivo para o arquivo de inventário de recurso onde você especificou todos os hosts de destino. O arquivo de inventário de recurso deve ser fornecido em formato `INI`. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--resource-query`	Opcional	Insira o ID de uma consulta de recurso que você criou. Uma consulta de recursos ajuda a criar dinamicamente seu inventário de recursos usando os recursos da nuvem que você criou com um espaço de trabalho Schematics. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--file` ou `-f`	Opcional	O caminho para o arquivo JSON onde você especificou o inventário de recurso que deseja criar.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para criar um inventário sem uma sessão de linha de comandos interativa.

Usando o arquivo de carga útil

É possível fornecer um arquivo de carga útil para especificar certos parâmetros para o comando inventory create. Em seguida, você transmite o nome do arquivo para o comando usando a opção de comando --file.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<INVENTORY_NAME>" como "myinventory".

Sintaxe para um 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Sintaxe para um 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
            }
        }
    ]
}

Sintaxe para um bastion_credentials_example.json

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

}

ibmcloud schematics inventory create --file inventory.json

Usando o modo interativo

Em vez de inserir os seus detalhes de inventário usando as opções de comando ou um arquivo de carga útil, também é possível usar o modo interativo para o comando. Este modo solicita que você insira os valores necessários para criar um inventário em Schematics.

Insira o comando para criar o inventário sem nenhuma opção de comando.
```
ibmcloud schematics inventory create ....
```
Insira um nome para o seu inventário e pressione a tecla de retorno.
Insira o grupo de recursos onde deseja criar o inventário e pressione a tecla de retorno.
Digite o local onde você deseja criar o inventário, como us-south, us-east, eu-de, ou eu-gb. Em seguida, pressione a tecla de retorno.
Revise os detalhes do inventário que foi criado.

Exemplo

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`

Exclua a definição de inventário de recurso usando o ID do inventário..

Sintaxe

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

Opções de comando

Schematics Sinalizações de exclusão de inventário
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de um inventário que você deseja excluir.
`--force` ou `-f`	Opcional	Forçar a exclusão sem confirmação do usuário.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem prompts do usuário.

Exemplo

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

`ibmcloud schematics inventory get`

Recupere informações detalhadas de um inventário existente no site IBM Cloud Schematics usando o ID do inventário.

Sintaxe

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

Opções de comando

Schematics inventário obter sinalizadores
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID do inventário de recurso para o qual você deseja listar informações detalhadas.
`--profile` ou `-p`	Opcional	A profundidade de informações que você deseja recuperar. Os valores suportados são `detailed` e `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para recuperar detalhes de um inventário sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics inventory list`

Recupere uma lista de todos os inventários de Schematics na região atual para sua conta.

Sintaxe

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

Opções de comando

Schematics bandeiras de lista de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--limit` ou `-l`	Opcional	O número máximo de inventários que você deseja listar. O número deve ser um número inteiro positivo entre 1 e 200. O valor padrão é `-1`.
`--offset` ou `-m`	Opcional	A posição do inventário na lista de inventários. Por exemplo, se você tiver três inventários em sua conta, o comando retornará esses inventários como uma lista com três elementos. Para ver um inventário específico nesta lista, deve-se inserir o número de posição que o inventário tem na lista. Para listar o primeiro inventário na lista, insira `0`. Para listar o segundo inventário, insira `1` e assim por diante. Números negativos não são suportados e são ignorados. O valor padrão é `-1`.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.

Exemplo

ibmcloud schematics inventory list --output json

`ibmcloud schematics inventory update`

Atualizar um inventário de recursos existente.

Sintaxe

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]

Opções de comando

Schematics sinalizadores de atualização de inventário
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	Insira o ID de um inventário de recurso que deseja atualizar.
`--name` ou `-n`	Obrigatório	O nome exclusivo de um inventário.
`--description` ou `-d`	Opcional	A descrição simples de um inventário.
`--location` ou `-l`	Opcional	As localizações geográficas suportadas pelo serviço IBM Cloud Schematics, como `us-south`, `us-east`, `eu-de`, `eu-gb`, `ca-tor`, ou `ca-mon`.
`resource-group` ou `-r`	Opcional	O nome do grupo de recursos para uma ação.
`--connection-type` ou `--ct`	Opcional	Tipo de uma conexão de inventário. Suporta os sites `ssh` e `winrm`.
`--bastion-ip-address` ou `-b`	Opcional	Digite o endereço IP do host do Bastion.
`--bastion-credential-json` ou `--bj`	Opcional	Forneça o caminho do arquivo JSON que contém a carga útil da credencial do Bastion para acessar o host do Bastion.
`--credential-json` ou `--cj`	Opcional	Forneça o caminho do arquivo JSON que contém a carga útil da credencial comum para acessar os hosts de destino. A hierarquia de credenciais em Schematics segue esta ordem: Credenciais em nível de host (prioridade mais alta), credenciais em nível de grupo (prioridade seguinte) e credenciais comuns (prioridade mais baixa).
`--inventory-view-json` ou `--inv`	Opcional	Caminho para o arquivo JSON que contém os detalhes do host. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--inventories-ini-file` ou `-y`	Opcional	Caminho de arquivo do arquivo de formato `INI` que contém os detalhes do host. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--resource-query`	Opcional	Insira o ID de uma consulta de recurso que você criou. Uma consulta de recursos ajuda a criar dinamicamente seu inventário de recursos usando os recursos da nuvem que você criou com um espaço de trabalho Schematics. Você deve passar o caminho do arquivo `--inventories-ini-file`, a ID `--resource-query` ou `--inventory-view-json` para que o inventário use os detalhes do host de destino. O fornecimento de quaisquer dois ou todos os três argumentos deve gerar um erro.
`--file` ou `-f`	Opcional	Caminho para o arquivo JSON que contém a definição de um inventário.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para atualizar um inventário sem uma sessão de linha de comandos interativa.

Usando o arquivo de carga útil

É possível fornecer um arquivo de carga útil para especificar certos parâmetros para o comando inventory update. Em seguida, você transmite o nome do arquivo para o comando usando a opção de comando --file.

Sintaxe para um 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": {}
                        }
                    }
                ]
            }
        ]
    }
}

Exemplo

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

Comandos de consulta de recurso de inventário

Crie dinamicamente inventários de recursos de ações usando consultas de recursos. As consultas de recursos permitem que você reúna informações sobre o host de destino em Schematics workspaces. Para obter mais informações sobre consultas e condições de recursos, consulte Criação de inventários de recursos para ações do site Schematics.

`ibmcloud schematics resource query create`

Crie uma consulta de recurso em IBM Cloud Schematics que você possa usar para construir o seu inventário de recurso. É possível criar uma consulta de recurso usando um arquivo de carga útil ou o modo interativo do comando. É possível criar condições de recurso usando consultas de recurso.

Sintaxe

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]

Opções de comando

Schematics consulta de recursos criar sinalizadores
Sinalize	Obrigatório / Opcional	Descrição
`--name` ou `-n`	Obrigatório	O nome exclusivo para uma consulta de recurso.
`--type` ou `-t`	Opcional	O tipo de recurso que você deseja recuperar. Os valores suportados são `vsi`.
`--query-file` ou `-f`	Opcional	O caminho para o arquivo JSON onde você especificou os detalhes de sua consulta de recurso. Para localizar uma lista de consultas suportadas, consulte Consultas de recurso suportadas.
`--file` ou `-f`	Opcional	O caminho para o arquivo JSON que especifica os detalhes da consulta de recurso que você deseja criar.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para criar a consulta de recurso sem uma sessão de linha de comandos interativa.

Usando o arquivo de carga útil

É possível fornecer um arquivo de carga útil para especificar certos parâmetros para o comando resource_query create. Em seguida, você transmite o nome do arquivo para o comando usando a opção de comando --file. Para obter uma lista de consultas de recurso suportadas, consulte Consultas de recursos suportadas.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<WORKSPACE_ID" como us-east.workspace.ID1231.

Sintaxe

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

Exemplo

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

Usando o modo interativo

Em vez de inserir os seus detalhes de consulta de recurso usando as opções de comando ou um arquivo de carga útil, é possível usar o modo interativo para o comando. Este modo solicita que você insira os valores necessários para criar uma consulta de recurso em Schematics. É possível criar condições de recurso usando consultas de recurso.

Insira o comando para criar a consulta de recurso sem nenhuma opção de comando.
```
ibmcloud schematics resource-query create
```
Insira um nome para a sua consulta de recurso e pressione a tecla de retorno.
Insira o caminho para o seu arquivo de carga útil. Para um arquivo de carga útil de amostra, consulte Usando o arquivo de carga útil. Em seguida, pressione a tecla de retorno.
Revise os detalhes da consulta de recurso que foi criada para você.

`ibmcloud schematics resource query delete`

Exclua a definição da consulta de recurso usando o ID de consulta de recurso do serviço do IBM Cloud Schematics. Observe que é possível excluir o local e a região, o grupo de recursos de onde o seu inventário foi criado. Além disso, certifique-se de que os seus endereços IP estejam na lista de permissões.

Sintaxe

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

Opções de comando

Schematics consulta de recursos de consulta de recursos
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de uma consulta de recurso que você deseja excluir.
`--force` ou `-f`	Opcional	Forçar a exclusão sem confirmação do usuário.
`--no-prompt`	Opcional	Configure esta sinalização para executar o comando sem prompts do usuário.

Exemplo

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

`ibmcloud schematics resource query get`

Recuperar as informações de uma consulta de recurso existente do IBM Cloud Schematics usando um ID de consulta de recurso.

Sintaxe

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

Opções de comando

Schematics consulta de recursos get flags
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da consulta de recurso que você deseja recuperar.
`--profile` ou `-p`	Opcional	A profundidade de informações que você deseja recuperar. Os valores suportados são `detailed` e `summary`. O valor padrão é `summary`.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para recuperar uma consulta de recurso sem uma sessão de linha de comandos interativa.

Exemplo

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

`ibmcloud schematics resource query list`

Recupere uma lista de todas as consultas de recursos do Schematics na região atual para sua conta.

Sintaxe

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

Opções de comando

Schematics sinalizadores de lista de consultas de recursos
Sinalize	Obrigatório / Opcional	Descrição
`--limit` ou `-l`	Opcional	O número máximo de consultas de recurso que você deseja listar. O número deve ser um número inteiro positivo entre 1 e 200. O valor padrão é `-1`.
`--offset` ou `-m`	Opcional	A posição da consulta de recurso na lista de consultas de recurso. Por exemplo, se você tiver três consultas de recurso em sua conta, o comando retornará essas consultas de recurso como uma lista com três elementos. Para ver uma consulta de recurso específica nesta lista, deve-se inserir o número de posição que a consulta de recurso tem na lista. Para listar a primeira consulta de recursos na lista, insira `0`. Para listar a segunda consulta de recursos, insira `1` e assim por diante. Números negativos não são suportados e são ignorados. O valor padrão é `-1`.
`--output` ou `-o`	Opcional	Especificar o formato de saída. Apenas o formato `JSON` é suportado.

Exemplo

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

`ibmcloud schematics resource query update`

Atualizar ou substituir uma consulta de recurso cria uma cópia dela e reativa uma consulta de recurso existente atualizando as informações de uma consulta de recurso do IBM Cloud Schematics existente.

Sintaxe

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]

Opções de comando

Schematics sinalizadores de atualização de consulta de recursos
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID de consulta de recurso.
`--name` ou `-n`	Obrigatório	O nome exclusivo para uma consulta de recurso.
`--type` ou `-t`	Opcional	O tipo da consulta de recursos, como `vsi`
`--query-file` ou `-f`	Opcional	O caminho para o arquivo JSON contendo consultas.
`--file` ou `-f`	Opcional	Caminho para o arquivo JSON que contém a definição de um inventário.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--no-prompt`	Opcional	Configure esta sinalização para criar a consulta de recurso sem uma sessão de linha de comandos interativa.

Exemplo

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

Comandos da área de trabalho

Analise os comandos que você pode usar para criar e trabalhar com o espaço de trabalho do IBM Cloud Schematics.

`ibmcloud schematics workspace action`

Recupere todas as atividades (trabalhos) de um espaço de trabalho, incluindo o ID do usuário da pessoa que iniciou a ação, o status e um registro de data e hora.

Quando você cria um plano de execução do Terraform ou aplica o modelo do Terraform com Schematics, uma ação Schematics é criada automaticamente e recebe um ID de ação. É possível usar o ID de ação para recuperar os logs dessa ação usando o comando ibmcloud schematics logs.

Sintaxe

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

Opções de comando

Schematics sinalizadores de execução da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja recuperar atividades de área de trabalho. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--act-id` ou `-a`	Opcional	Insira o ID de uma ação que deseja recuperar.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

ibmcloud schematics workspace action --id <WORKSPACE_ID>

`ibmcloud schematics workspace delete`

Excluir uma área de trabalho da região atual para sua conta. A exclusão do seu espaço de trabalho não remove nenhum recurso da nuvem que você provisionou com esse espaço de trabalho. É possível acessar e trabalhar com seus recursos diretamente no painel do IBM Cloud, mas não é possível usar o IBM Cloud Schematics para gerenciar seus recursos depois da exclusão da área de trabalho.

Decida se você deseja excluir a área de trabalho, quaisquer recursos associados ou ambos. Essa ação não pode ser desfeita Se você remover a área de trabalho e mantiver os recursos, será necessário gerenciar os recursos com a lista de recursos ou a CLI.

excluir área de trabalho e recurso associado
Ação	Excluir área de trabalho	Excluir todos os recursos associados
Excluir área de trabalho	True	False
Excluir apenas recursos	False	True
Excluir área de trabalho e os recursos provisionados pela área de trabalho	True	True
Recursos destruídos usando linha de comandos ou lista de recursos e deseja excluir área de trabalho	True	False

Sintaxe

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

Opções de comando

Schematics sinalizações de exclusão da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho que você deseja remover. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--force` ou `-f`	Opcional	Force a exclusão de sua área de trabalho sem prompts de linha de comandos.

Exemplo

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

`ibmcloud schematics workspace get`

Recupere os detalhes de um espaço de trabalho existente, como ID do espaço de trabalho, nome, status, versão, hora de criação, ID do modelo, ID de confirmação, status de criptografia e CRN de criptografia, incluindo os valores de todas as variáveis de entrada.

Sintaxe

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

Opções de comando

Schematics sinalizadores de obtenção do espaço de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja recuperar detalhes. Para localizar o `Resource ID` de uma área de trabalho, execute o comando `ibmcloud schematics workspace list` para visualizar as instâncias de serviço da lista. Por meio de seu grupo de recursos, obtenha um `Resource ID` para a sinalização `--id`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

ibmcloud schematics workspace get --id <WORKSPACE_ID>

`ibmcloud schematics workspace import`

É possível importar um recurso existente com um endereço de recurso válido em seu arquivo de estado da área de trabalho É necessário assegurar que o recurso seja importado apenas uma vez e para uma única área de trabalho Caso contrário, você pode ver um comportamento indesejado se o recurso for definido em vários espaços de trabalho. Revise a documentação do Terraform para obter detalhes sobre como usar o comando import.

Sintaxe

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

Opções de comando

Schematics sinalizações de importação da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja importar uma instância ou um recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--options` ou `-o`	Obrigatório	As sinalizações da linha de comandos. Por exemplo, `-var-file xxxxx/tf`.
`--address` ou `-adr`	Obrigatório	Forneça o endereço do nome do recurso que deseja importar.
`--resourceID` ou `-rid`	Obrigatório	Forneça o ID do recurso que você precisa importar no arquivo.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Use a opção -options -var-file=schematics.tfvars para informar Schematics para importar o recurso com as variáveis de área de trabalho salvas.

Exemplo

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`

Liste as áreas de trabalho para a região atual da conta do IBM Cloud e mostre os detalhes para sua área de trabalho. A área de trabalho de lista verifica a descontinuação em um loop chamando a API versions toda vez para toda a área de trabalho por meio do cache de arquivo.

Sintaxe

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

Opções de comando

sinalizadores da lista da área de trabalho Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--limit` ou `-l`	Opcional	O número máximo de áreas de trabalho que você deseja listar. O número deve ser um número inteiro positivo iniciando em 1. O máximo é 200. O valor padrão é `-1`.
`--offset` ou `-m`	Opcional	A posição da área de trabalho na lista de áreas de trabalho. Por exemplo, se tiver três áreas de trabalho em sua conta, o comando as retornará como uma lista de três elementos. Para ver uma área de trabalho específica nesta lista, deve-se inserir o número da posição que a área de trabalho ocupa na lista. Para listar a primeira área de trabalho na lista, insira `0`. Para listar a segunda área de trabalho, insira `1` e assim por diante. Números negativos não são suportados e são ignorados. O valor padrão é `-1`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.
`--region` ou `-r`	Opcional	Especifique a região, como `eu`, `us`, `eu-gb`, `eu-de`, `us-south`, ou `us-east`.

Exemplo

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

`ibmcloud schematics workspace new`

Crie um espaço de trabalho Schematics que aponte para seu modelo do Terraform em GitHub ou GitLab. Se você desejar fornecer seu modelo do Terraform fazendo upload de um archive de fita (.tar), será possível criar a área de trabalho sem uma conexão com um repositório GitHub e, em seguida, usar o comando ibmcloud schematics workspace upload para fornecer o modelo.

O Schematics não suporta passar o arquivo .tar para criar uma área de trabalho.

O IBM Cloud Schematics suporta 50 solicitações de API por minuto, por host e por cliente. O local pode ser a região us-east, us-south, eu-gb ou eu-de. É necessário esperar antes de chamar o comando novamente.

Para criar uma área de trabalho, é possível especificar as configurações da sua área de trabalho em um arquivo JSON. Certifique-se de que o arquivo JSON siga a estrutura esboçada nesse comando. Certifique-se também de que o location e o endpoint url estejam apontando para a mesma região quando você criar ou atualizar espaços de trabalho e ações. Para obter mais informações sobre localização e terminal, consulte Onde estão armazenadas minhas informações?.

IBM Cloud Schematics está descontinuando versões mais antigas do Terraform e introduzindo suporte para a versão mais recente do Terraform. Para obter mais informações, consulte o ciclo de vida de depreciação do Schematics Terraform e o cronograma de depreciação.

Sintaxe

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

Opções de comando

Sinalizações de criação da área de trabalho Schematics
Sinalize	Obrigatório / Opcional	Descrição
`--file` ou `-f`	Obrigatório	O caminho relativo para um arquivo JSON em sua máquina local que é usado para configurar sua área de trabalho. Para obter mais informações sobre o arquivo JSON de amostra com os detalhes, consulte Modelo de criação de arquivo JSON.
`--state`	Opcional	O caminho relativo para um arquivo de estado do Terraform existente em sua máquina local. Para criar o arquivo de estado do Terraform: 1. Mostre o conteúdo de um arquivo de estado do Terraform existente usando o `ibmcloud schematics state pull` comando 2. Copie o conteúdo do arquivo de estado da saída da linha de comando para um arquivo em seu computador local chamado `terraform.tfstate`. 3. Use o caminho relativo para o arquivo no parâmetro de comando `--state`. Nota A área de trabalho Schematics suporta o arquivo `terraform.tfstate` menor que 2 MB.
`--github-token` ou `-g`	Opcional	Insira os tokens de acesso pessoal funcional para operações de Git de HTTPS. Por exemplo, `--github-token ${FUNCTIONAL_GIT_KEY}`.
`--agent-id` ou `--aid`	Opcional	O ID de um Agente no qual sua área de trabalho é criada O agente o ajuda a executar os trabalhos do workspace em sua infraestrutura. Para obter mais informações, consulte Schematics Agente.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

O uso do comando Schematics ibmcloud terraform exibe um aviso e uma mensagem de descontinuidade, pois Alias 'terraform' estão descontinuados. Use "schematics" ou "sch" em seus comandos.

Criar modelo de arquivo em formato JSON

O Schematics suporta para fazer o download do modelo de módulos do Terraform a partir do repositório privado. Para obter mais informações, consulte Suporte para o download de módulos a partir de host remoto privado.

É possível criar o arquivo JSON como compartilhado no arquivo example.json para criação de área de trabalho e transmitir o caminho do arquivo juntamente com o nome do arquivo na sinalização do --file. A descrição de todos os parâmetros do example.json conforme descrito na tabela.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<workspace_name>" como "testworkspace".

Exemplo

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

Exemplo de JSON para upload em um arquivo .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>"
        }
        ]
    }
    ]
}

Descrição do componente do arquivo JSON
Parâmetro	Necessário/Opcional	Descrição
`workspace_name`	Opcional	Insira um nome para sua área de trabalho. O comprimento máximo do limite de caracteres é configurado para menos de 1 MB.. Para obter mais informações, consulte Projetando sua estrutura de área de trabalho.
`terraform_version`	Opcional	A versão do Terraform que você deseja usar para executar o seu código do Terraform. Digite `terraform_v1.5` para usar a versão do Terraform 1.5,`terraform_v1.4` para usar a versão do Terraform 1.4 e, da mesma forma, `terraform_v1.4`. Por exemplo, quando você especifica `terraform_v1.5` significa que os usuários podem ter um modelo que seja do Terraform `v1.5.0`, `v1.5.1` ou `v1.5.7`, etc. Certifique-se de que seus arquivos de configuração do Terraform sejam compatíveis com a versão do Terraform especificada. Esta é uma variável necessária. HashiCorp Se a versão do Terraform não for especificada, por padrão, o site Schematics selecionará a versão do seu modelo. O site Schematics é compatível com o site `Terraform_v1.x` e também planeja disponibilizar versões após o lançamento da linguagem de configuração (HCL) `30 to 45 days`.
`location`	Opcional	Digite o local onde deseja criar o espaço de trabalho. O local determina onde suas ações do Schematics são executadas e onde seus dados da área de trabalho são armazenados. Se você não inserir um local, o Schematics determinará o local com base na região do IBM Cloud que você destinou. Para visualizar a região que você destinou, execute `ibmcloud target --output json` e verifique o campo `region`. Para direcionar uma região diferente, execute `ibmcloud target -r <region>`. Se você inserir um local, certifique-se de que o local corresponda à região da IBM Cloud para a qual destinou.
`description`	Opcional	Digite uma descrição para o seu espaço de trabalho.
`template_repo.url`	Opcional	Digite o endereço URL para o repositório GitHub ou GitLab onde os arquivos de configuração do Terraform estão armazenados.
`template_repo.branch`	Opcional	Digite a ramificação GitHub ou GitLab onde os arquivos de configuração do Terraform estão armazenados. Agora, em `template_repo`, você também pode atualizar URL com mais parâmetros, conforme mostrado no bloco.
`template_repo.datafolder`	Opcional	Digite o nome da pasta no repositório Git que contém o modelo.
`template_repo.release`	Opcional	Digite a versão GitHub ou GitLab que aponta para os arquivos de configuração do Terraform.
`github_source_repo_url`	Opcional	Digite o link do seu repositório GitHub. O link pode ter como destino a ramificação `master`, uma ramificação diferente ou um subdiretório. Se você optar por criar sua área de trabalho sem um repositório GitHub, sua área de trabalho será criada com um estado rascunho. Para conectar sua área de trabalho a um repositório GitHub posteriormente, deve-se usar o comando `ibmcloud schematics workspace update`. Se você planeja fornecer seu modelo do Terraform fazendo upload de um arquivo tar (`.tar`), deixe a URL vazia e use o comando ibmcloud schematics workspace upload depois de ter criado a área de trabalho. Se você quiser clonar do repositório Git, consulte as extensões de arquivo permitidas e bloqueadas para clonagem.
`env_values`	Opcional	Uma lista de variáveis de ambiente que você deseja aplicar durante a execução de um script bash ou de uma ação do Terraform. Esse campo deve ser fornecido como uma lista de pares chave-valor. Cada entrada é um mapa com uma entrada em que `key = variable name` e `value = value`. É possível definir variáveis de ambiente para as ofertas de catálogo da IBM Cloud que são provisionadas usando arquivos de script de bash.
`variable_name`	Digite o nome da variável de entrada que você declarou nos seus arquivos de configuração do Terraform.
`variable_type`	Opcional	`Terraform v0.12` suporta `string`, `list`, `map`, `bool`, `number` e tipos de dados complexos, como `list(type)`, `map(type)`, `object({attribute name=type,..})`, `set(type)`, `tuple([type])`.
`variable_value`	Digite o valor como uma cadeia de caracteres para os tipos primitivos, como `bool`, `number`, `string` e `HCL` formato para as variáveis complexas, conforme fornecido em um arquivo `.tfvars`. É necessário inserir a sequência escapada do formato `HCL` para o valor, conforme mostrado no exemplo. Para obter mais informações sobre como declarar variáveis em um arquivo de configuração do Terraform e fornecer valor aos esquemas, consulte Uso de variáveis de entrada para personalizar recursos. Por exemplo
`secure`	Opcional	Define o parâmetro `secure` como true. Por padrão, esse parâmetro é definido como false.
`val1`	Opcional	No payload, você pode fornecer uma variável de ambiente que pode ser executada no seu espaço de trabalho durante o estágio de planejamento, aplicação ou destruição. Além disso, os valores são criptografados e armazenados no COS.

O IBM Cloud Schematics suporta a configuração de uma variável de ambiente, como TF_PARALLELISM, TF_LOG. Para obter mais informações sobre a lista de variáveis de ambiente e seu uso, consulte Lista de variáveis de ambiente.

Exemplo

ibmcloud schematics workspace new --file example.json

`ibmcloud schematics refresh`

Execute uma ação de atualização da IBM Cloud com relação à sua área de trabalho. Uma ação de atualização valida os recursos do Cloud em sua conta em relação ao estado que está armazenado no arquivo de estado do Terraform do seu espaço de trabalho. Se diferenças forem encontradas, o arquivo de estado do Terraforme será atualizado em conformidade.

Sintaxe

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

Opções de comando

Schematics bandeiras de atualização
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho com relação ao qual você deseja atualizar e executar uma ação. Para localizar o ID de uma área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics state list`

Liste os endereços Name, Type, URL e Taint Status dos recursos da nuvem que estão documentados em seu arquivo de estado do Terraform (terraform.tfstate).

O Taint Status retorna contaminado para (true) ou em branco para (false).

Sintaxe

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

Opções de comando

Schematics flags da lista de estados
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo do espaço de trabalho para o qual você deseja listar os recursos da nuvem que estão documentados no arquivo de estado do Terraform. Para localizar o ID de uma área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics workspace taint`

Marca manualmente uma instância ou os recursos como contaminados, forçando os recursos a serem recriados na próxima aplicação. A contaminação modifica o arquivo de estado, mas não a infraestrutura em sua área de trabalho. Quando você executa o próximo planejamento, as alterações são exibidas como recriadas e, na próxima aplicação, a alteração é implementada.

Deve-se executar o comando ibmcloud schematics state list para visualizar o status contaminado de seus recursos. O Taint Status retorna contaminado como (true) ou em branco como (false).

Sintaxe

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

Opções de comando

Schematics sinalizações de contaminação da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja recriar a instância ou o recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--options` ou `-o`	Opcional	Insira a sinalização de opção que você deseja mostrar.
`--address` ou `-adr`	Obrigatório	Insira o endereço do recurso para marcar como contaminação.

Exemplo

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

`ibmcloud schematics workspace untaint`

Marca manualmente uma instância ou recursos como untaint, forçando os recursos a serem restaurados na próxima aplicação. Quando você executa o próximo plano, as alterações aparecem como restauradas e, na próxima aplicação, a alteração é implementada.

É possível executar o comando ibmcloud schematics state list para visualizar o status contaminado de seus recursos. O Taint Status retorna contaminado como (true) ou em branco para (false).

Sintaxe

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

Opções de comando

Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja recriar a instância ou o recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--options` ou `-o`	Opcional	Insira a sinalização de opção que você deseja mostrar.
`--address` ou `-adr`	Opcional	Digite o endereço do recurso a ser marcado como `untaint`.
{: caption="Schematics sinalizadores da área de trabalho `untaint` "lado da legenda = "superior"}

Exemplo

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

`ibmcloud schematics workspace update`

Atualize os detalhes de uma área de trabalho existente, como o nome da área de trabalho, as variáveis ou a URL de controle de versão. Para provisionar ou modificar IBM Cloud, consulte o comando ibmcloud schematics plan.

O IBM Cloud Schematics suporta 50 solicitações de API por minuto, por host e por cliente. A região pode ser us-east, us-south, eu-gb ou eu-de. É necessário esperar antes de chamar o comando novamente. Certifique-se de que o location e o endpoint url estejam apontando para a mesma região quando você criar ou atualizar espaços de trabalho e ações. Para obter mais informações sobre localização e terminal, consulte Onde estão armazenadas minhas informações?.

Se você tiver fornecido o modelo do Terraform fazendo upload de um arquivo tar (.tar) e desejar atualizar seu modelo, deverá usar o comando ibmcloud schematics workspace upload.

Sintaxe

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

A sinalização Pull-latest não é suportada para áreas de trabalho criadas por meio de modelos de catálogos da IBM Cloud.

Opções de comando

Schematics sinalizadores de atualização da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja atualizar a instância ou o recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--file` ou `-f`	Opcional	O caminho relativo para um arquivo JSON em sua máquina local que inclui os parâmetros atualizados para sua área de trabalho. Para obter mais informações sobre o arquivo JSON de amostra com os detalhes, consulte Modelo de atualização de arquivo JSON.
`--github-token` ou `-g`	Opcional	Insira o valor do token do GitHub para acessar o repositório Git privado.
`--pull-latest` ou `--pl`	Opcional	Extraia as mudanças mais recentes do seu repositório GitHub na área de trabalho. Se esta sinalização for configurada, a sinalização `--file` será ignorada.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Atualizar modelo de arquivo em formato JSON

É possível criar a JSON como compartilhada no arquivo example.json para a atualização da área de trabalho e passar o caminho de arquivo juntamente com o nome do arquivo em sinalização --file. A descrição de todos os parâmetros de example.json é feita na tabela.

É necessário substituir os itens temporários do <...> pelos valores reais. Por exemplo, "<workspace_name>" como "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 atualizar carga útil
Parâmetro	Obrigatório / Opcional	Descrição
`name`	Opcional	Insira um nome para sua área de trabalho. Para obter mais informações, consulte Projetando sua estrutura da área de trabalho. Se você atualizar o nome da área de trabalho, o ID da área de trabalho não mudará.
`type`	Opcional	A versão do Terraform que você deseja usar para executar seu código do Terraform. Insira `terraform_v1.5` para usar o Terraform versão 1.5, `terraform_v1.4` para usar o Terraform versão 1.4. Por exemplo, quando você especifica `terraform_v1.5` significa que os usuários podem ter um modelo que seja do Terraform `v1.5.0`, `v1.5.1` ou `v1.5.7`, etc. Certifique-se de que seus arquivos de configuração do Terraform sejam compatíveis com a versão do Terraform especificada. Esta é uma variável necessária. Se a versão do Terraform não for especificada, por padrão, o site Schematics seleciona a versão do seu modelo.
`description`	Opcional	Insira as tags que você deseja associar à sua área de trabalho. As tags podem ajudá-lo a encontrar seu espaço de trabalho mais rapidamente.
`resource_group`	Opcional	Insira o grupo de recursos no qual você deseja provisionar sua área de trabalho.
`workspace_status`	Opcional	Congele ou descongele uma área de trabalho. Se uma área de trabalho estiver congelada, as mudanças na área de trabalho serão desativadas.
`template_repo.url`	Opcional	Insira a URL para o repositório GitHub ou GitLab no qual seus arquivos de configuração do Terraform estão armazenados.
`template_repo.branch`	Opcional	Insira a ramificação do GitHub ou do GitLab na qual seus arquivos de configuração do Terraform estão armazenados. Agora, no repositório de modelos, você também pode atualizar URL com mais parâmetros, conforme mostrado no bloco.
`template_repo.datafolder`	Opcional	Insira o nome da pasta no repositório Git que contém o modelo.
`template_repo.release`	Opcional	Insira a liberação do GitHub ou do GitLab que aponte para seus arquivos de configuração do Terraform.
`github_source_repo_url`	Opcional	Insira o link para seu repositório GitHub. O link pode ter como destino a ramificação `master`, uma ramificação diferente ou um subdiretório.
`template_data.folder`	Opcional	Insira o nome da variável de entrada que você declarou nos arquivos de configuração do Terraform.
`template_data.type`	Opcional	Digite o nome do tipo de variável de entrada que você declarou nos arquivos de configuração do Terraform.
`template_data[0].env_values[i].va11`	Opcional	Uma lista de variáveis de ambiente que você deseja aplicar durante a execução de um script de bash ou tarefa do Terraform. Este campo deve ser fornecido como uma lista de pares de valor chave, por exemplo, `TF_LOG=debug`. Cada entrada é um mapa com uma entrada em que key é o nome da variável de ambiente e value é o valor.
`template_data[0].env_values[i].val2`	Opcional	Uma lista de variáveis de ambiente que você deseja aplicar durante a execução de um script de bash ou tarefa do Terraform. Este campo deve ser fornecido como uma lista de pares de valor chave, por exemplo, `TF_LOG=debug`. Cada entrada é um mapa com uma entrada em que key é o nome da variável de ambiente e value é o valor.
`template_data[0].env_values_metadata`	Opcional	Metadados de variáveis de ambiente.
`template_data[0].variablestore[i].name`	Opcional	Insira o nome da variável de entrada que você declarou nos arquivos de configuração do Terraform.
`template_data[0].variablestore[ii].type`	Obrigatório	`Terraform v0.12` oferece suporte a `string`, `list`, `map`, `bool`, `number` e tipos de dados complexos, como `list(type)`, `map(type)`, `object({attribute name=type,..})`, `set(type)`, `tuple([type])`.
`template_data[0].variablestore[iii].value`	Opcional	Insira o valor como uma sequência para os tipos primitivos `bool`, `number` e `string` e como o formato `HCL` para as variáveis complexas, como fornecido em um arquivo `.tfvars`. É possível substituir os valores padrão de `.tfvars` configurando o parâmetro `use_default` como `true`. É necessário inserir a sequência escapada do formato `HCL` para o valor, conforme mostrado no exemplo. Para obter mais informações sobre como declarar variáveis em um arquivo de configuração do Terraform e fornecer valor aos esquemas, consulte Uso de variáveis de entrada para personalizar recursos e exemplo de armazenamento de variáveis
`template_data[0].variablestore[iv].secure`	Opcional	Configure o parâmetro `secure` como true. Por padrão, esse parâmetro é configurado como false.
`template_data[0].variablestore[v].use_default`	Opcional	Configure o parâmetro `use_default` como true para substituir o parâmetro padrão `.tfvars`. Por padrão, esse parâmetro é configurado como false.
`github_source_repo_url`	Opcional	Insira o link para seu repositório GitHub. O link pode ter como destino a ramificação `master`, uma ramificação diferente ou um subdiretório.

Exemplo para loja de variáveis

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

Exemplo

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

`ibmcloud schematics workspace update variables`

Atualizar variáveis permite atualizar uma ou mais variáveis de entrada para um espaço de trabalho existente. Não é possível atualizar as variáveis de metadados do espaço de trabalho, como nome ou URL de controle de origem. Para provisionar ou modificar IBM Cloud, consulte o comando ibmcloud schematics plan.

Sintaxe

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

Opções de comando

Schematics sinalizadores de atualização da área de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja atualizar a instância ou o recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--file` ou `-f`	Obrigatório	O caminho relativo para um arquivo JSON em seu computador local que inclui os parâmetros atualizados para as variáveis de seu espaço de trabalho a serem atualizadas. Para obter mais informações sobre o arquivo JSON de amostra com os detalhes, consulte Modelo de atualização de arquivo JSON.
`--template` ou `-tid`	Obrigatório	Digite o ID do modelo. Use ibmcloud schematics workspace get para obter o ID do modelo.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo de armazenamento de variáveis e valores de 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
                }
    ]
}

Exemplo

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

`ibmcloud schematics workspace upload`

Forneça o modelo do Terraform fazendo upload de um arquivo tar (.tar) para a área de trabalho do Schematics. O .tar suporta os comandos do Cloud Shell.

Antes de iniciar, certifique-se de que tenha criado sua área de trabalho sem um link para um repositório GitHub ou GitLab.

Sintaxe

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

Opções de comando

Schematics sinalizações de upload de áreas de trabalho
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador único da área de trabalho onde você deseja fazer o upload de seu arquivo tar (`.tar`). Para encontrar o ID da sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--file` ou `-f`	Obrigatório	Insira o caminho de arquivo completo na máquina local em que o arquivo `.tar` é armazenado.
`--template` ou `-tid`	Obrigatório	O identificador exclusivo do modelo do Terraform para o qual você deseja mostrar o conteúdo do arquivo de estado do Terraform. Para encontrar o ID do modelo, execute `ibmcloud schematics workspace get --id <workspace_ID>` e localize o ID do modelo no campo Variáveis de modelo para: da sua saída de linha de comandos.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

Crie o arquivo TAR de seu repositório de modelo usando o comando TAR que recebeu tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER

Exemplo do valor da variável

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

Comandos da tarefa da área de trabalho

Execute as operações do site Schematics para criar, atualizar e excluir recursos da nuvem. Usando a semântica do Terraform familiar, planeje, aplique e destrua áreas de trabalho do Terraform para gerenciar o ciclo de vida de recursos em nuvem

`ibmcloud schematics apply`

Quando você aplica um modelo do Terraform para um espaço de trabalho, seus recursos são provisionados, modificados ou removidos do site IBM Cloud. Os arquivos temporários criados durante a operação de aplicação podem ser mantidos para operações futuras.

Seu espaço de trabalho deve estar em um estado Inativo, Ativo, Falhado ou Parado para executar uma operação de aplicação do Schematics. Para obter mais informações sobre estados da área de trabalho, consulte diagrama de estado da área de trabalho.

Enquanto suas tarefas do Terraform estão em execução e a área de trabalho está bloqueada e as mudanças não podem ser feitas em sua área de trabalho até que a execução seja concluída

Sintaxe

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

Opções de comando

Schematics aplicar sinalizadores
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho que tem como destino o modelo Terraform em seu repositório de controle de versão que você deseja aplicar no IBM Cloud. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--target` ou `-t`	Opcional	Destine a criação de um recurso específico de seu arquivo de configuração do Terraform inserindo o endereço de recurso do Terraform, como `ibm_is_instance.vm1`. Todos os outros recursos definidos em seu arquivo de configuração não são criados ou atualizados. Para destinar a criação de múltiplos recursos, use a sintaxe a seguir: `--target <resource1> --target <resource2>`. Se o recurso de destino especificar o atributo `count` e nenhum índice for especificado no endereço de recurso, como `ibm_is_instance.vm1[1]`, todas as instâncias que compartilham o mesmo nome de recurso serão destinadas para a criação.
`--var-file` ou `--vf`	Opcional	O caminho do arquivo para o arquivo `terraform.tfvars` que você criou em sua máquina local. Use este arquivo para armazenar informações confidenciais, como a chave API ou as credenciais do IBM Cloud para conectar-se à infraestrutura clássica do IBM Cloud no formato `<key>=<value>`. As variáveis devem ser definidas no formato de linha única, por exemplo, como `availability_zone_names = ["us-east-1a","us-west-1c"]` Todos os pares chave-valor que são definidos nesse arquivos são carregados automaticamente no Terraform ao inicializar a CLI do Terraform. Para especificar múltiplos arquivos `tfvars`, especifique `--var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2`.
`--force` ou `-f`	Opcional	Force a execução deste comando sem prompts do usuário.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics destroy`

Remova os recursos da nuvem que você provisionou usando o espaço de trabalho Schematics, mesmo que esses recursos estejam ativos. Por padrão, o comando lista todos os recursos para visualização e, em seguida, recebe a confirmação para destruição. Se você usar o sinalizador --force or -f no comando destroy, não poderá ver a visualização dos recursos que deseja destruir.

Use este comando com cuidado. Depois de executar o comando, você não poderá reverter a remoção dos recursos da nuvem. Se você tiver gravado dados no armazenamento ou bancos de dados provisionados, assegure-se de criar um backup para persistir seus dados

Sua área de trabalho deve estar em um estado Ativo, Com falha ou Interrompido para executar uma ação de destruição do Schematics.

Sintaxe

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

Opções de comando

Schematics destruir bandeiras
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo do espaço de trabalho que aponta para o modelo do Terraform em seu repositório de origem que especifica os recursos da nuvem que você deseja remover. Para localizar o ID de uma área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--target` ou `-t`	Opcional	Destine a exclusão de um recurso específico inserindo o endereço de recurso do Terraform, como `ibm_is_instance.vm1`. Todos os outros recursos em sua área de trabalho permanecem inalterados. Para destinar a exclusão de múltiplos recursos, use a sintaxe a seguir: `--target <resource1> --target <resource2>`. Se o recurso de destino especificar o atributo `count` e nenhum índice for especificado no endereço de recurso, como `ibm_is_instance.vm1[1]`, todas as instâncias que compartilham o mesmo nome de recurso serão destinadas para a exclusão. Além disso, se o recurso de destino só puder ser excluído se os recursos dependentes forem excluídos, como um VPC só pode ser excluído quando a sub-rede conectada é excluída, todos os recursos dependentes também serão destinados para a exclusão.
`--force` ou `-f`	Opcional	Force a execução deste comando sem prompts do usuário. Não é possível ver a visualização dos recursos que você deseja destruir.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics logs`

Recupere os arquivos de registro do Terraform para o espaço de trabalho Schematics ou para um ID de ação específico do espaço de trabalho. Use os arquivos de log para solucionar problemas do modelo Terraform ou problemas que ocorrem durante o processo de fornecimento, modificação ou exclusão de recursos.

Sintaxe

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

Opções de comando

Schematics registra bandeiras
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja recuperar os arquivos de log do Terraform. Para localizar o ID de uma área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--act-id` ou `-1`	Opcional	O ID de uma ação para a qual você deseja recuperar logs do Terraform. Para localizar uma lista de identificadores de ação, execute o comando `ibmcloud schematics workspace action --id WORKSPACE_ID`.

Exemplo

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

`ibmcloud schematics output`

Recupere os valores de saída do Terraform para a área de trabalho Você pode definir valores de saída em seu modelo do Terraform para incluir dados que deseja tornar acessíveis a outros espaços de trabalho.

Sintaxe

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

Opções de comando

Schematics bandeiras de saída
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja listar valores de saída do Terraform. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

`ibmcloud schematics plan`

Examine o modelo do Terraform em seu repositório de origem e compare-o com os recursos da nuvem que já estão implantados. A saída da linha de comando mostra os recursos da nuvem que devem ser adicionados, modificados, mantidos ou removidos para atingir o estado descrito em seu arquivo de configuração.

Sua área de trabalho deve estar em um estado Inativo, Ativo, Com falha ou Interrompido para executar uma ação de planejamento do Schematics.

Durante a criação do plano de execução do Terraform, não é possível fazer nenhuma mudança em sua área de trabalho.

Sintaxe

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

Opções de comando

Schematics bandeiras de saída
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho que tem como destino o modelo Terraform em seu repositório de origem que você deseja varrer. Para localizar o ID de uma área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--var-file` ou `--vf`	Opcional	O caminho do arquivo para o arquivo `terraform.tfvars` que você criou em sua máquina local. Use este arquivo para armazenar informações confidenciais, como a chave API ou as credenciais do IBM Cloud para conectar-se à infraestrutura clássica do IBM Cloud no formato `<key>=<value>`. As variáveis devem ser definidas no formato de linha única, por exemplo, como `availability_zone_names = ["us-east-1a","us-west-1c"]` Todos os pares chave-valor que são definidos nesse arquivos são carregados automaticamente no Terraform ao inicializar a CLI do Terraform. Para especificar múltiplos arquivos `tfvars`, especifique `--var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2`.
`--output` ou `-o`	Opcional	Retorna a saída da linha de comandos no formato JSON. Atualmente apenas o formato de arquivo `JSON` é suportado.

Exemplo

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

Comandos de parada da área de trabalho

Depois de chamar uma tarefa da área de trabalho, como um plan, um apply ou um destroy, você pode desejar parar a tarefa em execução ou parar o fornecimento de recursos Ao parar ou cancelar uma tarefa de longa execução, é aconselhável primeiro verificar os logs da tarefa para determinar se a tarefa está realmente presa e precisa parar ou se está executando operações de longa execução que estão levando tempo para concluir.

Schematics oferece várias opções para permitir que os usuários (gracefully) stop, force-stop, ou terminate o trabalho em execução em ordem de imediatismo e impacto da operação de parada.

Revise os comandos para as tarefas (gracefully) stop, force-stop ou terminate

`ibmcloud schematics workspace job stop`

Interrompe um trabalho de espaço de trabalho em execução enviando um sinal de interrupção ao Terraform para encerrar a execução.

Sintaxe

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

Opções de comando

Schematics bandeiras de parada de tarefas
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID da área de trabalho a ser atualizado.
`--job-id` ou `--jid`	Obrigatório	O ID da tarefa.
`--stop,`	Opcional	Remove o trabalho da fila de pendências.
`--force-stop` ou `--fs`	Opcional	Envia um sinal de interrupção para a execução do Terraform no mecanismo e também tenta interromper imediatamente a execução.
`--terminate` ou `-t`	Opcional	Encerra bruscamente o mecanismo, marca a tarefa como interrompida e desbloqueia sua área de trabalho. Os dados não são salvos com esse sinalizador.

Exemplo

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>

Comandos do Arquivo de Estado da Área de Trabalho

Revise os comandos que podem ser usados para trabalho com o arquivo de estado do Terraform (terraform.tfstate) para uma área de trabalho.

É possível importar um arquivo de estado existente do Terraform durante a criação de sua área de trabalho. Para obter mais informações, consulte o comando ibmcloud workspace new.

`ibmcloud schematics state pull`

Mostre o conteúdo do arquivo de estado do Terraform (terraform.tfstate) para um modelo do Terraform específico de sua área de trabalho.

Sintaxe

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

Opções de comando

Schematics bandeiras de pull do estado
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID exclusivo da área de trabalho na qual você deseja executar os comandos.
`--template` ou `--tid`	Obrigatório	O identificador exclusivo do modelo do Terraform para o qual você deseja mostrar o conteúdo do arquivo de estado do Terraform. Para encontrar o ID do modelo, execute `ibmcloud schematics workspace get --id <workspace_ID>` e localize o ID do modelo no campo Variáveis de modelo para: da sua saída de linha de comandos.

Exemplo

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

`ibmcloud schematics workspace state show`

Fornece a saída legível de um estado ou plano de uma área de trabalho de acordo com a perspectiva do Terraform. É possível usar para garantir o estado atual e o status das operações planejadas. É necessário usar o ID da área de trabalho para recuperar os logs usando o comando ibmcloud schematics logs.

Sintaxe

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

Opções de comando

Schematics bandeiras de pull do estado
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID exclusivo da área de trabalho para atualizar.
`--address` ou `-adr`	Obrigatório	Insira o endereço que aponta para um único recurso no estado para mostrar.
`--options` ou `-o`	Opcional	Insira as sinalizações da linha de comandos.

Exemplo

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

`ibmcloud schematics workspace state mv`

Se você mover o estado para um recurso dentro do arquivo de estado. A área de trabalho continua funcionando, mas a próxima operação de plano ou aplicação não localizará o recurso ou a instância no arquivo de estado. Se nenhuma mudança for feita para o modelo, será possível ver a recriação do recurso na próxima operação pelo Terraform

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

Opções de comando

Schematics bandeiras de movimentação do estado
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID exclusivo da área de trabalho para a qual você deseja mover uma instância ou um recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--source` ou `-s`	Obrigatório	Insira o endereço de origem de um item para mover.
`--destination` ou `-d`	Obrigatório	Forneça o endereço de destino de um item.

Exemplo

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

`ibmcloud schematics workspace state rm`

Se você remover o estado de um recurso ou instância no arquivo de estado. A área de trabalho continua funcionando, mas a próxima operação de plano ou aplicação não localizará o recurso ou a instância no arquivo de estado. Se nenhuma mudança for feita para o modelo, será possível ver a recriação do recurso na próxima operação pelo Terraform

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

Opções de comando

Schematics state remover flags
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O identificador exclusivo da área de trabalho para a qual você deseja remover a instância ou o recurso. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--options` ou `-o`	Opcional	Insira a sinalização de opção que você deseja remover.
`--address` ou `-adr`	Obrigatório	Insira o endereço do recurso para marcar como contaminação.

Exemplo

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

Comandos do Terraform da área de trabalho..

Você pode executar comandos do Terraform para manipular os recursos da nuvem e modificar o estado do Schematics.

Os comandos do Terraform da área de trabalho não são suportados na IU

A tabela fornece o resumo dos comandos da área de trabalho do Terraform suportados

Resumo de comandos Terraform
Comando	Descrição
`show`	Inspeciona estado ou plano do Terraform.
`output`	Lê uma saída de um arquivo de estado do Terraform.
`import`	Importa uma infraestrutura existente no Terraform.
`taint`	Marque um recurso para recriação.
`untaint`	Não marque um recurso como contaminado.
`state`	Um comando avançado de gerenciamento de estado para gravar subcomandos a fim de remover ou mover `rm && mv`.

Comandos do Terraform

Comandos do Terraform são executados usando um arquivo JSON para especificar entradas.

Sintaxe

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

Opções de comando

Schematics Terraform ordena bandeiras
Sinalize	Obrigatório / Opcional	Descrição
`--id` ou `-i`	Obrigatório	O ID exclusivo da área de trabalho na qual você deseja executar os comandos. Para localizar o ID de sua área de trabalho, execute o comando `ibmcloud schematics workspace list`.
`--file` ou `--f`	Obrigatório	Caminho para o arquivo `JSON` contendo a lista de comandos do Terraform.

Exemplo de carga útil do arquivo 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"
}

A tabela fornece a lista de parâmetros de chave do arquivo JSON para a API Commands, para a linha de comandos e a API.

Lista de parâmetros principais
Chave	Obrigatório / Opcional	Descrição
`command`	Obrigatório	Forneça o comando. Os comandos suportados são `show`, `taint`, `untaint`, `state`, `import` e `output`.
`command_params`	Obrigatório	Os parâmetros de endereço para o nome do comando para `CLI`, como nome do recurso, caminho absoluto do nome do arquivo. Para a API, você precisa enviar o sinalizador de opção e o parâmetro de endereço em `command_params`.
`command_name`	Obrigatório	O nome para o bloco de comando.
`command_desc`	Opcional	O texto para descrever o bloco de comandos.
`command_onError`	Opcional	Instrução para continuar ou quebrar em caso de erro no comando.
`command_dependsOn`	Opcional	Dependência dos comandos anteriores.
`command_status`	Não necessário	Exibe o status executado do comando, `success` ou `failure`

Exemplo

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

Histórico da versão da CLI

Localize um resumo das mudanças para cada versão do plug-in da CLI do Schematics. Certifique-se de manter sua CLI atualizada para que seja possível utilizar todos os comandos disponíveis e suas opções.

Histórico de versões da linha de comando
Versão	Data de liberação	Mudanças
1.12.29	27 de outubro de 2025	O plugin CLI Schematics introduz credenciais e variáveis multihost durante a criação e atualização de inventários. Essa atualização simplifica o processo de manipulação de detalhes de autenticação e definições de configuração para vários sistemas de destino, garantindo uma experiência de automação mais eficiente e segura.
1.12.28	1 de agosto de 2025	Schematics Plug-in da CLI para atualizar subnamespaces e subcomandos nos metadados.
1.12.27	31 de julho de 2025	Schematics O plug-in da CLI é compatível com a região de Montreal(`ca-mon`).
1.12.26	07 de abril de 2025	Schematics O plug-in da CLI aprimorou a visualização do ibmcloud schematics destroy, atualizou uma imagem de base do pipeline, corrigiu `nil pointer exception` nas operações ibmcloud schematics action create, ibmcloud schematics action update e ibmcloud schematics action get.
1.12.25	10 de janeiro de 2025	Schematics O plug-in da CLI oferece suporte ao comando ibmcloud schematics workspace update variables da CLI para atualizar apenas as variáveis de entrada necessárias para um espaço de trabalho existente. Ele também aprimora o comando ibmcloud schematics destroy com o recurso de visualização para listar todos os recursos de trabalho com confirmação. Os comandos IBM Cloud Schematics espaço de trabalho, uma ação e um agente get obtêm o CRN de criptografia e o status da criptografia, como os detalhes `IBM Default` ou `BYOK` ou `KYOK`.
1.12.24	8 de julho de 2024	Schematics O plug-in da CLI corrige o suporte para direcionar os pontos de extremidade de Toronto por meio da região " `ca-tor`.
1.12.23	11 de junho de 2024	Schematics O plug-in da CLI aprimora a exibição do formato de arquivo ' `terraform.tfvars` durante o uso do argumento ' `--var-file` no comando ibmcloud workspace apply e ibmcloud workspace plan. O suporte à tradução de internacionalizaçãoI18n) foi atualizado.
1.12.22	30 de maio de 2024	Schematics O plug-in da CLI suporta " `ibmcloud schematics agent destroy` para destruir os recursos de implantação. E defina o parâmetro " `--force` como true para excluir todos os fluxos de agentes e manter a destruição paralela ao fluxo de destruição do espaço de trabalho.
1.12.21	19 de abril de 2024	Schematics O plug-in da CLI substitui o sinalizador ' `--json` em todos os comandos da CLI. Também foi corrigido o bug de depreciação do ' `CLI v1.12.20` nos comandos ' `ibmcloud schematics workspace refresh` ou plano da CLI.
1.12.20	25 de março de 2024	Schematics O plug-in da CLI oferece suporte a Red Hat OpenShift Kubernetes Service.
1.12.18	08 de março de 2024	Exibição da mensagem de aviso de depreciação do Terraform durante os comandos do espaço de trabalho que usam menos de ' `terraform_v1.5`, remoção do suporte para atualização da infraestrutura do agente e correção do erro ' `index out of range` ao usar o comando ' `ibmcloud schematics state list`.
1.12.17	14 de fevereiro de 2024	a instalação do plug-in Schematics é compatível com o Cloud Shell, e o comando ' `ibmcloud schematics workspace upload` agora é compatível com os comandos Cloud Shell.
1.12.16	7 de fevereiro de 2024	`ibmcloud schematics workspace list` oferece suporte ao armazenamento em cache para versões da API. as mensagens de depreciação `terraform_v1.2`, ' `terraform_v1.3` e ' `terraform_v1.4` são preenchidas para a criação dos modelos ' `ibmcloud schematics workspace new`.
1.12.15	24 de janeiro de 2024	Suporte para ' `refresh_token` na solicitação da API de atualização do agente, suporte aprimorado à versão do comando de atualização do agente.
1.12.14	10 de janeiro de 2024	Foram adicionados novos comandos e traduções para dar suporte ao agente e à política. Os espaços de trabalho do sistema da saída do comando da lista de espaços de trabalho estão ocultos. Aprimorou a exibição do trabalho do agente na saída do comando. Uso da API ' `/v1/versions` para as versões do agente.
1.12.12	17 de setembro de 2023	Schematics Criação e atualização de agente adicionadas com um `new flag --metadata` e uma correção de bug para configurar um tempo limite de HTTP para a solicitação.
1.12.10	22 de maio de 2023	Schematics Atualização do agente e correções de erros do comando ' `agent list` para definir os erros de tempo de execução.
1.12.9	6 de abril de 2023	Schematics Os comandos CLI do agente beta-1 e da política foram aprimorados para incluir o ' `-target-file` e o ' `output` do plano do agente, da aplicação do agente e da integridade do agente.
1.12.8	22 de março de 2023	os comandos CLI Schematics Agente " beta-1 e ' política estão disponíveis nas regiões ' `us-south`, ' `us-east`, ' `eu-de`, ' `eu-gb`.
1.12.7	07 de fevereiro de 2023	Correção de bug para desativar o ' `API_AGENT_ATTACHMENT` na região ' `us-south`, ' `us-east`, ' `eu-de`, ' `eu-gb`.
1.12.6	30 de janeiro de 2023	Suporte aprimorado a entradas complexas por meio do arquivo ' `yaml`. Correções relacionadas à saída de status, índice fora do intervalo para saída de ação do espaço de trabalho, problema de token de atualização para execução prolongada e correções de panes no spinner.
1.12.5	18 de dezembro de 2022	O uso do subcomando e o suporte para especificar entradas complexas por meio de um arquivo YAML local usando a opção ' `-input-file`.
1.12.3	18 de novembro de 2022	Corrigido o suporte ao uso do subcomando ' `source type`.
1.12.3	3 de novembro de 2022	Comandos aprimorados da CLI, com a atualização mais recente do SDK e a atualização do comando de ação do espaço de trabalho.
1.12.2	11 de agosto de 2022	Incluiu o sinalizador ' `--output` e correções de erros para os comandos e lançou o plug-in Schematics v1.12.2.
1.12.1	26 de julho de 2022	Incorporou os comandos de bugs e correções em Schematics.
1.12.0	11 de julho de 2022	Suporte para comandos `agents` em Schematics a partir da linha de comando.
1.11.1	8 de julho de 2022	Suporte para corrigir o problema de tradução em Schematics a partir da linha de comando.
1.10.0	5 de maio de 2022	Suporte para `stop`, `force-stop` e `terminate` no Schematics por meio da linha de comandos.
1.9.0	25 de abril de 2022	Suporte para detecção de `Drift` no Schematics por meio da linha de comandos.
1.8.1	17 de abril de 2022	Corrige a mensagem de exibição de descontinuação de alias para a saída JSON do Schematics.
1.8.0	13 de março de 2022	Suporta a passagem de arquivos ' `.tfvars` e ' `.json` para planejar e aplicar o comando. O uso do comando " `ibmcloud terraform` exibe uma mensagem de aviso. A versão também oferece suporte a pontos de extremidade privados Schematics por meio da linha de comando e aprimora a saída da exibição tabular para listar o recurso provisionado no espaço de trabalho Schematics.
1.7.3	4 de março de 2022	Suporta a transferência de arquivos `vars` para o comando do plano da linha de comandos, exibe `commit ID` no comando `ibmcloud schematics workspace get` e editou a descrição do comando `ibmcloud schematics workspace state show`.
1.7.2	17 de fevereiro de 2022	Suporta os binários das plataformas Linux™ arm64 e Mac OS arm64. Correções relacionadas ao fluxo `stdout/stderr`, arquivo `TF vars` inválido e tradução são liberados.
1.7.1	11 de fevereiro de 2022	Suporte para criação de logs de rastreio e testes de integração incluídos para alguns comandos. Correções para atualizar o ' `env values metadata`, pânico para sinalizadores inválidos e ' `ibmcloud schematics workspace output command` não está disponível.
1.7.0	12 de janeiro de 2022	Exibe a mensagem de descontinuação do Terraform v11.0 após a execução do comando. Correção do alias da linha de comandos. Remoção da aparência das sequências de caracteres duplicadas. Suporte ao horário global no arquivo de log.
1.6.2	2 de dezembro de 2021	Suporte para traduções não em inglês. Correção da aplicação do comando `--var-file` e ações do argumento `--target not setting`. Corrigir uma vulnerabilidade do pipeline.
1.6.1	21 de outubro de 2021	Suporta `winrm` para ações do Schematics. Adição dos valores das opções ' `--inventory-connection-type`, ' `--bastion-credential-json` e ' `--credential-json` às atualizações de criação e configuração. Traduções não em inglês atualizadas para a linha de comandos. Correção da exibição duplicada do argumento ' `command-object` no modo interativo ' `ibmcloud schematics jobs run`.
1.6.0	29 de setembro de 2021	Suporte para `linux-ppc64le` e binários `linux-s390x`. Lista " `Terraform v1.0` no painel de detalhes. Exibir a mensagem de depreciação ' `Terraform v0.11` na página do espaço de trabalho Schematics. Corrigido o comando de lista de consulta de recursos retorna valores como sequência de caracteres vazia.
1.5.12	02 de setembro de 2021	Suprimir mensagem de status para a sinalização `--output json`.
1.5.11	27 de agosto de 2021	Adição de um sinalizador `--pull-latest` ao comando de atualização do espaço de trabalho existente. Problema corrigido. Corrigido as traduções de código de idioma.
1.5.10	11 de agosto de 2021	Suporta `Terraform v0.15`. Corrigido traduções de código de idioma.
1.5.9	13 de julho de 2021	Corrigido traduções de código de idioma.
1.5.8	08 de julho de 2021	Correção do caminho da API de conjuntos de dados compartilhados. Comandos de conjuntos de dados compartilhados desativados.
1.5.7	04 de junho de 2021	Comando `ibmcloud schematics state list` aprimorado para exibir como dados tabulares com um status `taint` de nova coluna. Corrigido comando `ibmcloud schematics job run` com descrição de sinalização `--input`. Corrigido comando `ibmcloud schematics job run` com descrição de sinalização `--output json`. Corrigido comando `ibmcloud schematics action update` com sinalização `--credentials` e as traduções de código de idioma.
1.5.6	3 de junho de 2021	Atualizado comando `ibmcloud schematics workspace new` para oferecer suporte ao `Terraform v0.14` e as traduções de código de idioma.