heat-status <category> <command> [<args>]
heat-status is a tool that provides routines for checking the status of a Heat deployment.
The standard pattern for executing a heat-status command is:
heat-status <category> <command> [<args>]
Run without arguments to see a list of available command categories:
heat-status
Categories are:
upgrade
Detailed descriptions are below.
You can also run with a category argument such as upgrade
to see a list of
all commands in that category:
heat-status upgrade
These sections describe the available categories and arguments for heat-status.
heat-status upgrade check
Performs a release-specific readiness check before restarting services with new code. This command expects to have complete configuration and access to databases and services.
Return Codes
Return code | Description |
---|---|
0 | All upgrade readiness checks passed successfully and there is nothing to do. |
1 | At least one check encountered an issue and requires further investigation. This is considered a warning but the upgrade may be OK. |
2 | There was an upgrade status check failure that needs to be investigated. This should be considered something that stops an upgrade. |
255 | An unexpected error occurred. |
History of Checks
12.0.0 (Stein)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.