Masakari commands are CLI interface.
Create notification.
openstack notification create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<type>
<hostname>
<generated_time>
<payload>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Type of failure. The supported options are: COMPUTE_HOST, VM, PROCESS.
Hostname of notification.
Timestamp for notification. e.g. 2016-01-01T01:00:00.000
JSON string about failure event.
This command is provided by the python-masakariclient plugin.
List notifications.
openstack notification list
[-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]
[--limit <limit>]
[--marker <id>]
[--sort <key>[:<direction>]]
[--filters <"key1=value1;key2=value2...">]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Limit the number of notifications returned
Only return notifications that appear after the given notification ID
Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘type’, ‘created_at’, ‘updated_at’]
Filter parameters to apply on returned notifications. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘source_host_uuid’, ‘type’, ‘status’, generated-since]
This command is provided by the python-masakariclient plugin.
Show notification details.
openstack notification show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<notification>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
UUID of notification to display
This command is provided by the python-masakariclient plugin.
Create segment.
openstack segment create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--is_enabled <boolean>]
[--description <description>]
<name>
<recovery_method>
<service_type>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
The enabled flag of this segment. Supported after microversion 1.2.
Description of segment.
Name of segment.
Recovery method of segment. The supported options are: auto, reserved_host, auto_priority, rh_priority.
Service type of segment.
This command is provided by the python-masakariclient plugin.
Delete a segment(s).
openstack segment delete <segment> [<segment> ...]
Name or ID of segment(s) to delete
This command is provided by the python-masakariclient plugin.
Create a Host.
openstack segment host create
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--reserved <reserved>]
[--on_maintenance <on_maintenance>]
<name>
<type>
<control_attributes>
<segment_id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Host reservation. The supported options are: True, False.
Maintenance status of host. The supported options are: True, False.
Name of host.
Type of host.
Attribute about control.
Name or ID of segment.
This command is provided by the python-masakariclient plugin.
Delete a host.
openstack segment host delete <segment_id> <host>
Name or ID of segment.
Name or ID of the Host
This command is provided by the python-masakariclient plugin.
List Hosts.
openstack segment host list
[-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]
[--limit <limit>]
[--marker <id>]
[--sort <key>[:<direction>]]
[--filters <"key1=value1;key2=value2...">]
<segment_id>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Limit the number of hosts returned
Only return hosts that appear after the given host ID
Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘type’, ‘name’, ‘created_at’, ‘updated_at’]
Filter parameters to apply on returned hosts. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘failover_segment_id’, ‘type’, ‘on_maintenance’, ‘reserved’]
Name or ID of segment.
This command is provided by the python-masakariclient plugin.
Show host details.
openstack segment host show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<segment_id>
<host>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name or ID of segment.
Name or ID of the Host
This command is provided by the python-masakariclient plugin.
Update a Host.
openstack segment host update
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--reserved <reserved>]
[--on_maintenance <on_maintenance>]
[--name <name>]
[--type <type>]
[--control_attributes <control_attributes>]
<segment_id>
<host>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Host reservation. The supported options are: True, False.
Maintenance status of host. The supported options are: True, False.
Name of host.
Type of host.
Attributes about control.
Name or ID of segment.
Name or ID of the Host
This command is provided by the python-masakariclient plugin.
List segments.
openstack segment list
[-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]
[--limit <limit>]
[--marker <id>]
[--sort <key>[:<direction>]]
[--filters <"key1=value1;key2=value2...">]
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Limit the number of segments returned
Only return segments that appear after the given segment ID
Sorting option which is a string containing a list of keys separated by commas. Each key can be optionally appended by a sort direction (:asc or :desc). The valid sort keys are: [‘type’, ‘name’, ‘created_at’, ‘updated_at’]
Filter parameters to apply on returned segments. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: [‘recovery_method’, ‘service_type’]
This command is provided by the python-masakariclient plugin.
Show segment details.
openstack segment show
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
<segment>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Segment to display (name or ID)
This command is provided by the python-masakariclient plugin.
Update a segment.
openstack segment update
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width]
[--print-empty]
[--name <name>]
[--recovery_method <recovery_method>]
[--service_type <service_type>]
[--is_enabled <boolean>]
[--description <description>]
<segment>
the output format, defaults to table
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of segment.
Recovery method of segment. The supported options are: auto, reserved_host, auto_priority, rh_priority
Service type of segment.
The enabled flag of this segment. Supported after microversion 1.2.
Description of segment.
Name or ID of the segment to update.
This command is provided by the python-masakariclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.