1. Manuals
  2. Tumbleweed
  3. python-masakariclient-doc
  4. python-masakariclient(1)

Scroll to navigation

PYTHON-MASAKARICLIENT(1) python-masakariclient PYTHON-MASAKARICLIENT(1)

NAME

python-masakariclient - python-masakariclient 8.4.0

Masakariclient is a command-line client for Masakari.

CONTENTS

Installation

Note: The paths we are using for configuration files in these steps are with reference to Ubuntu Operating System. The paths may vary for other Operating Systems.

The branch_name which is used in commands, specify the branch_name as stable/<branch> for any stable branch installation. For eg: stable/queens, stable/pike. If unspecified the default will be master branch.

Using python install

Clone and install python-masakariclient repository.:

$ cd ~/
$ git clone https://github.com/openstack/python-masakariclient -b <branch_name>
$ cd python-masakariclient
$ sudo python setup.py install


Using pip

You can also install the latest version by using pip command::

$ pip install python-masakariclient


Or, if it is needed to install python-masakariclient from master branch, type:

$ pip install git+https://github.com/openstack/python-masakariclient.git


CLI Usage

Command List

The following list covers the extended commands for Masakari service available in openstack command.

These commands can be referenced by doing openstack help and the detail of individual command can be referred by openstack help <command-name>.

openstack segment create                        Create failover segment.
openstack segment update                        Update failover segment.
openstack segment list                          List all failover segments.
openstack segment show                          Show requested failover segment.
openstack segment delete                        Delete failover segment.
openstack segment host create                   Create host for given failover segment.
openstack segment host update                   Update Create host for given failover segment.
openstack segment host list                     List all hosts associated to failover segment.
openstack segment host show                     Show Create host for given failover segment.
openstack segment host delete                   Delete Create host for given failover segment.
openstack notification create                   Create notification of host.
openstack notification list                     List notifications of host.
openstack notification show                     List notification of host.


Masakari commands

Masakari commands are CLI interface.

notification create

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.

notification list

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.

notification show

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.

notification vmove list

List VMoves.

openstack notification vmove 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...">]


    <notification_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 vmoves returned

Only return vmoves that appear after the given vmove 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', 'status', 'start_time', 'end_time']

Filter parameters to apply on returned vmoves. This can be specified multiple times, or once with parameters separated by a semicolon. The valid filter keys are: ['type', 'status'

UUID of notification.

This command is provided by the python-masakariclient plugin.

notification vmove show

Show vmove details.

openstack notification vmove show


    [-f {json,shell,table,value,yaml}]


    [-c COLUMN]


    [--noindent]


    [--prefix PREFIX]


    [--max-width <integer>]


    [--fit-width]


    [--print-empty]


    <notification_id>


    <vmove_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.

UUID of COMPUTE_NODE type notification.

UUID of the VMove

This command is provided by the python-masakariclient plugin.

segment create

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.

segment delete

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.

segment host create

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.

segment host delete

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.

segment host list

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.

segment host show

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.

segment host update

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 <name>
Name of host.

--type <type>
Type of host.

--control_attributes <control_attributes>
Attributes about control.

Name or ID of segment.

Name or ID of the Host

This command is provided by the python-masakariclient plugin.

segment list

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.

segment show

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.

segment update

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 <name>
Name of segment.

--recovery_method <recovery_method>
Recovery method of segment. The supported options are: auto, reserved_host, auto_priority, rh_priority

--service_type <service_type>
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.

Contributor Guide

In the Contributor Guide, you will find information on tackerclient's lower level programming details or APIs as well as the transition to OpenStack client.

So You Want to Contribute...

For general information on contributing to OpenStack, please check out the contributor guide to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc. Below will cover the more project specific information you need to get started with python-masakariclient.

Communication


Contacting the Core Team

Please refer the python-masakariclient Core Team contacts.

New Feature Planning

python-masakariclient features are tracked on Launchpad.

Task Tracking

We track our tasks in Launchpad. If you're looking for some smaller, easier work item to pick up and get started on, search for the 'low-hanging-fruit' tag.

Reporting a Bug

You found an issue and want to make sure we are aware of it? You can do so on Launchpad.

Getting Your Patch Merged

All changes proposed to the python-masakariclient project require one or two +2 votes from python-masakariclient core reviewers before one of the core reviewers can approve patch by giving Workflow +1 vote.

Project Team Lead Duties

All common PTL duties are enumerated in the PTL guide.

Developing with Python-masakariClient

Project Info


Meetings

For details please refer to the OpenStack IRC meetings page.

Testing

Install the prerequisites for Tox:

•
On Ubuntu or Debian:

$ apt-get install gcc gettext python-dev libxml2-dev libxslt1-dev \


  zlib1g-dev


You may need to use pip install for some packages.

•
On RHEL or CentOS including Fedora:

$ yum install gcc python-devel libxml2-devel libxslt-devel


•
On openSUSE or SUSE linux Enterprise:

$ zypper install gcc python-devel libxml2-devel libxslt-devel



Install python-tox:

$ pip install tox


To run the full suite of tests maintained within Masakariclient.

$ tox


NOTE:

The first time you run tox, it will take additional time to build virtualenvs. You can later use the -r option with tox to rebuild your virtualenv in a similar manner.


To run tests for one or more specific test environments(for example, the most common configuration of Python 2.7, Python 3.6, Python 3.7 and PEP-8), list the environments with the -e option, separated by spaces:

$ tox -e py36,py37,pep8


See tox.ini for the full list of available test environments.

Building the Documentation

The documentation is generated with Sphinx using the tox command. To create HTML docs, run the commands:

$ tox -e docs


The resultant HTML will be in the doc/build/html directory.

Release Notes

The release notes for a patch should be included in the patch. See the Project Team Guide for more information on using reno in OpenStack.

If any of the following applies to the patch, a release note is required:

  • The deployer needs to take an action when upgrading
  • The plugin interface changes
  • A new feature is implemented
  • A command or option is removed
  • Current behavior is changed
  • A security bug is fixed

Reno is used to generate release notes. Use the commands:

$ tox -e venv -- reno new <bug-,bp-,whatever>


Then edit the sample file that was created and push it with your change.

To run the commands and see results:

$ git commit  # Commit the change because reno scans git log.
$ tox -e releasenotes


At last, look at the generated release notes files in releasenotes/build/html in your browser.

Testing new code

If a developer wants to test new code (feature, command or option) that they have written, Python-masakariclient may be installed from source by running the following commands in the base directory of the project:

$ python setup.py install


or

$ pip install -e .


Standardize Import Format

The import order shows below:

  • {{stdlib imports in human alphabetical order}}
  • n
  • {{third-party lib imports in human alphabetical order}}
  • n
  • {{project imports in human alphabetical order}}
  • n
  • n
  • {{begin your code}}

Example

import copy
import fixtures
from unittest import mock
import os
from osc_lib.api import auth
from osc_lib import utils
from openstackclient import shell
from openstackclient.tests import utils


RELEASE NOTES

FOR CONTRIBUTORS

•
If you are a new contributor to Python-masakariclient please refer: So You Want to Contribute...

INDICES AND TABLES

  • Index
  • Search Page

AUTHOR

unknown

COPYRIGHT

2024, OpenStack Foundation

March 24, 2024 8.4.0