1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
===========
aodh-status
===========
--------------------------------------
CLI interface for Aodh status commands
--------------------------------------
Synopsis
========
::
aodh-status <category> <command> [<args>]
Description
===========
:program:`aodh-status` is a tool that provides routines for checking the
status of a Aodh deployment.
Options
=======
The standard pattern for executing a :program:`aodh-status` command is::
aodh-status <category> <command> [<args>]
Run without arguments to see a list of available command categories::
aodh-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::
aodh-status upgrade
These sections describe the available categories and arguments for
:program:`aodh-status`.
Upgrade
~~~~~~~
.. _aodh-status-checks:
``aodh-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.
**Return Codes**
.. list-table::
:widths: 20 80
:header-rows: 1
* - 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**
**8.0.0 (Stein)**
* Sample check to be filled in with checks as they are added in Stein.
|