python-libraclient/doc/command.rst

Usage

Synopsis

libra_client [GENERAL OPTIONS <libra_client-options>] [COMMAND <libra_client-commands>] [COMMAND_OPTIONS]

Description

libra_client is a utility designed to communicate with Atlas API based Load Balancer as a Service systems.

Global Options

libra_client

--help, -h

Show help message and exit

--debug

Turn on HTTP debugging for requests

--insecure

Don't validate SSL certs

--bypass_url <bypass-url>

URL to use as an endpoint instead of the one specified by the Service Catalog

--service_type <service-type>

Alternative service type to use for your cloud provider (default is 'hpext:lbaas')

--os_auth_url <auth-url>

The OpenStack authentication URL. Default is OS_AUTH_URL or LIBRA_URL environment variables

--os_username <auth-user-name>

The user name to use for authentication. Default is OS_USERNAME or LIBRA_USERNAME environment variables

--os_password <auth-password>

The password to use for authentication. Default is OS_PASSWORD or LIBRA_PASSWORD environment variables

--os_tenant_name <auth-tenant-name>

The tenant to authenticate to. Default is OS_TENANT_NAME or LIBRA_PROJECT_ID environment variables

--os_region_name <region-name>

The region the load balancer is located. Default is OS_REGION_NAME or LIBRA_REGION_NAME environment variables

Client Commands

libra_client algorithms

algorithms

Gets a list of supported algorithms

libra_client create

create

Create a load balancer

--name <name>

The name of the node to be created

--port <port>

The port the load balancer will listen on

--protocol <protocol>

The protocol type for the load balancer (HTTP or TCP)

--node <ip:port>

The IP and port for a load balancer node (can be used multiple times to add multiple nodes)

--vip <vip>

The virtual IP ID of an existing load balancer to attach to

libra_client delete

delete

Delete a load balancer

--id <id>

The ID of the load balancer

libra_client limits

limits

Show the API limits for the user

libra_client list

list

List all load balancers

--deleted

Show deleted load balancers

libra_client logs

logs

Send a snapshot of logs to an object store

--id <id>

The ID of the load balancer

--storage <store>

Storage type

--endpoint <endpoint>

Object store endpoint to use

--basepath <basepath>

Object store based directory

--token <token>

Object store authentication token

libra_client modify

modify

Update a load balancer's configuration

--id <id>

The ID of the load balancer

--name <name>

A new name for the load balancer

--algorithm <algorithm>

A new algorithm for the load balancer

libra_client monitor-list

monitor-list

List the health monitor for a load balancer

--id <id>

The ID of the load balancer

libra_client monitor-delete

monitor-delete

Delete the health monitor for a load balancer

--id <id>

The ID of the load balancer

libra_client monitor-modify

monitor-modify

Modify the health monitor for a load balancer

--id <id>

The ID of the load balancer

libra_client node-add

node-add

Add a node to a load balancer

--id <id>

The ID of the load balancer

--node <ip:port>

The node address in ip:port format (can be used multiple times to add multiple nodes)

libra_client node-delete

node-delete

Delete a node from the load balancer

--id <id>

The ID of the load balancer

--nodeid <nodeid>

The ID of the node to be removed

libra_client node-list

node-list

List the nodes in a load balancer

--id <id>

The ID of the load balancer

libra_client node-modify

node-modify

Modify a node's state in a load balancer

--id <id>

The ID of the load balancer

--nodeid <nodeid>

The ID of the node to be modified

--condition <condition>

The new state of the node (either ENABLED or DISABLED)

libra_client node-status

node-status

Get the status of a node in a load balancer

--id <id>

The ID of the load balancer

--nodeid <nodeid>

The ID of the node in the load balancer

libra_client protocols

protocols

Gets a list of supported protocols

libra_client status

status

Get the status of a single load balancer

--id <id>

The ID of the load balancer

virtualips

Get a list of virtual IPs

--id <id>

The ID of the load balancer