CLI interface for Magnum status commands


magnum-status <category> <command> [<args>]


magnum-status is a tool that provides routines for checking the status of a Magnum deployment.


The standard pattern for executing a magnum-status command is:

magnum-status <category> <command> [<args>]

Run without arguments to see a list of available command categories:


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:

magnum-status upgrade

These sections describe the available categories and arguments for magnum-status.


magnum-status upgrade check

Performs a release-specific readiness check before restarting services with new code. For example, missing or changed configuration options, incompatible object states, or other conditions that could lead to failures while upgrading.

Sample Output

Upgrade Check Results

Check: Sample Check

Result: Success

Details: Sample detail

Return Codes

Return code



All upgrade readiness checks passed successfully and there is nothing to do.


At least one check encountered an issue and requires further investigation. This is considered a warning but the upgrade may be OK.


There was an upgrade status check failure that needs to be investigated. This should be considered something that stops an upgrade.


An unexpected error occurred.

History of Checks

8.0.0 (Stein)

  • Sample check to be filled in with checks as they are added in Stein.