安装 IBM Cloud CLI。

打算经常使用命令行？ 请尝试 为IBM Cloud命令行启用 shell 自动完成功能（仅限 Linux/MacOS）。

登录到 IBM Cloud CLI。 根据提示，输入您的 IBM Cloud 凭证。

ibmcloud login

如果您有联合标识，请使用 ibmcloud login --sso 登录到 IBM Cloud CLI。 输入用户名，并在命令行输出中使用提供的 URL 获取一次性密码。 如果不使用 --sso 时登录失败，而使用 --sso 选项时登录成功，说明您拥有的是联合标识。

为 Schematics安装 IBM Cloud 命令行插件。

ibmcloud plugin install schematics

验证 IBM Cloud Schematics 命令行插件是否安装成功。 此插件列示为 schematics。

ibmcloud plugin list

示例输出

Listing installed plug-ins...

Plugin Name                             Version      Status             Private endpoints supported   
schematics[sch]                           1.12.28   Update Available                     true  

列出所有支持的命令，确认可以使用 Schematics 命令行插件。 使用 Schematics 命令行插件的命令前缀是 ibmcloud schematics。

ibmcloud schematics help

示例输出

NAME:
ibmcloud schematics - Automate the deployment and management of IBM Cloud resources using Infrastructure as Code

USAGE:
ibmcloud schematics command [arguments...] [command options]

COMMANDS:
action, ac           Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables.
agent, ag            Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents.
apply                Apply a plan to an workspace to deploy the latest version of your configuration.
destroy              Destroy resources in an existing workspace. This action cannot be reversed.
inventory, iv        Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's
job, j               Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving.
kms                  listing and enabling IBM Cloud Schematics kms instances and root keys.
logs                 Show details about actions that ran against an workspace.
output               Get all the output values from your workspace; (ex. result of terraform output command
plan                 Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration.
policy, plcy         Create and manage policies. Policies tell Schematics which agent it should use to execute Terraform and Ansible jobs in a specific network zone.
refresh              Refresh the workspace with latest version of your workspace configuration.
resource-query, rq   Create and manage Schematics Resource Query. Resource query let you define conditions to fetch host group that can be used to perform actions
state                Advanced state management
version              Report version information about the IBM Cloud Schematics CLI.
workspace, ws        Create and manage workspaces. Workspaces let you define the source control repository that contains your Terraform configuration and pass workspace-specific variables.
help, h              Show help

Enter 'ibmcloud schematics help [command]' for more information about a command.

更新 IBM Cloud CLI。

登录到 IBM Cloud CLI。 根据提示，输入您的 IBM Cloud 凭证。

ibmcloud login

如果您有联合标识，请使用 ibmcloud login --sso 登录到 IBM Cloud CLI。 输入用户名，并在命令行输出中使用提供的 URL 获取一次性密码。 如果不使用 --sso 时登录失败，而使用 --sso 选项时登录成功，说明您拥有的是联合标识。

检查 Schematics 命令行插件是否有更新。 如果更新可用，则会在命令行输出中显示“**更新可用 **”通知。

ibmcloud plugin list | grep schematics

示例输出

schematics                      1.12.28        Update Available           false

更新 Schematics 命令行插件。

对于 Schematics 代理程序，Schematics 插件版本必须大于 1.12.12 版本。

ibmcloud plugin update schematics

ibmcloud plugin list | grep schematics

示例输出

schematics[sch]                      1.12.28        true

显示 Schematics 插件。

ibmcloud plugin show schematics

示例输出

Plugin Name                              schematics[sch]
Plugin Version                           1.12.28
Plugin SDK Version                       1.7.3
Minimal IBM Cloud CLI version required   0.15.1
Private endpoints supported              true

Commands:
schematics,sch                                 Automate the deployment and management of IBM Cloud resources using Infrastructure as Code
schematics,sch plan                            Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration.
schematics,sch version                         Report version information about the IBM Cloud Schematics CLI.
schematics,sch logs                            Show details about actions that ran against an workspace.
schematics,sch output                          Get all the output values from your workspace; (ex. result of terraform output command
schematics,sch destroy                         Destroy resources in an existing workspace. This action cannot be reversed.
schematics,sch refresh                         Refresh the workspace with latest version of your workspace configuration.
schematics,sch apply                           Apply a plan to an workspace to deploy the latest version of your configuration.
schematics,sch job,j                           Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving.
schematics,sch job,j run                       Run a job in IBM Cloud Schematics to work with your Schematics entities like workspaces/actions.
schematics,sch job,j get                       Get information about a job.
....
schematics,sch workspace,ws upload             Upload a tar file to a workspace from the IBM Cloud Schematics service.
schematics,sch workspace,ws commands           Run one or more terraform commands
schematics,sch workspace,ws taint              Marks a Terraform-managed resource as tainted, forcing it to be destroyed and recreated on the next apply
schematics,sch workspace,ws untaint            Unmarks a Terraform-managed resource as tainted, restoring it as the primary instance in the state
schematics,sch workspace,ws state              Advanced state management
schematics,sch workspace,ws import             Run a job to import existing resources into workspace
schematics,sch inventory,iv                    Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's
schematics,sch inventory,iv create             Create an Inventory in IBM Cloud Schematics to pass to Schematics action for target host groups
schematics,sch inventory,iv update             Update an Inventory in IBM Cloud Schematics with all new detail
schematics,sch inventory,iv get                Get information about an inventory
schematics,sch inventory,iv list               List all existing inventories in targeted account
schematics,sch inventory,iv delete             Delete an inventory from the IBM Cloud Schematics service
schematics,sch agent,ag                        Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents.
schematics,sch agent,ag create                 Create an agent in IBM Cloud Schematics.
schematics,sch agent,ag validate,plan          Run validate to create a prerequisite scan that analyses agent and cluster configuration before deploying your agent.
schematics,sch agent,ag deploy,apply           Run deploy to deploy your agent on the configured cluster.
schematics,sch agent,ag get                    View the details of an agent.
schematics,sch agent,ag list                   List all agents in your IBM Cloud account.
schematics,sch agent,ag update                 Update your agent details. Updating agent does not re-validate or re-deploy your agent.
schematics,sch agent,ag health                 Run health to perform a health check on your deployed agent.
schematics,sch agent,ag delete                 Delete an agent.
schematics,sch agent,ag destroy                Destroy the resources associated with agent deployment
schematics,sch action,ac                       Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables.
schematics,sch action,ac create                Create an action in IBM Cloud Schematics to work with your Ansible configuration in source control.
schematics,sch action,ac get                   Get information about an action.
schematics,sch action,ac list                  List all existing actions in this account.
schematics,sch action,ac delete                Delete an action from the IBM Cloud Schematics service.
schematics,sch action,ac update                Update the details of an existing action.
schematics,sch action,ac upload                Upload TAR file to an action from the IBM Cloud Schematics service

卸载 Schematics的 IBM Cloud 命令行插件。

ibmcloud plugin uninstall schematics

示例输出

Uninstalling plug-in 'schematics'...
OK
Plug-in 'schematics' was successfully uninstalled.

验证 IBM Cloud Schematics 命令行插件是否已成功卸载。

ibmcloud plugin list | grep schematics