CycleCloud CLI
Azure CycleCloud CLI を使用すると、コンソールまたはスクリプト ファイルからインストールを管理できます。
グローバル CLI パラメーター
これらはすべてのコマンドで使用できます。
-h, --help
このヘルプ メッセージを表示して終了します
-v, --version
CLI のバージョンを表示します。
--config=CONFIG_FILE
このコマンドに使用する既定以外の構成ファイルへのパスを指定します。
--loglevel=LOG_LEVEL
CLI の既定のログ レベルを設定します。
cyclecloud アカウント
クラウド プロバイダー アカウントを管理します。
cyclecloud account <command> [-o OUTPUT_FILE]
[--dry-run]
[-f INPUT_FILE]
[--force]
| sub-command | 説明 |
|---|---|
| list | アカウントの一覧表示 |
| account_nameを表示する<> | アカウントの詳細を表示する |
| create | 新しいアカウントを作成する |
| account_nameの編集<> | 既存のアカウントを編集する |
| account_nameの削除<> | 既存のアカウントを削除する |
cyclecloud アカウントの一覧
アカウントの一覧表示
cyclecloud account list
cyclecloud アカウント ショー
アカウントの詳細を表示する
cyclecloud account show <account_name>
cyclecloud アカウントの作成
新しいアカウントを作成する
cyclecloud account create [-o OUTPUT_FILE]
[--dry-run]
[-f INPUT_FILE]
-o OUTPUT_FILE
構成パラメーターをディスクに書き込みます
--dry-run
情報のプロンプトと検証を行いますが、変更は適用されません
-f INPUT_FILE
プロンプトを表示する代わりに、構成ファイルから定義を読み取ります
cyclecloud アカウントの編集
既存のアカウントを編集する
cyclecloud account edit <account_name> [-o OUTPUT_FILE]
[--dry-run]
[-f INPUT_FILE]
-o OUTPUT_FILE
構成パラメーターをディスクに書き込みます
--dry-run
情報のプロンプトと検証を行いますが、変更は適用されません
-f INPUT_FILE
プロンプトを表示する代わりに、構成ファイルから定義を読み取ります
cyclecloud アカウントの削除
既存のアカウントを削除する
cyclecloud account delete <account_name> [--force]
--force
true の場合、アカウントの削除を求めるメッセージは表示されません。
cyclecloud add_node
クラスターにノードを追加します。
cyclecloud add_node <CLUSTER> [--template=TEMPLATE]
[--count=COUNT]
[--fixed]
-t TEMPLATE, --template=TEMPLATE
このノードに使用するテンプレート。 指定しない場合、既定では使用可能な唯一のテンプレートが使用されます。それ以外の場合はエラーです。
-c COUNT, --count=COUNT
開始するノードの数。 指定しない場合は、1 が既定値です。
-f, --fixed
設定すると、ノードはクラスター テンプレートに永続的に (削除されるまで) 追加されます。 それ以外の場合、終了するとノードが自動的に削除されます。
cyclecloud 構成
サイクルクラウド構成を簡単に切り替える
cyclecloud config <command>
| sub-command | 説明 |
|---|---|
| show | 使用中の現在の構成を表示する |
| list | 使用可能な構成を一覧表示する |
| create <config_name> | 新しい構成を作成する |
| new_name old_name><名前を変更<する> | 既存の構成の名前を変更する |
| config_nameを使用 <する> | 指定した構成に切り替える |
| config_nameを削除する<> | 名前付き構成を削除する |
cyclecloud config show
使用中の現在の構成を表示する
cyclecloud config show
cyclecloud 構成リスト
使用可能な構成を一覧表示する
cyclecloud config list
cyclecloud config create
新しい構成を作成する
cyclecloud config create <config_name>
cyclecloud config rename
既存の構成の名前を変更する
cyclecloud config rename <old_name> <new_name>
cyclecloud 構成の使用
指定した構成に切り替える
cyclecloud config use <config_name>
cyclecloud config remove
名前付き構成を削除する
cyclecloud config remove <config_name>
cyclecloud connect
クラスター内の実行中のインスタンスに接続します。 7.8 以降、名前にはノード名、ホスト名、または IP アドレスを指定できます。
cyclecloud connect <NAME> [--keyfile=KEYFILE]
[--cluster=CLUSTER]
[--user=USER]
[--bastion-host=BASTION-HOST]
[--bastion-port=BASTION-PORT]
[--bastion-user=BASTION-USER]
[--bastion-key=BASTION-KEY]
-k KEYFILE, --keyfile=KEYFILE
ノードに指定されていない場合、またはノードに存在しない場合に使用するキーペア。
-c CLUSTER, --cluster=CLUSTER
ノード名がノード名の場合は、ノードが存在するクラスター。 同じ名前のノードが複数ある場合を除き、省略可能です。
-u USER, --user=USER
ノードにログインするユーザー。
--bastion-host=BASTION-HOST
接続をルーティングするための SSH 要塞ホスト。
--bastion-port=BASTION-PORT
要塞に接続するための SSH ポート。
--bastion-user=BASTION-USER
要塞に接続するためのユーザー ログイン。
--bastion-key=BASTION-KEY
要塞に接続するための秘密キー ファイル。
cyclecloud copy_cluster
クラスターのコピーを作成します。
cyclecloud copy_cluster <source_cluster_name> <new_cluster_name> [--parameters=PARAMETERS]
-p PARAMETERS, --parameters=PARAMETERS
使用するパラメーター ファイル
cyclecloud create_cluster
既存のテンプレートからクラスターを作成します。
cyclecloud create_cluster <TEMPLATE> <NAME> [--force]
[--parameters=PARAMETERS]
[--parameter-override=PARAMETER_OVERRIDE]
--force
指定した場合、クラスターが存在する場合は置き換えられます
-p PARAMETERS, --parameters=PARAMETERS
使用するパラメーター ファイル
-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE
特定のパラメーターを追加またはオーバーライドします。 p で指定された値よりも優先されます。
cyclecloud 資格情報
クラウド プロバイダー アカウントの資格情報を管理します。
cyclecloud credential <command>
| sub-command | 説明 |
|---|---|
| list | 資格情報の一覧表示 |
| create | 新しい資格情報の作成 |
| account_nameの編集<> | 既存の資格情報を編集する |
| account_nameの削除<> | 既存の資格情報を削除する |
cyclecloud 資格情報リスト
資格情報の一覧表示
cyclecloud credential list
cyclecloud 資格情報の作成
新しい資格情報の作成
cyclecloud credential create
cyclecloud 資格情報の編集
既存の資格情報を編集する
cyclecloud credential edit <account_name>
cyclecloud 資格情報の削除
既存の資格情報を削除する
cyclecloud credential delete <account_name>
cyclecloud delete_cluster
実行されていないクラスターを削除します。
cyclecloud delete_cluster <CLUSTER> [--recursive]
[--force]
-r, --recursive
このクラスターとそのすべてのサブクラスターを再帰的に削除します。
--force
このクラスターを強制的に削除します。 注: このオプションは、クラウド プロバイダー内のすべてのリソースが既に終了している場合にのみ使用してください。
cyclecloud delete_template
クラスター テンプレートを削除します
cyclecloud delete_template <TEMPLATE>
cyclecloud export_parameters
特定のクラスターのパラメーターをエクスポートします。
cyclecloud export_parameters <cluster_name> [-o OUTPUT_FILE]
[--format=OUTPUT_FORMAT]
-o OUTPUT_FILE
作成の場合は、クラスター パラメーターをディスクに書き込みます。
--format=OUTPUT_FORMAT
出力形式
cyclecloud イメージ
カスタム イメージを管理します。
cyclecloud image <command> [--account=ACCOUNTS]
[--name=NAME]
[--label=LABEL]
[--package-version=PACKAGE_VERSION]
[--bump-version=BUMP_VERSION]
[--os=OS]
[--jetpack-version=JETPACK_VERSION]
[--install-jetpack]
[--jetpack-platform=JETPACK_PLATFORM]
[--dry-run]
| sub-command | 説明 |
|---|---|
| image_name>追加 <[...] | 1 つ以上のイメージを追加する |
cyclecloud イメージの追加
1 つ以上のイメージを追加する
cyclecloud image add <image_name> [...] [--account=ACCOUNTS]
[--name=NAME]
[--label=LABEL]
[--package-version=PACKAGE_VERSION]
[--bump-version=BUMP_VERSION]
[--os=OS]
[--jetpack-version=JETPACK_VERSION]
[--install-jetpack]
[--jetpack-platform=JETPACK_PLATFORM]
[--dry-run]
--account=ACCOUNTS
このアカウントのみを検索します (複数のアカウントに対して繰り返すことができます)
--name=NAME
作成するパッケージの名前 (必須)
--label=LABEL
作成するパッケージのラベル
--package-version=PACKAGE_VERSION
このバージョンは、既定値の 1.0.0 ではなく、新しいイメージに使用します
--bump-version=BUMP_VERSION
'--bump-version minor' を使用して、最新のマイナー バージョンを 1 (例: 1.1 から 1.2) インクリメントするか、'--bump-version major' または '--bump-version patch' を使用します
--os=OS
'--os linux/windows' を使用してイメージ上のオペレーティング システムを指定する
--jetpack-version=JETPACK_VERSION
イメージにインストールされている、またはインストールする必要がある jetpack のバージョン
--install-jetpack
このイメージに実行時に jetpack をインストールする
--jetpack-platform=JETPACK_PLATFORM
イメージで使用される jetpack プラットフォーム (centos-7、ubuntu-14.04、windows など)
--dry-run
一致する画像を探しますが、画像情報は保存しません
cyclecloud import_cluster
テキスト ファイルからクラスターを作成します。 CLUSTER が指定されておらず、ファイルに 1 つのクラスターがある場合は、そのクラスターの名前が使用されます。
cyclecloud import_cluster [CLUSTER] [-c TEMPLATE]
[--force]
[--as-template]
[--file=FILE]
[--parameters=PARAMETERS]
[--parameter-override=PARAMETER_OVERRIDE]
[--recursive]
-c TEMPLATE
インポートするファイル内のクラスター。 指定しない場合は、新しいクラスターの名前が使用されます。
--force
指定した場合、クラスターが存在する場合は置き換えられます。
-t, --as-template
指定した場合、クラスターは、他のクラスターの作成にのみ使用できるテンプレートとして格納されます。
-f FILE, --file=FILE
テンプレートのインポート元のファイル。
-p PARAMETERS, --parameters=PARAMETERS
使用するパラメーター ファイル
-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE
特定のパラメーターを追加またはオーバーライドします。 p で指定された値よりも優先されます。
-r, --recursive
名前付きクラスターと、それが親であるファイル内のすべてのクラスターをインポートします。
cyclecloud import_template
テキスト ファイルからクラスター テンプレートをインポートします。 NAME が指定されておらず、ファイルに 1 つのクラスターがある場合は、そのクラスターの名前が使用されます。
cyclecloud import_template [NAME] [-c TEMPLATE]
[--force]
[--file=FILE]
-c TEMPLATE
インポートするファイル内のテンプレート。 指定しない場合は、新しいテンプレートの名前が使用されます。
--force
指定した場合、テンプレートが存在する場合は置き換えられます
-f FILE, --file=FILE
テンプレートのインポート元のファイル。
cyclecloud initialize
CycleCloud 設定を初期化します。
cyclecloud initialize [--batch]
[--force]
[--url=URL]
[--username=USERNAME]
[--password=PASSWORD]
[--verify-ssl=VERIFY-SSL]
[--name=NAMED_CONFIG]
--batch
指定した場合は、コマンド ラインで引数を指定する必要があります。 質問は "いいえ" と見なされます。
--force
有効な構成ファイルが使用可能な場合でも、強制的に再初期化します。
--url=URL
CycleServer インストールのベース URL。
--username=USERNAME
CycleServer インストールのユーザー名。
--password=PASSWORD
CycleServer インストールのパスワード。
--verify-ssl=VERIFY-SSL
CycleServer インストールの SSL 証明書を確認する (true) かどうか (false) かどうか。
--name=NAMED_CONFIG
config コマンドで使用できる名前付き構成を作成する
cyclecloud locker
CycleCloud ロッカーを管理します。
cyclecloud locker <command>
| sub-command | 説明 |
|---|---|
| list | ロッカーを一覧表示する |
| ロッカーを表示する<> | ロッカーの詳細を表示する |
cyclecloud locker list
ロッカーを一覧表示する
cyclecloud locker list
cyclecloud locker show
ロッカーの詳細を表示する
cyclecloud locker show <locker>
cyclecloud プロジェクト
CycleCloud プロジェクトを管理します。
cyclecloud project <command> [--skip-teardown]
[--output-json=JSON_FILE]
[--junit-xml=JUNIT_FILE]
[--extra-var=EXTRA_VARS]
[--template=TEMPLATE]
[--name=CLUSTER_NAME]
[--global]
[--project-version=PROJECT_VERSION]
[--build-dir=BUILD_DIR]
| sub-command | 説明 |
|---|---|
| init <name> | 新しい空のプロジェクトを作成する |
| url パスを><フェッチ<する> | GitHub <URL> からパスへのプロジェクトを <フェッチします> |
| info | プロジェクト情報を表示する |
| <add_spec仕様> | プロジェクトにスペックを追加する |
| <default_lockerロッカー> | にアップロードする既定のロッカーを設定します。 |
| テスト | 特定のクラスター定義の統合テストを実行する |
| build | プロジェクトを構築 |
| upload [locker] | 指定したロッカーをビルドしてプロジェクトをアップロードします (指定されていない場合は既定値を使用します) |
| ダウンロード [locker] | 指定したロッカーからプロジェクト BLOB をダウンロードします (指定されていない場合は既定値を使用します) |
| <generate_template ファイル> | ファイルに書き込まれたプロジェクトのクラスター テンプレートを生成する<> |
cyclecloud プロジェクト init
新しい空のプロジェクトを作成する
cyclecloud project init <name>
cyclecloud プロジェクトのフェッチ
GitHub <URL> からパスへのプロジェクトを <フェッチします>
cyclecloud project fetch <url> <path>
cyclecloud プロジェクト情報
プロジェクト情報を表示する
cyclecloud project info
cyclecloud プロジェクトのadd_spec
プロジェクトにスペックを追加する
cyclecloud project add_spec <spec>
cyclecloud プロジェクト default_locker
にアップロードする既定のロッカーを設定します。
cyclecloud project default_locker <locker> [--global]
--global
プロジェクト固有の値ではなく、グローバルな既定値を設定します。
cyclecloud プロジェクト テスト
特定のクラスター定義の統合テストを実行する
cyclecloud project test [--skip-teardown]
[--output-json=JSON_FILE]
[--junit-xml=JUNIT_FILE]
[--extra-var=EXTRA_VARS]
[--template=TEMPLATE]
[--name=CLUSTER_NAME]
--skip-teardown
テスト用に作成されたクラスターの破棄をスキップする
--output-json=JSON_FILE
指定した json ファイルに結果を出力する
--junit-xml=JUNIT_FILE
junit-xml 形式で指定した json ファイルに結果を出力します
-e EXTRA_VARS, --extra-var=EXTRA_VARS
テスト対象のクラスター テンプレートをパラメーター化するために使用される任意の key=value ペア
-t TEMPLATE, --template=TEMPLATE
クラスター テンプレート ファイルへのパス
-n CLUSTER_NAME, --name=CLUSTER_NAME
テストするクラスター定義の名前
cyclecloud プロジェクトのビルド
プロジェクトを構築
cyclecloud project build [--project-version=PROJECT_VERSION]
[--build-dir=BUILD_DIR]
--project-version=PROJECT_VERSION
project.iniに存在するプロジェクトのバージョンをオーバーライドする
--build-dir=BUILD_DIR
ビルド ディレクトリ
cyclecloud プロジェクトのアップロード
指定したロッカーをビルドしてプロジェクトをアップロードします (指定されていない場合は既定値を使用します)
cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]
--project-version=PROJECT_VERSION
project.iniに存在するプロジェクトのバージョンをオーバーライドする
cyclecloud プロジェクトのダウンロード
指定したロッカーからプロジェクト BLOB をダウンロードします (指定されていない場合は既定値を使用します)
cyclecloud project download [locker]
cyclecloud プロジェクト generate_template
ファイルに書き込まれたプロジェクトのクラスター テンプレートを生成する<>
cyclecloud project generate_template <file>
cyclecloud reboot_node
実行中のノードを再起動します。
cyclecloud reboot_node <CLUSTER> <NODE_NAME>
cyclecloud remove_node
クラスターからノードを削除します (開始された場合は終了します)。
cyclecloud remove_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
[--instance-filter=INSTANCE_FILTER]
[--creds=CREDS]
[--no-prompt]
[--force]
-f FILTER, --filter=FILTER
完全なクラス広告式に一致するノードを削除します。
--instance-filter=INSTANCE_FILTER
完全なクラス広告式に一致するアクティブなインスタンスを持つノードを削除します。
--creds=CREDS
名前付き資格情報セットの使用を開始したノードを削除します。
--no-prompt
指定した場合、フィルターに基づいてノードを終了する前に確認を求めるメッセージは表示されません。
--force
終了しない場合でも、このノードを強制的に削除します。 注: このオプションは、クラウド プロバイダーのこのノードのリソースが既に終了している場合にのみ使用してください。
cyclecloud 再試行
名前付きクラスターに対して失敗した初期化操作を再試行します。
cyclecloud retry <CLUSTER> [--recursive]
-r, --recursive
このクラスターとそのすべてのサブクラスターのオプションを再帰的に再試行します。
cyclecloud show_cluster
CycleCloud のクラスターまたはクラスターを表示します。
cyclecloud show_cluster <CLUSTER> [--recursive]
[--long]
[--templates]
-r, --recursive
このクラスターとそのすべてのサブクラスターを表示します。
-l, --long
概要を表示するのではなく、各ノードを一覧表示します。
-t, --templates
出力にクラスター テンプレートを含めます。
cyclecloud show_nodes
選択したノード/インスタンスの詳細を表示します。
cyclecloud show_nodes [NAME] [--attrs=ATTRS]
[--filter=FILTER]
[--instance-filter=INSTANCE_FILTER]
[--output=OUTPUT]
[--format=FORMAT]
[--creds=CREDS]
[--cluster=CLUSTER]
[--states=STATES]
[--long]
[--summary]
-a ATTRS, --attrs=ATTRS
指定した属性のセット (コンマ区切りリスト) を表示します。
-f FILTER, --filter=FILTER
完全なクラス広告式に一致するノードのみを表示します。
--instance-filter=INSTANCE_FILTER
完全なクラス広告式に一致するアクティブなインスタンスを持つノードのみを表示します。
--output=OUTPUT
Python スタイルの名前付きパラメーター書式指定文字列で記述された一致するノード属性を出力します。 例: --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n"
--format=FORMAT
出力表示形式 [xml | json | text] を変更します。
--creds=CREDS
名前付き資格情報セットの使用を開始したノードのみを表示します。
-c CLUSTER, --cluster=CLUSTER
指定したクラスター内のノードのみを表示します。
--states=STATES
指定した状態のノード (コンマ区切りリスト) のみを表示します。
-l, --long
ノードの完全なクラス広告表現を表示します。
-s, --summary
ノードの最小表現を表示します。
cyclecloud start_cluster
名前付きクラスターを起動します。
cyclecloud start_cluster <CLUSTER> [--recursive]
[--test]
-r, --recursive
このクラスターとそのすべてのサブクラスターを再帰的に開始します。
-t, --test
テスト モードでクラスターを起動する
cyclecloud start_node
(再)実行中のクラスターで終了したノードを開始します。
cyclecloud start_node <CLUSTER> <NODE_NAME>
cyclecloud terminate_cluster
名前付きクラスターを終了します。
cyclecloud terminate_cluster <CLUSTER> [--recursive]
-r, --recursive
このクラスターとそのすべてのサブクラスターを再帰的に終了します。
cyclecloud terminate_node
実行中のノードを終了します (ただし、クラスター内に残ります)。
cyclecloud terminate_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
[--instance-filter=INSTANCE_FILTER]
[--creds=CREDS]
[--no-prompt]
-f FILTER, --filter=FILTER
完全なクラス広告式に一致するノードを終了します。
--instance-filter=INSTANCE_FILTER
完全なクラス広告式に一致するアクティブなインスタンスでノードを終了します。
--creds=CREDS
名前付き資格情報セットを使用して開始されたノードを終了します。
--no-prompt
指定した場合、フィルターに基づいてノードを終了する前に確認を求めるメッセージは表示されません。