You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

a10_service_group - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ service groups.¶

New in version 1.8.

Synopsis
Options
Examples
Return Values
Notes
- Status

Synopsis ¶

Manage SLB (Server Load Balancing) service-group objects on A10 Networks devices via aXAPIv2.

Options ¶

parameter	required	default	choices	comments
host	yes			Hostname or IP of the A10 Networks device.
partition (added in 2.3)	no			set active-partition
password	yes			Password for the `username` account. aliases: pass, pwd
servers	no			A list of servers to add to the service group. Each list item should be a dictionary which specifies the `server:` and `port:`, but can also optionally specify the `status:`. See the examples below for details.
service_group	yes			The SLB (Server Load Balancing) service-group name aliases: service, pool, group
service_group_method	no	round-robin	round-robin weighted-rr least-connection weighted-least-connection service-least-connection service-weighted-least-connection fastest-response least-request round-robin-strict src-ip-only-hash src-ip-hash	The SLB service-group load balancing method, such as round-robin or weighted-rr. aliases: method
service_group_protocol	no	tcp	tcp udp	The SLB service-group protocol of TCP or UDP. aliases: proto, protocol
username	yes			An account with administrator privileges. aliases: user, admin
validate_certs	no	yes	yes no	If `no`, SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates.
write_config (added in 2.2)	no	no	yes no	If `yes`, any changes will cause a write of the running configuration to non-volatile memory. This will save all configuration changes, including those that may have been made manually or through other modules, so care should be taken when specifying `yes`.

Examples ¶

# Create a new service-group
- a10_service_group:
    host: a10.mydomain.com
    username: myadmin
    password: mypassword
    partition: mypartition
    service_group: sg-80-tcp
    servers:
      - server: foo1.mydomain.com
        port: 8080
      - server: foo2.mydomain.com
        port: 8080
      - server: foo3.mydomain.com
        port: 8080
      - server: foo4.mydomain.com
        port: 8080
        status: disabled

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
content	the full info regarding the slb_service_group	success	string	mynewservicegroup

Notes ¶

Note

Requires A10 Networks aXAPI 2.1.
When a server doesn’t exist and is added to the service-group the server will be created.
Requires A10 Networks aXAPI 2.1

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.