Scope

This document describes commands that will be introduced into python-quantumclient in order to support LBaaS advanced service. The implementation is proposed to be extensible to support different types of Quantum advanced services.

Implementation Details

In the upcoming Grizzly release Quantum core will be extended by advanced service framework. The similar extension mechanism will be introduced into the Client in order to support new REST API operations. The extension framework should enumerate and load extensions, where every extension is announced with command prefix and set of supported commands.

For example, LBaaS extension will introduce command [lbaas] vip-list , prefix lbaas may be optional until commands from different extension interferes with it. For interactive mode the user should be able to specify what extension subset to use (in order to minimize the number of accessible commands). Note that it is not proposed to use sub-shell, since it would be harder to use and implement.

LBaaS Command List

The command set corresponds to Quantum/LBaaS/API_1.0

  healthmonitor-create        Create a healthmonitor
  healthmonitor-delete        Delete a given healthmonitor
  healthmonitor-list          List healthmonitors that belong to a given tenant
  healthmonitor-show          Show information of a given healthmonitor
  healthmonitor-update        Update healthmonitor's information

  healthmonitor-associate     Associate a healthmonitor with a pool
  healthmonitor-disassociate  Disassociate a healthmonitor with a pool

  member-create               Create a member
  member-delete               Delete a given member
  member-list                 List members that belong to a given tenant
  member-show                 Show information of a given member
  member-update               Update member's information

  pool-create                 Create a pool
  pool-delete                 Delete a given pool
  pool-list                   List pools that belong to a given tenant
  pool-show                   Show information of a given pool
  pool-update                 Update pool's information

  vip-create                  Create a vip
  vip-delete                  Delete a given vip
  vip-list                    List vips that belong to a given tenant
  vip-show                    Show information of a given vip
  vip-update                  Update vip's information

healthmonitor-create

This command creates a new healthmonitor object.

healthmonitor-create --type <type> --delay <delay> --max_retries <max_retries> [--timeout <timeout>] <name>

delay: This is the minimum time in seconds between regular connections of the member.
timeout: Maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value.
max_retries: Number of permissible connection failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.

healthmonitor-delete

This command deletes a given healthmonitor object.

healthmonitor-delete <healthmonitor-id>

healthmonitor-list

This command shows list of health monitor objects available to tenant.

healthmonitor-list

healthmonitor-show

This command shows information about a given health monitor object.

healthmonitor-show <healthmonitor-id>

healthmonitor-update

This command updates information of a given health monitor object.

healthmonitor-update [--type <type>] [--delay <delay>] [--max_retries <max_retries>] [--timeout <timeout>] [--name <name>] <healthmonitor-id>

Neutron/LBaaS/CLI