CycleCloud CLI

發行項
07/15/2024

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	description
list	列出帳戶
顯示 < account_name>	顯示帳戶的詳細資料
建立	建立新的帳戶
編輯 < 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 組態之間切換

cyclecloud config <command>

sub-command	description
顯示	顯示使用中的目前組態
list	列出可用的組態
create < config_name>	建立新的組態
重新命名 < old_name >< new_name>	重新命名現有的組態
use < config_name>	切換至指定的組態
移除 < config_name>	移除具名組態

cyclecloud 設定顯示

顯示使用中的目前組態

cyclecloud config show

cyclecloud 設定清單

列出可用的組態

cyclecloud config list

cyclecloud config create

建立新的組態

cyclecloud config create <config_name>

cyclecloud 設定重新命名

重新命名現有的組態

cyclecloud config rename <old_name> <new_name>

cyclecloud 組態使用

切換至指定的組態

cyclecloud config use <config_name>

cyclecloud 設定移除

移除具名組態

cyclecloud config remove <config_name>

cyclecloud connect

連接到叢集中的執行中實例。從 7.8 開始，Name 可以是節點名稱、主機名稱或 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	description
list	列出認證
建立	建立新的認證
編輯 < 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	description
add < image_name > [...]	新增一或多個影像

cyclecloud 映射新增

新增一或多個影像

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，而且檔案具有單一叢集，則會使用該叢集的名稱。

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，而且檔案具有單一叢集，則會使用該叢集的名稱。

cyclecloud import_template [NAME] [-c TEMPLATE]
                                  [--force]
                                  [--file=FILE]

`-c TEMPLATE`

要匯入之檔案中的範本。如果未指定，則會使用新範本的名稱。

`--force`

如果指定，則會在範本存在時加以取代

`-f FILE, --file=FILE`

要從中匯入範本的檔案。

cyclecloud 初始化

初始化 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 安裝的 (true) ， (false) SSL 憑證。

`--name=NAMED_CONFIG`

建立可搭配 config 命令使用的具名組態

cyclecloud 保險箱

管理 CycleCloud 保險箱。

cyclecloud locker <command>

sub-command	description
list	清單保險箱
顯示 < 保險箱>	顯示保險箱的詳細資料

cyclecloud 保險箱清單

清單保險箱

cyclecloud locker list

cyclecloud 保險箱顯示

顯示保險箱的詳細資料

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	description
init < 名稱>	建立新的空白專案
擷取 < URL >< 路徑>	從 Github < URL > 擷取至 < 路徑的專案>
info	顯示專案資訊
<add_spec規格>	將規格新增至專案
<default_locker保險箱>	設定要上傳至的預設保險箱 ()
test	執行指定叢集定義的整合測試
build	建置專案
上傳 [保險箱]	建置並上傳指定的保險箱 () (若未指定) ，則會使用預設值
下載 [保險箱]	從指定的保險箱下載專案 Blob (s) (如果未指定，則會使用預設值)
<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`

用來參數化受測叢集範本的任意索引鍵=值組

`-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 (s) (如果未指定，則會使用預設值)

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 retry

重試具名叢集的初始化作業失敗。

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`

如果指定，則不會在根據篩選準則終止節點之前要求確認。

共用方式為

CycleCloud CLI

全域 CLI 參數

-h, --help

-v, --version

--config=CONFIG_FILE

--loglevel=LOG_LEVEL

cyclecloud 帳戶

cyclecloud 帳戶清單

cyclecloud 帳戶顯示

cyclecloud 帳戶建立

-o OUTPUT_FILE

--dry-run

-f INPUT_FILE

cyclecloud 帳戶編輯

-o OUTPUT_FILE

--dry-run

-f INPUT_FILE

cyclecloud 帳戶刪除

--force

cyclecloud add_node

-t TEMPLATE, --template=TEMPLATE

-c COUNT, --count=COUNT

-f, --fixed

cyclecloud 設定

cyclecloud 設定顯示

cyclecloud 設定清單

cyclecloud config create

cyclecloud 設定重新命名

cyclecloud 組態使用

cyclecloud 設定移除

cyclecloud connect

-k KEYFILE, --keyfile=KEYFILE

-c CLUSTER, --cluster=CLUSTER

-u USER, --user=USER

--bastion-host=BASTION-HOST

--bastion-port=BASTION-PORT

--bastion-user=BASTION-USER

--bastion-key=BASTION-KEY

cyclecloud copy_cluster

-p PARAMETERS, --parameters=PARAMETERS

cyclecloud create_cluster

--force

-p PARAMETERS, --parameters=PARAMETERS

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

cyclecloud 認證

cyclecloud 認證清單

cyclecloud 認證建立

cyclecloud 認證編輯

cyclecloud 認證刪除

cyclecloud delete_cluster

-r, --recursive

--force

cyclecloud delete_template

cyclecloud export_parameters

-o OUTPUT_FILE

--format=OUTPUT_FORMAT

cyclecloud 映射

cyclecloud 映射新增

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

cyclecloud import_cluster

-c TEMPLATE

--force

-t, --as-template

-f FILE, --file=FILE

-p PARAMETERS, --parameters=PARAMETERS

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

-r, --recursive

cyclecloud import_template

-c TEMPLATE

--force

`-h, --help`

`-v, --version`

`--config=CONFIG_FILE`

`--loglevel=LOG_LEVEL`

`-o OUTPUT_FILE`

`--dry-run`

`-f INPUT_FILE`

`-o OUTPUT_FILE`

`--dry-run`

`-f INPUT_FILE`

`--force`

`-t TEMPLATE, --template=TEMPLATE`

`-c COUNT, --count=COUNT`

`-f, --fixed`

`-k KEYFILE, --keyfile=KEYFILE`

`-c CLUSTER, --cluster=CLUSTER`

`-u USER, --user=USER`

`--bastion-host=BASTION-HOST`

`--bastion-port=BASTION-PORT`

`--bastion-user=BASTION-USER`

`--bastion-key=BASTION-KEY`

`-p PARAMETERS, --parameters=PARAMETERS`

`--force`

`-p PARAMETERS, --parameters=PARAMETERS`

`-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE`

`-r, --recursive`

`--force`

`-o OUTPUT_FILE`

`--format=OUTPUT_FORMAT`

`--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`

`-c TEMPLATE`

`--force`

`-t, --as-template`

`-f FILE, --file=FILE`

`-p PARAMETERS, --parameters=PARAMETERS`

`-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE`

`-r, --recursive`

`-c TEMPLATE`

`--force`

`-f FILE, --file=FILE`

`--batch`

`--force`

`--url=URL`

`--username=USERNAME`

`--password=PASSWORD`

`--verify-ssl=VERIFY-SSL`

`--name=NAMED_CONFIG`

`--global`

`--skip-teardown`

`--output-json=JSON_FILE`

`--junit-xml=JUNIT_FILE`

`-e EXTRA_VARS, --extra-var=EXTRA_VARS`

`-t TEMPLATE, --template=TEMPLATE`

`-n CLUSTER_NAME, --name=CLUSTER_NAME`

`--project-version=PROJECT_VERSION`

`--build-dir=BUILD_DIR`

`--project-version=PROJECT_VERSION`

`-f FILTER, --filter=FILTER`

`--instance-filter=INSTANCE_FILTER`

`--creds=CREDS`

`--no-prompt`

`--force`

`-r, --recursive`

`-r, --recursive`

`-l, --long`

`-t, --templates`

`-a ATTRS, --attrs=ATTRS`

`-f FILTER, --filter=FILTER`

`--instance-filter=INSTANCE_FILTER`

`--output=OUTPUT`

`--format=FORMAT`