Documentation

a10_server - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ server object.

New in version 1.8.

Synopsis

  • Manage SLB (Server Load Balancer) server 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
server_ip
no
The SLB server IPv4 address.

aliases: ip, address
server_name
yes
The SLB (Server Load Balancer) server name.

aliases: server
server_ports
no
A list of ports to create for the server. Each list item should be a dictionary which specifies the port: and protocol:, but can also optionally specify the status:. See the examples below for details. This parameter is required when state is present.
server_status
no enabled
  • enabled
  • disabled
The SLB virtual server status.

aliases: status
state
no present
  • present
  • absent
This is to specify the operation to create, update or remove SLB server.
username
yes
An account with administrator privileges.

aliases: user, admin
validate_certs
(added in 2.2)
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 server
- a10_server:
    host: a10.mydomain.com
    username: myadmin
    password: mypassword
    partition: mypartition
    server: test
    server_ip: 1.1.1.100
    server_ports:
      - port_num: 8080
        protocol: tcp
      - port_num: 8443
        protocol: TCP

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_server success string mynewserver


Notes

Note

  • Requires A10 Networks aXAPI 2.1.
  • 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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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