status-get

Summary

Print status information.

Usage

status-get [options] [--include-data] [--application]

Options

Flag

Default

Usage

--application

false

print status for all units of this application if this unit is the leader

--format

smart

Specify output format (json|smart|yaml)

--include-data

false

print all status data

-o, --output

Specify an output file

Examples

# Access the unit’s status:
status-get
status-get --include-data

# Access the application’s status:
status-get --application

Details

By default, only the status value is printed. If the –include-data flag is passed, the associated data are printed also.

Further details: status-get allows charms to query the current workload status.

Without arguments, it just prints the status code e.g. ‘maintenance’. With –include-data specified, it prints YAML which contains the status value plus any data associated with the status.

Include the –application option to get the overall status for the application, rather than an individual unit.