lbaas¶
lbaas health get¶
Usage
usage: -c lbaas health get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns the health status.
Return
Returns dict: Health status
Optional
optional arguments:
-h, --help show this help message and exit
lbaas listeners create¶
Usage
usage: -c lbaas listeners create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--description DESCRIPTION]
[--tags [TAGS [TAGS ...]]]
[--certificate-id CERTIFICATE_ID]
name load_balancer_id default_target_group_id
protocol port
Description
Creates a new listener.
Return
Returns dict: Listener instance
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
A description of the load balancer
--tags [TAGS [TAGS ...]]
List of tags to attach to the load balancer
--certificate-id CERTIFICATE_ID
The ID of the certificate to use for the listener
lbaas listeners delete¶
Usage
usage: -c lbaas listeners delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--override-protection]
listener_id
Description
Deletes a listener based on the given listener ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the VM is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas listeners get¶
Usage
usage: -c lbaas listeners get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
listener_id
Description
Returns a listener based on the given listener ID.
Return
Returns dict: Listener response
Optional
optional arguments:
-h, --help show this help message and exit
lbaas listeners list¶
Usage
usage: -c lbaas listeners list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ids [IDS [IDS ...]]]
[--load-balancer-id LOAD_BALANCER_ID]
Description
Returns all listeners.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--ids [IDS [IDS ...]]
List of listeners IDs for filtering
--load-balancer-id LOAD_BALANCER_ID
Filter target groups by the Load Balancer to which they are attached
lbaas listeners update¶
Usage
usage: -c lbaas listeners update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION]
[--default-target-group-id DEFAULT_TARGET_GROUP_ID]
[--protocol PROTOCOL] [--port PORT]
[--certificate-id CERTIFICATE_ID]
[--override-protection]
listener_id
Description
Update an existing listener.
Return
Returns dict: Listener instance
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The user defined name of the listener
--description DESCRIPTION
A description of the load balancer
--default-target-group-id DEFAULT_TARGET_GROUP_ID
The UUID of the default target group
--protocol PROTOCOL The protocol for connections from clients to the load balancer
--port PORT The port on which the load balancer is listening
--certificate-id CERTIFICATE_ID
The ID of the certificate to use for the listener
--override-protection
If True, will delete even if the VM is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas load-balancers assign-parameter-group¶
Usage
usage: -c lbaas load-balancers assign-parameter-group [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
loadbalancer_id
parameter_group_values_id
Description
Assign a parameter group to a given loadbalancer.
Return
Returns dict: Cluster response
Optional
optional arguments:
-h, --help show this help message and exit
lbaas load-balancers create¶
Usage
usage: -c lbaas load-balancers create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--engine-version-id ENGINE_VERSION_ID]
[--network-id NETWORK_ID]
[--network-ids [NETWORK_IDS [NETWORK_IDS ...]]]
[--description DESCRIPTION]
[--fip-id FIP_ID] [--is-external]
[--security-groups-ids [SECURITY_GROUPS_IDS [SECURITY_GROUPS_IDS ...]]]
[--instance-type INSTANCE_TYPE]
[--tags [TAGS [TAGS ...]]]
[--lb-type LB_TYPE]
[--create-dedicated-security-group]
[--replicas REPLICAS]
[--parameter-group-values-id PARAMETER_GROUP_VALUES_ID]
name
Description
Creates a new load balancer instance.
Return
Returns dict: Load balancer instance
Optional
optional arguments:
-h, --help show this help message and exit
--engine-version-id ENGINE_VERSION_ID
Create load balancer with this engine version
--network-id NETWORK_ID
The UUID of the network to attach the load balancer
--network-ids [NETWORK_IDS [NETWORK_IDS ...]]
List of UUIDs of the subnets to attach the load balancer
--description DESCRIPTION
A description of the load balancer
--fip-id FIP_ID The UUID of the floating IP to attach to the load balancer
--is-external If external IP will be allocated for the load balancer
--security-groups-ids [SECURITY_GROUPS_IDS [SECURITY_GROUPS_IDS ...]]
List of security groups to attach to the load balancer
--instance-type INSTANCE_TYPE
Name of instance type for the new VM
--tags [TAGS [TAGS ...]]
List of tags to attach to the load balancer
--lb-type LB_TYPE LoadBalancer type (application/network)
--create-dedicated-security-group
If True a security group will be allocated
and updated according to the load balancer listeners ports
--replicas REPLICAS Num of replicas for HA purpose, default value: 2
--parameter-group-values-id PARAMETER_GROUP_VALUES_ID
Parameter group values id
lbaas load-balancers delete¶
Usage
usage: -c lbaas load-balancers delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--override-protection]
loadbalancer_id
Description
Deletes a single load balancer instance based on the given load balancer instance ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the VM is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas load-balancers get¶
Usage
usage: -c lbaas load-balancers get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
loadbalancer_id
Description
Returns a load balancer instance based on the given load balancer instance ID.
Return
Returns dict: Load balancer response
Optional
optional arguments:
-h, --help show this help message and exit
lbaas load-balancers list¶
Usage
usage: -c lbaas load-balancers list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ids [IDS [IDS ...]]]
[--names [NAMES [NAMES ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--tags [TAGS [TAGS ...]]]
Description
Returns all load balancer instances.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--ids [IDS [IDS ...]]
List of load balancers IDs for filtering
--names [NAMES [NAMES ...]]
List of load balancers names for filtering
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
Filter load balancers by tag keys, format ["key1", "key2, key3", "key4", ...]
--tag-values [TAG_VALUES [TAG_VALUES ...]]
Filter load balancers by tag values, format ["value1, value2", "value3", "value4",...]
--tags [TAGS [TAGS ...]]
Filter load balancers by tags. JSON format '{"key": "key1", "value": ["value1","value2"]}'
lbaas load-balancers set-security-groups¶
Usage
usage: -c lbaas load-balancers set-security-groups [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
loadbalancer_id
--security_groups_ids
[--security_groups_ids ...]
Description
Set the loadbalancer security groups.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
lbaas load-balancers upgrade¶
Usage
usage: -c lbaas load-balancers upgrade [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
loadbalancer_id
Description
Upgrade the specified Loadbalancer to the enabled revision of its engine version.
Return
Returns dict: The new instance
Optional
optional arguments:
-h, --help show this help message and exit
lbaas parameter group copy¶
Usage
usage: -c lbaas parameter group copy [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--target-name TARGET_NAME]
[--target-description TARGET_DESCRIPTION]
values_id
Description
Copy parameter group values.
Return
Returns dict: The new parameter group values
Optional
optional arguments:
-h, --help show this help message and exit
--target-name TARGET_NAME
(Optional) Name of the new parameter group
--target-description TARGET_DESCRIPTION
(Optional) Description of the new parameter group values
lbaas parameter group delete¶
Usage
usage: -c lbaas parameter group delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
values_id
Description
Delete a parameter group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
lbaas parameter group get¶
Usage
usage: -c lbaas parameter group get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--include-schema]
values_id
Description
Retrieve the details of a specified parameter group values.
Return
Returns dict: The parameter group values
Optional
optional arguments:
-h, --help show this help message and exit
--include-schema (Optional) Include schema information with the values
lbaas parameter group list¶
Usage
usage: -c lbaas parameter group list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--marker MARKER] [--limit LIMIT]
[--sort-by SORT_BY] [--order ORDER]
[--tags TAGS] [--filters FILTERS]
[--include-schema]
Description
List the available parameter group values.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--marker MARKER (Optional) marker from previous list
--limit LIMIT (Optional) max number of records to return
--sort-by SORT_BY (Optional) field by which to sort records
--order ORDER (Optional) order in which to sort records
--tags TAGS (Optional) return only records matching tags
--filters FILTERS (Optional) dictionary to filter records by all criteria provided
example: '{"name": "my-name", "status": "Active"}'
--include-schema (Optional) Include schema information with the values
lbaas parameter group reset¶
Usage
usage: -c lbaas parameter group reset [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--parameters [PARAMETERS [PARAMETERS ...]]]
values_id
Description
Reset the values of those of the family default. If parameters is passed, only those listed will be reset.
Return
Returns dict: The new parameter group
Optional
optional arguments:
-h, --help show this help message and exit
--parameters [PARAMETERS [PARAMETERS ...]]
(Optional) List of parameters to reset
lbaas parameter group update¶
Usage
usage: -c lbaas parameter group update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--values VALUES]
[--reset-all RESET_ALL] [--name NAME]
[--description DESCRIPTION]
values_id
Description
Update the parameters in a parameter group.
Return
Returns dict: Updated parameter group values
Optional
optional arguments:
-h, --help show this help message and exit
--values VALUES (Optional) The parameters
--reset-all RESET_ALL
(Optional) If true, all parameters are reset to family default
--name NAME (Optional) Updated Name of the parameter group values
--description DESCRIPTION
(Optional) Updated Description of the parameter group values
lbaas rules create¶
Usage
usage: -c lbaas rules create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--description DESCRIPTION]
name listener_id priority --conditions
[--conditions ...] --actions [--actions ...]
Description
Creates a new rule.
Return
Returns dict: Rule instance
Optional
optional arguments:
-h, --help show this help message and exit
--description DESCRIPTION
A description of the rule
lbaas rules delete¶
Usage
usage: -c lbaas rules delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--override-protection]
rule_id
Description
Deletes a rule based on the given rule ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the Rule is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas rules get¶
Usage
usage: -c lbaas rules get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
rule_id
Description
Returns a rule based on the given rule ID.
Return
Returns dict: Rule instance
Optional
optional arguments:
-h, --help show this help message and exit
lbaas rules list¶
Usage
usage: -c lbaas rules list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ids [IDS [IDS ...]]] [--listener-id LISTENER_ID]
Description
Returns all rules.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--ids [IDS [IDS ...]]
List of rule IDs for filtering
--listener-id LISTENER_ID
Filter rules by the Listener to which they are attached
lbaas rules update¶
Usage
usage: -c lbaas rules update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--conditions [CONDITIONS [CONDITIONS ...]]]
[--actions [ACTIONS [ACTIONS ...]]]
rule_id
Description
Update a rule based on the given rule ID and conditions and or actions.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--conditions [CONDITIONS [CONDITIONS ...]]
List of the rule's conditions
--actions [ACTIONS [ACTIONS ...]]
List of the rule's actions
lbaas target-groups create¶
Usage
usage: -c lbaas target-groups create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--protocol PROTOCOL]
[--port PORT]
[--health-check-path HEALTH_CHECK_PATH]
[--health-check-interval-secs HEALTH_CHECK_INTERVAL_SECS]
[--health-check-timeout-secs HEALTH_CHECK_TIMEOUT_SECS]
[--health-check-healthy-threshold-count HEALTH_CHECK_HEALTHY_THRESHOLD_COUNT]
[--health-check-unhealthy-threshold-count HEALTH_CHECK_UNHEALTHY_THRESHOLD_COUNT]
[--description DESCRIPTION]
[--tags [TAGS [TAGS ...]]]
[--stickiness-enabled]
[--cookie-duration-seconds COOKIE_DURATION_SECONDS]
[--target-type TARGET_TYPE]
[--vpc-id VPC_ID]
name
Description
Creates a new target group.
Return
Returns dict: Target group instance
Optional
optional arguments:
-h, --help show this help message and exit
--protocol PROTOCOL The protocol for the target group
--port PORT The port for the target group
--health-check-path HEALTH_CHECK_PATH
Path (URL) for http health check
--health-check-interval-secs HEALTH_CHECK_INTERVAL_SECS
Interval between two consecutive health checks
--health-check-timeout-secs HEALTH_CHECK_TIMEOUT_SECS
The amount of time, in seconds, during which no response from a target means a failed health check
--health-check-healthy-threshold-count HEALTH_CHECK_HEALTHY_THRESHOLD_COUNT
Number of consecutive valid health checks before considering the server as UP
--health-check-unhealthy-threshold-count HEALTH_CHECK_UNHEALTHY_THRESHOLD_COUNT
Number of consecutive invalid health checks before considering the server as DOWN
--description DESCRIPTION
A description of the target group
--tags [TAGS [TAGS ...]]
List of tags to attach to the target group
--stickiness-enabled Should the target group be configured with sticky session
--cookie-duration-seconds COOKIE_DURATION_SECONDS
The time period (seconds) the requests from a client should be routed to the same target
--target-type TARGET_TYPE
Target type for this target group (instance/ip)
--vpc-id VPC_ID The vpc_id for the target group, default is None
lbaas target-groups delete¶
Usage
usage: -c lbaas target-groups delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--override-protection]
target_group_id
Description
Deletes a target group based on the given target group ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the VM is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas target-groups deregister-target¶
Usage
usage: -c lbaas target-groups deregister-target [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--override-protection]
target_group_id target_id
Description
Registers targets with a target group identifed by the given target group ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--override-protection
If True, will delete even if the VM is protected from deletion
e.g an internal resource. Allowed only for admins
lbaas target-groups get¶
Usage
usage: -c lbaas target-groups get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--detailed]
target_group_id
Description
Returns a target group based on the given target group ID.
Return
Returns dict: Target group response
Optional
optional arguments:
-h, --help show this help message and exit
--detailed Get the group listeners and targets info
lbaas target-groups list¶
Usage
usage: -c lbaas target-groups list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ids [IDS [IDS ...]]]
[--names [NAMES [NAMES ...]]] [--detailed]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
[--tags [TAGS [TAGS ...]]]
[--loadbalancer-id LOADBALANCER_ID]
Description
Returns all target groups.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--ids [IDS [IDS ...]]
List of target groups IDs for filtering
--names [NAMES [NAMES ...]]
List of target groups names for filtering
--detailed Get the groups listeners and targets info
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
Filter target groups by tag keys, format ["key1", "key2, key3", "key4", ...]
--tag-values [TAG_VALUES [TAG_VALUES ...]]
Filter target groups by tag values, format ["value1, value2", "value3", "value4",...]
--tags [TAGS [TAGS ...]]
Filter target groups by tags. JSON format '{"key": "key1", "value": ["value1","value2"]}'
--loadbalancer-id LOADBALANCER_ID
Filter target groups by the Load Balancer to which they are attached
lbaas target-groups list-targets¶
Usage
usage: -c lbaas target-groups list-targets [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ids [IDS [IDS ...]]]
target_group_id
Description
Returns a list of registered targets with the target group identified by the given target group ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--ids [IDS [IDS ...]]
Filter specific VMs
lbaas target-groups register-targets¶
Usage
usage: -c lbaas target-groups register-targets [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
target_group_id --targets_info
[--targets_info ...]
Description
Registers targets with a target group identifed by the given target group ID.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
lbaas target-groups update¶
Usage
usage: -c lbaas target-groups update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--stickiness-enabled]
[--cookie-duration-seconds COOKIE_DURATION_SECONDS]
target_group_id
Description
Update the requested target group sticky session policy.
Return
Returns dict: Target group response
Optional
optional arguments:
-h, --help show this help message and exit
--stickiness-enabled Should the target group be configured with sticky session
--cookie-duration-seconds COOKIE_DURATION_SECONDS
The time period (seconds) the requests from a client should be routed to the same target