Chapter 57. overcloud This chapter describes the commands under the overcloud command. 57.1. overcloud admin authorize Deploy the ssh keys needed by Mistral. Usage: Table 57.1. Command arguments Value Summary -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 This option no longer has any effect. --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout for the ssh port to become active. --static-inventory STATIC_INVENTORY Path to an existing ansible inventory to use. if not specified, one will be generated in ~/tripleo-ansible- inventory.yaml --limit LIMIT_HOSTS Define which hosts or group of hosts to run the admin Authorize tasks against. 57.2. overcloud backup Backup the Overcloud Usage: Table 57.2. Command arguments Value Summary --init [INIT] Initialize environment for backup, using rear , nfs or ironic 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 , --setup- nfs and --setup-ironic . --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. --setup-ironic Setup rear on the overcloud controller hosts which will install and configure ReaR with ironic --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: /root/config- download/overcloud/tripleo-ansible-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. 57.3. overcloud cell export Export cell information used as import of another cell Usage: Table 57.3. Command arguments Value Summary -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" --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files are stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --config-download-dir CONFIG_DOWNLOAD_DIR Directory to search for config-download export data. Defaults to USDHOME/overcloud-deploy/<stack>/config- download --force-overwrite, -f Overwrite output file if it exists. 57.4. overcloud ceph deploy Usage: Table 57.4. Positional arguments Value Summary <deployed_baremetal.yaml> Path to the environment file output from "openstack overcloud node provision". This argument may be excluded only if --ceph-spec is used. Table 57.5. Command arguments Value Summary -h, --help Show this help message and exit -o <deployed_ceph.yaml>, --output <deployed_ceph.yaml> The path to the output environment file describing the Ceph deployment to pass to the overcloud deployment. -y, --yes Skip yes/no prompt before overwriting an existing <deployed_ceph.yaml> output file (assume yes). --skip-user-create Do not create the cephadm ssh user. this user is necessary to deploy but may be created in a separate step via openstack overcloud ceph user enable . --skip-hosts-config Do not update /etc/hosts on deployed servers. by default this is configured so overcloud nodes can reach each other and the undercloud by name. --skip-container-registry-config Do not update /etc/containers/registries.conf on deployed servers. By default this is configured so overcloud nodes can pull containers from the undercloud registry. --skip-ntp Do not install/enable ntp chronyd service. By default time synchronization service chronyd is installed and enabled later by tripleo. --cephadm-ssh-user CEPHADM_SSH_USER Name of the ssh user used by cephadm. warning: if this option is used, it must be used consistently for every openstack overcloud ceph call. Defaults to ceph- admin . (default=Env: CEPHADM_SSH_USER) --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --roles-data ROLES_DATA Path to an alternative roles_data.yaml. used to decide which node gets which Ceph mon, mgr, or osd service based on the node's role in <deployed_baremetal.yaml>. --network-data NETWORK_DATA Path to an alternative network_data.yaml. used to define Ceph public_network and cluster_network. This file is searched for networks with name_lower values of storage and storage_mgmt. If none found, then search repeats but with service_net_map_replace in place of name_lower. Use --public-network-name or --cluster-network-name options to override name of the searched for network from storage or storage_mgmt to a customized name. If network_data has no storage networks, both default to ctlplane. If found network has >1 subnet, they are all combined (for routed traffic). If a network has ipv6 true, then the ipv6_subnet is retrieved instead of the ip_subnet, and the Ceph global ms_bind_ipv4 is set false and the ms_bind_ipv6 is set true. Use --config to override these defaults if desired. --public-network-name PUBLIC_NETWORK_NAME Name of the network defined in network_data.yaml which should be used for the Ceph public_network. Defaults to storage . --cluster-network-name CLUSTER_NETWORK_NAME Name of the network defined in network_data.yaml which should be used for the Ceph cluster_network. Defaults to storage_mgmt . --cluster CLUSTER Name of the ceph cluster. if set to foo , then the files /etc/ceph/<FSID>/foo.conf and /etc/ceph/<FSID>/foo.client.admin.keyring will be created. Otherwise these files will use the name ceph . Changing this means changing command line calls too, e.g. ceph health will become ceph --cluster foo health unless export CEPH_ARGS= -- cluster foo is used. --mon-ip MON_IP Ip address of the first ceph monitor. if not set, an IP from the Ceph public_network of a server with the mon label from the Ceph spec is used. IP must already be active on server. --config CONFIG Path to an existing ceph.conf with settings to be assimilated by the new cluster via cephadm bootstrap --config --cephadm-extra-args CEPHADM_EXTRA_ARGS String of extra parameters to pass cephadm. e.g. if --cephadm-extra-args --log-to-file --skip-prepare- host , then cephadm boostrap will use those options. Warning: requires --force as not all possible options ensure a functional deployment. --force Run command regardless of consequences. --ansible-extra-vars ANSIBLE_EXTRA_VARS Path to an existing ansible vars file which can override any variable in tripleo-ansible. If -- ansible-extra-vars vars.yaml is passed, then ansible-playbook -e @vars.yaml ... is used to call tripleo-ansible Ceph roles. Warning: requires --force as not all options ensure a functional deployment. --ceph-client-username CEPH_CLIENT_USERNAME Name of the cephx user. e.g. if openstack is used, then ceph auth get client.openstack will return a working user with key and capabilities on the deployed Ceph cluster. Ignored unless tripleo_cephadm_pools is set via --ansible-extra-vars. If this parameter is not set and tripleo_cephadm_keys is set via --ansible- extra-vars, then openstack will be used. Used to set CephClientUserName in --output. --ceph-client-key CEPH_CLIENT_KEY Value of the cephx key. e.g. AQC+vYNXgDAgAhAAc8UoYt+OTz5uhV7ItLdwUw== . Ignored unless tripleo_cephadm_pools is set via --ansible- extra-vars. If this parameter is not set and tripleo_cephadm_keys is set via --ansible-extra-vars, then a random key will be generated. Used to set CephClientKey in --output. --skip-cephx-keys Do not create cephx keys even if tripleo_cephadm_pools is set via --ansible-extra-vars. If this option is used, then even the defaults of --ceph-client-key and --ceph-client-username are ignored, but the pools defined via --ansible-extra-vars are still created. --single-host-defaults Adjust configuration defaults to suit a single-host Ceph cluster. --ntp-server NTP_SERVER NTP Servers to be used while configuring chronyd service. e.g. --ntp-server 0.pool.ntp.org, 1.pool.ntp.org,2. pool.ntp.org --ntp-heat-env-file NTP_HEAT_ENV_FILE Path to existing heat environment file with NTP servers to be used while configuring chronyd service. NTP servers are extracted from NtpServer key. --ceph-spec CEPH_SPEC Path to an existing ceph spec file. if not provided a spec will be generated automatically based on --roles- data and <deployed_baremetal.yaml>. The <deployed_baremetal.yaml> parameter is optional only if --ceph-spec is used. --osd-spec OSD_SPEC Path to an existing osd spec file. mutually exclusive with --ceph-spec. If the Ceph spec file is generated automatically, then the OSD spec in the Ceph spec file defaults to {data_devices: {all: true}} for all service_type osd. Use --osd-spec to override the data_devices value inside the Ceph spec file. --crush-hierarchy CRUSH_HIERARCHY Path to an existing crush hierarchy spec file. --standalone Use single host ansible inventory. used only for development or testing environments. --container-image-prepare CONTAINER_IMAGE_PREPARE Path to an alternative container_image_prepare_defaults.yaml. Used to control which Ceph container is pulled by cephadm via the ceph_namespace, ceph_image, and ceph_tag variables in addition to registry authentication via ContainerImageRegistryCredentials. --cephadm-default-container Use the default continer defined in cephadm instead of container_image_prepare_defaults.yaml. If this is used, cephadm bootstrap is not passed the --image parameter. Table 57.6. container-image-prepare overrides Value Summary The following options may be used to override individual values set via- container-image-prepare. If the example variables below were set theimage would be concatenated into quay.io/ceph/ceph:latest and a customregistry login would be used.--container-namespace CONTAINER_NAMESPACE E.g. quay.io/ceph --container-image CONTAINER_IMAGE E.g. ceph --container-tag CONTAINER_TAG E.g. latest --registry-url REGISTRY_URL- registry-username REGISTRY_USERNAME- registry-password REGISTRY_PASSWORD None 57.5. overcloud ceph spec Usage: Table 57.7. Positional arguments Value Summary <deployed_baremetal.yaml> Path to the environment file output from "openstack overcloud node provision". This argument may be excluded only if --standalone is used. Table 57.8. Command arguments Value Summary -h, --help Show this help message and exit -o <ceph_spec.yaml>, --output <ceph_spec.yaml> The path to the output cephadm spec file to pass to the "openstack overcloud ceph deploy --ceph-spec <ceph_spec.yaml>" command. -y, --yes Skip yes/no prompt before overwriting an existing <ceph_spec.yaml> output file (assume yes). --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --roles-data ROLES_DATA Path to an alternative roles_data.yaml. used to decide which node gets which Ceph mon, mgr, or osd service based on the node's role in <deployed_baremetal.yaml>. --mon-ip MON_IP Ip address of the first ceph monitor. only available with --standalone. --standalone Create a spec file for a standalone deployment. used for single server development or testing environments. --osd-spec OSD_SPEC Path to an existing osd spec file. when the ceph spec file is generated its OSD spec defaults to {data_devices: {all: true}} for all service_type osd. Use --osd-spec to override the data_devices value inside the Ceph spec file. --crush-hierarchy CRUSH_HIERARCHY Path to an existing crush hierarchy spec file. 57.6. overcloud ceph user disable Usage: Table 57.9. Positional arguments Value Summary <ceph_spec.yaml> Path to an existing ceph spec file which describes the Ceph cluster where the cephadm SSH user will have their public and private keys removed and cephadm will be disabled. Spec file is necessary to determine which nodes to modify. WARNING: Ceph cluster administration or modification will no longer function. Table 57.10. Command arguments Value Summary -h, --help Show this help message and exit -y, --yes Skip yes/no prompt before disabling cephadm and its SSH user. (assume yes). --cephadm-ssh-user CEPHADM_SSH_USER Name of the ssh user used by cephadm. warning: if this option is used, it must be used consistently for every openstack overcloud ceph call. Defaults to ceph- admin . (default=Env: CEPHADM_SSH_USER) --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --standalone Use single host ansible inventory. used only for development or testing environments. Table 57.11. required named arguments Value Summary --fsid <FSID> The fsid of the ceph cluster to be disabled. required for disable option. 57.7. overcloud ceph user enable Usage: Table 57.12. Positional arguments Value Summary <ceph_spec.yaml> Path to an existing ceph spec file which describes the Ceph cluster where the cephadm SSH user will be created (if necessary) and have their public and private keys installed. Spec file is necessary to determine which nodes to modify and if a public or private key is required. Table 57.13. Command arguments Value Summary -h, --help Show this help message and exit --fsid <FSID> The fsid of the ceph cluster to be (re-)enabled. if the user disable option has been used, the FSID may be passed to the user enable option so that cephadm will be re-enabled for the Ceph cluster idenified by the FSID. --standalone Use single host ansible inventory. used only for development or testing environments. --cephadm-ssh-user CEPHADM_SSH_USER Name of the ssh user used by cephadm. warning: if this option is used, it must be used consistently for every openstack overcloud ceph call. Defaults to ceph- admin . (default=Env: CEPHADM_SSH_USER) --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" 57.8. overcloud container image build Build overcloud container images with kolla-build. Usage: Table 57.14. Command arguments Value Summary -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 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. --build-timeout <build timeout in seconds> Build timeout in seconds. 57.9. overcloud container image prepare Generate files defining the images, tags and registry. Usage: Table 57.15. Command arguments Value Summary -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: 17.0 --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-rhel9 --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. 57.10. overcloud container image tag discover Discover the versioned tag for an image. Usage: Table 57.16. Command arguments Value Summary -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} 57.11. overcloud container image upload Push overcloud container images to registries. Usage: Table 57.17. Command arguments Value Summary -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 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. 57.12. overcloud credentials Create the overcloudrc files Usage: Table 57.18. Positional arguments Value Summary stack The name of the stack you want to create rc files for. Table 57.19. Command arguments Value Summary -h, --help Show this help message and exit --directory [DIRECTORY] The directory to create the rc files. defaults to the current directory. --working-dir WORKING_DIR The working directory that contains the input, output, and generated files for the deployment. Defaults to "USDHOME/overcloud-deploy/<stack>" 57.13. overcloud delete Delete overcloud stack and plan Usage: Table 57.20. Positional arguments Value Summary stack Name or id of heat stack to delete(default=env: OVERCLOUD_STACK_NAME) Table 57.21. Command arguments Value Summary -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. -b <baremetal_deployment.yaml>, --baremetal-deployment <baremetal_deployment.yaml> Configuration file describing the baremetal deployment --networks-file <network_data.yaml> Configuration file describing the network deployment to enable unprovisioning of networks. --network-ports Enable unprovisioning of network ports --heat-type {installed,pod,container,native} The type of heat process that was used to executethe deployment. pod (Default): Use an ephemeral Heat pod. installed: Use the system installed Heat. container: Use an ephemeral Heat container. native: Use an ephemeral Heat process. 57.14. overcloud deploy Deploy Overcloud Usage: Table 57.22. Command arguments Value Summary --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. --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 This option no longer has any effect. --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout 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_default.yaml in the --templates directory --vip-file VIP_FILE Configuration file describing the network virtual ips. --plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE Plan environment file for derived parameters. --no-cleanup Don't cleanup temporary files, just log their location --update-plan-only Deprecated: only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release. Not supported anymore. --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 Deprecated: run deployment via config-download mechanism. This is now the default, and this CLI options has no effect. --no-config-download, --stack-only Disable the config-download workflow and only create the stack and download the config. No software configuration, setup, or any changes will be applied to overcloud nodes. --config-download-only Disable the stack create and setup, and only run the config-download workflow to apply the software configuration. Requires that config-download setup was previously completed, either with --stack-only and --setup-only or a full deployment --setup-only Disable the stack and config-download workflow to apply the software configuration and only run the setup to enable ssh connectivity. --config-dir CONFIG_DIR The directory where the configuration files will be pushed --config-type CONFIG_TYPE Only used when "--setup-only" is invoked. type of object config to be extract from the deployment, defaults to all keys available --no-preserve-config Only used when "--setup-only" is invoked. 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. --output-dir OUTPUT_DIR Directory to use for saved output when using --config- download. When not specified, <working-dir>/config- download will be used. --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>] Deploy baremetal nodes, network and virtual ip addresses as defined in baremetal_deployment.yaml along with overcloud. If no baremetal_deployment YAML file is given, the tripleo-<stack_name>-baremetal- deployment.yaml file in the working-dir will be used. --network-config Apply network config to provisioned nodes. (implies " --network-ports") --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 the config- download ansible-playbook command. --skip-tags SKIP_TAGS A list of tags to skip when running the the config- download ansible-playbook command. --ansible-forks ANSIBLE_FORKS The number of ansible forks to use for the config- download ansible-playbook command. --disable-container-prepare Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --heat-type {pod,container,native} The type of heat process to use to execute the deployment. pod (Default): Use an ephemeral Heat pod. container (Experimental): Use an ephemeral Heat container. native (Experimental): Use an ephemeral Heat process. --heat-container-api-image <HEAT_CONTAINER_API_IMAGE> The container image to use when launching the heat-api process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat-api:ephemeral --heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE> The container image to use when launching the heat- engine process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat- engine:ephemeral --rm-heat If specified and --heat-type is container or pod any existing container or pod of a ephemeral Heat process will be deleted first. Ignored if --heat-type is native. --skip-heat-pull When --heat-type is pod or container, assume the container image has already been pulled --disable-protected-resource-types Disable protected resource type overrides. resources types that are used internally are protected, and cannot be overridden in the user environment. Setting this argument disables the protection, allowing the protected resource types to be override in the user environment. -y, --yes Use -y or --yes to skip any confirmation required before the deploy operation. Use this with caution! --allow-deprecated-network-data Set this to allow using deprecated network data yaml definition schema. 57.15. overcloud export ceph Export Ceph information used as import of another stack Export Ceph information from one or more stacks to be used as input of another stack. Creates a valid YAML file with the CephExternalMultiConfig parameter populated. Usage: Table 57.23. Command arguments Value Summary -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 USDHOME/overcloud-deploy/<stack>/config- download 57.16. overcloud export Export stack information used as import of another stack Usage: Table 57.24. Command arguments Value Summary -h, --help Show this help message and exit --stack <stack> Name of the environment main heat stack to export information from. (default=overcloud) --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. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files are stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --config-download-dir CONFIG_DOWNLOAD_DIR Directory to search for config-download export data. Defaults to USDHOME/overcloud-deploy/<stack>/config- download --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. 57.17. overcloud external-update run Run external minor update Ansible playbook This will run the external minor update Ansible playbook, executing tasks from the undercloud. The update playbooks are made available after completion of the overcloud update prepare command. Usage: Table 57.25. Command arguments Value Summary -h, --help Show this help message and exit --static-inventory STATIC_INVENTORY Deprecated: tripleo-ansible-inventory.yaml in working dir will be used. --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 -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. --refresh Deprecated: refresh the config-download playbooks.use overcloud update prepare instead to refresh playbooks. 57.18. overcloud external-upgrade run Run external major upgrade Ansible playbook This will run the external major upgrade Ansible playbook, executing tasks from the undercloud. The upgrade playbooks are made available after completion of the overcloud upgrade prepare command. Usage: Table 57.26. Command arguments Value Summary -h, --help Show this help message and exit --static-inventory STATIC_INVENTORY Deprecated: tripleo-ansible-inventory.yaml in working dir will be used. --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 -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. 57.19. overcloud generate fencing Generate fencing parameters Usage: Table 57.27. Positional arguments Value Summary instackenv None Table 57.28. Command arguments Value Summary -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 57.20. overcloud image build Build images for the overcloud Usage: Table 57.29. Command arguments Value Summary -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 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 USDTRIPLEO_ROOT,or current directory if unset. --temp-dir TEMP_DIR Temporary directory to use when building the images. Defaults to USDTMPDIR or current directory if unset. 57.21. overcloud image upload Make existing image files available for overcloud deployment. Usage: Table 57.30. Command arguments Value Summary -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 Deprecated: copy files locally, even if there is an image service endpoint. The default has been changed to copy files locally. --no-local Upload files to image service. --local-path LOCAL_PATH Root directory for image file copy destination when there is no image endpoint, or when --local is specified 57.22. overcloud netenv validate Validate the network environment file. Usage: Table 57.31. Command arguments Value Summary -h, --help Show this help message and exit -f NETENV, --file NETENV Path to the network environment file 57.23. overcloud network extract Usage: Table 57.32. Command arguments Value Summary -h, --help Show this help message and exit --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) -o <network_deployment.yaml>, --output <network_deployment.yaml> The output file path describing the network deployment -y, --yes Skip yes/no prompt for existing files (assume yes). 57.24. overcloud network provision Usage: Table 57.33. Positional arguments Value Summary <network_data.yaml> Configuration file describing the network deployment. Table 57.34. Command arguments Value Summary -h, --help Show this help message and exit -o <network_environment.yaml>, --output <network_environment.yaml> The output network environment file path. -y, --yes Skip yes/no prompt for existing files (assume yes). --templates TEMPLATES The directory containing the heat templates to deploy --stack STACK Name or id of heat stack, when set the networks file will be copied to the working dir. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy-<stack>" 57.25. overcloud network unprovision Usage: Table 57.35. Positional arguments Value Summary <network_data.yaml> Configuration file describing the network deployment. Table 57.36. Command arguments Value Summary -h, --help Show this help message and exit -y, --yes Skip yes/no prompt (assume yes). 57.26. overcloud network vip extract Usage: Table 57.37. Command arguments Value Summary -h, --help Show this help message and exit --stack STACK Name of heat stack (default=env: overcloud_stack_name) -o <vip_data.yaml>, --output <vip_data.yaml> The output file path describing the virtual ip deployment -y, --yes Skip yes/no prompt for existing files (assume yes). 57.27. overcloud network vip provision Usage: Table 57.38. Positional arguments Value Summary <vip_data.yaml> Configuration file describing the network virtual ips. Table 57.39. Command arguments Value Summary -h, --help Show this help message and exit --stack STACK Name of heat stack (default=env: overcloud_stack_name) -o <vip_environment.yaml>, --output <vip_environment.yaml> The output virtual ip environment file path. -y, --yes Skip yes/no prompt for existing files (assume yes). --templates TEMPLATES The directory containing the heat templates to deploy --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy-<stack>" 57.28. overcloud node bios configure Apply BIOS configuration on given nodes Usage: Table 57.40. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to configure bios Table 57.41. Command arguments Value Summary -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). 57.29. overcloud node bios reset Reset BIOS configuration to factory default Usage: Table 57.42. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to reset bios Table 57.43. Command arguments Value Summary -h, --help Show this help message and exit --all-manageable Reset bios on all nodes currently in manageable state 57.30. overcloud node clean Run node(s) through cleaning. Usage: Table 57.44. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to be cleaned Table 57.45. Command arguments Value Summary -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 57.31. overcloud node configure Configure Node boot options. Usage: Table 57.46. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to be configured Table 57.47. Command arguments Value Summary -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). --boot-mode {uefi,bios} Whether to set the boot mode to uefi (uefi) or legacy BIOS (bios) --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. 57.32. overcloud node delete Delete overcloud nodes. Usage: Table 57.48. Positional arguments Value Summary <node> Node id(s) to delete (otherwise specified in the --baremetal-deployment file) Table 57.49. Command arguments Value Summary -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) --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 --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout for the ssh port to become active. -y, --yes Skip yes/no prompt (assume yes). 57.33. overcloud node discover Discover overcloud nodes by polling their BMCs. Usage: Table 57.50. Command arguments Value Summary -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. --node-timeout NODE_TIMEOUT Maximum timeout for node introspection. --max-retries MAX_RETRIES Maximum introspection retries. --retry-timeout RETRY_TIMEOUT Maximum timeout between introspectionretries 57.34. overcloud node extract provisioned Usage: Table 57.51. Command arguments Value Summary -h, --help Show this help message and exit --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) -o <baremetal_deployment.yaml>, --output <baremetal_deployment.yaml> The output file path describing the baremetal deployment -y, --yes Skip yes/no prompt for existing files (assume yes). --roles-file ROLES_FILE, -r ROLES_FILE Role data definition file 57.35. overcloud node import Import baremetal nodes from a JSON, YAML or CSV file. The node status will be set to manageable by default. Usage: Table 57.52. Positional arguments Value Summary env_file None Table 57.53. Command arguments Value Summary -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) --boot-mode {uefi,bios} Whether to set the boot mode to uefi (uefi) or legacy BIOS (bios) --http-boot HTTP_BOOT Root directory for the ironic-python-agent image --concurrency CONCURRENCY Maximum number of nodes to introspect at once. 57.36. overcloud node introspect Introspect specified nodes or all nodes in manageable state. Usage: Table 57.54. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to be introspected Table 57.55. Command arguments Value Summary -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-timeout NODE_TIMEOUT Maximum timeout for node introspection. --max-retries MAX_RETRIES Maximum introspection retries. --retry-timeout RETRY_TIMEOUT Maximum timeout between introspectionretries 57.37. overcloud node provide Mark nodes as available based on UUIDs or current manageable state. Usage: Table 57.56. Positional arguments Value Summary <node_uuid> Baremetal node uuids for the node(s) to be provided Table 57.57. Command arguments Value Summary -h, --help Show this help message and exit --all-manageable Provide all nodes currently in manageable state 57.38. overcloud node provision Provision new nodes using Ironic. Usage: Table 57.58. Positional arguments Value Summary <baremetal_deployment.yaml> Configuration file describing the baremetal deployment Table 57.59. Command arguments Value Summary -h, --help Show this help message and exit -o OUTPUT, --output OUTPUT The output environment file path -y, --yes Skip yes/no prompt for existing files (assume yes). --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) --network-ports Deprecated! network ports will always be provisioned. Enable provisioning of network ports --network-config Apply network config to provisioned nodes. (implies " --network-ports") --templates TEMPLATES The directory containing the heat templates to deploy --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy-<stack>" 57.39. overcloud node unprovision Unprovisions nodes using Ironic. Usage: Table 57.60. Positional arguments Value Summary <baremetal_deployment.yaml> Configuration file describing the baremetal deployment Table 57.61. Command arguments Value Summary -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) --network-ports Deprecated! network ports will always be unprovisioned. Enable unprovisioning of network ports 57.40. overcloud profiles list List overcloud node profiles Usage: Table 57.62. Command arguments Value Summary -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 Table 57.63. Output formatter options Value Summary -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 to show multiple columns --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 --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 57.64. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 57.65. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 57.66. Table formatter options Value Summary --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. 57.41. overcloud profiles match Assign and validate profiles on nodes Usage: Table 57.67. Command arguments Value Summary -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 57.42. overcloud raid create Create RAID on given nodes Usage: Table 57.68. Positional arguments Value Summary configuration Raid configuration (yaml/json string or file name). Table 57.69. Command arguments Value Summary -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. 57.43. overcloud restore Restore the Overcloud Usage: Table 57.70. Command arguments Value Summary --inventory INVENTORY Tripleo inventory file generated with tripleo-ansible- inventory command. Defaults to: /root/config- download/overcloud/tripleo-ansible-inventory.yaml --stack [STACK] Name or id of the stack to be used(default=env: OVERCLOUD_STACK_NAME) --node-name NODE_NAME Controller name is a required parameter which defines the controller node to be restored. --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. 57.44. overcloud role list List availables roles. Usage: Table 57.71. Command arguments Value Summary -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 57.45. overcloud role show Show information about a given role. Usage: Table 57.72. Positional arguments Value Summary <role> Role to display more information about. Table 57.73. Command arguments Value Summary -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 57.46. overcloud roles generate Generate roles_data.yaml file Usage: Table 57.74. Positional arguments Value Summary <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. Table 57.75. Command arguments Value Summary -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 57.47. overcloud status Get deployment status Usage: Table 57.76. Command arguments Value Summary -h, --help Show this help message and exit --plan PLAN, --stack PLAN Name of the stack/plan. (default: overcloud) --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files are stored. Defaults to "USDHOME/overcloud-deploy/<stack>" 57.48. overcloud support report collect Run sosreport on selected servers. Usage: Table 57.77. Positional arguments Value Summary server_name Server name, group name, or partial name to match. for example "Controller" will match all controllers for an environment. Table 57.78. Command arguments Value Summary -h, --help Show this help message and exit --stack STACK Stack name to use for log collection. -c CONTAINER, --container CONTAINER This option no-longer has any effect. -o DESTINATION, --output DESTINATION Output directory for the report --skip-container-delete This option no-longer has any effect. -t TIMEOUT, --timeout TIMEOUT This option no-longer has any effect. -n CONCURRENCY, --concurrency CONCURRENCY This option no-longer has any effect. --collect-only This option no-longer has any effect. --download-only This option no-longer has any effect. 57.49. overcloud update prepare Use Heat to update and render the new Ansible playbooks based on the updated templates. These playbooks will be rendered and used during the update run step to perform the minor update of the overcloud nodes. Usage: Table 57.79. Command arguments Value Summary --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. --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 This option no longer has any effect. --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout 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_default.yaml in the --templates directory --vip-file VIP_FILE Configuration file describing the network virtual ips. --plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE Plan environment file for derived parameters. --no-cleanup Don't cleanup temporary files, just log their location --update-plan-only Deprecated: only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release. Not supported anymore. --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 Deprecated: run deployment via config-download mechanism. This is now the default, and this CLI options has no effect. --no-config-download, --stack-only Disable the config-download workflow and only create the stack and download the config. No software configuration, setup, or any changes will be applied to overcloud nodes. --config-download-only Disable the stack create and setup, and only run the config-download workflow to apply the software configuration. Requires that config-download setup was previously completed, either with --stack-only and --setup-only or a full deployment --setup-only Disable the stack and config-download workflow to apply the software configuration and only run the setup to enable ssh connectivity. --config-dir CONFIG_DIR The directory where the configuration files will be pushed --config-type CONFIG_TYPE Only used when "--setup-only" is invoked. type of object config to be extract from the deployment, defaults to all keys available --no-preserve-config Only used when "--setup-only" is invoked. 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. --output-dir OUTPUT_DIR Directory to use for saved output when using --config- download. When not specified, <working-dir>/config- download will be used. --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>] Deploy baremetal nodes, network and virtual ip addresses as defined in baremetal_deployment.yaml along with overcloud. If no baremetal_deployment YAML file is given, the tripleo-<stack_name>-baremetal- deployment.yaml file in the working-dir will be used. --network-config Apply network config to provisioned nodes. (implies " --network-ports") --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 the config- download ansible-playbook command. --skip-tags SKIP_TAGS A list of tags to skip when running the the config- download ansible-playbook command. --ansible-forks ANSIBLE_FORKS The number of ansible forks to use for the config- download ansible-playbook command. --disable-container-prepare Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --heat-type {pod,container,native} The type of heat process to use to execute the deployment. pod (Default): Use an ephemeral Heat pod. container (Experimental): Use an ephemeral Heat container. native (Experimental): Use an ephemeral Heat process. --heat-container-api-image <HEAT_CONTAINER_API_IMAGE> The container image to use when launching the heat-api process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat-api:ephemeral --heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE> The container image to use when launching the heat- engine process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat- engine:ephemeral --rm-heat If specified and --heat-type is container or pod any existing container or pod of a ephemeral Heat process will be deleted first. Ignored if --heat-type is native. --skip-heat-pull When --heat-type is pod or container, assume the container image has already been pulled --disable-protected-resource-types Disable protected resource type overrides. resources types that are used internally are protected, and cannot be overridden in the user environment. Setting this argument disables the protection, allowing the protected resource types to be override in the user environment. -y, --yes Use -y or --yes to skip any confirmation required before the deploy operation. Use this with caution! --allow-deprecated-network-data Set this to allow using deprecated network data yaml definition schema. 57.50. overcloud update run Run minor update ansible playbooks on Overcloud nodes Usage: Table 57.80. Command arguments Value Summary -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. can be used multiple times. 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 all 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 Deprecated: tripleo-ansible-inventory.yaml in working dir will be used. --stack STACK Name or id of heat stack (default=env: OVERCLOUD_STACK_NAME) --tags TAGS A list of tags to use when running the the config- download ansible-playbook command. --skip-tags SKIP_TAGS A list of tags to skip when running the 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. 57.51. overcloud upgrade converge Major upgrade converge - reset Heat resources in the stored plan This is the last step for completion of a overcloud major upgrade. The main task is updating the plan and stack to unblock future stack updates. For the major upgrade workflow we have set specific values for some stack Heat resources. This unsets those back to their default values. Usage: Table 57.81. Command arguments Value Summary --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. --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 This option no longer has any effect. --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout 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_default.yaml in the --templates directory --vip-file VIP_FILE Configuration file describing the network virtual ips. --plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE Plan environment file for derived parameters. --no-cleanup Don't cleanup temporary files, just log their location --update-plan-only Deprecated: only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release. Not supported anymore. --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 Deprecated: run deployment via config-download mechanism. This is now the default, and this CLI options has no effect. --no-config-download, --stack-only Disable the config-download workflow and only create the stack and download the config. No software configuration, setup, or any changes will be applied to overcloud nodes. --config-download-only Disable the stack create and setup, and only run the config-download workflow to apply the software configuration. Requires that config-download setup was previously completed, either with --stack-only and --setup-only or a full deployment --setup-only Disable the stack and config-download workflow to apply the software configuration and only run the setup to enable ssh connectivity. --config-dir CONFIG_DIR The directory where the configuration files will be pushed --config-type CONFIG_TYPE Only used when "--setup-only" is invoked. type of object config to be extract from the deployment, defaults to all keys available --no-preserve-config Only used when "--setup-only" is invoked. 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. --output-dir OUTPUT_DIR Directory to use for saved output when using --config- download. When not specified, <working-dir>/config- download will be used. --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>] Deploy baremetal nodes, network and virtual ip addresses as defined in baremetal_deployment.yaml along with overcloud. If no baremetal_deployment YAML file is given, the tripleo-<stack_name>-baremetal- deployment.yaml file in the working-dir will be used. --network-config Apply network config to provisioned nodes. (implies " --network-ports") --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 the config- download ansible-playbook command. --skip-tags SKIP_TAGS A list of tags to skip when running the the config- download ansible-playbook command. --ansible-forks ANSIBLE_FORKS The number of ansible forks to use for the config- download ansible-playbook command. --disable-container-prepare Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --heat-type {pod,container,native} The type of heat process to use to execute the deployment. pod (Default): Use an ephemeral Heat pod. container (Experimental): Use an ephemeral Heat container. native (Experimental): Use an ephemeral Heat process. --heat-container-api-image <HEAT_CONTAINER_API_IMAGE> The container image to use when launching the heat-api process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat-api:ephemeral --heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE> The container image to use when launching the heat- engine process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat- engine:ephemeral --rm-heat If specified and --heat-type is container or pod any existing container or pod of a ephemeral Heat process will be deleted first. Ignored if --heat-type is native. --skip-heat-pull When --heat-type is pod or container, assume the container image has already been pulled --disable-protected-resource-types Disable protected resource type overrides. resources types that are used internally are protected, and cannot be overridden in the user environment. Setting this argument disables the protection, allowing the protected resource types to be override in the user environment. -y, --yes Use -y or --yes to skip any confirmation required before the deploy operation. Use this with caution! --allow-deprecated-network-data Set this to allow using deprecated network data yaml definition schema. 57.52. overcloud upgrade prepare Run heat stack update for overcloud nodes to refresh heat stack outputs. The heat stack outputs are what we use later on to generate ansible playbooks which deliver the major upgrade workflow. This is used as the first step for a major upgrade of your overcloud. Usage: Table 57.82. Command arguments Value Summary --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. --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 This option no longer has any effect. --overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT Timeout 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_default.yaml in the --templates directory --vip-file VIP_FILE Configuration file describing the network virtual ips. --plan-environment-file PLAN_ENVIRONMENT_FILE, -p PLAN_ENVIRONMENT_FILE Plan environment file for derived parameters. --no-cleanup Don't cleanup temporary files, just log their location --update-plan-only Deprecated: only update the plan. do not perform the actual deployment. NOTE: Will move to a discrete command in a future release. Not supported anymore. --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 Deprecated: run deployment via config-download mechanism. This is now the default, and this CLI options has no effect. --no-config-download, --stack-only Disable the config-download workflow and only create the stack and download the config. No software configuration, setup, or any changes will be applied to overcloud nodes. --config-download-only Disable the stack create and setup, and only run the config-download workflow to apply the software configuration. Requires that config-download setup was previously completed, either with --stack-only and --setup-only or a full deployment --setup-only Disable the stack and config-download workflow to apply the software configuration and only run the setup to enable ssh connectivity. --config-dir CONFIG_DIR The directory where the configuration files will be pushed --config-type CONFIG_TYPE Only used when "--setup-only" is invoked. type of object config to be extract from the deployment, defaults to all keys available --no-preserve-config Only used when "--setup-only" is invoked. 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. --output-dir OUTPUT_DIR Directory to use for saved output when using --config- download. When not specified, <working-dir>/config- download will be used. --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>] Deploy baremetal nodes, network and virtual ip addresses as defined in baremetal_deployment.yaml along with overcloud. If no baremetal_deployment YAML file is given, the tripleo-<stack_name>-baremetal- deployment.yaml file in the working-dir will be used. --network-config Apply network config to provisioned nodes. (implies " --network-ports") --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 the config- download ansible-playbook command. --skip-tags SKIP_TAGS A list of tags to skip when running the the config- download ansible-playbook command. --ansible-forks ANSIBLE_FORKS The number of ansible forks to use for the config- download ansible-playbook command. --disable-container-prepare Disable the container preparation actions to prevent container tags from being updated and new containers from being fetched. If you skip this but do not have the container parameters configured, the deployment action may fail. --working-dir WORKING_DIR The working directory for the deployment where all input, output, and generated files will be stored. Defaults to "USDHOME/overcloud-deploy/<stack>" --heat-type {pod,container,native} The type of heat process to use to execute the deployment. pod (Default): Use an ephemeral Heat pod. container (Experimental): Use an ephemeral Heat container. native (Experimental): Use an ephemeral Heat process. --heat-container-api-image <HEAT_CONTAINER_API_IMAGE> The container image to use when launching the heat-api process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat-api:ephemeral --heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE> The container image to use when launching the heat- engine process. Only used when --heat-type=pod. Defaults to: localhost/tripleo/openstack-heat- engine:ephemeral --rm-heat If specified and --heat-type is container or pod any existing container or pod of a ephemeral Heat process will be deleted first. Ignored if --heat-type is native. --skip-heat-pull When --heat-type is pod or container, assume the container image has already been pulled --disable-protected-resource-types Disable protected resource type overrides. resources types that are used internally are protected, and cannot be overridden in the user environment. Setting this argument disables the protection, allowing the protected resource types to be override in the user environment. -y, --yes Use -y or --yes to skip any confirmation required before the deploy operation. Use this with caution! --allow-deprecated-network-data Set this to allow using deprecated network data yaml definition schema. 57.53. overcloud upgrade run Run major upgrade ansible playbooks on Overcloud nodes This will run the major upgrade ansible playbooks on the overcloud. By default all playbooks are executed, that is the upgrade_steps_playbook.yaml then the deploy_steps_playbook.yaml and then the post_upgrade_steps_playbook.yaml. The upgrade playbooks are made available after completion of the overcloud upgrade prepare command. This overcloud upgrade run command is the second step in the major upgrade workflow. Usage: Table 57.83. Command arguments Value Summary -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. can be used multiple times. 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 all playbooks so that all services are updated and running with the target version configuration. --static-inventory STATIC_INVENTORY Deprecated: tripleo-ansible-inventory.yaml in working dir will be used. --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) -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.

Commands:
openstack overcloud admin authorize [-h] [--stack STACK] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--static-inventory STATIC_INVENTORY] [--limit LIMIT_HOSTS]
openstack overcloud backup [--init [INIT]] [--setup-nfs] [--setup-rear] [--setup-ironic] [--cron] [--inventory INVENTORY] [--storage-ip STORAGE_IP] [--extra-vars EXTRA_VARS]
openstack overcloud cell export [-h] [--control-plane-stack <control plane stack>] [--cell-stack <cell stack>] [--output-file <output file>] [--working-dir WORKING_DIR] [--config-download-dir CONFIG_DOWNLOAD_DIR] [--force-overwrite]
openstack overcloud ceph deploy [-h] -o <deployed_ceph.yaml> [-y] [--skip-user-create] [--skip-hosts-config] [--skip-container-registry-config] [--skip-ntp] [--cephadm-ssh-user CEPHADM_SSH_USER] [--stack STACK] [--working-dir WORKING_DIR] [--roles-data ROLES_DATA] [--network-data NETWORK_DATA] [--public-network-name PUBLIC_NETWORK_NAME] [--cluster-network-name CLUSTER_NETWORK_NAME] [--cluster CLUSTER] [--mon-ip MON_IP] [--config CONFIG] [--cephadm-extra-args CEPHADM_EXTRA_ARGS] [--force] [--ansible-extra-vars ANSIBLE_EXTRA_VARS] [--ceph-client-username CEPH_CLIENT_USERNAME] [--ceph-client-key CEPH_CLIENT_KEY] [--skip-cephx-keys] [--single-host-defaults] [--ntp-server NTP_SERVER] [--ntp-heat-env-file NTP_HEAT_ENV_FILE] [--ceph-spec CEPH_SPEC | --osd-spec OSD_SPEC] [--crush-hierarchy CRUSH_HIERARCHY] [--standalone] [--container-image-prepare CONTAINER_IMAGE_PREPARE] [--cephadm-default-container] [--container-namespace CONTAINER_NAMESPACE] [--container-image CONTAINER_IMAGE] [--container-tag CONTAINER_TAG] [--registry-url REGISTRY_URL] [--registry-username REGISTRY_USERNAME] [--registry-password REGISTRY_PASSWORD] [<deployed_baremetal.yaml>]
openstack overcloud ceph spec [-h] -o <ceph_spec.yaml> [-y] [--stack STACK] [--working-dir WORKING_DIR] [--roles-data ROLES_DATA] [--mon-ip MON_IP] [--standalone] [--osd-spec OSD_SPEC | --crush-hierarchy CRUSH_HIERARCHY] [<deployed_baremetal.yaml>]
openstack overcloud ceph user disable [-h] [-y] [--cephadm-ssh-user CEPHADM_SSH_USER] [--stack STACK] [--working-dir WORKING_DIR] --fsid <FSID> [--standalone] <ceph_spec.yaml>
openstack overcloud ceph user enable [-h] [--fsid <FSID>] [--standalone] [--cephadm-ssh-user CEPHADM_SSH_USER] [--stack STACK] [--working-dir WORKING_DIR] <ceph_spec.yaml>
openstack overcloud container image build [-h] [--config-file <yaml config file>] --kolla-config-file <config file> [--list-images] [--list-dependencies] [--exclude <container-name>] [--use-buildah] [--work-dir <container builds directory>] [--build-timeout <build timeout in seconds>]
openstack overcloud container image prepare [-h] [--template-file <yaml template file>] [--push-destination <location>] [--tag <tag>] [--tag-from-label <image label>] [--namespace <namespace>] [--prefix <prefix>] [--suffix <suffix>] [--set <variable=value>] [--exclude <regex>] [--include <regex>] [--output-images-file <file path>] [--environment-file <file path>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--output-env-file <file path>] [--roles-file ROLES_FILE] [--modify-role MODIFY_ROLE] [--modify-vars MODIFY_VARS]
openstack overcloud container image tag discover [-h] --image <container image> [--tag-from-label <image label>]
openstack overcloud container image upload [-h] --config-file <yaml config file> [--cleanup <full, partial, none>]
openstack overcloud credentials [-h] [--directory [DIRECTORY]] [--working-dir WORKING_DIR] stack
openstack overcloud delete [-h] [-y] [-s] [-b <baremetal_deployment.yaml>] [--networks-file <network_data.yaml>] [--network-ports] [--heat-type {installed,pod,container,native}] [stack]
openstack overcloud deploy [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--vip-file VIP_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--setup-only] [--config-dir CONFIG_DIR] [--config-type CONFIG_TYPE] [--no-preserve-config] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b [<baremetal_deployment.yaml>]] [--network-config] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [--disable-container-prepare] [--working-dir WORKING_DIR] [--heat-type {pod,container,native}] [--heat-container-api-image <HEAT_CONTAINER_API_IMAGE>] [--heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE>] [--rm-heat] [--skip-heat-pull] [--disable-protected-resource-types] [-y] [--allow-deprecated-network-data]
openstack overcloud export ceph [-h] [--stack <stack>] [--cephx-key-client-name <cephx>] [--output-file <output file>] [--force-overwrite] [--config-download-dir CONFIG_DOWNLOAD_DIR]
openstack overcloud export [-h] [--stack <stack>] [--output-file <output file>] [--force-overwrite] [--working-dir WORKING_DIR] [--config-download-dir CONFIG_DOWNLOAD_DIR] [--no-password-excludes]
openstack overcloud external-update run [-h] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [-e EXTRA_VARS] [-y] [--limit LIMIT] [--ansible-forks ANSIBLE_FORKS] [--refresh]
openstack overcloud external-upgrade run [-h] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [-e EXTRA_VARS] [-y] [--limit LIMIT] [--ansible-forks ANSIBLE_FORKS]
openstack overcloud generate fencing [-h] [-a FENCE_ACTION] [--delay DELAY] [--ipmi-lanplus] [--ipmi-no-lanplus] [--ipmi-cipher IPMI_CIPHER] [--ipmi-level IPMI_LEVEL] [--output OUTPUT] instackenv
openstack overcloud image build [-h] [--config-file <yaml config file>] [--image-name <image name>] [--no-skip] [--output-directory OUTPUT_DIRECTORY] [--temp-dir TEMP_DIR]
openstack overcloud image upload [-h] [--image-path IMAGE_PATH] [--os-image-name OS_IMAGE_NAME] [--ironic-python-agent-name IPA_NAME] [--http-boot HTTP_BOOT] [--update-existing] [--whole-disk] [--architecture ARCHITECTURE] [--platform PLATFORM] [--image-type {os,ironic-python-agent}] [--progress] [--local] [--no-local] [--local-path LOCAL_PATH]
openstack overcloud netenv validate [-h] [-f NETENV]
openstack overcloud network extract [-h] --stack STACK -o <network_deployment.yaml> [-y]
openstack overcloud network provision [-h] -o <network_environment.yaml> [-y] [--templates TEMPLATES] [--stack STACK] [--working-dir WORKING_DIR] <network_data.yaml>
openstack overcloud network unprovision [-h] [-y] <network_data.yaml>
openstack overcloud network vip extract [-h] --stack STACK -o <vip_data.yaml> [-y]
openstack overcloud network vip provision [-h] --stack STACK -o <vip_environment.yaml> [-y] [--templates TEMPLATES] [--working-dir WORKING_DIR] <vip_data.yaml>
openstack overcloud node bios configure [-h] [--all-manageable] [--configuration <configuration>] [<node_uuid> ...]
openstack overcloud node bios reset [-h] [--all-manageable] [<node_uuid> ...]
openstack overcloud node clean [-h] [--all-manageable] [--provide] [<node_uuid> ...]
openstack overcloud node configure [-h] [--all-manageable] [--deploy-kernel DEPLOY_KERNEL] [--deploy-ramdisk DEPLOY_RAMDISK] [--instance-boot-option {local,netboot}] [--boot-mode {uefi,bios}] [--root-device ROOT_DEVICE] [--root-device-minimum-size ROOT_DEVICE_MINIMUM_SIZE] [--overwrite-root-device-hints] [<node_uuid> ...]
openstack overcloud node delete [-h] [-b <BAREMETAL DEPLOYMENT FILE>] [--stack STACK] [--timeout <TIMEOUT>] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [-y] [<node> ...]
openstack overcloud node discover [-h] (--ip <ips> | --range <range>) --credentials <key:value> [--port <ports>] [--introspect] [--run-validations] [--provide] [--no-deploy-image] [--instance-boot-option {local,netboot}] [--concurrency CONCURRENCY] [--node-timeout NODE_TIMEOUT] [--max-retries MAX_RETRIES] [--retry-timeout RETRY_TIMEOUT]
openstack overcloud node extract provisioned [-h] [--stack STACK] [-o <baremetal_deployment.yaml>] [-y] [--roles-file ROLES_FILE]
openstack overcloud node import [-h] [--introspect] [--run-validations] [--validate-only] [--provide] [--no-deploy-image] [--instance-boot-option {local,netboot}] [--boot-mode {uefi,bios}] [--http-boot HTTP_BOOT] [--concurrency CONCURRENCY] env_file
openstack overcloud node introspect [-h] [--all-manageable] [--provide] [--run-validations] [--concurrency CONCURRENCY] [--node-timeout NODE_TIMEOUT] [--max-retries MAX_RETRIES] [--retry-timeout RETRY_TIMEOUT] [<node_uuid> ...]
openstack overcloud node provide [-h] [--all-manageable] [<node_uuid> ...]
openstack overcloud node provision [-h] [-o OUTPUT] [-y] [--stack STACK] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--concurrency CONCURRENCY] [--timeout TIMEOUT] [--network-ports] [--network-config] [--templates TEMPLATES] [--working-dir WORKING_DIR] <baremetal_deployment.yaml>
openstack overcloud node unprovision [-h] [--stack STACK] [--all] [-y] [--network-ports] <baremetal_deployment.yaml>
openstack overcloud profiles list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
openstack overcloud profiles match [-h] [--dry-run] [--control-scale CONTROL_SCALE] [--compute-scale COMPUTE_SCALE] [--ceph-storage-scale CEPH_STORAGE_SCALE] [--block-storage-scale BLOCK_STORAGE_SCALE] [--swift-storage-scale SWIFT_STORAGE_SCALE] [--control-flavor CONTROL_FLAVOR] [--compute-flavor COMPUTE_FLAVOR] [--ceph-storage-flavor CEPH_STORAGE_FLAVOR] [--block-storage-flavor BLOCK_STORAGE_FLAVOR] [--swift-storage-flavor SWIFT_STORAGE_FLAVOR]
openstack overcloud raid create [-h] --node NODE configuration
openstack overcloud restore [--inventory INVENTORY] [--stack [STACK]] --node-name NODE_NAME [--extra-vars EXTRA_VARS]
openstack overcloud role list [-h] [--roles-path <roles directory>]
openstack overcloud role show [-h] [--roles-path <roles directory>] <role>
openstack overcloud roles generate [-h] [--roles-path <roles directory>] [-o <output file>] [--skip-validate] <role> [<role> ...]
openstack overcloud status [-h] [--plan PLAN] [--working-dir WORKING_DIR]
openstack overcloud support report collect [-h] [--stack STACK] [-c CONTAINER] [-o DESTINATION] [--skip-container-delete] [-t TIMEOUT] [-n CONCURRENCY] [--collect-only] [--download-only] server_name
openstack overcloud update prepare [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--vip-file VIP_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--setup-only] [--config-dir CONFIG_DIR] [--config-type CONFIG_TYPE] [--no-preserve-config] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b [<baremetal_deployment.yaml>]] [--network-config] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [--disable-container-prepare] [--working-dir WORKING_DIR] [--heat-type {pod,container,native}] [--heat-container-api-image <HEAT_CONTAINER_API_IMAGE>] [--heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE>] [--rm-heat] [--skip-heat-pull] [--disable-protected-resource-types] [-y] [--allow-deprecated-network-data]
openstack overcloud update run [-h] --limit LIMIT [--playbook [PLAYBOOK ...]] [--ssh-user SSH_USER] [--static-inventory STATIC_INVENTORY] [--stack STACK] [--tags TAGS] [--skip-tags SKIP_TAGS] [-y] [--ansible-forks ANSIBLE_FORKS]
openstack overcloud upgrade converge [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--vip-file VIP_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--setup-only] [--config-dir CONFIG_DIR] [--config-type CONFIG_TYPE] [--no-preserve-config] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b [<baremetal_deployment.yaml>]] [--network-config] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [--disable-container-prepare] [--working-dir WORKING_DIR] [--heat-type {pod,container,native}] [--heat-container-api-image <HEAT_CONTAINER_API_IMAGE>] [--heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE>] [--rm-heat] [--skip-heat-pull] [--disable-protected-resource-types] [-y] [--allow-deprecated-network-data]
openstack overcloud upgrade prepare [--templates [TEMPLATES]] [--stack STACK] [--timeout <TIMEOUT>] [--libvirt-type {kvm,qemu}] [--ntp-server NTP_SERVER] [--no-proxy NO_PROXY] [--overcloud-ssh-user OVERCLOUD_SSH_USER] [--overcloud-ssh-key OVERCLOUD_SSH_KEY] [--overcloud-ssh-network OVERCLOUD_SSH_NETWORK] [--overcloud-ssh-enable-timeout OVERCLOUD_SSH_ENABLE_TIMEOUT] [--overcloud-ssh-port-timeout OVERCLOUD_SSH_PORT_TIMEOUT] [--environment-file <HEAT ENVIRONMENT FILE>] [--environment-directory <HEAT ENVIRONMENT DIRECTORY>] [--roles-file ROLES_FILE] [--networks-file NETWORKS_FILE] [--vip-file VIP_FILE] [--plan-environment-file PLAN_ENVIRONMENT_FILE] [--no-cleanup] [--update-plan-only] [--validation-errors-nonfatal] [--validation-warnings-fatal] [--disable-validations] [--inflight-validations] [--dry-run] [--run-validations] [--skip-postconfig] [--force-postconfig] [--skip-deploy-identifier] [--answers-file ANSWERS_FILE] [--disable-password-generation] [--deployed-server] [--config-download] [--no-config-download] [--config-download-only] [--setup-only] [--config-dir CONFIG_DIR] [--config-type CONFIG_TYPE] [--no-preserve-config] [--output-dir OUTPUT_DIR] [--override-ansible-cfg OVERRIDE_ANSIBLE_CFG] [--config-download-timeout CONFIG_DOWNLOAD_TIMEOUT] [--deployment-python-interpreter DEPLOYMENT_PYTHON_INTERPRETER] [-b [<baremetal_deployment.yaml>]] [--network-config] [--limit LIMIT] [--tags TAGS] [--skip-tags SKIP_TAGS] [--ansible-forks ANSIBLE_FORKS] [--disable-container-prepare] [--working-dir WORKING_DIR] [--heat-type {pod,container,native}] [--heat-container-api-image <HEAT_CONTAINER_API_IMAGE>] [--heat-container-engine-image <HEAT_CONTAINER_ENGINE_IMAGE>] [--rm-heat] [--skip-heat-pull] [--disable-protected-resource-types] [-y] [--allow-deprecated-network-data]
openstack overcloud upgrade run [-h] --limit LIMIT [--playbook [PLAYBOOK ...]] [--static-inventory STATIC_INVENTORY] [--ssh-user SSH_USER] [--tags TAGS] [--skip-tags SKIP_TAGS] [--stack STACK] [-y] [--ansible-forks ANSIBLE_FORKS]