Chapter 55. overcloud

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--init [INIT]

Initialize environment for backup, using rear or nfs as args which will check for package install and configured ReaR or NFS server. Defaults to: rear. i.e. --init rear. WARNING: This flag will be deprecated and replaced by --setup-rear and --setup-nfs.

--setup-nfs

Setup the nfs server on the backup node which will install required packages and configuration on the host BackupNode in the ansible inventory.

--setup-rear

Setup rear on the overcloud controller hosts which will install and configure ReaR.

--cron

Sets up a new cron job that by default will execute a weekly backup at Sundays midnight, but that can be customized by using the tripleo_backup_and_restore_cron extra-var.

--inventory INVENTORY

Tripleo inventory file generated with tripleo-ansible- inventory command. Defaults to: /home/stack/tripleo- inventory.yaml.

--storage-ip STORAGE_IP

Storage ip is an optional parameter which allows for an ip of a storage server to be specified, overriding the default undercloud. WARNING: This flag will be deprecated in favor of --extra-vars which will allow to pass this and other variables.

--extra-vars EXTRA_VARS

Set additional variables as dict or as an absolute path of a JSON or YAML file type. i.e. --extra-vars {"key": "val", "key2": "val2"} i.e. --extra-vars /path/to/my_vars.yaml i.e. --extra-vars /path/to/my_vars.json. For more information about the variables that can be passed, visit: https://opendev.org/openstack/tripleo-ansible/src/bran ch/master/tripleo_ansible/roles/backup_and_restore/def aults/main.yml.

-h, --help

Show this help message and exit

--control-plane-stack <control plane stack>

Name of the environment main heat stack to export information from. (default=Env: OVERCLOUD_STACK_NAME)

--cell-stack <cell stack>, -e <cell stack>

Name of the controller cell heat stack to export information from. Used in case of: control plane stack cell controller stack multiple compute stacks

--output-file <output file>, -o <output file>

Name of the output file for the cell data export. it will default to "<name>.yaml"

--config-download-dir CONFIG_DOWNLOAD_DIR

Directory to search for config-download export data. Defaults to $HOME/config-download

--force-overwrite, -f

Overwrite output file if it exists.

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--config-dir CONFIG_DIR

The directory where the configuration files will be pushed

--config-type CONFIG_TYPE

Type of object config to be extract from the deployment, defaults to all keys available

--no-preserve-config

If specified, will delete and recreate the --config- dir if it already exists. Default is to use the existing dir location and overwrite files. Files in --config-dir not from the stack will be preserved by default.

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the images to build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append. If not specified, the default set of containers will be built.

--kolla-config-file <config file>

Path to a kolla config file to use. multiple config files can be specified, with values in later files taking precedence. By default, tripleo kolla conf file /usr/share/tripleo-common/container- images/tripleo_kolla_config_overrides.conf is added.

--list-images

Show the images which would be built instead of building them.

--list-dependencies

Show the image build dependencies instead of building them.

--exclude <container-name>

Name of a container to match against the list of containers to be built to skip. Can be specified multiple times.

--use-buildah

Use buildah instead of docker to build the images with Kolla.

--work-dir <container builds directory>

Tripleo container builds directory, storing configs and logs for each image and its dependencies.

-h, --help

Show this help message and exit

--template-file <yaml template file>

Yaml template file which the images config file will be built from. Default: /usr/share/tripleo-common/container- images/tripleo_containers.yaml.j2

--push-destination <location>

Location of image registry to push images to. if specified, a push_destination will be set for every image entry.

--tag <tag>

Override the default tag substitution. if --tag-from- label is specified, start discovery with this tag. Default: 16.2

--tag-from-label <image label>

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

--namespace <namespace>

Override the default namespace substitution. Default: registry.redhat.io/rhosp-rhel8

--prefix <prefix>

Override the default name prefix substitution. Default: openstack-

--suffix <suffix>

Override the default name suffix substitution. Default:

--set <variable=value>

Set the value of a variable in the template, even if it has no dedicated argument such as "--suffix".

--exclude <regex>

Pattern to match against resulting imagename entries to exclude from the final output. Can be specified multiple times.

--include <regex>

Pattern to match against resulting imagename entries to include in final output. Can be specified multiple times, entries not matching any --include will be excluded. --exclude is ignored if --include is used.

--output-images-file <file path>

File to write resulting image entries to, as well as stdout. Any existing file will be overwritten.

--environment-file <file path>, -e <file path>

Environment files specifying which services are containerized. Entries will be filtered to only contain images used by containerized services. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the update command. Entries will be filtered to only contain images used by containerized services. Can be specified more than once. Files in directories are loaded in ascending sort order.

--output-env-file <file path>

File to write heat environment file which specifies all image parameters. Any existing file will be overwritten.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the t-h-t templates directory used for deployment. May be an absolute path or the path relative to the templates dir.

--modify-role MODIFY_ROLE

Name of ansible role to run between every image upload pull and push.

--modify-vars MODIFY_VARS

Ansible variable file containing variables to use when invoking the role --modify-role.

-h, --help

Show this help message and exit

--image <container image>

Fully qualified name of the image to discover the tag for (Including registry and stable tag).

--tag-from-label <image label>

Use the value of the specified label(s) to discover the tag. Labels can be combined in a template format, for example: {version}-{release}

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the image build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--cleanup <full, partial, none>

Cleanup behavior for local images left after upload. The default full will attempt to delete all local images. partial will leave images required for deployment on this host. none will do no cleanup.

plan

The name of the plan you want to create rc files for.

-h, --help

Show this help message and exit

--directory [DIRECTORY]

The directory to create the rc files. defaults to the current directory.

stack

Name or id of heat stack to delete(default=env: OVERCLOUD_STACK_NAME)

-h, --help

Show this help message and exit

-y, --yes

Skip yes/no prompt (assume yes).

-s, --skip-ipa-cleanup

Skip removing overcloud hosts, services, and dns records from FreeIPA. This is particularly relevant for deployments using certificates from FreeIPA for TLS. By default, overcloud hosts, services, and DNS records will be removed from FreeIPA before deleting the overcloud. Using this option might require you to manually cleanup FreeIPA later.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. This option will be removed in the "U" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. This option will be removed in the "U" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. This option will be removed in the "U" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. This option will be removed in the "U" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. This option will be removed in the "U" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. This option will be removed in the "U" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. This option will be removed in the "U" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. This option will be removed in the "U" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. This option will be removed in the "U" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. This option will be removed in the "U" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

file_in

None

-h, --help

Show this help message and exit

-s SERVER_NAME, --server_name SERVER_NAME

Nova server_name or partial name to match.

-g GROUP, --group GROUP

Heat software config "group" type. defaults to "script".

-h, --help

Show this help message and exit

--stack <stack>

Name of the overcloud stack(s) to export ceph information from. If a comma delimited list of stacks is passed, Ceph information for all stacks will be exported into a single file. (default=Env: OVERCLOUD_STACK_NAME)

--cephx-key-client-name <cephx>, -k <cephx>

Name of the cephx client key to export. (default=openstack)

--output-file <output file>, -o <output file>

Name of the output file for the ceph data export. Defaults to "ceph-export-<STACK>.yaml" if one stack is provided. Defaults to "ceph-export-<N>-stacks.yaml" if N stacks are provided.

--force-overwrite, -f

Overwrite output file if it exists.

--config-download-dir CONFIG_DOWNLOAD_DIR

Directory to search for config-download export data. Defaults to /var/lib/mistral

-h, --help

Show this help message and exit

--stack <stack>

Name of the environment main heat stack to export information from. (default=Env: OVERCLOUD_STACK_NAME)

--output-file <output file>, -o <output file>

Name of the output file for the stack data export. it will default to "<name>.yaml"

--force-overwrite, -f

Overwrite output file if it exists.

--config-download-dir CONFIG_DOWNLOAD_DIR

Directory to search for config-download export data. Defaults to /var/lib/mistral/<stack>

--no-password-excludes

Dont exclude certain passwords from the password export. Defaults to False in that some passwords will be excluded that are not typically necessary.

-h, --help

Show this help message and exit

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

Set additional variables as key=value or yaml/json

--no-workflow

Run ansible-playbook directly via system command instead of running Ansiblevia the TripleO mistral workflows.

-y, --yes

Use -y or --yes to skip the confirmation required before any upgrade operation. Use this with caution!

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-h, --help

Show this help message and exit

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

-e EXTRA_VARS, --extra-vars EXTRA_VARS

Set additional variables as key=value or yaml/json

--no-workflow

Run ansible-playbook directly via system command instead of running Ansiblevia the TripleO mistral workflows.

-y, --yes

Use -y or --yes to skip the confirmation required before any upgrade operation. Use this with caution!

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

Name of the stack/plan. (default: overcloud)

instackenv

None

-h, --help

Show this help message and exit

-a FENCE_ACTION, --action FENCE_ACTION

Deprecated: this option is ignored.

--delay DELAY

Wait delay seconds before fencing is started

--ipmi-lanplus

Deprecated: this is the default.

--ipmi-no-lanplus

Do not use lanplus. defaults to: false

--ipmi-cipher IPMI_CIPHER

Ciphersuite to use (same as ipmitool -c parameter.

--ipmi-level IPMI_LEVEL

Privilegel level on ipmi device. valid levels: callback, user, operator, administrator.

--output OUTPUT

Write parameters to a file

-h, --help

Show this help message and exit

--config-file <yaml config file>

Yaml config file specifying the image build. may be specified multiple times. Order is preserved, and later files will override some options in previous files. Other options will append.

--image-name <image name>

Name of image to build. may be specified multiple times. If unspecified, will build all images in given YAML files.

--no-skip

Skip build if cached image exists.

--output-directory OUTPUT_DIRECTORY

Output directory for images. defaults to $TRIPLEO_ROOT,or current directory if unset.

--temp-dir TEMP_DIR

Temporary directory to use when building the images. Defaults to $TMPDIR or current directory if unset.

-h, --help

Show this help message and exit

--image-path IMAGE_PATH

Path to directory containing image files

--os-image-name OS_IMAGE_NAME

Openstack disk image filename

--ironic-python-agent-name IPA_NAME

Openstack ironic-python-agent (agent) image filename

--http-boot HTTP_BOOT

Root directory for the ironic-python-agent image. if uploading images for multiple architectures/platforms, vary this argument such that a distinct folder is created for each architecture/platform.

--update-existing

Update images if already exist

--whole-disk

When set, the overcloud-full image to be uploaded will be considered as a whole disk one

--architecture ARCHITECTURE

Architecture type for these images, x86_64, i386 and ppc64le are common options. This option should match at least one arch value in instackenv.json

--platform PLATFORM

Platform type for these images. platform is a sub- category of architecture. For example you may have generic images for x86_64 but offer images specific to SandyBridge (SNB).

--image-type {os,ironic-python-agent}

If specified, allows to restrict the image type to upload (os for the overcloud image or ironic-python- agent for the ironic-python-agent one)

--progress

Show progress bar for upload files action

--local

Copy files locally, even if there is an image service endpoint

--local-path LOCAL_PATH

Root directory for image file copy destination when there is no image endpoint, or when --local is specified

-h, --help

Show this help message and exit

-f NETENV, --file NETENV

Path to the network environment file

<node_uuid>

Baremetal node uuids for the node(s) to configure bios

-h, --help

Show this help message and exit

--all-manageable

Configure bios for all nodes currently in manageable state

--configuration <configuration>

Bios configuration (yaml/json string or file name).

<node_uuid>

Baremetal node uuids for the node(s) to reset bios

-h, --help

Show this help message and exit

--all-manageable

Reset bios on all nodes currently in manageable state

<node_uuid>

Baremetal node uuids for the node(s) to be cleaned

-h, --help

Show this help message and exit

--all-manageable

Clean all nodes currently in manageable state

--provide

Provide (make available) the nodes once cleaned

<node_uuid>

Baremetal node uuids for the node(s) to be configured

-h, --help

Show this help message and exit

--all-manageable

Configure all nodes currently in manageable state

--deploy-kernel DEPLOY_KERNEL

Image with deploy kernel.

--deploy-ramdisk DEPLOY_RAMDISK

Image with deploy ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

--root-device ROOT_DEVICE

Define the root device for nodes. can be either a list of device names (without /dev) to choose from or one of two strategies: largest or smallest. For it to work this command should be run after the introspection.

--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE

Minimum size (in gib) of the detected root device. Used with --root-device.

--overwrite-root-device-hints

Whether to overwrite existing root device hints when --root-device is used.

<node>

Node id(s) to delete (otherwise specified in the --baremetal-deployment file)

-h, --help

Show this help message and exit

-b <BAREMETAL DEPLOYMENT FILE>, --baremetal-deployment <BAREMETAL DEPLOYMENT FILE>

Configuration file describing the baremetal deployment

--stack STACK

Name or id of heat stack to scale (default=env: OVERCLOUD_STACK_NAME)

--templates [TEMPLATES]

The directory containing the heat templates to deploy. This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.) This argument is deprecated. The command now utilizes a deployment plan, which should be updated prior to running this command, should that be required. Otherwise this argument will be silently ignored.

--timeout <TIMEOUT>

Timeout in minutes to wait for the nodes to be deleted. Keep in mind that due to keystone session duration that timeout has an upper bound of 4 hours

-y, --yes

Skip yes/no prompt (assume yes).

-h, --help

Show this help message and exit

--ip <ips>

Ip address(es) to probe

--range <range>

Ip range to probe

--credentials <key:value>

Key/value pairs of possible credentials

--port <ports>

Bmc port(s) to probe

--introspect

Introspect the imported nodes

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

--concurrency CONCURRENCY

Maximum number of nodes to introspect at once.

env_file

None

-h, --help

Show this help message and exit

--introspect

Introspect the imported nodes

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

--validate-only

Validate the env_file and then exit without actually importing the nodes.

--provide

Provide (make available) the nodes

--no-deploy-image

Skip setting the deploy kernel and ramdisk.

--instance-boot-option {local,netboot}

Whether to set instances for booting from local hard drive (local) or network (netboot).

--http-boot HTTP_BOOT

Root directory for the ironic-python-agent image

--concurrency CONCURRENCY

Maximum number of nodes to introspect at once.

<node_uuid>

Baremetal node uuids for the node(s) to be introspected

-h, --help

Show this help message and exit

--all-manageable

Introspect all nodes currently in manageable state

--provide

Provide (make available) the nodes once introspected

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

--concurrency CONCURRENCY

Maximum number of nodes to introspect at once.

<node_uuid>

Baremetal node uuids for the node(s) to be provided

-h, --help

Show this help message and exit

--all-manageable

Provide all nodes currently in manageable state

<baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

-h, --help

Show this help message and exit

-o OUTPUT, --output OUTPUT

The output environment file path

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to newly deployed nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access toovercloud nodes. when undefined the keywill be autodetected.

--concurrency CONCURRENCY

Maximum number of nodes to provision at once. (default=20)

--timeout TIMEOUT

Number of seconds to wait for the node provision to complete. (default=3600)

<baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

-h, --help

Show this help message and exit

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--all

Unprovision every instance in the deployment

-y, --yes

Skip yes/no prompt (assume yes)

name

The name of the plan, which is used for the swift container, Mistral environment and Heat stack names.

file_in

None

-h, --help

Show this help message and exit

name

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

-h, --help

Show this help message and exit

--templates TEMPLATES

The directory containing the heat templates to deploy. If this or --source_url isn’t provided, the templates packaged on the Undercloud will be used.

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--disable-password-generation

Disable password generation.

--source-url SOURCE_URL

The url of a git repository containing the heat templates to deploy. If this or --templates isn’t provided, the templates packaged on the Undercloud will be used.

<name>

Name of the plan(s) to delete

-h, --help

Show this help message and exit

name

The name of the plan to deploy.

-h, --help

Show this help message and exit

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--run-validations

Run the pre-deployment validations. these external validations are from the TripleO Validations project.

<name>

Name of the plan to export.

-h, --help

Show this help message and exit

--output-file <output file>, -o <output file>

Name of the output file for export. it will default to "<name>.tar.gz".

--force-overwrite, -f

Overwrite output file if it exists.

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

--all

List all nodes, even those not available to nova.

--control-scale CONTROL_SCALE

New number of control nodes.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes.

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes.

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes.

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

--dry-run

Only run validations, but do not apply any changes.

--control-scale CONTROL_SCALE

New number of control nodes.

--compute-scale COMPUTE_SCALE

New number of compute nodes.

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes.

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes.

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes.

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes.

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes.

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes.

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes

configuration

Raid configuration (yaml/json string or file name).

-h, --help

Show this help message and exit

--node NODE

Nodes to create raid on (expected to be in manageable state). Can be specified multiple times.

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

<role>

Role to display more information about.

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

<role>

List of roles to use to generate the roles_data.yaml file for the deployment. NOTE: Ordering is important if no role has the "primary" and "controller" tags. If no role is tagged then the first role listed will be considered the primary role. This usually is the controller role.

-h, --help

Show this help message and exit

--roles-path <roles directory>

Filesystem path containing the role yaml files. by default this is /usr/share/openstack-tripleo-heat- templates/roles

-o <output file>, --output-file <output file>

File to capture all output to. for example, roles_data.yaml

--skip-validate

Skip role metadata type validation whengenerating the roles_data.yaml

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

--detail

Include details about each role

--current

Only show the information for the roles currently enabled for the plan.

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<role>

Name of the role to look up.

-h, --help

Show this help message and exit

--name NAME

The name of the plan, which is used for the object storage container, workflow environment and orchestration stack names.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

-h, --help

Show this help message and exit

--plan PLAN, --stack PLAN

Name of the stack/plan. (default: overcloud)

server_name

Server name, group name, or partial name to match. for example "Controller" will match all controllers for an environment.

-h, --help

Show this help message and exit

-c, --container

Deprecated: swift container to store logs to

-o DESTINATION, --output DESTINATION

Output directory for the report

--stack STACK

Stack name to use for log collection.

--skip-container-delete

Deprecated: do not delete the container after the files have been downloaded. Ignored if --collect-only or --download-only is provided.

-t TIMEOUT, --timeout TIMEOUT

Maximum time to wait for the log collection and container deletion workflows to finish.

-n CONCURRENCY, --concurrency CONCURRENCY

Number of parallel log collection and object deletion tasks to run.

--collect-only

Deprecated: skip log downloads, only collect logs and put in the container

--download-only

Deprecated: skip generation, only download from the provided container

-v VERBOSITY, --verbose VERBOSITY

None

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. This option will be removed in the "U" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. This option will be removed in the "U" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. This option will be removed in the "U" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. This option will be removed in the "U" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. This option will be removed in the "U" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. This option will be removed in the "U" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. This option will be removed in the "U" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. This option will be removed in the "U" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. This option will be removed in the "U" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. This option will be removed in the "U" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-y, --yes

Use -y or --yes to skip the confirmation required before any update operation. Use this with caution!

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. This option will be removed in the "U" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. This option will be removed in the "U" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. This option will be removed in the "U" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. This option will be removed in the "U" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. This option will be removed in the "U" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. This option will be removed in the "U" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. This option will be removed in the "U" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. This option will be removed in the "U" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. This option will be removed in the "U" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. This option will be removed in the "U" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-y, --yes

Use -y or --yes to skip the confirmation required before any update operation. Use this with caution!

-h, --help

Show this help message and exit

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--playbook PLAYBOOK

Ansible playbook to use for the minor update. defaults to the special value all which causes all the update playbooks to be executed. That is the update_steps_playbook.yaml and then thedeploy_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: make sure to run both those playbooks so that all services are updated and running with the target version configuration.

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--no-workflow

Run ansible-playbook directly via system command instead of running Ansiblevia the TripleO mistral workflows.

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

-y, --yes

Use -y or --yes to skip the confirmation required before any update operation. Use this with caution!

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. This option will be removed in the "U" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. This option will be removed in the "U" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. This option will be removed in the "U" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. This option will be removed in the "U" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. This option will be removed in the "U" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. This option will be removed in the "U" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. This option will be removed in the "U" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. This option will be removed in the "U" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. This option will be removed in the "U" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. This option will be removed in the "U" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-y, --yes

Use -y or --yes to skip the confirmation required before any upgrade operation. Use this with caution!

--templates [TEMPLATES]

The directory containing the heat templates to deploy

--stack STACK

Stack name to create or update

--timeout <TIMEOUT>, -t <TIMEOUT>

Deployment timeout in minutes.

--control-scale CONTROL_SCALE

New number of control nodes. (deprecated. use an environment file and set the parameter ControllerCount. This option will be removed in the "U" release.)

--compute-scale COMPUTE_SCALE

New number of compute nodes. (deprecated. use an environment file and set the parameter ComputeCount. This option will be removed in the "U" release.)

--ceph-storage-scale CEPH_STORAGE_SCALE

New number of ceph storage nodes. (deprecated. use an environment file and set the parameter CephStorageCount. This option will be removed in the "U" release.)

--block-storage-scale BLOCK_STORAGE_SCALE

New number of cinder storage nodes. (deprecated. use an environment file and set the parameter BlockStorageCount. This option will be removed in the "U" release.)

--swift-storage-scale SWIFT_STORAGE_SCALE

New number of swift storage nodes. (deprecated. use an environment file and set the parameter ObjectStorageCount. This option will be removed in the "U" release.)

--control-flavor CONTROL_FLAVOR

Nova flavor to use for control nodes. (deprecated. use an environment file and set the parameter OvercloudControlFlavor. This option will be removed in the "U" release.)

--compute-flavor COMPUTE_FLAVOR

Nova flavor to use for compute nodes. (deprecated. use an environment file and set the parameter OvercloudComputeFlavor. This option will be removed in the "U" release.)

--ceph-storage-flavor CEPH_STORAGE_FLAVOR

Nova flavor to use for ceph storage nodes. (DEPRECATED. Use an environment file and set the parameter OvercloudCephStorageFlavor. This option will be removed in the "U" release.)

--block-storage-flavor BLOCK_STORAGE_FLAVOR

Nova flavor to use for cinder storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudBlockStorageFlavor. This option will be removed in the "U" release.)

--swift-storage-flavor SWIFT_STORAGE_FLAVOR

Nova flavor to use for swift storage nodes (DEPRECATED. Use an environment file and set the parameter OvercloudSwiftStorageFlavor. This option will be removed in the "U" release.)

--libvirt-type {kvm,qemu}

Libvirt domain type.

--ntp-server NTP_SERVER

The ntp for overcloud nodes.

--no-proxy NO_PROXY

A comma separated list of hosts that should not be proxied.

--overcloud-ssh-user OVERCLOUD_SSH_USER

User for ssh access to overcloud nodes

--overcloud-ssh-key OVERCLOUD_SSH_KEY

Key path for ssh access to overcloud nodes. Whenundefined the key will be autodetected.

--overcloud-ssh-network OVERCLOUD_SSH_NETWORK

Network name to use for ssh access to overcloud nodes.

--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT

Timeout for the ssh enable process to finish.

--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT

Timeout for to wait for the ssh port to become active.

--environment-file <HEAT ENVIRONMENT FILE>, -e <HEAT ENVIRONMENT FILE>

Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

--environment-directory <HEAT ENVIRONMENT DIRECTORY>

Environment file directories that are automatically added to the heat stack-create or heat stack-update commands. Can be specified more than once. Files in directories are loaded in ascending sort order.

--roles-file ROLES_FILE, -r ROLES_FILE

Roles file, overrides the default roles_data.yaml in the --templates directory. May be an absolute path or the path relative to --templates

--networks-file NETWORKS_FILE, -n NETWORKS_FILE

Networks file, overrides the default network_data.yaml in the --templates directory

--plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE

Plan environment file, overrides the default plan- environment.yaml in the --templates directory

--no-cleanup

Don’t cleanup temporary files, just log their location

--update-plan-only

Only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release.

--validation-errors-nonfatal

Allow the deployment to continue in spite of validation errors. Note that attempting deployment while errors exist is likely to fail.

--validation-warnings-fatal

Exit if there are warnings from the configuration pre- checks.

--disable-validations

Deprecated. disable the pre-deployment validations entirely. These validations are the built-in pre- deployment validations. To enable external validations from tripleo-validations, use the --run-validations flag. These validations are now run via the external validations in tripleo-validations.

--inflight-validations

Activate in-flight validations during the deploy. in- flight validations provide a robust way to ensure deployed services are running right after their activation. Defaults to False.

--dry-run

Only run validations, but do not apply any changes.

--run-validations

Run external validations from the tripleo-validations project.

--skip-postconfig

Skip the overcloud post-deployment configuration.

--force-postconfig

Force the overcloud post-deployment configuration.

--skip-deploy-identifier

Skip generation of a unique identifier for the DeployIdentifier parameter. The software configuration deployment steps will only be triggered if there is an actual change to the configuration. This option should be used with Caution, and only if there is confidence that the software configuration does not need to be run, such as when scaling out certain roles.

--answers-file ANSWERS_FILE

Path to a yaml file with arguments and parameters.

--disable-password-generation

Disable password generation.

--deployed-server

Use pre-provisioned overcloud nodes. removes baremetal,compute and image services requirements from theundercloud node. Must only be used with the-- disable-validations.

--config-download

Run deployment via config-download mechanism. this is now the default, and this CLI options may be removed in the future.

--no-config-download, --stack-only

Disable the config-download workflow and only create the stack and associated OpenStack resources. No software configuration will be applied.

--config-download-only

Disable the stack create/update, and only run the config-download workflow to apply the software configuration.

--output-dir OUTPUT_DIR

Directory to use for saved output when using --config- download. The directory must be writeable by the mistral user. When not specified, the default server side value will be used (/var/lib/mistral/<execution id>.

--override-ansible-cfg OVERRIDE_ANSIBLE_CFG

Path to ansible configuration file. the configuration in the file will override any configuration used by config-download by default.

--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT

Timeout (in minutes) to use for config-download steps. If unset, will default to however much time is leftover from the --timeout parameter after the stack operation.

--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER

The path to python interpreter to use for the deployment actions. This may need to be used if deploying on a python2 host from a python3 system or vice versa.

-b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml>

Configuration file describing the baremetal deployment

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--tags TAGS

A list of tags to use when running the config-download ansible-playbook command.

--skip-tags SKIP_TAGS

A list of tags to skip when running the config- download ansible-playbook command.

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.

-y, --yes

Use -y or --yes to skip the confirmation required before any upgrade operation. Use this with caution!

-h, --help

Show this help message and exit

--limit LIMIT

A string that identifies a single node or comma- separatedlist of nodes the config-download Ansible playbook execution will be limited to. For example: --limit "compute-0,compute-1,compute-5".

--playbook PLAYBOOK

Ansible playbook to use for the major upgrade. Defaults to the special value all which causes all the upgrade playbooks to run. That is the upgrade_steps_playbook.yaml then deploy_steps_playbook.yaml and then post_upgrade_steps_playbook.yaml. Set this to each of those playbooks in consecutive invocations of this command if you prefer to run them manually. Note: you will have to run all of those playbooks so that all services are upgraded and running with the target version configuration.

--static-inventory STATIC_INVENTORY

Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml

--ssh-user SSH_USER

Deprecated: only tripleo-admin should be used as ssh user.

--tags TAGS

A string specifying the tag or comma separated list of tags to be passed as --tags to ansible-playbook.

--skip-tags SKIP_TAGS

A string specifying the tag or comma separated list of tags to be passed as --skip-tags to ansible-playbook. The currently supported values are validation and pre-upgrade. In particular validation is useful if you must re-run following a failed upgrade and some services cannot be started.

--stack STACK

Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME)

--no-workflow

Run ansible-playbook directly via system command instead of running Ansiblevia the TripleO mistral workflows.

-y, --yes

Use -y or --yes to skip the confirmation required before any upgrade operation. Use this with caution!

--ansible-forks ANSIBLE_FORKS

The number of ansible forks to use for the config- download ansible-playbook command.