<a id="lbaas"></a>

# lbaas

## lbaas certificates add

**Usage**

```none
  usage: symp lbaas certificates add
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--noindent]
                                     [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     listener_id certificate_id
```

**Description**

Add additional certificate to listener.

**Returns**

Returns dict: Certificate instance

**Mandatory**

```none
positional arguments:
  listener_id           The UUID of listener
  certificate_id        The UUID of certificate in certificate manager
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas certificates delete

**Usage**

```none
  usage: symp lbaas certificates delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--override-protection]
                                        record_id
```

**Description**

Delete an additional certificate based on the given listener ID and certificate ID.

**Mandatory**

```none
positional arguments:
  record_id             The UUID of additional certificate
```

**Optional**

```none
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 certificates delete-by-certificate-id

**Usage**

```none
  usage: symp lbaas certificates delete-by-certificate-id
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                          [-c COLUMN]
                                                          [--max-width <integer>]
                                                          [--fit-width]
                                                          [--print-empty]
                                                          [--noindent]
                                                          [--prefix PREFIX]
                                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                          listener_id
                                                          certificate_id
```

**Description**

Delete an additional certificate based on listener_id and certificate_id.

**Mandatory**

```none
positional arguments:
  listener_id           The UUID of listener
  certificate_id        The UUID of certificate
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas certificates get

**Usage**

```none
  usage: symp lbaas certificates get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--noindent]
                                     [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     record_id
```

**Description**

Returns am additional certificate based on the given ID.

**Returns**

Returns dict: Additional certificate response

**Mandatory**

```none
positional arguments:
  record_id             ID of the requested additional certificate object
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas certificates list

**Usage**

```none
  usage: symp lbaas certificates list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty] [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--sort-column SORT_COLUMN]
                                      [--listener-id LISTENER_ID]
                                      [--ids [IDS [IDS ...]]]
                                      [--certificate-ids [CERTIFICATE_IDS [CERTIFICATE_IDS ...]]]
```

**Description**

Returns all additional certificates in listeners.

**Returns**

Returns list: List certificates

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --listener-id LISTENER_ID
                        The UUID of listener
  --ids [IDS [IDS ...]]
                        List of UUIDs to filter by
  --certificate-ids [CERTIFICATE_IDS [CERTIFICATE_IDS ...]]
                        List of certificate UUIDs to filter by
```

## lbaas health healthz

**Usage**

```none
  usage: symp lbaas health healthz
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
```

**Description**

Returns the health status.

Note:
: This endpoint will be used continuously by cluster manager in order to
  determine if the service is up and running and ready to serve requests.

**Returns**

Returns dict: Health status

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas health livez

**Usage**

```none
  usage: symp lbaas health livez
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
```

**Description**

Returns the liveness status.

**Returns**

Returns dict: Liveness status

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas health readyz

**Usage**

```none
  usage: symp lbaas health readyz
[-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
```

**Description**

Returns the readiness status.

**Returns**

Returns dict: Readiness status

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas listeners add-tags

**Usage**

```none
  usage: symp lbaas listeners add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--system-tag]
                                       listener_id --tags [--tags ...]
```

**Description**

Add tags to a listener.

**Mandatory**

```none
positional arguments:
  listener_id           ID of listener to which to add the tags
  --tags                List of tags to add to a listener. JSON format '{"key": "key1", "value": "value1"}'
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be added as system tag
```

## lbaas listeners create

**Usage**

```none
  usage: symp lbaas listeners create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--noindent]
                                     [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--description DESCRIPTION]
                                     [--tags [TAGS [TAGS ...]]]
                                     [--certificate-id CERTIFICATE_ID]
                                     name load_balancer_id default_action
                                     protocol port
```

**Description**

Creates a new listener.

**Returns**

Returns dict: Listener instance

**Mandatory**

```none
positional arguments:
  name                  The user defined name of the listener
  load_balancer_id      The UUID of the load balancer
  default_action        The default listener action, a json with one of the following schema:
                        Forward action:
                        {
                        "type": "forward",
                        "config": Target Group UUID
                        }
                        Fixed response action:
                        {
                        "type": "fixed-response",
                        "config": {
                        "status_code": one of 2XX|4XX|5XX (required)
                        "body": maximum 1024 characters
                        "content_type": text/plain | text/css | text/html | application/javascript | application/json
                        }
                        }
                        Redirect action:
                        {
                        "type": "redirect",
                        "config": {
                        "status_code": one of 301|302|307|308 (required)
                        "protocol": one of http|https|${protocol}
                        "host": string
                        "port": string
                        "path": string
                        "query": string
                        }
                        }
  protocol              The protocol for connections from clients to the load balancer
  port                  The port on which the load balancer is listening
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        A description of the listener
  --tags [TAGS [TAGS ...]]
                        List of tags to attach to the listener
  --certificate-id CERTIFICATE_ID
                        The ID of the certificate to use for the listener
```

## lbaas listeners delete

**Usage**

```none
  usage: symp lbaas listeners delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--noindent]
                                     [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--override-protection]
                                     listener_id
```

**Description**

Deletes a listener based on the given listener ID.

**Mandatory**

```none
positional arguments:
  listener_id           ID of the listener to delete
```

**Optional**

```none
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**

```none
  usage: symp lbaas listeners get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                  [--recursive] [--additional-certificates]
                                  listener_id
```

**Description**

Returns a listener based on the given listener ID.

**Returns**

Returns dict: Listener response

**Mandatory**

```none
positional arguments:
  listener_id           ID of the requested load balancer object
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --recursive           If True will add additional certificates and rules
  --additional-certificates
                        If True will add additional certificates
```

## lbaas listeners list

**Usage**

```none
  usage: symp lbaas listeners list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--sort-column SORT_COLUMN]
                                   [--ids [IDS [IDS ...]]]
                                   [--load-balancer-id LOAD_BALANCER_ID]
                                   [--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
                                   [--tag-values [TAG_VALUES [TAG_VALUES ...]]]
                                   [--tags [TAGS [TAGS ...]]]
```

**Description**

Returns all listeners.

**Returns**

Returns list: Listeners

**Optional**

```none
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
  --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 listeners list-tags

**Usage**

```none
  usage: symp lbaas listeners list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--sort-column SORT_COLUMN]
```

**Description**

List tags of all listeners.

**Returns**

Returns list: List of all tags

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas listeners remove-tags

**Usage**

```none
  usage: symp lbaas listeners remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--system-tag]
                                          listener_id --tags [--tags ...]
```

**Description**

Remove tags from a listener.

**Mandatory**

```none
positional arguments:
  listener_id           ID of a listener from which to remove the tags
  --tags                Tags to remove from listener. JSON format '{"key": "key1", "value": "value1"}' or String
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be removed from system tags
```

## lbaas listeners update

**Usage**

```none
  usage: symp lbaas listeners update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty] [--noindent]
                                     [--prefix PREFIX]
                                     [-m [NAME=VALUE [NAME=VALUE ...]]]
                                     [--name NAME] [--description DESCRIPTION]
                                     [--default-action DEFAULT_ACTION]
                                     [--protocol PROTOCOL] [--port PORT]
                                     [--certificate-id CERTIFICATE_ID]
                                     [--override-protection]
                                     listener_id
```

**Description**

Update an existing listener.

**Returns**

Returns dict: Listener instance

**Mandatory**

```none
positional arguments:
  listener_id           ID of the listener to update
```

**Optional**

```none
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-action DEFAULT_ACTION
                        The default listener action, a json with one of the following schema:
                        Forward action:
                        {
                        "type": "forward",
                        "config": Target Group UUID
                        }
                        Fixed response action:
                        {
                        "type": "fixed-response",
                        "config": {
                        "status_code": one of 2XX|4XX|5XX (required)
                        "body": maximum 1024 characters
                        "content_type": text/plain | text/css | text/html | application/javascript | application/json
                        }
                        }
                        Redirect action:
                        {
                        "type": "redirect",
                        "config": {
                        "status_code": one of 301|302|307|308 (required)
                        "protocol": one of http|https|${protocol}
                        "host": string
                        "port": string
                        "path": string
                        "query": string
                        }
                        }
  --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 add-tags

**Usage**

```none
  usage: symp lbaas load-balancers add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            [--system-tag]
                                            loadbalancer_id --tags [--tags ...]
```

**Description**

Add tags to a load balancer.

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of load balancer to which to add the tags
  --tags                List of tags to add to a load balancer. JSON format '{"key": "key1", "value": "value1"}'
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be added as system tag
```

## lbaas load-balancers assign-parameter-group

**Usage**

```none
  usage: symp lbaas load-balancers assign-parameter-group
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                          [-c COLUMN]
                                                          [--max-width <integer>]
                                                          [--fit-width]
                                                          [--print-empty]
                                                          [--noindent]
                                                          [--prefix PREFIX]
                                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                          loadbalancer_id
                                                          parameter_group_values_id
```

**Description**

Assign a parameter group to a given loadbalancer.

**Returns**

Returns dict: Cluster response

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of the requested loadbalancer
  parameter_group_values_id
                        ID of the parameter group to be assigned
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas load-balancers create

**Usage**

```none
  usage: symp lbaas load-balancers create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--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]
                                          [--ip-addresses [IP_ADDRESSES [IP_ADDRESSES ...]]]
                                          name
```

**Description**

Creates a new load balancer instance.

**Returns**

Returns dict: Load balancer instance

**Mandatory**

```none
positional arguments:
  name                  The user defined name of the load balancer
```

**Optional**

```none
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) (default: application)
  --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
  --ip-addresses [IP_ADDRESSES [IP_ADDRESSES ...]]
                        List of ip_addresses to use when creating the LB, the first IP address will be used
                        as the VRRP address, and the next IP addresses will be used by the VMs.
                        Any number of IP Addresses can be specified and the service will only use needed IPs or allocate random IPs.
                        There is no check if the IP addresses are in use. So creation may succeed while actual provisioning will fail
```

## lbaas load-balancers delete

**Usage**

```none
  usage: symp lbaas load-balancers delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--override-protection]
                                          loadbalancer_id
```

**Description**

Deletes a single load balancer instance based on the given load balancer instance ID.

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of the load balancer instance to delete
```

**Optional**

```none
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**

```none
  usage: symp lbaas load-balancers get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       loadbalancer_id
```

**Description**

Returns a load balancer instance based on the given load balancer instance ID.

**Returns**

Returns dict: Load balancer response

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of the requested load balancer object
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas load-balancers list

**Usage**

```none
  usage: symp lbaas load-balancers list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--sort-column SORT_COLUMN]
                                        [--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.

**Returns**

Returns list: Load balancer instances

**Optional**

```none
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 list-tags

**Usage**

```none
  usage: symp lbaas load-balancers list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             [--sort-column SORT_COLUMN]
```

**Description**

List tags of all load balancers.

**Returns**

Returns list: List of all tags

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas load-balancers remove-tags

**Usage**

```none
  usage: symp lbaas load-balancers remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                                               [--system-tag]
                                               loadbalancer_id --tags
                                               [--tags ...]
```

**Description**

Remove tags from a load balancer.

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of a load balancer from which to remove the tags
  --tags                Tags to remove from load balancer. JSON format '{"key": "key1", "value": "value1"}' or String
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be removed from system tags
```

## lbaas load-balancers set-security-groups

**Usage**

```none
  usage: symp lbaas load-balancers set-security-groups
[-f {adaptive_table,csv,json,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--fit-width]
                                                       [--print-empty]
                                                       [--noindent]
                                                       [--quote {all,minimal,none,nonnumeric}]
                                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                       [--sort-column SORT_COLUMN]
                                                       loadbalancer_id
                                                       --security_groups_ids
                                                       [--security_groups_ids ...]
```

**Description**

Set the loadbalancer security groups.

**Returns**

Returns list: The load balancer security groups IDs

**Mandatory**

```none
positional arguments:
  loadbalancer_id       Requested load balancer instance ID
  --security_groups_ids
                        List of IDs of security groups
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas load-balancers upgrade

**Usage**

```none
  usage: symp lbaas load-balancers upgrade
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           loadbalancer_id
```

**Description**

Upgrade the specified Loadbalancer to the enabled revision of its engine version.

**Returns**

Returns dict: The new instance

**Mandatory**

```none
positional arguments:
  loadbalancer_id       ID of the load balancer instance to upgrade
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas parameter group copy

**Usage**

```none
  usage: symp lbaas parameter group copy
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--target-name TARGET_NAME]
                                         [--target-description TARGET_DESCRIPTION]
                                         values_id
```

**Description**

Copy parameter group values.

**Returns**

Returns dict: The new parameter group values

**Mandatory**

```none
positional arguments:
  values_id             The parameter group id
```

**Optional**

```none
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**

```none
  usage: symp lbaas parameter group delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           values_id
```

**Description**

Delete a parameter group.

**Mandatory**

```none
positional arguments:
  values_id             The parameter group id
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas parameter group get

**Usage**

```none
  usage: symp lbaas parameter group get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        [--include-schema]
                                        values_id
```

**Description**

Retrieve the details of a specified parameter group values.

**Returns**

Returns dict: The parameter group values

**Mandatory**

```none
positional arguments:
  values_id             The parameter group values id
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --include-schema      (Optional) Include schema information with the values
```

## lbaas parameter group list

**Usage**

```none
  usage: symp lbaas parameter group list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--sort-column SORT_COLUMN]
                                         [--marker MARKER] [--limit LIMIT]
                                         [--sort-by SORT_BY] [--order ORDER]
                                         [--tags TAGS] [--filters FILTERS]
                                         [--include-schema]
```

**Description**

List the available parameter group values.

**Returns**

Returns list: List of defined parameter group values

**Optional**

```none
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**

```none
  usage: symp lbaas parameter group reset
[-f {adaptive_table,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [-m [NAME=VALUE [NAME=VALUE ...]]]
                                          [--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.

**Returns**

Returns dict: The new parameter group

**Mandatory**

```none
positional arguments:
  values_id             The parameter group values id
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --parameters [PARAMETERS [PARAMETERS ...]]
                        (Optional) List of parameters to reset
```

## lbaas parameter group update

**Usage**

```none
  usage: symp lbaas parameter group update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--values VALUES]
                                           [--reset-all RESET_ALL] [--name NAME]
                                           [--description DESCRIPTION]
                                           values_id
```

**Description**

Update the parameters in a parameter group.

**Returns**

Returns dict: Updated parameter group values

**Mandatory**

```none
positional arguments:
  values_id             The parameter group id
```

**Optional**

```none
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 add-tags

**Usage**

```none
  usage: symp lbaas rules add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--system-tag]
                                   rule_id --tags [--tags ...]
```

**Description**

Add tags to a rule.

**Mandatory**

```none
positional arguments:
  rule_id               ID of rule to which to add the tags
  --tags                List of tags to add to a rule. JSON format '{"key": "key1", "value": "value1"}'
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be added as system tag
```

## lbaas rules create

**Usage**

```none
  usage: symp lbaas rules create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--description DESCRIPTION]
                                 [--tags [TAGS [TAGS ...]]]
                                 name listener_id priority --conditions
                                 [--conditions ...] --actions [--actions ...]
```

**Description**

Creates a new rule.

**Returns**

Returns dict: Rule instance

**Mandatory**

```none
positional arguments:
  name                  The user defined name of the rule
  listener_id           The UUID of the listener
  priority              The rule priority
  --conditions          List of the rule's conditions
  --actions             List of the rule's actions
                        Each action is a JSON with the following schema:
                        Forward action:
                        {
                        "type": "forward",
                        "config": Target Group UUID
                        }
                        Fixed response action:
                        {
                        "type": "fixed-response",
                        "config": {
                        "status_code": one of 2XX|4XX|5XX (required)
                        "body": maximum 1024 characters
                        "content_type": text/plain | text/css | text/html | application/javascript | application/json
                        }
                        }
                        Redirect action:
                        {
                        "type": "redirect",
                        "config": {
                        "status_code": one of 301|302|307|308 (required)
                        "protocol": one of http|https|${protocol}
                        "host": string
                        "port": string
                        "path": string
                        "query": string
                        }
                        }
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        A description of the rule
  --tags [TAGS [TAGS ...]]
                        List of tags to attach to the listener
```

## lbaas rules delete

**Usage**

```none
  usage: symp lbaas rules delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--override-protection]
                                 rule_id
```

**Description**

Deletes a rule based on the given rule ID.

**Mandatory**

```none
positional arguments:
  rule_id               ID of the rule to delete
```

**Optional**

```none
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**

```none
  usage: symp lbaas rules get
[-f {adaptive_table,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--fit-width]
                              [--print-empty] [--noindent] [--prefix PREFIX]
                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                              rule_id
```

**Description**

Returns a rule based on the given rule ID.

**Returns**

Returns dict: Rule instance

**Mandatory**

```none
positional arguments:
  rule_id               ID of the requested rule object
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas rules list

**Usage**

```none
  usage: symp lbaas rules list
[-f {adaptive_table,csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>] [--fit-width]
                               [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                               [--sort-column SORT_COLUMN]
                               [--ids [IDS [IDS ...]]]
                               [--listener-id LISTENER_ID]
```

**Description**

Returns all rules.

**Returns**

Returns list: Rules

**Optional**

```none
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 list-tags

**Usage**

```none
  usage: symp lbaas rules list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--sort-column SORT_COLUMN]
```

**Description**

List tags of all rules.

**Returns**

Returns list: List of all tags

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas rules remove-tags

**Usage**

```none
  usage: symp lbaas rules remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty] [--noindent]
                                      [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--system-tag]
                                      rule_id --tags [--tags ...]
```

**Description**

Remove tags from a rule.

**Mandatory**

```none
positional arguments:
  rule_id               ID of a rule from which to remove the tags
  --tags                Tags to remove from rule. JSON format '{"key": "key1", "value": "value1"}' or String
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be removed from system tags
```

## lbaas rules update

**Usage**

```none
  usage: symp lbaas rules update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--conditions [CONDITIONS [CONDITIONS ...]]]
                                 [--actions [ACTIONS [ACTIONS ...]]]
                                 rule_id
```

**Description**

Update a rule based on the given rule ID and conditions and or actions.

**Returns**

Returns: Rule instance

**Mandatory**

```none
positional arguments:
  rule_id               ID of the rule to delete
```

**Optional**

```none
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
                        Each action is a JSON with the following schema:
                        Forward action:
                        {
                        "type": "forward",
                        "config": Target Group UUID
                        }
                        Fixed response action:
                        {
                        "type": "fixed-response",
                        "config": {
                        "status_code": one of 2XX|4XX|5XX (required)
                        "body": maximum 1024 characters
                        "content_type": text/plain | text/css | text/html | application/javascript | application/json
                        }
                        }
                        Redirect action:
                        {
                        "type": "redirect",
                        "config": {
                        "status_code": one of 301|302|307|308 (required)
                        "protocol": one of http|https|${protocol}
                        "host": string
                        "port": string
                        "path": string
                        "query": string
                        }
                        }
```

## lbaas target-groups add-tags

**Usage**

```none
  usage: symp lbaas target-groups add-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--system-tag]
                                           target_group_id --tags [--tags ...]
```

**Description**

Add tags to a target group.

**Mandatory**

```none
positional arguments:
  target_group_id       ID of a target group to which to add the tags
  --tags                List of tags to add to a target group. JSON format '{"key": "key1", "value": "value1"}'
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be added as system tag
```

## lbaas target-groups create

**Usage**

```none
  usage: symp lbaas target-groups create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--protocol PROTOCOL] [--port PORT]
                                         [--health-check-protocol HEALTH_CHECK_PROTOCOL]
                                         [--health-check-port HEALTH_CHECK_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]
                                         [--health-check-http-code-matcher HEALTH_CHECK_HTTP_CODE_MATCHER]
                                         [--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.

**Returns**

Returns dict: Target group instance

**Mandatory**

```none
positional arguments:
  name                  The user defined name of the target group
```

**Optional**

```none
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-protocol HEALTH_CHECK_PROTOCOL
                        Protcol for target health checks
  --health-check-port HEALTH_CHECK_PORT
                        Protcol for target health checks
                        Default is "traffic-port" which corresponds to the target port
  --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
  --health-check-http-code-matcher HEALTH_CHECK_HTTP_CODE_MATCHER
                        The HTTP status code to expect when performing health checks.
                        Can also be a range and multiple values (e.g. 200,201,205-299)
  --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**

```none
  usage: symp lbaas target-groups delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--override-protection]
                                         target_group_id
```

**Description**

Deletes a target group based on the given target group ID.

**Mandatory**

```none
positional arguments:
  target_group_id       ID of the target group to delete
```

**Optional**

```none
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**

```none
  usage: symp lbaas target-groups deregister-target
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty] [--noindent]
                                                    [--prefix PREFIX]
                                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                    [--override-protection]
                                                    target_group_id target_id
```

**Description**

Registers targets with a target group identifed by the given target group ID.

**Mandatory**

```none
positional arguments:
  target_group_id       ID of target group to remove targets
  target_id             List of target ID to deregister
```

**Optional**

```none
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**

```none
  usage: symp lbaas target-groups get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty] [--noindent]
                                      [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--detailed]
                                      target_group_id
```

**Description**

Returns a target group based on the given target group ID.

**Returns**

Returns dict: Target group response

**Mandatory**

```none
positional arguments:
  target_group_id       ID of the requested target group object
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --detailed            Get the group listeners and targets info
```

## lbaas target-groups list

**Usage**

```none
  usage: symp lbaas target-groups list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [-m [NAME=VALUE [NAME=VALUE ...]]]
                                       [--sort-column SORT_COLUMN]
                                       [--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.

**Returns**

Returns list: Target groups

**Optional**

```none
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-tags

**Usage**

```none
  usage: symp lbaas target-groups list-tags
[-f {adaptive_table,csv,json,table,value,yaml}]
                                            [-c COLUMN] [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [-m [NAME=VALUE [NAME=VALUE ...]]]
                                            [--sort-column SORT_COLUMN]
```

**Description**

List tags of all target groups.

**Returns**

Returns list: List of all tags

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas target-groups list-targets

**Usage**

```none
  usage: symp lbaas target-groups list-targets
[-f {adaptive_table,csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                                               [--sort-column SORT_COLUMN]
                                               [--ids [IDS [IDS ...]]]
                                               target_group_id
```

**Description**

Returns a list of registered targets with the target group identified by the given target group ID.

**Returns**

Returns list: Targets

**Mandatory**

```none
positional arguments:
  target_group_id       ID of the target group of which to list targets
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --ids [IDS [IDS ...]]
                        Filter specific VMs
```

## lbaas target-groups register-targets

**Usage**

```none
  usage: symp lbaas target-groups register-targets
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width] [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                   target_group_id
                                                   --targets_info
                                                   [--targets_info ...]
```

**Description**

Registers targets with a target group identifed by the given target group ID.

**Mandatory**

```none
positional arguments:
  target_group_id       ID of target group to add targets
  --targets_info        List of targets info.
                        Target info is a dict containing the following keys: vm_id/vm_ip (mandatory), port (optional)
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## lbaas target-groups remove-tags

**Usage**

```none
  usage: symp lbaas target-groups remove-tags
[-f {adaptive_table,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                                              [--system-tag]
                                              target_group_id --tags
                                              [--tags ...]
```

**Description**

Remove tags from a target group.

**Mandatory**

```none
positional arguments:
  target_group_id       ID of a target group from which to remove the tags
  --tags                Tags to remove from target group. JSON format '{"key": "key1", "value": "value1"}' or String
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --system-tag          If True and user is system_admin, tag will be removed from system tags
```

## lbaas target-groups update

**Usage**

```none
  usage: symp lbaas target-groups update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [-m [NAME=VALUE [NAME=VALUE ...]]]
                                         [--stickiness-enabled STICKINESS_ENABLED]
                                         [--cookie-duration-seconds COOKIE_DURATION_SECONDS]
                                         [--health-check-protocol HEALTH_CHECK_PROTOCOL]
                                         [--health-check-port HEALTH_CHECK_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]
                                         [--health-check-http-code-matcher HEALTH_CHECK_HTTP_CODE_MATCHER]
                                         target_group_id
```

**Description**

Update the requested target group.

**Returns**

Returns dict: Target group response

**Mandatory**

```none
positional arguments:
  target_group_id       ID of the target group to delete
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --stickiness-enabled 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
  --health-check-protocol HEALTH_CHECK_PROTOCOL
                        Protcol for target health checks
  --health-check-port HEALTH_CHECK_PORT
                        Protcol for target health checks
  --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
  --health-check-http-code-matcher HEALTH_CHECK_HTTP_CODE_MATCHER
                        The HTTP status code to expect when performing health checks.
                        Can also be a range and multiple values (e.g. 200,201,205-299)
```