libra/doc/client/command.rst
Andrew Hutchings 1612b65263 PDF build and doc reshuffle
Add PDF builder
Reshuffle the client doc building
2012-10-25 13:40:15 +01:00

3.3 KiB

Libra Client

Synopsis

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

Description

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

Global Options

libra_client.py

--help, -h

Show help message and exit

--os_auth_url <auth-url>

The OpenStack authentication URL

--os_username <auth-user-name>

The user name to use for authentication

--os_password <auth-password>

The password to use for authentication

--os_tenant_name <auth-tenant-name>

The tenant to authenticate to

--os_region_name <region-name>

The region the load balancer is located

Client Commands

libra_client.py 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.py 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.py list

list

List all load balancers

libra_client.py status

status

Get the status of a single load balancer

--id <id>

The ID of the load balancer

libra_client.py delete

delete

Delete a load balancer

--id <id>

The ID of the load balancer

libra_client.py node-list

node-list

List the nodes in a load balancer

--id <id>

The ID of the load balancer

libra_client.py 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.py 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.py 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.py 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