CycleCloud CLI

2025-06-10

The Azure CycleCloud CLI allows you to manage your installation from a console or script file.

Global CLI Parameters

These parameters are available for all commands.

`-h, --help`

Shows the help message and exits.

`-v, --version`

Shows the version for the CLI.

`--config=CONFIG_FILE`

Specifies the path to a nondefault config file to be used for this command.

`--loglevel=LOG_LEVEL`

Sets the default log level for the CLI.

cyclecloud account

Manage cloud provider accounts.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]

subcommand	descrição
`list`	List accounts.
`show <account_name>`	Show detail for an account.
`create`	Crie uma nova conta.
`edit <account_name>`	Edit an existing account.
`delete <account_name>`	Delete an existing account.

cyclecloud account list

List accounts.

cyclecloud account list

cyclecloud account show

Show detail for an account.

cyclecloud account show <account_name>

cyclecloud account create

Crie uma nova conta.

cyclecloud account create [-o OUTPUT_FILE]
                          [--dry-run]
                          [-f INPUT_FILE]

`-o OUTPUT_FILE`

Writes the configuration parameters to disk

`--dry-run`

Prompts and validates information but doesn't enact any changes

`-f INPUT_FILE`

Reads the definition from a configuration file instead of prompting

cyclecloud account edit

Edit an existing account.

cyclecloud account edit <account_name> [-o OUTPUT_FILE]
                                       [--dry-run]
                                       [-f INPUT_FILE]

`-o OUTPUT_FILE`

Writes the configuration parameters to disk.

`--dry-run`

Prompts and validates information but doesn't enact any changes.

`-f INPUT_FILE`

Reads the definition from a configuration file instead of prompting.

cyclecloud account delete

Delete an existing account.

cyclecloud account delete <account_name> [--force]

`--force`

If true, doesn't prompt to delete the account.

cyclecloud add_node

Adds more nodes to the cluster.

cyclecloud add_node <CLUSTER> [--template=TEMPLATE]
                              [--count=COUNT]
                              [--fixed]

`-t TEMPLATE, --template=TEMPLATE`

The template to use for this node. If not specified, the default is to use the only template available otherwise error.

`-c COUNT, --count=COUNT`

How many nodes to start. If not specified, the default is 1.

`-f, --fixed`

If set, the node is permanently added (until removed) to the cluster template. Otherwise, the node is automatically removed when terminated.

cyclecloud config

Easily switch between cyclecloud configurations.

cyclecloud config <command>

Subcommand	Descrição
`show`	Show the current configuration.
`list`	List available configurations.
`create <config_name>`	Create a new configuration.
`rename <old_name> <new_name>`	Rename an existing configuration.
`use <config_name>`	Switch to a specified configuration.
`remove <config_name>`	Remove a named configuration.

cyclecloud config show

Show the current configuration.

cyclecloud config show

cyclecloud config list

List available configurations.

cyclecloud config list

cyclecloud config create

Create a new configuration.

cyclecloud config create <config_name>

cyclecloud config rename

Rename an existing configuration.

cyclecloud config rename <old_name> <new_name>

cyclecloud config use

Switch to a specified configuration.

cyclecloud config use <config_name>

cyclecloud config remove

Remove a named configuration.

cyclecloud config remove <config_name>

cyclecloud connect

Connects to a running instance in the cluster. As of 7.8, the Name can be either a node name, a hostname, or an IP address.

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`

The keypair to use, if not given on the node or the node doesn't exist.

`-c CLUSTER, --cluster=CLUSTER`

The cluster the node is in, if the name is a node name. Optional unless there are multiple nodes with the same name.

`-u USER, --user=USER`

The user to sign in to the node.

`--bastion-host=BASTION-HOST`

SSH bastion host to route connections through.

`--bastion-port=BASTION-PORT`

SSH port for connecting to the bastion.

`--bastion-user=BASTION-USER`

User name for connecting to the bastion.

`--bastion-key=BASTION-KEY`

Private key file for connecting to the bastion.

cyclecloud copy_cluster

Makes a copy of a cluster.

cyclecloud copy_cluster <source_cluster_name> <new_cluster_name> [--parameters=PARAMETERS]

`-p PARAMETERS, --parameters=PARAMETERS`

The parameters file to use.

cyclecloud create_cluster

Creates a cluster from an existing template.

cyclecloud create_cluster <TEMPLATE> <NAME> [--force]
                                            [--parameters=PARAMETERS]
                                            [--parameter-override=PARAMETER_OVERRIDE]

`--force`

If specified, the cluster is replaced if it exists.

`-p PARAMETERS, --parameters=PARAMETERS`

The parameters file to use.

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

Add or override a specific parameter. This option takes precedence over values specified in -p.

cyclecloud credential

Manage cloud provider account credentials.

cyclecloud credential <command>

Subcommand	Descrição
`list`	List credentials.
`create`	Create a new credential.
`edit <account_name>`	Edit an existing credential.
`delete <account_name>`	Delete an existing credential.

cyclecloud credential list

List credentials.

cyclecloud credential list

cyclecloud credential create

Create a new credential.

cyclecloud credential create

cyclecloud credential edit

Edit an existing credential.

cyclecloud credential edit <account_name>

cyclecloud credential delete

Delete an existing credential.

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Delete a nonrunning cluster.

cyclecloud delete_cluster <CLUSTER> [--recursive]
                                    [--force]

`-r, --recursive`

Recursively delete this cluster and all its subclusters.

`--force`

Force this cluster to be deleted. Use this option only if all resources in your cloud provider are already terminated.

cyclecloud delete_template

Delete a cluster template.

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

Export Parameters for a given cluster.

cyclecloud export_parameters <cluster_name> [-o OUTPUT_FILE]
                                            [--format=OUTPUT_FORMAT]

`-o OUTPUT_FILE`

For create, writes the cluster parameters to disk.

`--format=OUTPUT_FORMAT`

Output format.

cyclecloud image

Manage custom images.

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]

Subcommand	Descrição
`add <image_name> [...]`	Add one or more images.

cyclecloud image add

Add one or more images.

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`

Search only this account. You can repeat this option for multiple accounts.

`--name=NAME`

The name of the package to create. Este parâmetro é obrigatório.

`--label=LABEL`

The label of the package to create.

`--package-version=PACKAGE_VERSION`

Use this version for the new image instead of the default of 1.0.0.

`--bump-version=BUMP_VERSION`

Use --bump-version minor to increment the latest minor version by 1 (for example, 1.1 to 1.2), or use --bump-version major or --bump-version patch.

`--os=OS`

Use --os linux/windows to specify the operating system on the image.

`--jetpack-version=JETPACK_VERSION`

The version of Jetpack that is installed or should be installed on the image.

`--install-jetpack`

Install Jetpack at runtime on this image.

`--jetpack-platform=JETPACK_PLATFORM`

The Jetpack platform used on the image (for example, centos-7, ubuntu-14.04, windows).

`--dry-run`

Looks for matching images but doesn't store any image information.

cyclecloud import_cluster

Creates a cluster from a text file. If CLUSTER isn't provided and the file contains a single cluster, the name of that cluster is used.

cyclecloud import_cluster [CLUSTER] [-c TEMPLATE]
                                    [--force]
                                    [--as-template]
                                    [--file=FILE]
                                    [--parameters=PARAMETERS]
                                    [--parameter-override=PARAMETER_OVERRIDE]
                                    [--recursive]

`-c TEMPLATE`

The cluster in the file to import. If not specified, the name of the new cluster is used.

`--force`

If specified, the cluster is replaced if it exists.

`-t, --as-template`

If specified, the cluster is stored as a template which can only be used to create other clusters.

`-f FILE, --file=FILE`

The file for importing the template.

`-p PARAMETERS, --parameters=PARAMETERS`

The parameters file to use.

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

Add or override a specific parameter. Takes precedent over values specified in -p.

`-r, --recursive`

Imports the named cluster and all clusters in the file for which it's the parent.

cyclecloud import_template

Imports a cluster template from a text file. If NAME isn't given, and the file has a single cluster, the name of that cluster is used.

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

`-c TEMPLATE`

The template in the file to import. If not specified, the name of the new template is used.

`--force`

If specified, the template is replaced if it exists.

`-f FILE, --file=FILE`

The file for importing the template.

cyclecloud initialize

Initializes CycleCloud settings.

cyclecloud initialize [--batch]
                      [--force]
                      [--url=URL]
                      [--username=USERNAME]
                      [--password=PASSWORD]
                      [--verify-ssl=VERIFY-SSL]
                      [--name=NAMED_CONFIG]

`--batch`

If specified, the arguments must be supplied on the command line. Questions are assumed to be 'no'.

`--force`

Force reinitialization even if a valid config file is available.

`--url=URL`

The base URL for the CycleServer install.

`--username=USERNAME`

The username for the CycleServer install.

`--password=PASSWORD`

The password for the CycleServer install.

`--verify-ssl=VERIFY-SSL`

Whether to verify (true) or not (false) SSL certificates for the CycleServer install.

`--name=NAMED_CONFIG`

Create a named configuration that you can use with the config command.

cyclecloud locker

Manage CycleCloud lockers.

cyclecloud locker <command>

Subcommand	Descrição
`list`	List lockers.
`show <locker>`	Show detail for a locker.

cyclecloud locker list

List lockers.

cyclecloud locker list

cyclecloud locker show

Show detail for a locker.

cyclecloud locker show <locker>

cyclecloud project

Manage CycleCloud projects.

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]

Subcommand	Descrição
`init <name>`	Crie um novo projeto vazio.
`fetch <url> <path>`	Fetch a project from a GitHub <url> to <path>.
`info`	Display project info.
`add_spec <spec>`	Add a spec to the project.
`default_locker <locker>`	Set the default lockers to upload to.
`test`	Execute integration test for a given cluster definition.
`build`	Construa o projeto.
`upload [locker]`	Build and upload project the specified lockers (uses default if none specified).
`download [locker]`	Download the project blobs from the specified lockers (uses default if none specified).
`generate_template <file>`	Generate a cluster template for the project, written to <file>.

cyclecloud project init

Crie um novo projeto vazio.

cyclecloud project init <name>

cyclecloud project fetch

Fetches a project from a GitHub <url> to <path>.

cyclecloud project fetch <url> <path>

cyclecloud project info

Displays the project info.

cyclecloud project info

cyclecloud project add_spec

Adds a spec to the project.

cyclecloud project add_spec <spec>

cyclecloud project default_locker

Sets the default locker for uploads.

cyclecloud project default_locker <locker> [--global]

`--global`

Set global default instead of project specific value.

cyclecloud project test

Executes integration test for a cluster definition.

cyclecloud project test [--skip-teardown]
                        [--output-json=JSON_FILE]
                        [--junit-xml=JUNIT_FILE]
                        [--extra-var=EXTRA_VARS]
                        [--template=TEMPLATE]
                        [--name=CLUSTER_NAME]

`--skip-teardown`

Skip tearing down cluster created for testing.

`--output-json=JSON_FILE`

Output the results to the specified json file.

`--junit-xml=JUNIT_FILE`

Output the results in junit-xml format to the specified json file.

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

Arbitrary key=value pairs used to parameterize the cluster template under test.

`-t TEMPLATE, --template=TEMPLATE`

Path to cluster template file.

`-n CLUSTER_NAME, --name=CLUSTER_NAME`

Name of cluster definition to test.

cyclecloud project build

Construa o projeto.

cyclecloud project build [--project-version=PROJECT_VERSION]
                         [--build-dir=BUILD_DIR]

`--project-version=PROJECT_VERSION`

Override the project version present in project.ini.

`--build-dir=BUILD_DIR`

The build directory.

cyclecloud project upload

Build and upload project the specified lockers (uses default if none specified).

cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]

`--project-version=PROJECT_VERSION`

Override the project version present in project.ini.

cyclecloud project download

Download the project blobs from the specified lockers. If you don't specify lockers, the command uses the default lockers.

cyclecloud project download [locker]

cyclecloud project generate_template

Generate a cluster template for the project. The command writes the template to <file>.

cyclecloud project generate_template <file>

cyclecloud reboot_node

Reboot a running node.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Remove a node from the cluster. The command terminates the node if it started.

cyclecloud remove_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                             [--instance-filter=INSTANCE_FILTER]
                                             [--creds=CREDS]
                                             [--no-prompt]
                                             [--force]

`-f FILTER, --filter=FILTER`

Remove nodes that match the complete class-ad expression.

`--instance-filter=INSTANCE_FILTER`

Remove nodes with active instances that match the complete class-ad expression.

`--creds=CREDS`

Remove nodes that you started using the named set of credentials.

`--no-prompt`

If specified, doesn't ask for confirmation before terminating nodes based on a filter.

`--force`

Force this node to be removed, even if not terminated. Only use this option if the resources for this node in your cloud provider are already terminated.

cyclecloud retry

Retries failed initialization operations for the named cluster.

cyclecloud retry <CLUSTER> [--recursive]

`-r, --recursive`

Recursively retry options in this cluster and all its subclusters.

cyclecloud show_cluster

Shows the cluster or clusters in CycleCloud.

cyclecloud show_cluster <CLUSTER> [--recursive]
                                  [--long]
                                  [--templates]

`-r, --recursive`

Show this cluster and all of its subclusters.

`-l, --long`

Lists each node rather than showing a summary.

`-t, --templates`

Include cluster templates in the output.

cyclecloud show_nodes

Show details of selected nodes or instances.

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`

Display the specified set of attributes (comma-separated list).

`-f FILTER, --filter=FILTER`

Show only nodes matching the complete class-ad expression.

`--instance-filter=INSTANCE_FILTER`

Show only nodes with active instances matching the complete class-ad expression.

`--output=OUTPUT`

Output the matching node attributes described by a Python-style named-parameter format string. Por exemplo, --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n".

`--format=FORMAT`

Change the output display format [xml | json | text].

`--creds=CREDS`

Show only nodes started using the named set of credentials.

`-c CLUSTER, --cluster=CLUSTER`

Show only nodes in the specified cluster.

`--states=STATES`

Show only nodes in the specified states (comma-separated list).

`-l, --long`

Display the complete class-ad representation of the node.

`-s, --summary`

Display a minimal representation of the node.

cyclecloud start_cluster

Starts the named cluster.

cyclecloud start_cluster <CLUSTER> [--recursive]
                                   [--test]

`-r, --recursive`

Recursively start this cluster and all its subclusters.

`-t, --test`

Start cluster in test mode.

cyclecloud start_node

Starts terminated nodes in a running cluster.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Terminates the named cluster.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

`-r, --recursive`

Recursively terminate this cluster and all its subclusters.

cyclecloud terminate_node

Terminates a running node (but leaves it in the cluster).

cyclecloud terminate_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                                [--instance-filter=INSTANCE_FILTER]
                                                [--creds=CREDS]
                                                [--no-prompt]

`-f FILTER, --filter=FILTER`

Terminate nodes matching the complete class-ad expression.

`--instance-filter=INSTANCE_FILTER`

Terminate nodes with active instances matching the complete class-ad expression.

`--creds=CREDS`

Terminate nodes started using the named set of credentials.

`--no-prompt`

If specified, doesn't ask for confirmation before terminating nodes based on a filter.

Partilhar via

CycleCloud CLI

Global CLI Parameters

-h, --help

-v, --version

--config=CONFIG_FILE

--loglevel=LOG_LEVEL

cyclecloud account

cyclecloud account list

cyclecloud account show

cyclecloud account create

-o OUTPUT_FILE

--dry-run

-f INPUT_FILE

cyclecloud account edit

-o OUTPUT_FILE

--dry-run

-f INPUT_FILE

cyclecloud account delete

--force

cyclecloud add_node

-t TEMPLATE, --template=TEMPLATE

-c COUNT, --count=COUNT

-f, --fixed

cyclecloud config

cyclecloud config show

cyclecloud config list

cyclecloud config create

cyclecloud config rename

cyclecloud config use

cyclecloud config remove

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 credential

cyclecloud credential list

cyclecloud credential create

cyclecloud credential edit

cyclecloud credential delete

cyclecloud delete_cluster

-r, --recursive

--force

cyclecloud delete_template

cyclecloud export_parameters

-o OUTPUT_FILE

--format=OUTPUT_FORMAT

cyclecloud image

cyclecloud image add

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