IBM Cloud Schematics CLI

ibmcloud schematics action create

単一のターゲットホストまたはターゲットホストグループに対して Ansible playbook を実行するアクションを作成します。 クラウド操作の実行や、クラウド・リソースへのソフトウェアのインストールは、Ansible Playbook を使用して行います。 この機能を試したり、始めるには、 IBM- Ansible プレイブックを提供 のいずれかを使用してください。 ペイロード・ファイルまたはコマンドの対話モードを使用して、アクションを作成することができます。

ワークスペースとアクションを作成または更新する際に、 location と url のエンドポイントが同じリージョンを指していることを確認する。 ロケーションとエンドポイントについて詳しくは、 情報の保管場所 を参照してください。

構文

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]

コマンド・オプション

例

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

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

ibmcloud schematics action create --file sample.json

ibmcloud schematics action update

action_id を使用して、既存のアクションの情報を更新します。 CLI location および url エンドポイントが、ワークスペースおよびアクションを作成または更新するリージョンを指していることを確認します。 ロケーションとエンドポイントについて詳しくは、 情報の保管場所 を参照してください。

構文

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]

コマンド・オプション

例

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

ibmcloud schematics action get

アクション ID、Name、Status、Creation Time、Encryption Status、 Encryption CRN など、既存の Schematics アクションの詳細を取得する。

構文

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

コマンド・オプション

例

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

ibmcloud schematics action list

アカウント現在の IBM Cloud 地域で定義されているすべてのアクションのリストを取得します。

構文

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

コマンド・オプション

例

ibmcloud schematics action list --profile ids

ibmcloud schematics action delete

Schematics アクションを削除します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics action upload

ローカル・ファイル・システムから IBM Cloud Schematics アクションに、テープ・アーカイブ・ファイル (.tar) をアップロードすることもできます。 .tar ファイルを格納するローカル・マシン上の絶対ファイル・パスを入力します。 tar -cvf mytestactionupload.tar $TEMPLATE_REPO_FOLDER コマンドに付与された TAR コマンドを使用して、テンプレート・リポジトリーの .tar ファイルを作成します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics job run

Schematics アクションで指定した Ansible プレイブックを実行するジョブを IBM Cloud Schematics に作成します。 ペイロード・ファイルまたはコマンドの対話モードを使用して、ジョブを作成することができます。

構文

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]

コマンド・オプション

アクションにプレイブック名が含まれている場合は、プレイブック名を追加して、アクションのプレイブック名が優先されるようにする必要があります。 ジョブを使用して Playbook 名をオーバーライドする必要がある場合は、新しい Playbook 名を使用してアクションを作成する必要があります。

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

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

ibmcloud schematics job update

既存のジョブの設定をコピーしてジョブを作成し、そのジョブを IBM Cloud Schematics で実行します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics job get

ジョブIDを使用してアクション・ジョブの詳細を取得する。

構文

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

コマンド・オプション

例

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

ibmcloud schematics job list

Schematics アクションに対して実行されたすべての Schematics ジョブのリストを取得します。 このコマンドは、ステータスが in_progress、 success、または failed のジョブのリストを表示します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics job logs

Schematics アクションジョブのログを取得する。 ジョブログの表示についての詳細は、 Schematics ジョブの詳細を確認するを 参照してください。

構文

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

コマンド・オプション

例

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

ibmcloud schematics job delete

Schematics アクションのジョブを削除します。

実行中のジョブは、削除したり停止したりすることができません。 ジョブを削除するには、ジョブが完了するまで待つ必要があります。

構文

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

コマンド・オプション

例

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

ibmcloud schematics agent create

現在選択されている Schematics 地域にエージェント登録を作成する。 エージェントは、インフラ上でTerraformや Ansible のジョブを実行するのに役立ちます。 create コマンドを使用する手順について詳しくは、 エージェントのデプロイ を参照してください。

構文

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]

コマンド・オプション

例

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

エージェントをアンインストールします。 削除コマンドを使用する手順について詳しくは、 エージェントの削除 を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent delete --id <AGENT_ID>

ibmcloud schematics agent deploy

強制デプロイするエージェントをデプロイまたはアップグレードします。 デプロイ・コマンドを使用する手順について詳しくは、 エージェントのデプロイ を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent deploy --id <AGENT_ID>

ibmcloud schematics agent destroy

エージェントを削除すると、 Schematics エージェントの展開に関連付けられたクラウドリソースが削除されます。

構文

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

コマンド・オプション

例

ibmcloud schematics agent destroy --id <AGENT_ID>

ibmcloud schematics agent get

既存のエージェントの詳細（エージェントID、名前、ステータス、バージョン、作成日時、暗号化ステータス、暗号化CRNなど）を取得します。すべての入力変数の値を含みます。 getコマンドの使用方法の詳細については、 エージェントの表示 を参照してください

構文

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

コマンド・オプション

例

ibmcloud schematics agent get --id <AGENT_ID>

ibmcloud schematics agent health

エージェントのデプロイメント後の検証を実行します。 エージェントの正常性コマンドを使用する手順について詳しくは、 エージェントの正常性のモニター を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent health --id <AGENT_ID>

ibmcloud schematics agent list

現在の Schematics 領域で定義されているエージェントをリストします。 リスト・コマンドを使用する手順について詳しくは、 エージェントの表示 を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent list --location us-south

ibmcloud schematics agent update

エージェント構成を更新します。 エージェントを更新しても、エージェントの再検証や再展開は行われません。 エージェント更新コマンドを使用する手順について詳しくは、 エージェントのデプロイ を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent update --id <AGENT_ID>

ibmcloud schematics agent validate

デプロイする前に、エージェントおよびクラスター構成を分析する前提条件スキャンを検査します。 validate コマンドを使用する手順について詳しくは、 エージェントのデプロイ を参照してください。

構文

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

コマンド・オプション

例

ibmcloud schematics agent validate --id AGENT_ID

ibmcloud schematics policy create

Schematics を使って、ワークスペースやアクションのような、ターゲットエージェントで実行する1つ以上の Schematics オブジェクトを選択して、ポリシーを作成します。

構文

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]

コマンド・オプション

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

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

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

Schematics ポリシーを削除します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics policy get

ポリシー ID を使用して、既存の Schematics ポリシーの詳細を取得します。

構文

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

コマンド・オプション

例

ibmcloud schematics policy get --id <POLICY_ID>

ibmcloud schematics policy list

アカウント IBM Cloud 地域にあるすべてのポリシーのリストを取得します。

構文

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

例

ibmcloud schematics policy list  --profile ids092030

ibmcloud schematics policy update

ポリシー ID を使用して既存のポリシーを更新します。

構文

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

例

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

開始前に

鍵管理システムが、特定の場所と地域から作成されたインスタンスをリストアップするためには、以下の前提条件が確保されていなければならない。

• BYOKかKYOKを持つべきだ。 IBM Key Protect キーを作成するには、 Key Protect インスタンスの作成を 参照のこと。 BYOKの場合はMulti-Tenant、KYOKの場合はDedicatedをお選びください。
• Schematics サービスに ルート鍵を追加 する必要があります。
• BYOKと KYOK を Schematics サービスに統合するには、サービス許可へのサービスを構成する必要があります。

KMS 設定は一回限りの設定です。 KMSの設定を更新するには、 サポートチケットを 開く必要があります。

ibmcloud schematics kms instance ls

ご使用の IBM Cloud または Key Protect を見つけるために、鍵が作成されたロケーションと暗号化スキーム (KYOK や BYOK など) を使用して、ご使用の Hyper Protect Crypto Services アカウントの KMS インスタンスをすべてリストします。

構文

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

コマンド・オプション

例

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

ibmcloud schematics kms enable

特定のロケーションのデータを KMS で暗号化できるようにします。 Schematics のお客様キーの有効化に関する詳細は、 キーの有効化を 参照のこと。

プライベート・エンドポイント、CRN、1 次 CRK、2 次 CRK を使用して、ご使用のロケーションの KMS 設定を更新します。 KMSの設定は一度しか更新できないことに注意してください。 例えば、North Americaなどの地域の API エンドポイントを使用する場合は、us-south または us-east で作成されたもののみが取得されます。

構文

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]

コマンド・オプション

例

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

KYOK または BYOK を使用する API エンドポイントの KMS を取得します。 例えば、North Americaなどの地域の API エンドポイントを使用する場合は、us-south または us-east で作成されたもののみが取得されます。 なお、 info コマンドラインを実行するには、 アカウント kms instances を有効にする必要がある。

構文

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

コマンド・オプション

例

ibmcloud schematics kms info -l US

ibmcloud schematics help

サポートされている IBM Cloud Schematics コマンド・ライン・コマンドを表示します。

構文

ibmcloud schematics help

コマンド・オプション

例

ibmcloud schematics help

ibmcloud schematics version

IBM Cloud Provider Plug-in for Terraform、 Ansible、 Helm、 Kubernetes など、 Schematics アクションをクラウド リソース上で実行するために使用される、 Schematics でサポートされているすべてのオープン ソース プロジェクトのバージョンを一覧表示します。

構文

ibmcloud schematics version [--output OUTPUT]

コマンド・オプション

例

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

ibmcloud schematics inventory create

Ansible アクションで使用する リソース・インベントリを Schematics で作成するには、ペイロード・ファイルまたは対話型モードを使用します。 インベントリには、 Ansible プレイブックを実行するすべてのターゲット・ホストが含まれます。

構文

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]

コマンド・オプション

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

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

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

}

ibmcloud schematics inventory create --file inventory.json

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

インベントリー ID を使用して、リソース・インベントリー定義を削除します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics inventory get

インベントリ ID を使用して、既存の IBM Cloud Schematics インベントリの詳細情報を取得します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics inventory list

あなたのアカウント現在の地域のすべての Schematics インベントリのリストを取得します。

構文

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

コマンド・オプション

例

ibmcloud schematics inventory list --output json

ibmcloud schematics inventory update

既存の資源目録を更新する。

構文

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]

コマンド・オプション

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

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

ibmcloud sch inventory update --file inventory_view_example.json --id us-south.INVENTORY.S1.66e00002a

ibmcloud schematics resource query create

リソース・インベントリーの作成に使用できるリソース照会を IBM Cloud Schematics で作成します。 ペイロード・ファイルまたはコマンドの対話モードを使用して、リソース照会を作成することができます。 リソース条件は、リソース照会を使用して作成できます。

構文

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]

コマンド・オプション

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

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

ibmcloud schematics resource query delete

リソース照会 ID を使用して、IBM Cloud Schematics サービスからリソース照会定義を削除します。 インベントリーの作成元のロケーションとリージョン、リソース・グループを削除できることに注意してください。 また、IP アドレスが許可リストに含まれていることも確認してください。

構文

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

コマンド・オプション

例

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

ibmcloud schematics resource query get

リソース照会 ID を使用して、既存の IBM Cloud Schematics リソース照会の情報を取得します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics resource query list

自分のアカウント現在のリージョン内のすべての Schematics リソースクエリのリストを取得します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics resource query update

リソース照会を更新または置換すると、リソース照会のコピーが作成され、既存の IBM Cloud Schematics リソース照会の情報が更新されて既存のリソース照会が再起動します。

構文

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]

コマンド・オプション

例

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

ibmcloud schematics workspace action

アクションを開始した人のユーザー ID、ステータス、タイムスタンプを含む、ワークスペースのすべてのアクティビティ (ジョブ) を取得します。

Terraformの実行プランを作成したり、 Schematics を使ってTerraformテンプレートを適用したりすると、 Schematics アクションが自動的に作成され、アクションIDが割り当てられます。 アクション ID を使用することにより、ibmcloud schematics logs コマンドを使用してこのアクションのログを取得できます。

構文

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

コマンド・オプション

例

ibmcloud schematics workspace action --id <WORKSPACE_ID>

ibmcloud schematics workspace delete

アカウントの現在のリージョンからワークスペースを削除します。 ワークスペースを削除しても、このワークスペースでプロビジョニングしたクラウド リソースは削除されません。 ワークスペースを削除した後は、IBM Cloud のダッシュボードから直接リソースにアクセスして操作することはできますが、IBM Cloud Schematics を使用してリソースを管理することはできません。

ワークスペースまたは関連リソースの一方を削除するのか、それとも両方を削除するのかを決定します。 この操作は元に戻せません。 ワークスペースを削除してリソースを保持する場合、そのリソースはリソース・リストまたは CLI で管理する必要があります。

構文

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

コマンド・オプション

例

ibmcloud schematics workspace delete --id <WORKSPACE_ID>

ibmcloud schematics workspace get

既存のワークスペースの詳細（ワークスペースID、名前、ステータス、バージョン、作成日時、テンプレートID、コミットID、暗号化ステータス、暗号化CRNなど）を取得します。これには、すべての入力変数の値が含まれます。

構文

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

コマンド・オプション

例

ibmcloud schematics workspace get --id <WORKSPACE_ID>

ibmcloud schematics workspace import

有効なリソース・アドレスを持つ既存のリソースをワークスペース状態ファイルにインポートできます。 リソースが単一のワークスペースに 1 回のみインポートされるようにする必要があります。 そうしないと、リソースが複数のワークスペースで定義されている場合に、望ましくない動作が発生する可能性があります。 import コマンドの使用方法について詳しくは、 Terraform の資料 を参照してください。

構文

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

コマンド・オプション

保存されたワークスペース変数を使用してリソースをインポートするように Schematics に指示するには、オプション -options -var-file=schematics.tfvars を使用します。

例

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

IBM Cloud アカウントの現在の地域のワークスペースをリストし、ワークスペースの詳細を表示します。 リスト・ワークスペースは、ファイル・キャッシュを介してすべてのワークスペースに対して毎回 versions API を呼び出すことにより、ループ内の非推奨をチェックします。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace new

GitHub または GitLab に、Terraform テンプレートを指す Schematics ワークスペースを作成します。 テープ・アーカイブ・ファイル (.tar) をアップロードすることによって Terraform テンプレートを提供する場合は、GitHub リポジトリーへの接続を設定せずにワークスペースを作成してから、ibmcloud schematics workspace upload コマンドを使用してテンプレートを提供します。

Schematics は、ワークスペースを作成するために .tar ファイルの受け渡しをサポートしていません。

IBM Cloud Schematics は、お客様ごとに 1 ホストにつき 1 分当たり 50 の API 要求をサポートします。 ロケーションとして、us-east、us-south、eu-gb、または eu-de のリージョンを指定できます。 コマンドを再呼び出しする前に待機する必要があります。

JSON ファイルでワークスペース設定を指定すると、ワークスペースを作成できます。 その JSON ファイルが、このコマンドで示される構造に従っているか確認します。 また、ワークスペースとアクションを作成または更新する際には、 location と url のエンドポイントが同じリージョンを指していることを確認してください。 ロケーションとエンドポイントについて詳しくは、 情報の保管場所 を参照してください。

IBM Cloud Schematics は古いバージョンのTerraformを非推奨とし、新しいバージョンのTerraformのサポートを導入する。 詳細については、 Schematics Terraform deprecation lifecycleと Deprecation Scheduleを 参照してください。

構文

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

コマンド・オプション

Schematics ibmcloud terraform コマンドを使用すると、 エイリアス 'terraform' が非推奨であるため、警告と非推奨メッセージが表示されます。 コマンドには'schematics'または'sch'を使う。

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

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

ibmcloud schematics workspace new --file example.json

ibmcloud schematics refresh

ワークスペースに対して IBM Cloud refresh アクションを実行します。 refresh アクションは、ワークスペースの Terraform 状態ファイルに保存されている状態に対して、 アカウント Cloud リソースを検証します。 相違が見つかった場合は、それに応じて Terraform 状態ファイルが更新されます。

構文

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

コマンド・オプション

例

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

ibmcloud schematics state list

Terraformのステートファイル(terraform.tfstate)にドキュメント化されているクラウドリソースの Name, Type, URL, Taint Status をリストアップします。

Taint Status は、(true) の場合は tainted、(false) の場合はブランクを返します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace taint

次回の適用時にリソースを強制的に再作成することによって、インスタンスまたはリソースを汚染されたものとして手動でマークします。 汚染により、状態ファイルが変更されますが、ワークスペース内のインフラストラクチャーは変更されません。 次の計画を実行すると、変更が再作成されたと表示され、次の適用で変更が実装されます。

リソースのテイント状況を表示するには、ibmcloud schematics state list コマンドを実行する必要があります。Taint Status は、テイント を (true)、またはブランク を (false) で返します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace untaint

手動でインスタンスまたはリソースを untaint としてマークし、次回の適用時にリソースを強制的にリストアします。 次の計画を実行すると、変更が復元されたと表示され、次の適用で変更が実行されます。

ibmcloud schematics state list コマンドを実行すると、リソースのテイント状況を表示できます。Taint Status は、テイント を (true)、またはブランク を (false) で返します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace update

IBM Cloud Schematics は古いバージョンのTerraformを非推奨とし、新しいバージョンのTerraformのサポートを導入する。 詳細については、 Schematics Terraform deprecation lifecycleと Deprecation Scheduleを 参照してください。

ワークスペース名、変数、ソース管理 URL など、既存のワークスペースの詳細情報を更新します。 IBM Cloud をプロビジョンまたは変更するには、ibmcloud schematics plan コマンドを参照してください。

IBM Cloud Schematics は、お客様ごとに 1 ホストにつき 1 分当たり 50 の API 要求をサポートします。 地域は、 us-east、 us-south、 eu-gb、または eu-de。 コマンドを再呼び出しする前に待機する必要があります。 ワークスペースとアクションを作成または更新するときに、 location と url のエンドポイントが同じリージョンを指していることを確認する。 ロケーションとエンドポイントについて詳しくは、 情報の保管場所 を参照してください。

テープ・アーカイブ・ファイル (.tar) をアップロードすることによって Terraform テンプレートを提供したときに、テンプレートを更新する場合は、ibmcloud schematics workspace upload コマンドを使用する必要があります。

構文

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

Pull-latest フラグは、IBM Cloud カタログからのテンプレートを使用して作成されたワークスペースではサポートされていません。

コマンド・オプション

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

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

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

ibmcloud schematics workspace update variables

IBM Cloud Schematics は古いバージョンのTerraformを非推奨とし、新しいバージョンのTerraformのサポートを導入する。 詳細については、 Schematics Terraform deprecation lifecycleと Deprecation Scheduleを 参照してください。

変数の更新により、既存のワークスペースの1つまたは複数の入力変数を更新することができます。 ワークスペースのメタデータ変数（名前やソース管理URL など）を更新することはできません。 IBM Cloud をプロビジョンまたは変更するには、ibmcloud schematics plan コマンドを参照してください。

構文

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

コマンド・オプション

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

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

ibmcloud schematics workspace upload

テープ・アーカイブ・ファイル (.tar) を Schematics ワークスペースにアップロードすることによって、Terraform テンプレートを提供します。 .tar は Cloud Shell コマンドをサポートしている。

始める前に、GitHub リポジトリーまたは GitLab リポジトリーへのリンクを設定せずにワークスペースを作成したことを確認します。

構文

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

コマンド・オプション

例

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

TAR が指定された TAR コマンドを使用して、テンプレート・リポジトリーの tar -cvf vpc.tar $TEMPLATE_REPO_FOLDER ファイルを作成します。

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

ibmcloud schematics apply

ワークスペースの Terraform テンプレートを適用すると、リソースのプロビジョニング、変更、 IBM Cloud からの削除が行われます。 適用操作中に作成された一時ファイルは、将来の操作のために 永続化する ことができる。

Schematics の適用操作を実行するには、ワークスペースが非アクティブ、 アクティブ、 失敗、または停止状態である必要があります。 ワークスペースの状態について詳しくは、 ワークスペースの状態遷移図 を参照してください。

Terraform ジョブの実行中は、ワークスペースはロックされ、実行が完了するまでワークスペースに変更を加えることはできません。

構文

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

コマンド・オプション

例

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

ibmcloud schematics destroy

Schematics ワークスペースを使用してプロビジョニングしたクラウド リソースを、これらのリソースがアクティブであっても削除します。 デフォルトでは、コマンドはプレビューするすべてのリソースをリストアップし、その後、破棄する確認を受け取ります。 --force or -f フラグをdestroyコマンドで使用すると、destoryしたいリソースのプレビューを確認できません。

このコマンドは注意して使用してください。 コマンドを実行した後、クラウド・リソースの削除を元に戻すことはできません。 プロビジョンされたストレージまたはデータベースにデータを書き込んだ場合は、データを永続化するためのバックアップを必ず作成してください。

Schematics destroy アクションを実行するには、ワークスペースの状態が**「アクティブ」、「失敗」または「停止」**のいずれかである必要があります。

構文

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

コマンド・オプション

例

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

ibmcloud schematics logs

Schematics ワークスペースまたは特定のワークスペースのアクションIDのTerraformログファイルを取得する。 このログ・ファイルを使用して、Terraform テンプレートの問題、またはリソースをプロビジョン、変更、削除するプロセス中に生じた問題のトラブルシューティングを行います。

構文

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

コマンド・オプション

例

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

ibmcloud schematics output

ワークスペースの Terraform 出力値を取得します。 Terraformテンプレートで出力値を定義し、他のワークスペースからアクセスできるようにしたいデータを含めることができる。

構文

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

コマンド・オプション

例

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

ibmcloud schematics plan

ソースリポジトリのTerraformテンプレートをスキャンし、このテンプレートをすでにデプロイされているクラウドリソースと比較します。 コマンドライン出力は、設定ファイルに記述された状態を達成するために追加、変更、 永続化、または削除しなければならないクラウド・リソースを示します。

Schematics の plan アクション実行するには、ワークスペースの状態が**「非アクティブ」、「アクティブ」、「失敗」、または「停止」**のいずれかである必要があります。

Terraform 実行プランの作成中は、ワークスペースに変更を加えることはできません。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace job stop

実行中のワークスペースジョブを停止し、Terraformに割り込みシグナルを送って実行を終了させる。

構文

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

コマンド・オプション

例

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>

ibmcloud schematics state pull

ワークスペースにある特定の Terraform テンプレート用 Terraform 状態ファイル (terraform.tfstate) の内容を表示します。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace state show

Terraform に表示されるワークスペースの状態またはプランからの読み取り可能な出力を提供します。 現在の状態と計画された操作状況を確認するために使用できます。 ibmcloud schematics logs コマンドを使用してログを取得するには、ワークスペース ID を使用する必要があります。

構文

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

コマンド・オプション

例

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

ibmcloud schematics workspace state mv

状態ファイル内のリソースの状態を移動する場合。 ワークスペースは引き続き機能しますが、次のプランまたは適用操作では、状態ファイル内にリソースまたはインスタンスが見つかりません。 テンプレートに変更が加えられていない場合は、Terraform による次の操作でリソースの再作成が表示されます。

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

コマンド・オプション

例

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

ibmcloud schematics workspace state rm

状態ファイル内のリソースまたはインスタンスの状態を削除する場合。 ワークスペースは引き続き機能しますが、次のプランまたは適用操作では、状態ファイル内にリソースまたはインスタンスが見つかりません。 テンプレートに変更が加えられていない場合は、Terraform による次の操作でリソースの再作成が表示されます。

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

コマンド・オプション

例

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

Terraform コマンド

Terraform コマンドは、入力を指定するために JSON ファイルを使用して実行されます。

構文

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

コマンド・オプション

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

次の表は、コマンド・ラインおよび API において Commands API に使用する JSON ファイルのキー・パラメーターをリストしたものです。

例

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