你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CycleCloud CLI

项目
04/11/2023

使用 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>	显示帐户的详细信息
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 配置之间轻松切换

cyclecloud config <command>

sub-command	description
show	显示正在使用的当前配置
list	列出可用配置
创建 <config_name>	创建新的配置
重命名 <old_name><new_name>	重命名现有配置
使用 <config_name>	切换到指定的配置
删除 <config_name>	删除命名配置

cyclecloud 配置显示

显示正在使用的当前配置

cyclecloud config show

cyclecloud 配置列表

列出可用配置

cyclecloud config list

cyclecloud 配置创建

创建新的配置

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 开始，名称可以是节点名称、主机名或 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	列出凭据
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	description
添加 <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`

是否验证 (true) 是否为 CycleServer 安装) SSL 证书 (false。

`--name=NAMED_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保险箱>	设置要上传到的默认保险箱 (s)
测试	对给定群集定义执行集成测试
build	生成项目
上传 [保险箱]	生成并上传指定的保险箱 (s) (使用默认值（如果未指定任何) ）
下载 [保险箱]	从指定的保险箱下载项目 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

设置要上传到的默认保险箱 (s)

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 项目上传

生成并上传指定的保险箱 (s) (使用默认值（如果未指定任何) ）

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

重试命名群集的初始化操作失败。

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`

如果指定，则不会在基于筛选器终止节点之前请求确认。

Share via

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 配置创建

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`