Documentation

a10_server_axapi3 - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices

New in version 2.3.

Synopsis

  • Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.

Options

parameter required default choices comments
host
yes
Hostname or IP of the A10 Networks device.
operation
no create
  • create
  • update
  • remove
Create, Update or Remove SLB server. For create and update operation, we use the IP address and server name specified in the POST message. For delete operation, we use the server name in the request URI.
password
yes
Password for the username account.

aliases: pass, pwd
server_ip
yes
The SLB (Server Load Balancer) 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:.
server_status
no enable
  • enable
  • disable
The SLB (Server Load Balancer) virtual server status.

aliases: action
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 server
- a10_server:
    host: a10.mydomain.com
    username: myadmin
    password: mypassword
    server: test
    server_ip: 1.1.1.100
    validate_certs: false
    server_status: enable
    write_config: yes
    operation: create
    server_ports:
      - port-number: 8080
        protocol: tcp
        action: enable
      - port-number: 8443
        protocol: TCP

Notes

Note

  • 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.