CLI de IBM Cloud Schematics

Ejecute estos comandos para trabajar con IBM Cloud Schematics espacios de trabajo, acciones, recursos aprovisionados y configurar Schematics.

Schematics Comandos CLI son específicos de cada región. Sólo funcionan en la región/localización en la que la CLI IBM Cloud está configurada para trabajar. Asegúrese de que la CLI location y el punto final url apuntan a la región donde desea crear o actualizar los espacios de trabajo y las acciones. Para obtener más información sobre la ubicación y el punto final, consulte ¿Dónde se almacena mi información?

Para ejecutar comandos Schematics, utilice ibmcloud schematics o ibmcloud sch.

Antes de empezar

Asegúrese de mantener su CLI actualizada para poder utilizar los comandos liberados actuales y sus opciones. Para obtener más información sobre las versiones actuales de la línea de comandos, consulte Historial de versiones de la línea de comandos.

Mandatos de acciones

Revise los comandos para crear, actualizar, listar, borrar y trabajar con sus acciones Schematics.

ibmcloud schematics action create

Cree una acción para ejecutar un playbook de Ansible en un único host de destino o en un grupo de hosts de destino. Los playbooks Ansible se utilizan para llevar a cabo operaciones de nube o para instalar software en los recursos de nube. Para probar esta función o iniciarse en ella, utilice una de las páginas IBM- Ansible playbooks. Puede crear una acción utilizando un archivo de carga útil o la modalidad interactiva del mandato.

Asegúrese de que location y url apunten a la misma región cuando cree o actualice los espacios de trabajo y las acciones. Para obtener más información sobre la ubicación y el punto final, consulte ¿Dónde se almacena mi información?.

Sintaxis

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]

Opciones de comando

Las acciones deSchematics crean distintivos
Distintivo Obligatorio / Opcional Descripción
--name o -n Obligatorio Un nombre exclusivo para la acción.
--description o -d Opcional La descripción breve de una acción.
--location o -l Obligatorio La geografía o ubicación donde desea crear la acción, como us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. La geografía o ubicación determina dónde se ejecuta la acción y dónde se guardan los datos de la acción. Para obtener más información, consulte ¿Dónde se almacena mi información?. Asegúrese de que puede almacenar datos en esta ubicación ya que no podrá cambiar la ubicación una vez creada la acción.
--resource-group o -r Obligatorio El nombre del grupo de recursos donde desea crear la acción.
--template o -tr Opcional El URL del repositorio Git donde está almacenado el playbook Ansible.
--playbook-name o --pn Opcional El nombre del playbook Ansible.
--credentials o -C Opcional La vía de acceso del archivo a la clave SSH privada que desea utilizar para acceder al host de destino, como por ejemplo ~/.ssh/id_rsa. La clave SSH debe contener al final de los detalles clave en caso de llamadas de línea de mandatos o API.
--credential-json o --cj Opcional Proporcione la vía de acceso del archivo JSON que contiene la carga útil JSON de credencial para acceder al host de destino.
--bastion o -b Opcional La dirección IP del host bastión.
--bastion-credential-json o --bj Opcional Proporcione la vía de acceso del archivo JSON que contiene la carga útil JSON de credencial de bastión para acceder al host de bastión.
--inventory o -y Opcional El ID del inventario de recursos que desea utilizar en la acción. Para listar los inventarios existentes, ejecute ibmcloud schematics inventory list.
--inventory-connection-type o --it Opcional Tipo de conexión de inventario. Los valores soportados son ssh o winrm. Por defecto es SSH. Actualmente, WinRM sólo admite sistemas Windows con la dirección pública IPs y no admite hosts Bastion.
--input o --in Opcional Las variables de entrada de la acción. Las variables de entrada deben especificarse en forma de pares clave-valor, como por ejemplo --input mykey=myvalue. Para especificar varias variables de entrada, utilice varios distintivos --input en el mandato. También puede almacenar las variables de entrada en un archivo y hacer referencia a este archivo utilizando la opción de mandato --input-file.
--input-file o --if Opcional La vía de acceso a un archivo en el que ha especificado todas las variables de entrada. Las variables de entrada deben especificarse como pares clave-valor en formato JSON.
--env o -e Opcional Variables de entorno para una acción. Las variables de entorno deben especificarse en forma de pares clave-valor, como por ejemplo --env mykey=myvalue. Para proporcionar varias variables de entorno, utilice varios distintivos --env en el mandato.
--env-file o -E Opcional La vía de acceso a un archivo en el que ha especificado todas las variables de entorno de una acción. Las variables de entorno deben especificarse como pares clave-valor en formato JSON.
--github-token o -g Opcional La señal de acceso personal en GitHub que desea utilizar para conectarse a un repositorio GitHub privado. Si desea clonar desde el repositorio Git, consulte las extensiones de archivos permitidas y bloqueadas para la clonación.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--file o -f Opcional La vía de acceso al archivo de carga útil JSON que contiene la definición de la acción que desea crear. Para obtener más información, consulte Utilización de un archivo de carga útil.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin una modalidad interactiva.

Ejemplo

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

Utilización de un archivo de carga

Cree un archivo JSON que incluya los detalles de la acción que desea crear, como el ID, el nombre y la descripción. A continuación, utilice la opción de mandato --file para crear la acción desde el archivo de carga útil.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<ACTION_NAME>" como "testaction".

Sintaxis

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

Ejemplo

ibmcloud schematics action create --file sample.json

Utilización de la modalidad interactiva

En lugar de especificar las opciones del mandato o utilizar un archivo de carga útil, puede utilizar la modalidad interactiva del mandato para crear una acción. De forma predeterminada, la acción se crea con una mínima entrada del usuario. Para añadir más información a la acción, puede actualizar la acción más adelante.

  1. Para iniciar la modalidad interactiva ejecute el mandato sin las opciones del mandato.
    ibmcloud schematics action create
  2. Especifique un nombre para la acción y pulse la tecla Intro.
  3. Especifique el grupo de recursos en el que desea crear la acción y pulse la tecla Intro.
  4. Especifique la ubicación en la que desea crear la acción, como por ejemplo us-south, us-east, eu-de o eu-gb. A continuación, pulse la tecla Intro. La ubicación determina dónde se ejecuta la acción y dónde se guardan los datos de la acción. Para obtener más información, consulte ¿Dónde se almacena mi información?. Asegúrese de que puede almacenar datos en esta ubicación ya que no podrá cambiar la ubicación una vez creada la acción.
  5. Especifique el URL del repositorio GitHub donde está almacenado el playbook Ansible. A continuación, pulse la tecla Intro.
  6. Si procede, especifique la señal de acceso personal que desea utilizar para acceder al repositorio GitHub. A continuación, pulse la tecla Intro. Si desea clonar desde el repositorio Git, consulte las extensiones de archivos permitidas y bloqueadas para la clonación.
  7. Escriba el nombre del playbook Ansible que desea ejecutar y pulse Intro.
  8. Revise los detalles de la acción que se le ha creado.

ibmcloud schematics action update

Actualizar la información de una acción existente utilizando action_id. Asegúrese de que la CLI location y el punto final url apuntan a la región donde desea crear o actualizar los espacios de trabajo y las acciones. Para obtener más información sobre la ubicación y el punto final, consulte ¿Dónde se almacena mi información?.

Sintaxis

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]

Opciones de comando

Schematics acciones actualizar distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de una acción que desea actualizar.
--name o -n Opcional Un nuevo nombre exclusivo para la acción.
--description o -d Opcional La descripción breve de una acción.
--location o -l Obligatorio Ubicaciones geográficas respaldadas por el servicio IBM Cloud Schematics, como us-south, us-east, eu-de, eu-gb, ca-tor o ca-mon.
--resource-group o -r Obligatorio Nombre de grupo de recursos para una acción.
--template o -tr Opcional El URL del repositorio Git donde está almacenado el playbook Ansible.
--playbook-name o --pn Opcional El nombre del playbook.
--github-token o -g Opcional La señal de acceso personal en GitHub que desea utilizar para conectarse a un repositorio GitHub privado. Si desea clonar desde el repositorio Git, consulte las extensiones de archivos permitidas y bloqueadas para la clonación.
--credentials o -C Opcional La vía de acceso del archivo a la clave SSH privada que desea utilizar para acceder al host de destino, como por ejemplo ~/.ssh/id_rsa. La clave SSH debe contener al final de los detalles clave en caso de llamadas de línea de mandatos o API.
--credential-json o --cj Opcional Proporcione la vía de acceso del archivo JSON que contiene la carga útil JSON de credencial para acceder al host de destino.
--bastion o -b Opcional La dirección IP del host bastión.
--bastion-credential-json o --bj Opcional Proporcione la vía de acceso del archivo JSON que contiene la carga útil JSON de credencial de bastión para acceder al host de bastión.
--inventory o -y Opcional El ID del inventario de recursos que desea utilizar en la acción. Para listar los inventarios existentes, ejecute ibmcloud schematics inventory list.
--inventory-connection-type o --it Opcional Tipo de conexión de inventario. Los valores soportados son ssh o winrm. Por defecto es SSH. Actualmente, WinRM sólo admite sistemas Windows con la dirección pública IPs y no admite hosts Bastion.
--input o --in Opcional Las variables de entrada de la acción. Las variables de entrada deben especificarse en forma de pares clave-valor, como por ejemplo --input mykey=myvalue. Para especificar varias variables de entrada, utilice varios distintivos --input en el mandato. También puede almacenar las variables de entrada en un archivo y hacer referencia a este archivo en la opción de mandato --input-file.
--input-file o --if Opcional La vía de acceso a un archivo en el que ha especificado todas las variables de entrada. Las variables de entrada deben especificarse como pares clave-valor en formato JSON.
--env o -e Opcional Variables de entorno para una acción. Las variables de entorno deben especificarse en forma de pares clave-valor, como por ejemplo --env mykey=myvalue. Para proporcionar varias variables de entorno, utilice varios distintivos --env en el mandato.
--env-file o -E Opcional La vía de acceso a un archivo en el que ha especificado todas las variables de entorno de una acción. Las variables de entorno deben especificarse como pares clave-valor en formato JSON.
--file o -f Opcional Vía de acceso al archivo JSON de carga útil que contiene la definición de la acción que a actualizar. Para obtener más información, consulte Utilización del archivo de carga útil. Tenga presente que los parámetros, como la ubicación o el grupo de recursos, no se pueden actualizar después de crear la acción.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin solicitudes de usuario.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics action get

Recupere los detalles de una acción existente en Schematics, como el ID de la acción, el nombre, el estado, la hora de creación, el estado de cifrado y el CRN de cifrado, incluidos los valores de todas las variables de entrada.

Sintaxis

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

Opciones de comando

Schematics acciones obtener distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de una acción que desea recuperar.
--profile o -p Opcional La profundidad de la información que desea recuperar. Los valores soportados son detailed y summary. El valor predeterminado es summary.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin la modalidad interactiva.

Ejemplo

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

ibmcloud schematics action list

Recupere una lista de todas las acciones definidas en la región IBM Cloud actual para su cuenta.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de acciones
Distintivo Obligatorio / Opcional Descripción
--limit o -l Opcional El número máximo de acciones que desea listar. El número debe ser un entero positivo del 1 al 200. El valor predeterminado es -1.
--offset o -m Opcional La posición de la acción en la lista de acciones a partir de la cual desea empezar a listar las acciones. Por ejemplo, si tiene tres acciones en su cuenta y región, el comando devuelve estas acciones como una lista con tres elementos. Para recuperar todas las acciones, debe especificar la posición número 0. Para recuperar las acciones número 2 y 3 y dejar fuera la acción número 1 de esta lista, debe especificar la posición número 1. La posición número 1 representa la segunda posición en la lista de acciones. No se admiten números negativos y se ignorarán.
--profile o -p Opcional La profundidad de la información que se devuelve. Los valores soportados son ids y summary. El valor predeterminado es summary.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

ibmcloud schematics action list --profile ids

ibmcloud schematics action delete

Suprimir una acción de Schematics.

Sintaxis

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

Opciones de comando

Acciones deSchematics suprimir distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de una acción que desea suprimir.
--force o -f Opcional Forzar la supresión sin la confirmación del usuario.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin solicitudes de usuario.

Ejemplo

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

ibmcloud schematics action upload

Puede cargar un archivo de archivado de cinta (.tar) desde el sistema de archivos local a una acción de IBM Cloud Schematics. Especifique la vía de acceso completa en la máquina local donde se almacena el archivo .tar. Cree el archivo .tar del repositorio de plantillas utilizando el mandato TAR proporcionado: tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER.

Sintaxis

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

Opciones de comando

Schematics acciones cargar distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio ID de una acción que desea cargar.
--file o -f Obligatorio Vía de acceso del archivo TAR para cargar una acción.
--no-prompt Opcional Establezca este distintivo para detener la sesión de línea de mandatos interactiva.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

Mandatos de trabajo de acciones

Revise los comandos para crear, actualizar, listar y eliminar trabajos de Schematics cuando trabaje con acciones de Schematics.

ibmcloud schematics job run

Cree un trabajo en IBM Cloud Schematics para ejecutar el playbook Ansible especificado por su acción Schematics. Puede crear un trabajo utilizando un archivo de carga útil o la modalidad interactiva del mandato.

Sintaxis

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]

Opciones de comando

Schematics distintivos de ejecución de trabajo
Distintivo Obligatorio / Opcional Descripción
--command-object o -c Obligatorio El nombre del recurso de automatización de Schematics. Actualmente solo se admite action.
--command-object-id o -cid Obligatorio El ID de las acciones de Schematics donde desea ejecutar el trabajo.
--command-name, o -n Obligatorio El mandato que desea ejecutar para la acción. Los valores soportados son ansible_playbook_check y ansible_playbook_run.
--playbook-name o -pn Opcional El nombre del playbook Ansible que desea ejecutar.
--command-options o -co Opcional Las opciones de línea de mandatos para el mandato.
--input o --in Opcional Las variables de entrada de una acción. Este indicador puede activarse varias veces y debe tener el formato --inputs test=testvalue.
--input-file o --if Opcional Variables de entrada para una acción. Proporcione la vía de acceso al archivo JSON que contiene variables de entrada.
--env o -e Opcional Variables de entorno para una acción. Este indicador puede activarse varias veces y debe tener el formato --env-variables test=testvalue.
--env-file o -E Opcional Variables de entorno para una acción. Proporcione una vía de acceso de archivo JSON que contenga variables de entorno.
--result-format o -f Opcional La salida de respuesta del resultado en formato JSON.
--file o -f Opcional Vía de acceso del archivo JSON que contiene la definición del nuevo trabajo.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Si la acción contiene el nombre del libro de jugadas, es necesario añadir el nombre del libro de jugadas, para que el nombre del libro de jugadas de la acción tenga prioridad. Si necesita modificar el nombre del playbook durante el trabajo, tendrá que crear una acción con el nuevo nombre del playbook.

Utilización del archivo de carga útil

Puede proporcionar un archivo de carga útil para especificar determinados parámetros para el mandato job run. A continuación, pase el nombre de archivo al mandato utilizando la opción de mandato --file.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<COMMAND_OBJECT>" como "action".

Sintaxis

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

Ejemplo

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

Utilización de la modalidad interactiva

En lugar de especificar los detalles del trabajo utilizando las opciones de mandatos o un archivo de carga útil, puede utilizar la modalidad interactiva para el mandato. Esta modalidad le solicita que especifique los valores necesarios para crear un trabajo en Schematics.

  1. Especifique el mandato para crear el trabajo sin ninguna opción de mandato.
    ibmcloud schematics job run
  2. Cuando vea la solicitud Enter command-object>, especifique action y pulse Intro.
  3. Cuando vea la solicitud Enter command-object-id>, especifique los detalles del ID de acción y pulse Intro.
  4. Cuando vea la solicitud Enter command-name>, especifique ansible_playbook_run o ansible_playbook_check y pulse Intro.
  5. Revise la salida de la CLI del trabajo que se le ha creado.

ibmcloud schematics job update

Crear un trabajo copiando los valores de un trabajo existente y ejecutar el trabajo en IBM Cloud Schematics.

Sintaxis

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

Opciones de comando

Schematics distintivos de actualización de trabajo
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un trabajo existente que desea copiar y volver a ejecutar.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--no-prompt Opcional Establezca este distintivo para crear el trabajo sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics job get

Recuperar los detalles de un trabajo de acciones utilizando un ID de trabajo.

Sintaxis

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

Opciones de comando

Schematics distintivos de obtención de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID del ID de trabajo que desea recuperar.
--profile o -p Opcional La profundidad de la información que desea recuperar. Los valores soportados son detailed y summary. El valor predeterminado es summary.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--no-prompt Opcional Establezca este distintivo para recuperar detalles del trabajo sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics job list

Recupere una lista de todos los trabajos de Schematics que se ejecutaron para una acción de Schematics. El comando muestra una lista de trabajos con el estado in_progress, success, o failed.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de trabajos
Distintivo Obligatorio / Opcional Descripción
--resource-type o -rt Obligatorio El nombre del recurso de Schematics. Solo se admite action.
--id o -i Obligatorio El ID de las acciones de Schematics para las que desea listar trabajos.
--limit o -l Opcional El número máximo de espacio de trabajos que desea mostrar en la lista. El número debe ser un entero positivo del 1 al 200. El valor predeterminado es -1.
--offset o -m Opcional La posición del trabajo en la lista de trabajos a partir del cual desea empezar a listar los trabajos. Por ejemplo, si tiene tres trabajos en la cuenta, el mandato devuelve estos trabajos en forma de una lista con tres elementos. Para recuperar todos los trabajos, debe especificar la posición número 0. Para recuperar el número de trabajo 2 y 3 y dejar fuera el número de trabajo 1 de esta lista, debe especificar la posición número 1. La posición número 1 representa la segunda posición en la lista de trabajos. No se admiten números negativos y se ignorarán.
--profile o -p Opcional La profundidad de la información que se devuelve. Los valores soportados son ids o summary. El valor predeterminado es summary.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--all o -A Opcional Lista todos los trabajos, incluyendo los trabajos internos de Schematics.
--no-prompt Opcional Establezca este distintivo para crear el trabajo sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics job logs

Recuperar los registros de un trabajo de acción Schematics. Para obtener más información sobre la visualización de los registros de tareas, consulte Revisión de los detalles de las tareas en Schematics.

Sintaxis

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

Opciones de comando

Distintivos de registros de trabajo deSchematics
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID del trabajo del que desea recuperar los registros detallados.
--log-prefix o --lp Opcional Añade el prefijo del mandato ejecutado en los registros del trabajo.
--log-header o --lh Opcional Se utiliza para convertir las cabeceras de mandatos en los registros del trabajo en al formato de Schematics.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics job delete

Suprimir un trabajo de una acción de Schematics.

No se puede suprimir ni detener un trabajo en ejecución. Para eliminar un trabajo, debe esperar a que finalice el trabajo.

Sintaxis

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

Opciones de comando

Schematics distintivos de supresión de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID del trabajo que desea suprimir.
--force o -f Opcional Forzar la supresión sin confirmación del usuario.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin una sesión de línea de mandatos interactiva.

Ejemplo

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

Mandatos de agentes

ibmcloud schematics agent create

Crear un registro de agente en la región Schematics actualmente seleccionada. Los agentes le ayudan a ejecutar sus trabajos Terraform o Ansible en su infraestructura. Para obtener más información sobre los pasos para utilizar el mandato create, consulte Despliegue de agentes.

Sintaxis

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]

Opciones de comando

Schematics Crear distintivos de agente
Distintivo Obligatorio / Opcional Descripción
--name o -n Obligatorio Nombre único de un agente. Debe ser descriptivo del rol de agente, ubicación y uso.
--location o -l Obligatorio La ubicación Schematics donde se definen los agentes, us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. Los trabajos se recogen en esta ubicación para su ejecución.
--agent-location o --al Obligatorio Etiqueta descriptiva definida por el usuario para identificar dónde se despliega el agente en el entorno de usuario. Podría ser una región de nube o un centro de datos de usuario. Por ejemplo, London MZR.
--cluster-id o -c Obligatorio El ID del cluster Kubernetes para desplegar un Agente.
--cluster-resource-group o --cg Obligatorio El nombre del grupo de recursos de los clusters.
--cos-instance-name o --on Obligatorio El nombre de la instancia COS.
--cos-bucket o -b Obligatorio El ID o el nombre del cubo COS.
--cos-location o --ol Obligatorio La ubicación del grupo de COS. El formato soportado es eu-gb, us-south, etc.
--resource-group o -g Obligatorio Nombre o ID de grupo de recursos con el que está asociado el agente.
--version o -v Obligatorio Etiqueta definida por el usuario que especifica la versión del agente. Ejemplo v1.0.0
--infra-type o -i Obligatorio Especifique el tipo de infraestructura del agente de destino. Los valores soportados son ibm-kubernetes, ibm-openshift o ibm-satellite.
--description o -d Opcional Descripción que identifica el uso del agente y las zonas y recursos de red a los que el agente puede acceder.
--tags o -t Opcional Etiquetas de agente. Puede repetir el distintivo varias veces. Las etiquetas permiten una búsqueda más rápida y fácil de los recursos relacionados con el agente.
--metadata o --md Opcional Metadatos del agente. Puede utilizar el distintivo varias veces. Por ejemplo, git:private-git.github.com o git:gitlab.com. Si no se establece, por defecto es git:github.com.
--validate Opcional Ejecutar validate después de crear el agente.
--deploy Opcional Ejecutar el despliegue sin validar después de crear el agente.
--file o f Opcional Ruta a un archivo JSON que contiene la definición de un agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

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

Desinstalar un agente. Para obtener más información sobre los pasos para utilizar el mandato delete, consulte supresión de un agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de supresión de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--force o -f Opcional La acción de fuerza sin confirmación. Establezca el parámetro --force en true para suprimir todos los flujos de agente para mantener la destrucción paralela al flujo de destrucción de espacio de trabajo. De forma predeterminada, este parámetro se establece en false.

Ejemplo

ibmcloud schematics agent delete --id <AGENT_ID>

ibmcloud schematics agent deploy

Despliegue o actualización de un agente para forzar el despliegue. Para obtener más información sobre los pasos para utilizar el mandato de despliegue, consulte Despliegue del agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de despliegue de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--force-redeploy o -fd Opcional Forzar volver a desplegar un agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics agent deploy --id <AGENT_ID>

ibmcloud schematics agent destroy

Destruir un agente destruye los recursos en la nube asociados con el despliegue del agente de Schematics.

Sintaxis

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

Opciones de comando

Schematics Distintivos de destrucción de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--force o -f Opcional La acción de fuerza sin confirmación.

Ejemplo

ibmcloud schematics agent destroy --id <AGENT_ID>

ibmcloud schematics agent get

Recupera los detalles de un agente existente, como ID de agente, Nombre, Estado, Versión, Hora de creación, Estado de cifrado y CRN de cifrado, incluidos los valores de todas las variables de entrada. Para obtener más información sobre los pasos para utilizar el comando get, consulte Visualización de un agente

Sintaxis

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

Opciones de comando

Schematics Distintivos de obtención de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics agent get --id <AGENT_ID>

ibmcloud schematics agent health

Realiza la validación posterior al despliegue de un agente. Para obtener más información sobre los pasos para utilizar el mandato de estado del agente, consulte Supervisión del estado del agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de salud del agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics agent health --id <AGENT_ID>

ibmcloud schematics agent list

Lista los agentes definidos en la región Schematics actual. Para obtener más información sobre los pasos para utilizar el mandato list, consulte visualización de un agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de lista de agentes
Distintivo Obligatorio / Opcional Descripción
--location o -l Opcional Ubicaciones geográficas respaldadas por el servicio IBM Cloud Schematics, como us-south, us-east, eu-de, eu-gb, ca-tor o ca-mon.
--limit o -lm Opcional Número máximo de agentes que mostrar. Se ignora si se define un número negativo. El límite máximo es 200, (por defecto es -1).
--offset o -m Opcional La compensación de la lista. Se ignora si se establece un número negativo (por defecto: -1)).
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics agent list --location us-south

ibmcloud schematics agent update

Actualizar una configuración de agente. La actualización de un agente no revalida ni vuelve a desplegar su agente. Para obtener más información sobre los pasos para utilizar el mandato de actualización del agente, consulte Despliegue del agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de actualización de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID de un agente.
--tags o -t Opcional Etiquetas de agente. Esta bandera se puede utilizar varias veces, y la búsqueda de los recursos relacionados con el agente más rápido.
--description o -d Opcional Breve descripción de un agente.
--version value o -v Opcional Especifica la versión de un agente. El valor predeterminado es la versión más reciente disponible.
--metadata Opcional Metadatos del agente. Puede utilizar el distintivo varias veces. Por ejemplo, git:private-git.github.com o git:gitlab.com. Si no se establece, por defecto es git:github.com.
--file o -f Opcional Ruta al fichero JSON que contiene la definición del agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.
--no-prompt Opcional Establezca este distintivo para actualizar un inventario sin una sesión de línea de mandatos interactiva.

Ejemplo

ibmcloud schematics agent update --id <AGENT_ID>

ibmcloud schematics agent validate

Comprueba la exploración de requisitos previos que analiza una configuración de agente y clúster antes del despliegue. Para obtener más información sobre los pasos para utilizar el mandato validate, consulte Despliegue del agente.

Sintaxis

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

Opciones de comando

Schematics Distintivos de validación de agente
Distintivo Obligatorio / Opcional Descripción
--id Obligatorio El ID del agente.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics agent validate --id AGENT_ID

Mandatos de política de agentes

Schematics las políticas (de asignación) indican a Schematics qué agente debe utilizar para ejecutar los trabajos de espacio de trabajo y acción en una zona de red específica. Cada agente tiene asociada al menos una política para identificar los trabajos que deben ejecutarse en la ubicación de los agentes. Véase políticas de asignación.

ibmcloud schematics policy create

Cree una política utilizando Schematics para seleccionar uno o varios objetos de Schematics, como un espacio de trabajo o una acción, que se ejecutarán en el agente de destino.

Sintaxis

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]

Opciones de comando

Schematics distintivos de creación de política
Distintivo Obligatorio / Opcional Descripción
--name o -n Obligatorio El nombre único de la política.
--kind o -K Obligatorio Tipo de política para gestionar y derivar decisiones de política. Se puede consultar en agent_assignment_policy.
--location o -l Opcional Ubicación geográfica del servicio Schematics donde se define el agente. Por ejemplo, us-south, us-east, eu-de, eu-gb, ca-tor, o ca-mon. Los trabajos se seleccionan desde esta ubicación para su proceso.
--resource-group o -r Obligatorio Nombre o ID de grupo de recursos para la política.
--target-file o tf Opcional Vía de acceso al archivo JSON que contiene la definición de la política.
--description o -d Opcional La descripción de la política Schematics.
--tags o -t Opcional Las etiquetas se pueden utilizar varias veces para buscar y localizar políticas de agente más rápido.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Utilización del archivo de carga útil

Puede proporcionar un archivo de carga útil para especificar determinados parámetros para el mandato policy create. A continuación, pase el nombre de archivo al mandato utilizando la opción de mandato --target-file.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<SELECTOR_KIND>" como "ids".

Sintaxis

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

Ejemplo

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

Ejemplo

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

Borrar una política Schematics.

Sintaxis

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

Opciones de comando

Schematics distintivos de supresión de política
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de la póliza.
--force o -f Opcional La acción de fuerza sin confirmación.

Ejemplo

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

ibmcloud schematics policy get

Recupera los detalles de una política Schematics existente utilizando el ID de la política.

Sintaxis

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

Opciones de comando

Schematics distintivos de obtención de política
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio ID de la política.
--profile o -p Opcional Nivel de detalles que devolver. Los valores válidos son summary, detailed, o ids. Por defecto summary.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

ibmcloud schematics policy get --id <POLICY_ID>

ibmcloud schematics policy list

Obtenga una lista de todas las pólizas en la región IBM Cloud para su cuenta.

Sintaxis

ibmcloud schematics policy list [--profile PROFILE] [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]
Schematics Distintivos de lista de políticas
Distintivo Obligatorio / Opcional Descripción
--profile o -r Opcional El nivel de detalle a devolver. Los valores válidos son summary, detailed y ids. Por defecto summary.
--limit o -l Opcional Número máximo de pólizas a listar. Se ignora si se define un número negativo. El número debe ser un entero positivo del 1 al 200. El valor predeterminado es -1.
--offseto -m Opcional La compensación de la lista. Se ignora si se define un número negativo. El valor predeterminado es -1.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

ibmcloud schematics policy list  --profile ids092030

ibmcloud schematics policy update

Actualizar una política existente utilizando el ID de política.

Sintaxis

ibmcloud schematics policy update --id POLICY_ID [--kind POLICY_KIND] [--description DESCRIPTION] [--resource-group RESOURCE_GROUP] [--tags TAGS] [--file FILE] [--output OUTPUT]
Schematics distintivos de actualización de política
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio ID de la política.
--kind o -k Opcional Tipo de política para gestionar y derivar decisiones de política. Se puede consultar en agent_assignment_policy.
--description o -d Opcional La descripción de la política de personalización de Schematics.
--resource-group o -r Opcional Nombre o ID de grupo de recursos para la política.
--tags o -t Opcional Etiquetas de política. Este distintivo se puede utilizar varias veces para buscar y localizar políticas de agente más rápido.
--file o -f Opcional Ruta al archivo JSON que contiene la definición de la política.
--output o -o Opcional Especifique el formato de salida, sólo se admite JSON.

Ejemplo

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

Configurar comandos BYOK o KYOK

Puede utilizar sus claves de cifrado de IBM Key Protect (disponibles como Multi-Tenant para BYOK o Dedicated para KYOK) para cifrar y proteger sus datos almacenados en Schematics. Para más información sobre cómo proteger los datos sensibles en Schematics, consulte proteger sus datos sensibles en Schematics.

Hyper Protect Crypto Services (HPCS) ha quedado obsoleto para las nuevas integraciones. Las integraciones HPCS existentes seguirán funcionando, pero las nuevas integraciones con HPCS ya no son compatibles. Para nuevas integraciones, utilice Key Protect Dedicated for KYOK capabilities.

Antes de empezar

Para que el sistema de gestión de claves enumere las instancias creadas a partir de su ubicación y región específicas, deben cumplirse los siguientes requisitos previos.

Los valores de KMS son valores puntuales. Es necesario abrir un ticket de soporte para actualizar la configuración de KMS.

ibmcloud schematics kms instance ls

Lista todas las instancias de KMS de su cuenta de IBM Cloud para encontrar su Key Protect o Hyper Protect Crypto Services utilizando la ubicación en la que se han creado las claves y han cifrado el esquema como, por ejemplo, KYOK o BYOK.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de KMS
Distintivo Obligatorio / Opcional Descripción
--location o -l Obligatorio Establezca el nombre de la ubicación de Schematics. Los valores soportados son US o EU.
--scheme o -s Obligatorio Especifique el esquema de cifrado. Los valores soportados son KYOK o BYOK.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics kms enable

Habilite KMS para cifrar los datos en la ubicación específica. Para obtener más información sobre la activación de claves gestionadas por el cliente para Schematics, consulte la activación de claves.

Actualice los valores de KMS para su ubicación, utilizando su punto final privado, CRN, CRK primario y CRK secundario. Tenga en cuenta que sólo puede actualizar la configuración de KMS una vez. Por ejemplo, si utiliza un punto final de API para una geografía, como, por ejemplo, North America, solo se recuperan las creadas en us-south o us-east.

Sintaxis

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]

Opciones de comando

Schematics distintivos de habilitación de KMS
Distintivo Obligatorio / Opcional Descripción
--location o -l Obligatorio Establezca el nombre de la ubicación de Schematics. Los valores soportados son US o EU.
--scheme o -s Obligatorio Especifique el esquema de cifrado. Los valores soportados son KYOK o BYOK.
--group o -g Obligatorio Especifique el nombre del grupo de recursos. El valor predeterminado es Default.
--primary_name o --pn Obligatorio Especifique el nombre de KMS primario.
--primary_crn o --pc Obligatorio Especifique el nombre de CRN de clave primaria.
--primary_endpoint o --pe Obligatorio Especifique el punto final privado de KMS primario.
--secondary_name o --sn Opcional Especifique el nombre de KMS secundario.
--secondary_crn o --sc Opcional Especifique el CRN de la clave secundaria.
--secondary_endpoint o --se Opcional Especifique el punto final privado de KMS secundario.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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 el KMS en el punto final de la API que tiene KYOK o BYOK. Por ejemplo, si utiliza un punto final de API para una geografía, como, por ejemplo, North America, solo se recuperan las creadas en us-south o us-east. Tenga en cuenta que debe habilitar kms instances en su cuenta para ejecutar comando info.

Sintaxis

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

Opciones de comando

Schematics distintivos de información de KMS
Distintivo Obligatorio / Opcional Descripción
--location o -l Obligatorio Establezca el nombre de la ubicación de Schematics. Los valores soportados son US o EU.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

ibmcloud schematics kms info -l US

Mandatos generales

Utilice estos mandatos generales para buscar información de ayuda y de versión para el plugin de línea de mandatos de IBM Cloud Schematics.

ibmcloud schematics help

Ver los mandatos de línea de mandatos de IBM Cloud Schematics admitidos.

Sintaxis

ibmcloud schematics help

Opciones de comando

Schematics distintivos de ayuda
Distintivo Obligatorio / Opcional Descripción
--help o -h Obligatorio Lista los mandatos admitidos.
command Opcional Especifique el nombre del mandato para captar los detalles.

Ejemplo

ibmcloud schematics help

ibmcloud schematics version

Enumera las versiones de todos los proyectos de código abierto soportados en Schematics, tales como IBM Cloud Provider Plug-in for Terraform, Ansible, Helm, y Kubernetes que se utilizan para ejecutar acciones Schematics en recursos Cloud.

Sintaxis

ibmcloud schematics version [--output OUTPUT]

Opciones de comando

Distintivos de versión deSchematics
Distintivo Obligatorio / Opcional Descripción
--output o -o Opcional Devuelve la salida de la CLI en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

Mandatos de inventario

Revise los comandos para crear, actualizar, listar, eliminar y trabajar con sus inventarios de IBM Cloud Schematics utilizados con las acciones de Schematics.

ibmcloud schematics inventory create

Para crear un inventario de recursos en Schematics para utilizarlo con una acción de Ansible, puede utilizar un archivo de carga útil o el modo interactivo. El inventario incluye todos los hosts de destino en los que pretende ejecutar su playbook Ansible.

Sintaxis

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]

Opciones de mandato

Schematics distintivos de creación de inventario
Distintivo Obligatorio / Opcional Descripción
--name o -n Obligatorio El nombre exclusivo de un inventario de recursos.
--description o -d Opcional La descripción breve de un inventario.
--location o -l Opcional La ubicación en la que desea almacenar su inventario de recursos, como us-south, us-east, eu-de, eu-gb, ca-tor o ca-mon.
resource-group o -r Opcional El nombre del grupo de recursos donde desea crear la acción.
--connection-type o --ct Opcional Tipo de conexión de un inventario. Admite tanto ssh como winrm.
--bastion-ip-address o -b Opcional Introduzca la dirección IP del host Bastion.
--bastion-credential-json o --bj Opcional Proporcione la ruta del archivo JSON que contiene la carga útil de credenciales de Bastion para acceder al host de Bastion.
--credential-json o --cj Opcional Proporcione la ruta del archivo JSON que contiene la carga útil de las credenciales comunes para acceder a los hosts de destino. La jerarquía de credenciales en Schematics sigue este orden: Credenciales de nivel de host (mayor prioridad), Credenciales de nivel de grupo (siguiente prioridad) y Credenciales comunes (menor prioridad).
--inventory-view-json o --inv Opcional Ruta al archivo JSON que contiene los detalles del host. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--inventories-ini-file o -y Opcional La vía de acceso de archivo al archivo de inventario de recursos donde ha especificado todos los hosts de destino. El archivo de inventario de recursos debe proporcionarse en formato INI. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--resource-query Opcional Especifique el ID de una consulta de recursos que haya creado. Una consulta de recursos ayuda a construir dinámicamente su inventario de recursos utilizando los recursos de la Nube que usted creó con un espacio de trabajo Schematics. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--file o -f Opcional La vía de acceso al archivo JSON donde ha especificado el inventario de recursos que desea crear.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.
--no-prompt Opcional Establezca este distintivo para crear un inventario sin una sesión de línea de mandatos interactiva.

Utilización del archivo de carga útil

Puede proporcionar un archivo de carga útil para especificar determinados parámetros para el mandato inventory create. A continuación, pase el nombre de archivo al mandato utilizando la opción de mandato --file.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<INVENTORY_NAME>" como "myinventory".

Sintaxis para un inventory_view_example.json

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

Sintaxis para un common_credentials_example.json

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

Sintaxis para un bastion_credentials_example.json

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

}

ibmcloud schematics inventory create --file inventory.json

Utilización de la modalidad interactiva

En lugar de especificar sus detalles de inventario utilizando las opciones de mandato o un archivo de carga útil, también puede utilizar la modalidad interactiva del mandato. Esta modalidad le solicita que especifique los valores necesarios para crear un inventario en Schematics.

  1. Especifique el mandato para crear el inventario sin ninguna opción de mandato.

    ibmcloud schematics inventory create ....

  2. Especifique un nombre para el inventario y pulse la tecla Intro.

  3. Especifique el grupo de recursos en el que desea crear el inventario y pulse la tecla Intro.

  4. Introduzca la ubicación en la que desea crear el inventario, como us-south, us-east, eu-de, o eu-gb. A continuación, pulse la tecla Intro.

  5. Revise los detalles del inventario que se ha creado.

Ejemplo

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

Suprima la definición de inventario de recursos utilizando el ID de inventario.

Sintaxis

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

Opciones de comando

Schematics distintivos de supresión de inventario
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de un inventario que desea suprimir.
--force o -f Opcional Forzar la supresión sin la confirmación del usuario.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin solicitudes de usuario.

Ejemplo

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

ibmcloud schematics inventory get

Recupere información detallada de un inventario existente en IBM Cloud Schematics utilizando el ID del inventario.

Sintaxis

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

Opciones de comando

Schematics distintivos de obtención de inventario
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID del inventario de recursos del que desea listar información detallada.
--profile o -p Opcional La profundidad de la información que desea recuperar. Los valores soportados son detailed y summary. El valor predeterminado es summary.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.
--no-prompt Opcional Establezca este distintivo para recuperar los detalles de un inventario sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics inventory list

Obtenga una lista de todos los inventarios de Schematics en la región actual para su cuenta.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de trabajos
Distintivo Obligatorio / Opcional Descripción
--limit o -l Opcional El número máximo de inventarios que desea listar. El número debe ser un entero positivo del 1 al 200. El valor predeterminado es -1.
--offset o -m Opcional La posición del inventario en la lista de inventarios. Por ejemplo, si tiene tres inventarios en la cuenta, el mandato devuelve estos inventarios en forma de una lista con tres elementos. Para ver un inventario específico en esta lista, debe especificar el número de posición que tiene ese inventario en la lista. Para listar el primer inventario de la lista, especifique 0. Para listar el segundo inventario, especifique 1 y así sucesivamente. No se admiten números negativos y se ignorarán. El valor predeterminado es -1.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.

Ejemplo

ibmcloud schematics inventory list --output json

ibmcloud schematics inventory update

Actualizar un inventario de recursos existente.

Sintaxis

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]

Opciones de comando

Schematics distintivos de actualización de inventario
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio Especifique el ID de un inventario de recursos que desea actualizar.
--name o -n Obligatorio El nombre exclusivo de un inventario.
--description o -d Opcional La descripción breve de un inventario.
--location o -l Opcional Las ubicaciones geográficas que admite el servicio IBM Cloud Schematics, como us-south, us-east, eu-de, eu-gb, ca-tor o ca-mon.
resource-group o -r Opcional El nombre del grupo de recursos para una acción.
--connection-type o --ct Opcional Tipo de conexión de un inventario. Admite tanto ssh como winrm.
--bastion-ip-address o -b Opcional Introduzca la dirección IP del host Bastion.
--bastion-credential-json o --bj Opcional Proporcione la ruta del archivo JSON que contiene la carga útil de credenciales de Bastion para acceder al host de Bastion.
--credential-json o --cj Opcional Proporcione la ruta del archivo JSON que contiene la carga útil de las credenciales comunes para acceder a los hosts de destino. La jerarquía de credenciales en Schematics sigue este orden: Credenciales de nivel de host (mayor prioridad), Credenciales de nivel de grupo (siguiente prioridad) y Credenciales comunes (menor prioridad).
--inventory-view-json o --inv Opcional Ruta al archivo JSON que contiene los detalles del host. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--inventories-ini-file o -y Opcional Vía de acceso de archivo del archivo en formato INI que contiene los detalles del host. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--resource-query Opcional Especifique el ID de una consulta de recursos que haya creado. Una consulta de recursos ayuda a construir dinámicamente su inventario de recursos utilizando los recursos de la Nube que usted creó con un espacio de trabajo Schematics. Debe pasar la ruta del archivo --inventories-ini-file, el ID de --resource-query o --inventory-view-json para que el inventario utilice los detalles del host de destino. Si se proporcionan dos o los tres argumentos, se producirá un error.
--file o -f Opcional La vía de acceso al archivo JSON que contiene la definición de un inventario.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.
--no-prompt Opcional Establezca este distintivo para actualizar un inventario sin una sesión de línea de mandatos interactiva.

Utilización del archivo de carga útil

Puede proporcionar un archivo de carga útil para especificar determinados parámetros para el mandato inventory update. A continuación, pase el nombre de archivo al mandato utilizando la opción de mandato --file.

Sintaxis para un inventory_view_example.json

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

Ejemplo

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

Mandatos de consulta de recursos de inventario

Construir dinámicamente inventarios de recursos de acciones mediante consultas de recursos. Las consultas de recursos permiten recopilar información sobre el host de destino en los espacios de trabajo de Schematics. Para obtener más información sobre consultas y condiciones de recursos, consulte Creación de inventarios de recursos para acciones Schematics.

ibmcloud schematics resource query create

Crear una consulta de recursos en IBM Cloud Schematics que pueda utilizar para crear el inventario de recursos. Puede crear una consulta de recursos utilizando un archivo de carga útil o la modalidad interactiva del mandato. Puede crear condiciones de recursos utilizando consultas de recursos.

Sintaxis

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]

Opciones de comando

Schematics distintivos de creación de consulta de recurso
Distintivo Obligatorio / Opcional Descripción
--name o -n Obligatorio El nombre exclusivo de una consulta de recursos.
--type o -t Opcional El tipo de recurso que desea recuperar. Los valores soportados son vsi.
--query-file o -f Opcional La vía de acceso al archivo JSON donde ha especificado los detalles de la consulta de recursos. Para obtener una lista de las consultas soportadas, consulte Consultas de recursos soportadas.
--file o -f Opcional La vía de acceso al archivo JSON que especifica los detalles de la consulta de recursos que desea crear.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--no-prompt Opcional Establezca este distintivo para crear la consulta de recursos sin una sesión de línea de mandatos interactiva.

Utilización del archivo de carga útil

Puede proporcionar un archivo de carga útil para especificar determinados parámetros para el mandato resource_query create. A continuación, pase el nombre de archivo al mandato utilizando la opción de mandato --file. Para obtener una lista de las consultas de recursos soportadas, consulte Consultas de recursos soportadas.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<WORKSPACE_ID" como us-east.workspace.ID1231.

Sintaxis

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

Ejemplo

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

Utilización de la modalidad interactiva

En lugar de especificar los detalles de consulta de recursos utilizando las opciones de mandatos o un archivo de carga útil, puede utilizar la modalidad interactiva para el mandato. Esta modalidad le solicita que especifique los valores necesarios para crear una consulta de recursos en Schematics. Puede crear condiciones de recursos utilizando consultas de recursos.

  1. Especifique el mandato para crear la consulta de recursos sin ninguna opción de mandato.
    ibmcloud schematics resource-query create
  2. Especifique un nombre para la consulta de recursos y pulse la tecla Intro.
  3. Especifique la vía de acceso al archivo de carga útil. Para ver un archivo de carga útil de ejemplo, consulte Utilización del archivo de carga útil. A continuación, pulse la tecla Intro.
  4. Revise los detalles de la consulta de recursos que se le ha creado.

ibmcloud schematics resource query delete

Suprimir la definición de consulta de recursos del recurso utilizando el ID de consulta de recursos del servicio IBM Cloud Schematics. Tenga presente que puede suprimir la ubicación y la región, el grupo de recursos desde el que se ha creado el inventario. Asegúrese también de que las direcciones IP estén en la lista de elementos permitidos.

Sintaxis

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

Opciones de comando

Schematics distintivos de supresión de consulta
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de una consulta de recursos que desea suprimir.
--force o -f Opcional Forzar la supresión sin la confirmación del usuario.
--no-prompt Opcional Establezca este distintivo para ejecutar el mandato sin solicitudes de usuario.

Ejemplo

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

ibmcloud schematics resource query get

Recuperar la información de una consulta de recursos de IBM Cloud Schematics existente utilizando un ID de consulta de recursos.

Sintaxis

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

Opciones de comando

Schematics distintivos get de consulta de recurso
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de la consulta de recursos que desea recuperar.
--profile o -p Opcional La profundidad de la información que desea recuperar. Los valores soportados son detailed y summary. El valor predeterminado es summary.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.
--no-prompt Opcional Establezca este distintivo para recuperar una consulta de recursos sin una sesión de línea de mandatos interactiva.

Ejemplo

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

ibmcloud schematics resource query list

Obtenga una lista de todas las consultas de recursos de Schematics en la región actual para su cuenta.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de consulta de recursos
Distintivo Obligatorio / Opcional Descripción
--limit o -l Opcional El número máximo de consultas de recursos que desea listar. El número debe ser un entero positivo del 1 al 200. El valor predeterminado es -1.
--offset o -m Opcional La posición de la consulta de recursos en la lista de consultas de recursos. Por ejemplo, si tiene tres consultas de recursos en la cuenta, el mandato devuelve estas consultas de recursos en forma de una lista con tres elementos. Para ver una consulta de recursos específica en esta lista, debe especificar el número de posición que tiene esa consulta de recursos en la lista. Para listar la primera consulta de recursos de la lista, especifique 0. Para listar la segunda consulta de recursos, especifique 1 y así sucesivamente. No se admiten números negativos y se ignorarán. El valor predeterminado es -1.
--output o -o Opcional Especifique el formato de salida. Solo se admite el formato JSON.

Ejemplo

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

ibmcloud schematics resource query update

Al actualizar o sustituir una consulta de recursos se crea una copia de una consulta de recursos y se vuelve a iniciar una consulta de recursos existente actualizando la información de una consulta de recursos de IBM Cloud Schematics.

Sintaxis

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]

Opciones de comando

Schematics distintivos de actualización de consulta de recurso
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de consulta de recursos.
--name o -n Obligatorio El nombre exclusivo de una consulta de recursos.
--type o -t Opcional El tipo de la consulta de recursos, tales como vsi
--query-file o -f Opcional La vía de acceso al archivo JSON que contiene consultas.
--file o -f Opcional La vía de acceso al archivo JSON que contiene la definición de un inventario.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--no-prompt Opcional Establezca este distintivo para crear la consulta de recursos sin una sesión de línea de mandatos interactiva.

Ejemplo

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

Mandatos de espacio de trabajo

Revise los comandos que puede utilizar para crear y trabajar con su espacio de trabajo IBM Cloud Schematics.

ibmcloud schematics workspace action

Recupera todas las actividades (trabajos) de un espacio de trabajo, incluyendo el ID de usuario de la persona que inició la acción, el estado y una marca de tiempo.

Cuando creas un plan de ejecución Terraform, o aplicas tu plantilla Terraform con Schematics, se crea automáticamente una acción Schematics y se le asigna un ID de acción. Puede utilizar el ID de acción para recuperar los registros de esta acción utilizando el mandato ibmcloud schematics logs.

Sintaxis

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

Opciones de comando

Schematics distintivos de ejecución de espacio de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea recuperar las actividades de espacio de trabajo. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--act-id o -a Opcional Especifique el ID de una acción que desee recuperar.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

ibmcloud schematics workspace action --id <WORKSPACE_ID>

ibmcloud schematics workspace delete

Suprimir un espacio de trabajo de la región actual para su cuenta. La eliminación de su espacio de trabajo no elimina ningún recurso de la nube que haya aprovisionado con este espacio de trabajo. Puede acceder y trabajar con sus recursos desde el panel de control de IBM Cloud directamente, pero no puede utilizar IBM Cloud Schematics para gestionar los recursos tras suprimir el espacio de trabajo.

Decida si desea suprimir el espacio de trabajo, cualquier recurso asociado o ambos. Esta acción no se puede deshacer. Si elimina un espacio de trabajo y conserva los recursos, tiene que gestionar los recursos con la lista de recursos o con la CLI.

suprimir espacio de trabajo y recurso asociado
Acción Suprimir espacio de trabajo Suprimir todos los recursos asociados
Suprimir espacio de trabajo True False
Suprimir solo recursos False True
Suprimir espacio de trabajo y los recursos suministrados por espacio de trabajo True True
Recursos destruidos utilizando la línea de mandatos o la lista de recursos, y desea suprimir el espacio de trabajo True False

Sintaxis

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

Opciones de comando

Schematics distintivos de supresión de espacio de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo que desea eliminar. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--force o -f Opcional Forzar la supresión del espacio de trabajo sin solicitudes de la línea de mandatos.

Ejemplo

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

ibmcloud schematics workspace get

Recupere los detalles de un espacio de trabajo existente, como ID del espacio de trabajo, Nombre, Estado, Versión, Hora de creación, ID de plantilla, ID de confirmación, Estado de cifrado y CRN de cifrado, incluidos los valores de todas las variables de entrada.

Sintaxis

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

Opciones de comando

El espacio de trabajoSchematics obtiene distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea recuperar los detalles. Para buscar el Resource ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list para ver las instancias de servicio de lista. Desde el grupo de recursos obtenga un Resource ID para el distintivo --id.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

ibmcloud schematics workspace get --id <WORKSPACE_ID>

ibmcloud schematics workspace import

Puede importar un recurso existente con una dirección de recurso válida en el archivo de estado del espacio de trabajo. Debe asegurarse de que el recurso sólo se importa una vez y a un único espacio de trabajo. De lo contrario, es posible que vea un comportamiento no deseado si el recurso está definido en varios espacios de trabajo. Consulte la documentación de Terraform para obtener detalles sobre cómo utilizar el mandato import.

Sintaxis

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

Opciones de comando

Schematics distintivos de importación de espacio de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea importar una instancia o un recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--options o -o Obligatorio Los distintivos de línea de mandatos. Por ejemplo, -var-file xxxxx/tf.
--address o -adr Obligatorio Proporciona la dirección del nombre del recurso que desea importar.
--resourceID o -rid Obligatorio Especifique el ID de recurso que necesita para importar en el archivo.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Utilice la opción -options -var-file=schematics.tfvars para indicar a Schematics que importe el recurso con las variables de espacio de trabajo guardadas.

Ejemplo

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 los espacios de trabajo de la región actual de su cuenta de IBM Cloud y muestra los detalles del espacio de trabajo. El espacio de trabajo de lista comprueba el desuso en un bucle invocando la API versions cada vez para todo el espacio de trabajo a través de la memoria caché de archivos.

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de espacios de trabajo
Distintivo Obligatorio / Opcional Descripción
--limit o -l Opcional El número máximo de espacio de trabajos que desea mostrar en la lista. El número debe ser un entero positivo a partir del 1, el máximo es 200. El valor predeterminado es -1.
--offset o -m Opcional La posición del espacio de trabajo en la lista de espacios de trabajo. Por ejemplo, si tiene tres espacios de trabajo en la cuenta, el mandato devuelve estos espacios de trabajo como una lista con tres elementos. Para ver un espacio de trabajo específico en esta lista, debe especificar el número de posición que tiene dicho espacio de trabajo en la lista. Para listar el primer espacio de trabajo de la lista, especifique 0. Para listar el segundo espacio de trabajo, entre 1 y así sucesivamente. No se admiten números negativos y se ignorarán. El valor predeterminado es -1.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.
--region o -r Opcional Especifique la región, como eu, us, eu-gb, eu-de, us-south o us-east.

Ejemplo

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

ibmcloud schematics workspace new

Cree un espacio de trabajo Schematics que apunte a su plantilla Terraform en GitHub o GitLab. Si desea proporcionar la plantilla de Terraform actualizando un archivo de archivado de cinta (.tar), puede crear el espacio de trabajo sin conexión a un repositorio GitHub y utilizar luego el mandato ibmcloud schematics workspace upload para proporcionar la plantilla.

Schematics no soporta a pasar el archivo .tar para crear un espacio de trabajo.

IBM Cloud Schematics admite 50 solicitudes de API por minuto, por host y por cliente. La ubicación puede ser la región us-east, us-south, eu-gb o eu-de. Es necesario esperar antes de volver a llamar al mandato.

Para crear un espacio de trabajo, puede especificar los valores del espacio de trabajo en un archivo JSON. Asegúrese de que el archivo JSON siga la estructura descrita en este mandato. Asegúrese también de que location y url apunten a la misma región cuando cree o actualice espacios de trabajo y acciones. Para obtener más información sobre la ubicación y el punto final, consulte ¿Dónde se almacena mi información?.

IBM Cloud Schematics está dejando obsoletas las versiones anteriores de Terraform e introduciendo soporte para la versión más reciente de Terraform. Para obtener más información, consulte Schematics Terraform deprecation lifecycle and the Deprecation Schedule.

Sintaxis

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

Opciones de comando

Espacio de trabajoSchematics crear distintivos
Distintivo Obligatorio / Opcional Descripción
--file o -f Obligatorio La vía de acceso relativa a un archivo JSON de su máquina local que se utiliza para configurar el espacio de trabajo. Para obtener más información sobre el archivo JSON de ejemplo con los detalles, consulte Archivo JSON crear plantilla.
--state Opcional La vía de acceso relativa a un archivo de estado de Terraform existente en la máquina local. Para crear el archivo de estado de Terraform:
1. Mostrar el contenido de un archivo de estado de Terraform existente utilizando el mandato ibmcloud schematics state pull.
2. Copie el contenido del archivo de estado de la salida de comando en un archivo de su equipo local llamado terraform.tfstate.
3. Utilice la vía de acceso relativa del archivo en el parámetro del mandato --state. Nota El espacio de trabajo Schematics da soporte al archivo terraform.tfstate de menos de 2 MB.
--github-token o -g Opcional Especifique las señales de acceso personal funcionales para operaciones Git de HTTPS. Por ejemplo, --github-token ${FUNCTIONAL_GIT_KEY}.
--agent-id o --aid Opcional El ID de un agente donde se crea el espacio de trabajo. El agente le ayuda a ejecutar los trabajos de su espacio de trabajo en su infraestructura. Para obtener más información, consulte Agente deSchematics.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

El uso comando Schematics ibmcloud terraform muestra advertencia y mensaje de deprecación como Alias 'terraform' son deprecated. Utiliza 'schematics' o 'sch' en tus comandos.

Plantilla para crear archivo en formato JSON

Schematics soporta la descarga de la plantilla de módulos de Terraform desde el repositorio privado. Para obtener más información, consulte Soporte para descargar módulos del host remoto privado.

Puede crear el archivo JSON como compartido en el archivo example.json para la creación del espacio de trabajo y pasar la vía de acceso del archivo junto con el nombre de archivo en el distintivo de --file. La descripción de todos los parámetros de example.json tal como se describe en la tabla.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<workspace_name>" como "testworkspace".

Ejemplo

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

Ejemplo de JSON para cargar en un archivo .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>"
        }
        ]
    }
    ]
}
Descripción de los componentes del archivo JSON
Parámetro Obligatorio/Opcional Descripción
workspace_name Opcional Especifique un nombre para el espacio de trabajo. La longitud máxima del límite de caracteres se establece en menos de 1 MB. Para obtener más información, consulte Diseño de la estructura del espacio de trabajo.
terraform_version Opcional La versión de Terraform que desea utilizar para ejecutar el código Terraform. Introduzca terraform_v1.5 para utilizar la versión de Terraform 1.5,terraform_v1.4 para utilizar la versión de Terraform 1.4, y de forma similar, terraform_v1.4. Por ejemplo, cuando especifica terraform_v1.5 significa que los usuarios pueden tener una plantilla que sea de Terraform v1.5.0, v1.5.1 o v1.5.7, etc. Asegúrese de que los archivos de configuración de Terraform son compatibles con la versión de Terraform que especifique. Esta es una variable necesaria. Si no se especifica la versión de Terraform, de forma predeterminada, Schematics selecciona la versión de su plantilla. Schematics es compatible con Terraform_v1.x y también tiene previsto poner a disposición versiones posteriores a 30 to 45 days de HashiCorp Configuration Language (HCL) release.
location Opcional Introduzca la ubicación donde desea crear su espacio de trabajo. La ubicación determina dónde se ejecutan las acciones de Schematics y dónde se almacenan los datos del espacio de trabajo. Si no especifica una ubicación, Schematics determina la ubicación en función de la región de IBM Cloud de destino. Para ver la región de destino, ejecute ibmcloud target --output json y mire el campo region. Para seleccionar otra región, ejecute ibmcloud target -r <region>. Si especifica una ubicación, asegúrese de que la ubicación coincida con la región IBM Cloud que ha seleccionado.
description Opcional Introduzca una descripción para su espacio de trabajo.
template_repo.url Opcional Introduzca el URL al repositorio GitHub o GitLab donde se almacenan sus archivos de configuración de Terraform.
template_repo.branch Opcional Introduzca la rama GitHub o GitLab en la que se almacenan los archivos de configuración de Terraform. Ahora, en template_repo, también puede actualizar URL con más parámetros como se muestra en el bloque.
template_repo.datafolder Opcional Introduzca el nombre de la carpeta en el repositorio Git, que contiene la plantilla.
template_repo.release Opcional Introduzca la versión GitHub o GitLab que apunta a sus archivos de configuración de Terraform.
github_source_repo_url Opcional Introduzca el enlace a su repositorio GitHub. El enlace puede hacer referencia a la ramificación master, a cualquier otra ramificación o a un subdirectorio. Si decide crear su espacio de trabajo sin un repositorio GitHub, se crea el espacio de trabajo con el estado borrador. Para conectar después el espacio de trabajo a un repositorio GitHub, debe utilizar el mandato ibmcloud schematics workspace update. Si tiene previsto proporcionar la plantilla de Terraform cargando un archivo de archivado de cinta (.tar), deje el URL vacío y utilice el mandato ibmcloud schematics workspace upload tras crear el espacio de trabajo. Si quieres clonar desde el repositorio Git consulta las extensiones de archivo permitidas y bloqueadas para clonar.
env_values Opcional Una lista de variables de entorno que desea aplicar durante la ejecución de un script bash o una acción de Terraform. Este campo se debe especificar como una lista de pares de clave-valor. Cada entrada es un mapa con una entrada donde key = variable name y value = value. Puede definir variables de entorno para las ofertas de catálogo de IBM Cloud que se suministran utilizando archivos de script bash.
variable_name Opcional Introduzca el nombre para la variable de entrada que declaró en sus archivos de configuración de Terraform.
variable_type Opcional Terraform v0.12 soporta string, list, map, bool, number y tipos de datos complejos como list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
variable_value Opcional Introduzca el valor como una cadena para los tipos primitivos como bool, number, string, y HCL formato para las variables complejas, tal y como se proporciona en un archivo .tfvars. Debe indicar la serie con caracteres de escape del formato HCL para el valor, como se muestra en el ejemplo. Para obtener más información sobre cómo declarar variables en un archivo de configuración de Terraform y proporcionar valor a los esquemas, consulte Uso de variables de entrada para personalizar recursos. Por ejemplo
secure Opcional Establezca el parámetro secure en verdadero. Por defecto, este parámetro es falso.
val1 Opcional En la carga útil puede proporcionar una variable de entorno que se puede ejecutar en su espacio de trabajo durante la etapa de planificación, aplicación o destrucción. Los valores también se cifran y se almacenan en COS.

IBM Cloud Schematics da soporte a la configuración de la variable de entorno como, por ejemplo, TF_PARALLELISM, TF_LOG. Para obtener más información sobre la lista de variables de entorno y su uso, consulte Lista de variables de entorno.

Ejemplo

ibmcloud schematics workspace new --file example.json

ibmcloud schematics refresh

Realice una acción de renovación de IBM Cloud en el espacio de trabajo. Una acción de actualización valida los recursos de la nube de su cuenta con respecto al estado almacenado en el archivo de estado de Terraform de su espacio de trabajo. Si se encuentran diferencias, el archivo de estado de Terraform se actualiza en consecuencia.

Sintaxis

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

Opciones de comando

Schematics distintivos de renovación
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo que desea renovar y sobre el que desea ejecutar una acción. Para averiguar el ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics state list

Enumere los Name, Type, URL, y Taint Status de los recursos Cloud que están documentados en su archivo de estado de Terraform (terraform.tfstate).

Taint Status devuelve dañado para (true) o vacío para (false).

Sintaxis

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

Opciones de comando

Schematics distintivos de lista de estados
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador único del espacio de trabajo para el que desea listar los recursos de la nube que están documentados en el archivo de estado de Terraform. Para averiguar el ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics workspace taint

Marca manualmente una instancia o recursos como marcados, forzando a que los recursos se vuelvan a crear en la siguiente aplicación. La marca modifica el archivo de estado, pero no la infraestructura del espacio de trabajo. Cuando realice la siguiente planificación, los cambios se mostrarán como recreados, y en la siguiente aplicación el cambio se implementará.

Debe ejecutar el mandato ibmcloud schematics state list para ver el estado dañado de los recursos. Taint Status devuelve tainted para (verdadero) o blank para (falso).

Sintaxis

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

Opciones de comando

Schematics
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea volver a crear una instancia o un recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--options o -o Opcional Especifique el distintivo option que desea mostrar.
--address o -adr Obligatorio Escriba la dirección del recurso a marcar como marcado.

Ejemplo

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

ibmcloud schematics workspace untaint

Marca manualmente una instancia o recursos como untaint, obligando a restaurar los recursos en la siguiente aplicación. Cuando realice el siguiente plan, los cambios se mostrarán como restaurados y en la siguiente aplicación el cambio se implementará.

Puede ejecutar el mandato ibmcloud schematics state list para ver el estado dañado de los recursos. Taint Status devuelve tainted para (verdadero) o blank para (falso).

Sintaxis

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

Opciones de comando

Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea volver a crear una instancia o un recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--options o -o Opcional Especifique el distintivo option que desea mostrar.
--address o -adr Opcional Introduzca la dirección del recurso que desea marcar como untaint.
{: caption="Schematics espacio de trabajo untaint flags "caption-side = "top"}

Ejemplo

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

ibmcloud schematics workspace update

IBM Cloud Schematics está dejando obsoletas las versiones anteriores de Terraform e introduciendo soporte para la versión más reciente de Terraform. Para obtener más información, consulte Schematics Terraform deprecation lifecycle and the Deprecation Schedule.

Actualizar los detalles de un espacio de trabajo existente, como el nombre de espacio de trabajo, las variables o el URL de control de origen. Para suministrar o modificar IBM Cloud, consulte el mandato ibmcloud schematics plan.

IBM Cloud Schematics admite 50 solicitudes de API por minuto, por host y por cliente. La región puede ser us-east, us-south, eu-gb o eu-de. Es necesario esperar antes de volver a llamar al mandato. Asegúrese de que location y url apuntan a la misma región cuando cree o actualice espacios de trabajo y acciones. Para obtener más información sobre la ubicación y el punto final, consulte ¿Dónde se almacena mi información?.

Si ha proporcionado la plantilla de Terraform cargando un archivo de archivado de cinta (.tar) y desea actualizar la plantilla, debe utilizar el mandato ibmcloud schematics workspace upload.

Sintaxis

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

El indicador Pull-latest no se admite en los espacios de trabajo creados utilizando plantillas de los catálogos de IBM Cloud.

Opciones de comando

Schematics distintivos de actualización de espacio de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea actualizar la instancia o recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--file o -f Opcional La vía de acceso relativa a un archivo JSON de su máquina local que incluye los parámetros actualizados para el espacio de trabajo. Para obtener más información sobre el archivo JSON de muestra con los detalles, consulte Plantilla de actualización del archivo JSON.
--github-token o -g Opcional Especifique el valor de la señal de GitHub para acceder al repositorio Git privado.
--pull-latest o --pl Opcional Extraiga en el espacio de trabajo los cambios más recientes del repositorio de GitHub. Si se establece este indicador, se ignora --file.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Plantilla para actualizar archivo en formato JSON

Puede crear el JSON como compartido en el archivo example.json para actualizar el espacio de trabajo y pasar la vía de acceso del archivo junto con el nombre del archivo en el distintivo --file. En la tabla se describen todos los parámetros de example.json.

Debe sustituir los marcadores <...> por los valores reales. Por ejemplo, "<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
	  }
        ]
    }
    ],
}
carga útil de actualización deIBM Cloud Schematics
Parámetro Obligatorio / Opcional Descripción
name Opcional Especifique un nombre para el espacio de trabajo. Para obtener más información, consulte Diseño de la estructura del espacio de trabajo. Si actualiza el nombre del espacio de trabajo, el ID del espacio de trabajo no cambia.
type Opcional La versión de Terraform que desea utilizar para ejecutar el código de Terraform. Especifique terraform_v1.5 para utilizar Terraform versión 1.5, terraform_v1.4 para utilizar Terraform versión 1.4. Por ejemplo, cuando especifica terraform_v1.5 significa que los usuarios pueden tener una plantilla que sea de Terraform v1.5.0, v1.5.1 o v1.5.7, etc. Asegúrese de que los archivos de configuración de Terraform son compatibles con la versión de Terraform que especifique. Esta es una variable necesaria. Si no se especifica la versión de Terraform, por defecto, Schematics selecciona la versión de su plantilla.
description Opcional Especifique las etiquetas que quiera asociar con el espacio de trabajo. Las etiquetas pueden ayudarte a encontrar más rápidamente tu espacio de trabajo.
resource_group Opcional Especifique el grupo de recursos en el que quiere suministrar el espacio de trabajo.
workspace_status Opcional Bloquee o desbloquee un espacio de trabajo. Si un espacio de trabajo está bloqueado, los cambios en el espacio de trabajo están inhabilitados.
template_repo.url Opcional Especifique el URL al repositorio GitHub o GitLab donde se almacenan los archivos de configuración de Terraform.
template_repo.branch Opcional Especifique la rama de GitHub o GitLab donde se almacenan los archivos de configuración de Terraform. Ahora, en el repositorio de plantillas, también puede actualizar URL con más parámetros como se muestra en el bloque.
template_repo.datafolder Opcional Especifique el nombre de la carpeta en el repositorio Git, que contiene la plantilla.
template_repo.release Opcional Especifique el release de GitHub o GitLab que apunta a los archivos de configuración de Terraform.
github_source_repo_url Opcional Especifique el enlace al repositorio GitHub. El enlace puede hacer referencia a la ramificación master, a cualquier otra ramificación o a un subdirectorio.
template_data.folder Opcional Especifique el nombre de la variable de entrada que haya declarado en los archivos de configuración de Terraform.
template_data.type Opcional Introduzca el nombre para el tipo de variable de entrada que declaró en sus archivos de configuración de Terraform.
template_data[0].env_values[i].va11 Opcional Una lista de variables de entorno que desea aplicar durante la ejecución de un script bash o un trabajo de Terraform. Este campo se debe proporcionar como una lista de pares de clave-valor, por ejemplo, TF_LOG=debug. Cada entrada es una correlación con una entrada donde la clave es el nombre de la variable de entorno y el valor es el valor.
template_data[0].env_values[i].val2 Opcional Una lista de variables de entorno que desea aplicar durante la ejecución de un script bash o un trabajo de Terraform. Este campo se debe proporcionar como una lista de pares de clave-valor, por ejemplo, TF_LOG=debug. Cada entrada es una correlación con una entrada donde la clave es el nombre de la variable de entorno y el valor es el valor.
template_data[0].env_values_metadata Opcional Metadatos de variables de entorno.
template_data[0].variablestore[i].name Opcional Especifique el nombre de la variable de entrada que haya declarado en los archivos de configuración de Terraform.
template_data[0].variablestore[ii].type Obligatorio Terraform v0.12 admite string, list, map, bool, number y tipos de datos complejos como list(type), map(type), object({attribute name=type,..}), set(type), tuple([type]).
template_data[0].variablestore[iii].value Opcional Indique el valor como serie para los tipos primitivos, como formato bool, number, string y HCL para las variables complejas, tal como lo proporciona en un archivo .tfvars. Puede sustituir los valores predeterminados de .tfvars definiendo el parámetro use_default en true. Debe indicar la serie con caracteres de escape del formato HCL para el valor, como se muestra en el ejemplo. Para obtener más información sobre cómo declarar variables en un archivo de configuración de Terraform y proporcionar valor a los esquemas, consulte Uso de variables de entrada para personalizar recursos y ejemplo de almacén de variables
template_data[0].variablestore[iv].secure Opcional Defina el parámetro secure en true. De forma predeterminada, este parámetro se establece en false.
template_data[0].variablestore[v].use_default Opcional Defina el parámetro use_default en true para sustituir el parámetro predeterminado .tfvars. De forma predeterminada, este parámetro se establece en false.
github_source_repo_url Opcional Especifique el enlace al repositorio GitHub. El enlace puede hacer referencia a la ramificación master, a cualquier otra ramificación o a un subdirectorio.

Ejemplo de almacén de variables

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

Ejemplo

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

ibmcloud schematics workspace update variables

IBM Cloud Schematics está dejando obsoletas las versiones anteriores de Terraform e introduciendo soporte para la versión más reciente de Terraform. Para obtener más información, consulte Schematics Terraform deprecation lifecycle and the Deprecation Schedule.

Actualizar variables permite actualizar una o varias variables de entrada de un espacio de trabajo existente. No puede actualizar las variables de metadatos del espacio de trabajo, como el nombre o URL control de origen. Para suministrar o modificar IBM Cloud, consulte el mandato ibmcloud schematics plan.

Sintaxis

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

Opciones de comando

Schematics distintivos de actualización de espacio de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea actualizar la instancia o recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--file o -f Obligatorio La ruta relativa a un archivo JSON en su máquina local que incluye los parámetros actualizados para sus variables de espacio de trabajo a actualizar. Para obtener más información sobre el archivo JSON de muestra con los detalles, consulte Plantilla de actualización del archivo JSON.
--template o -tid Obligatorio Introduzca el ID de la plantilla. Utilice ibmcloud schematics workspace get para obtener el ID de la plantilla.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo de valores variables de tienda y entorno

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

Ejemplo

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

ibmcloud schematics workspace upload

Proporcionar la plantilla de Terraform cargando un archivo de archivado de cinta (.tar) en su espacio de trabajo Schematics. .tar admite los comandos Cloud Shell.

Antes de empezar, asegúrese de que ha creado el espacio de trabajo sin un enlace a un repositorio GitHub o GitLab.

Sintaxis

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

Opciones de comando

Schematics espacios de trabajo cargan distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo donde desea cargar el archivo de archivado de cinta (.tar). Para buscar el ID del espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--file o -f Obligatorio Especifique la vía de acceso completa en la máquina local donde se almacena el archivo .tar.
--template o -tid Obligatorio El identificador exclusivo de la plantilla de Terraform para la que desea mostrar el contenido del archivo de estado de Terraform. Para buscar el ID de la plantilla, ejecute ibmcloud schematics workspace get --id <workspace_ID> y busque el ID de plantilla en el campo Variables de plantilla para: de la salida de línea de mandatos.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

Cree el archivo TAR del repositorio de plantillas con el mandato TAR proporcionado tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER

Ejemplo del valor de la variable

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

Mandatos de trabajo de espacio de trabajo

Ejecutar operaciones de Schematics, para crear, actualizar y eliminar recursos de la nube. Utilizando la semántica familiar de Terraform, planifique, aplique y destruya espacios de trabajo de Terraform para gestionar el ciclo de vida de los recursos de nube.

ibmcloud schematics apply

Cuando se aplica una plantilla Terraform al espacio de trabajo, los recursos se aprovisionan, modifican o eliminan de IBM Cloud. Los archivos temporales creados durante la operación de aplicación pueden conservarse para futuras operaciones.

Su área de trabajo debe estar en estado Inactivo, Activo, Fallido o Detenido para realizar una operación de aplicación de Schematics. Para obtener más información sobre los estados del espacio de trabajo, consulte diagrama de estado del espacio de trabajo.

Mientras los trabajos de Terraform están en ejecución, el espacio de trabajo está bloqueado y no se pueden realizar cambios en el espacio de trabajo hasta que se complete la ejecución.

Sintaxis

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

Opciones de comando

Schematics aplicar distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo que hace referencia a la plantilla de Terraform en el repositorio de control de origen que desea aplicar en IBM Cloud. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--target o -t Opcional Define como objetivo la creación de un recurso específico del archivo de configuración de Terraform especificando la dirección del recurso de Terraform, como ibm_is_instance.vm1. El resto de recursos definidos en el archivo de configuración no se crean ni actualizan. Para apuntar a la creación de varios recursos, utilice la siguiente sintaxis: --target <resource1> --target <resource2>. Si el recurso objetivo especifica el atributo count y no se ha especificado ningún índice en la dirección del recurso, como ibm_is_instance.vm1[1], el objetivo de la creación serán todas las instancias que comparten el mismo nombre de recurso.
--var-file o --vf Opcional La vía de acceso al archivo terraform.tfvars que ha creado en su máquina local. Utilice este archivo para almacenar información confidencial, como la clave o las credenciales de la API de IBM Cloud para conectarse a la infraestructura clásica de IBM Cloud en el formato <key>=<value>. Las variables deben definirse en formato de una sola línea, por ejemplo, como availability_zone_names = ["us-east-1a","us-west-1c"]. Todos los pares de clave-valor que se definen en este archivo se cargan automáticamente en Terraform al inicializar la CLI de Terraform. Para especificar varios archivos tfvars, especifique --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--force o -f Opcional Forzar la ejecución de este mandato sin solicitudes de usuario.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics destroy

Elimine los recursos de Nube que aprovisionó utilizando su espacio de trabajo Schematics, incluso si estos recursos están activos. Por defecto, el comando lista todos los recursos a previsualizar y luego recibe la confirmación para destruirlos. Si utiliza la bandera --force or -f en el comando destroy, no podrá ver la vista previa de los recursos que desea destruir.

Utilice este mandato con precaución. Después de ejecutar el comando, no podrá revertir la eliminación de sus recursos Cloud. Si ha escrito datos en almacenamiento o bases de datos suministrados, asegúrese de crear una copia de seguridad para que los datos persistan

Su espacio de trabajo debe estar en estado Activo, Error, o Detenido para poder llevar a cabo una acción de destrucción de Schematics.

Sintaxis

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

Opciones de comando

Schematics destruir distintivos
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador único del espacio de trabajo que apunta a la plantilla de Terraform en su repositorio de origen que especifica los recursos de Cloud que desea eliminar. Para averiguar el ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--target o -t Opcional Define como objetivo la supresión de un recurso específico especificando la dirección del recurso de Terraform, como ibm_is_instance.vm1. El resto de los recursos del espacio de trabajo no sufren ningún cambio. Para definir como objetivo la supresión de varios recursos, utilice la siguiente sintaxis: --target <resource1> --target <resource2>. Si el recurso objetivo especifica el atributo count y no se ha especificado ningún índice en la dirección del recurso, como ibm_is_instance.vm1[1], el objetivo de la supresión serán todas las instancias que comparten el mismo nombre de recurso. Además, si el recurso objetivo sólo puede suprimirse si se suprimen los recursos dependientes (por ejemplo, una nube privada virtual sólo puede suprimirse si se suprime la subred adjunta), dichos recursos dependientes serán también objetivo de la supresión.
--force o -f Opcional Forzar la ejecución de este mandato sin solicitudes de usuario. No puede ver la vista previa de los recursos que desea destruir.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics logs

Recupere los archivos de registro de Terraform para el espacio de trabajo Schematics o un ID de acción de espacio de trabajo específico. Puede utilizar los archivos de registro para resolver problemas relacionados con las plantillas de Terraform o problemas que se produzcan durante el proceso de suministro, modificación o supresión de recursos.

Sintaxis

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

Opciones de comando

Schematics
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea recuperar los archivos de registro de Terraform. Para averiguar el ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--act-id o -1 Opcional El ID de una acción para la que desea recuperar los archivos de registro de Terraform. Para obtener una lista de ID de acción, ejecute el mandato ibmcloud schematics workspace action --id WORKSPACE_ID.

Ejemplo

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

ibmcloud schematics output

Recupere los valores de salida de Terraform para el espacio de trabajo. Puede definir valores de salida en su plantilla Terraform para incluir datos que desee hacer accesibles a otros espacios de trabajo.

Sintaxis

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

Opciones de comando

Schematics distintivos de salida
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea listar los valores de salida de Terraform. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

ibmcloud schematics plan

Escanee la plantilla Terraform en su repositorio de origen y compare esta plantilla con los recursos Cloud que ya están desplegados. La salida de comando muestra los recursos de la nube que deben añadirse, modificarse, persistir o eliminarse para alcanzar el estado descrito en el archivo de configuración.

Su espacio de trabajo debe estar en estado Inactivo, Activo, Error, o Detenido para poder llevar a cabo una acción de planificación de Schematics.

Durante la creación del plan de ejecución de Terraform no puede realizar cambios en el espacio de trabajo.

Sintaxis

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

Opciones de comando

Schematics distintivos de salida
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo que hace referencia a la plantilla de Terraform en su repositorio de origen que desea explorar. Para averiguar el ID de un espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--var-file o --vf Opcional La vía de acceso al archivo terraform.tfvars que ha creado en su máquina local. Utilice este archivo para almacenar información confidencial, como la clave o las credenciales de la API de IBM Cloud para conectarse a la infraestructura clásica de IBM Cloud en el formato <key>=<value>. Las variables deben definirse en formato de una sola línea, por ejemplo, como availability_zone_names = ["us-east-1a","us-west-1c"]. Todos los pares de clave-valor que se definen en este archivo se cargan automáticamente en Terraform al inicializar la CLI de Terraform. Para especificar varios archivos tfvars, especifique --var-file TFVARS_FILE_PATH1 --var-file TFVARS_FILE_PATH2.
--output o -o Opcional Devuelve la salida de línea de mandatos en formato JSON. Actualmente solo se admite el formato de archivo JSON.

Ejemplo

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

Mandatos de detención de espacio de trabajo

Después de invocar un trabajo de espacio de trabajo, como un plan, un apply o un destroy, es posible que desee detener el trabajo en ejecución o detener el suministro de recursos. Al detener o cancelar un trabajo de larga ejecución, es aconsejable comprobar primero los registros de trabajo para determinar si el trabajo está realmente atascado y necesita detenerse, o si está realizando operaciones de larga ejecución que tardan tiempo en completarse.

Schematics proporciona una serie de opciones para permitir a los usuarios (gracefully) stop, force-stop, o terminate el trabajo en ejecución en orden de inmediatez e impacto de la operación de parada.

Revise los mandatos para los trabajos (gracefully) stop, force-stop o terminate.

ibmcloud schematics workspace job stop

Detiene un trabajo de espacio de trabajo en ejecución enviando una señal de interrupción a Terraform para finalizar la ejecución.

Sintaxis

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

Opciones de comando

Schematics distintivos de detención de trabajo
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID de espacio de trabajo que debe actualizarse.
--job-id o --jid Obligatorio El ID de trabajo del trabajo.
--stop, Opcional Elimina el trabajo de la cola de pendientes.
--force-stop o --fs Opcional Envía una señal de kill a la ejecución de Terraform en el motor, también intenta detener inmediatamente la ejecución.
--terminate o -t Opcional Termina abruptamente el motor, marca el trabajo como detenido y desbloquea el espacio de trabajo. Los datos no se guardan utilizando esta bandera.

Ejemplo

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>

Mandatos de archivo de estado de espacio de trabajo

Revise los mandatos que puede utilizar para trabajar con el archivo de estado de Terraform (terraform.tfstate) para un espacio de trabajo.

Puede importar un archivo de estado de Terraform existente durante la creación del espacio de trabajo. Para obtener más información, consulte el mandato ibmcloud workspace new.

ibmcloud schematics state pull

Mostrar el contenido del archivo de estado de Terraform (terraform.tfstate) para una plantilla de Terraform específica del espacio de trabajo.

Sintaxis

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

Opciones de comando

Schematics distintivos de extracción de estado
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID exclusivo del espacio de trabajo en el que desea ejecutar los mandatos.
--template o --tid Obligatorio El identificador exclusivo de la plantilla de Terraform para la que desea mostrar el contenido del archivo de estado de Terraform. Para buscar el ID de la plantilla, ejecute ibmcloud schematics workspace get --id <workspace_ID> y busque el ID de plantilla en el campo Variables de plantilla para: de la salida de línea de mandatos.

Ejemplo

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

ibmcloud schematics workspace state show

Proporciona la salida legible de un estado o plan de un espacio de trabajo tal como lo ve Terraform. Puede utilizar para garantizar el estado actual y el estado de las operaciones planificadas. Debe utilizar el ID de espacio de trabajo para recuperar los registros utilizando el mandato ibmcloud schematics logs.

Sintaxis

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

Opciones de comando

Schematics distintivos de extracción de estado
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID exclusivo del espacio de trabajo que se va a actualizar.
--address o -adr Obligatorio Especifique la dirección que apunta a un único recurso en el estado que se va a mostrar.
--options o -o Opcional Especifique los distintivos de línea de mandatos.

Ejemplo

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

ibmcloud schematics workspace state mv

Si mueve el estado de un recurso dentro del archivo de estado. El espacio de trabajo continúa funcionando, pero la siguiente operación de planificación o aplicación no encontrará el recurso o la instancia en el archivo de estado. Si no se realizan cambios en la plantilla, puede ver la recreación del recurso en la siguiente operación por parte de Terraform.

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

Opciones de comando

Schematics distintivos de movimiento de estado
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID exclusivo del espacio de trabajo del que desea mover una instancia o un recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--source o -s Obligatorio Especifica la dirección de origen de un elemento a mover.
--destination o -d Obligatorio Proporciona la dirección de destino de un elemento.

Ejemplo

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

ibmcloud schematics workspace state rm

Si elimina el estado de un recurso o instancia dentro del archivo de estado. El espacio de trabajo continúa funcionando, pero la siguiente operación de planificación o aplicación no encontrará el recurso o la instancia en el archivo de estado. Si no se realizan cambios en la plantilla, puede ver la recreación del recurso en la siguiente operación por parte de Terraform.

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

Opciones de comando

Schematics distintivos de eliminación de estado
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El identificador exclusivo del espacio de trabajo para el que desea eliminar una instancia o un recurso. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--options o -o Opcional Especifique el distintivo de opción que desea eliminar.
--address o -adr Obligatorio Escriba la dirección del recurso a marcar como marcado.

Ejemplo

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

Mandatos de Terraform de espacio de trabajo

Puede ejecutar comandos Terraform para manipular los recursos de la nube y modificar el estado de Schematics.

Los mandatos Terraform de espacio de trabajo no están soportados en la interfaz de usuario.

La tabla proporciona el resumen de los mandatos de espacio de trabajo de Terraform soportados.

Resumen de mandatos de Terraform
Mandato Descripción
show Inspecciona el estado o el plan de Terraform.
output Lee una salida de un archivo de estado de Terraform.
import Importa una infraestructura existente en Terraform.
taint Marcar un recurso para que se vuelva a crear.
untaint No marcar un recurso como marcado.
state Un mandato de gestión de estado avanzada para escribir submandatos para eliminar o mover rm && mv.

Mandatos de Terraform

Los mandatos de Terraform se ejecutan utilizando un archivo JSON para especificar entradas.

Sintaxis

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

Opciones de comando

Schematics distintivos de mandatos de Terraform
Distintivo Obligatorio / Opcional Descripción
--id o -i Obligatorio El ID exclusivo del espacio de trabajo en el que desea ejecutar los mandatos. Para averiguar el ID de su espacio de trabajo, ejecute el mandato ibmcloud schematics workspace list.
--file o --f Obligatorio Vía de acceso al archivo JSON que contiene la lista de mandatos de Terraform.

Ejemplo de carga útil del archivo Test.JSON

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

La tabla proporciona la lista de parámetros clave del archivo JSON para la API Commands, para la línea de mandatos y la API.

Lista de parámetros clave
Clave Obligatorio / Opcional Descripción
command Obligatorio Especifique el mandato. Los mandatos admitidos son show, taint, untaint, state, import, output.
command_params Obligatorio Los parámetros de dirección para el nombre de mandato para CLI, como por ejemplo el nombre de recurso y la vía de acceso absoluta del nombre de archivo. Para la API, debe enviar el indicador de opción y el parámetro de dirección en command_params.
command_name Obligatorio El nombre del bloque de mandatos.
command_desc Opcional El texto que describe el bloque de mandatos.
command_onError Opcional Instrucción para continuar o cancelar en caso de que se produzca un error en el mandato.
command_dependsOn Opcional Dependencia de los mandatos anteriores.
command_status No necesario Muestra el estado ejecutado por el mandato, que puede ser success o failure

Ejemplo

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

Historial de versiones de CLI

Encuentre un resumen de los cambios para cada versión del plugin de CLI de Schematics. Asegúrese de mantener la CLI actualizada para que pueda utilizar todos los mandatos disponibles y sus opciones.

Historial de versiones de la línea de comandos
Versión Fecha del release Cambios
1.12.29 27 de octubre de 2025 El plugin CLI Schematics introduce credenciales y variables multihost durante la creación y actualización de inventarios. Esta actualización agiliza el proceso de gestión de los detalles de autenticación y los ajustes de configuración de numerosos sistemas de destino, lo que garantiza una experiencia de automatización más eficaz y segura.
1.12.28 1 de agosto de 2025 Schematics Plugin CLI para actualizar subespacios de nombres y subcomandos en los metadatos.
1.12.27 31 de julio de 2025 Schematics El plugin CLI es compatible con la región de Montreal(ca-mon).
1.12.26 07 de abril de 2025 El complemento CLI Schematics mejoró la vista previa de destrucción de esquemas de IBMCloud, se actualizó una imagen base de canalización y se corrigió nil pointer exception en las operaciones de acción crear, acción actualizar y acción obtener de esquemas de IBM Cloud.
1.12.25 10 de enero de 2025 Schematics El plugin CLI es compatible con el comando CLI ibmcloud schematics workspace update variables para actualizar sólo las variables de entrada necesarias para un espacio de trabajo existente. También mejora el comando ibmcloud schematics destroy con la función de vista previa para enumerar todos los recursos de trabajo con confirmación. Los comandos get IBM Cloud Schematics espacio de trabajo, una acción, y un agente obtienen el CRN de encriptación y el estado de encriptación como IBM Default o BYOK o KYOK detalles.
1.12.24 8 de julio de 2024 Schematics CLI plugin corrige el apoyo a los puntos finales de destino de Toronto a través de ' ca-tor región.
1.12.23 11 de junio de 2024 el plugin CLI Schematics ' mejora la visualización del formato de archivo ' terraform.tfvars durante el uso del argumento ' --var-file ' en los comandos ' ibmcloud workspace aplicar y ' plan de espacio de trabajo ibmcloud '. Se actualiza el soporte para la traducción de InternacionalizaciónI18n).
1.12.22 30 de mayo de 2024 Schematics CLI plugin soporta ' ibmcloud schematics agent destroy para destruir los recursos de despliegue. Y establezca el parámetro ' --force ' a true para eliminar todos los flujos de agentes para mantener la destrucción paralela al flujo de destrucción del espacio de trabajo.
1.12.21 19 de abril de 2024 Schematics CLI plugin deprecates ' --json flag in all the CLI commands. También se ha corregido el error de depreciación de ' CLI v1.12.20 ' en los comandos CLI ' ibmcloud schematics workspace refresh o plan.
1.12.20 25 de marzo de 2024 Schematics El plugin CLI soporta Red Hat OpenShift {{site {{site.data.keyword.containershort_notm}}.
1.12.18 08 de marzo de 2024 Visualización del mensaje de advertencia de depreciación de Terraform durante los comandos del espacio de trabajo utilizando menos de ' terraform_v1.5, Se elimina el soporte para la actualización de la infraestructura del agente, y se corrige el error ' index out of range ' al utilizar el comando ' ibmcloud schematics state list '.
1.12.17 14 de febrero de 2024 la instalación del plug-in 'Schematics ' admite los comandos ' Cloud Shell, y ' ibmcloud schematics workspace upload ' admite ahora los comandos ' Cloud Shell '.
1.12.16 7 de febrero de 2024 ibmcloud schematics workspace list admite el almacenamiento en caché de las versiones de la API. terraform_v1.2 terraform_v1.3, terraform_v1.4 mensaje de desaprobación se rellenan para crear las ibmcloud schematics workspace new plantillas.
1.12.15 24 de enero de 2024 Soporte para ' refresh_token ' en la petición API de actualización de agente, mejorado el soporte de versión para el comando de actualización de agente.
1.12.14 10 de enero de 2024 Se han añadido nuevos comandos y traducciones para el agente y la política. Se ocultan los espacios de trabajo del sistema de la salida del comando de lista de espacios de trabajo. Mejora de la visualización del trabajo del agente en la salida de comandos. Utilización de la API ' /v1/versions ' para las versiones de los agentes.
1.12.12 17 de septiembre de 2023 Schematics Creación y actualización de agentes añadidas con un new flag --metadata y una corrección de errores para configurar un tiempo de espera HTTP para la solicitud.
1.12.10 22 de mayo de 2023 Schematics Actualización de agente y correcciones de errores de comando ' agent list ' para establecer los errores de tiempo de ejecución.
1.12.9 6 de abril de 2023 Schematics Los comandos CLI de agente beta-1 y política se han mejorado para incluir el ' -target-file, y el ' output de plan de agente, aplicar agente y salud de agente.
1.12.8 22 mar 2023 los comandos CLI "Schematics Agente " beta-1 y ' política ' están disponibles en la región ' us-south, ' us-east, ' eu-de, ' eu-gb.
1.12.7 07 feb 2023 Corrección de errores para desactivar " API_AGENT_ATTACHMENT en la región " us-south, " us-east, " eu-de, " eu-gb.
1.12.6 30 de enero de 2023 Soporte mejorado de entradas complejas a través del archivo ' yaml '. Correcciones relacionadas con la salida de estado, índice fuera de rango para la salida de la acción del espacio de trabajo, problema con el token de actualización para ejecuciones largas y correcciones de pánico del spinner.
1.12.5 18 dic 2022 El uso del subcomando, y el soporte para especificar entradas complejas a través de un archivo YAML local utilizando la opción ' -input-file.
1.12.3 18 de noviembre de 2022 Corregido el soporte de uso del subcomando ' source type.
1.12.3 3 de noviembre de 2022 Comandos CLI mejorados, con la última actualización del SDK, y actualización del comando de acción del espacio de trabajo.
1.12.2 11 ago 2022 Incluido ' --output bandera y correcciones de errores para los comandos en y publicado Schematics v1.12.2 plug-in.
1.12.1 26 de julio de 2022 Incorporados los comandos de errores y correcciones en Schematics.
1.12.0 11 de julio de 2022 Compatibilidad con comandos agents en Schematics desde comando.
1.11.1 8 de julio de 2022 Soporte para solucionar el problema de traducción en Schematics desde la línea de comandos.
1.10.0 5 de mayo de 2022 Soporte para stop, force-stop y terminate en Schematics desde la línea de mandatos.
1.9.0 25 de abril de 2022 Soporte para la detección de Drift en Schematics desde la línea de mandatos.
1.8.1 17 de abril de 2022 Corrige el mensaje de visualización del alias de desuso para la salida JSON de Schematics.
1.8.0 13 de marzo de 2022 Permite pasar los archivos " .tfvars " y " .json " al comando planificar y aplicar. La utilización del comando ' ibmcloud terraform ' muestra un mensaje de advertencia. La versión también admite puntos finales privados " Schematics " a través de la línea de comandos y mejora la salida de la vista tabular para enumerar el recurso aprovisionado en el espacio de trabajo " Schematics.
1.7.3 4 de marzo de 2022 Da soporte a pasar archivos vars al mandato de plan de línea de mandatos, visualiza commit ID en el mandato ibmcloud schematics workspace get y edita la descripción de mandato de ibmcloud schematics workspace state show.
1.7.2 17 de febrero de 2022 Da soporte a los binarios de plataforma Linux™ arm64 y Mac OS arm64. Se publican los arreglos relacionados con la corriente stdout/stderr, el archivo TF vars no válido y la traducción.
1.7.1 11 de febrero de 2022 Soporte para el registro de rastreo y las pruebas de integración añadidas para algunos mandatos. Correcciones para actualizar ' env values metadata, pánico por banderas inválidas, y ' ibmcloud schematics workspace output command ' no está disponible.
1.7.0 12 de enero de 2022 Muestra el mensaje de desuso de Terraform v11.0 después de la ejecución del mandato. Arreglo del alias de línea de mandatos. Se elimina el aspecto de las series duplicadas. Soporte al tiempo global en el archivo de registro.
1.6.2 2 de diciembre de 2021 Soporte para traducciones en idiomas distintos al inglés. Arreglo del mandato de aplicación --var-file y el argumento de acciones --target not setting. Corregir una vulnerabilidad de la tubería.
1.6.1 21 de octubre de 2021 Da soporte a acciones winrm para Schematics. Añadido el valor de la opción ' --inventory-connection-type, ' --bastion-credential-json y ' --credential-json ' a las actualizaciones de crear y configurar. Traducciones de otros idiomas distintos al inglés actualizadas para la línea de mandatos. Corregida la duplicación de la visualización del argumento ' command-object en el modo interactivo ' ibmcloud schematics jobs run '.
1.6.0 29 de septiembre de 2021 Soporte para binarios linux-ppc64le y linux-s390x. Muestra " Terraform v1.0 " en el panel de detalles. Mostrar mensaje de eliminación de ' Terraform v0.11 ' en la página del espacio de trabajo Schematics. Se ha corregido el mandato de lista de consulta de recursos que devuelve los valores como una serie vacía.
1.5.12 02 de septiembre de 2021 Suprimir mensaje de estado para el distintivo --output json.
1.5.11 27 de agosto de 2021 Se ha añadido un indicador --pull-latest al comando actualización del espacio de trabajo existente. Problema solucionado. Se han arreglado las traducciones del entorno local.
1.5.10 11 de agosto de 2021 Admite Terraform v0.15. Se han arreglado las traducciones del entorno local.
1.5.9 13 de julio de 2021 Se han arreglado las traducciones del entorno local.
1.5.8 08 de julio de 2021 Corregida la ruta de la API de conjuntos de datos compartidos. Comandos de conjuntos de datos compartidos desactivados.
1.5.7 04 de junio de 2021 Se ha mejorado mandato ibmcloud schematics state list para mostrar como datos tabulares con un nuevo estado de columna taint. Se ha arreglado el mandato ibmcloud schematics job run con la descripción de distintivo --input. Se ha arreglado el mandato ibmcloud schematics job run con la descripción de distintivo --output json. Se ha arreglado el mandato ibmcloud schematics action update con el distintivo --credentials y las traducciones del entorno local.
1.5.6 03 de junio de 2021 Se ha actualizado el mandato ibmcloud schematics workspace new para dar soporte a Terraform v0.14 y a las traducciones de entorno local.