Docs4dev
Docs
ansible / 2.4 / a10_virtual_server_module.html

a10_virtual_server - Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ virtual servers.

New in version 1.8.

Synopsis

  • Manage SLB (Server Load Balancing) virtual 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
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.
virtual_server
 yes
The SLB (Server Load Balancing) virtual server name.
aliases: vip, virtual
virtual_server_ip
 no
The SLB virtual server IPv4 address.
aliases: ip, address
virtual_server_ports
 no
A list of ports to create for the virtual server. Each list item should be a dictionary which specifies the port: and type:, but can also optionally specify the service_group: as well as the status:. See the examples below for details. This parameter is required when state is present.
virtual_server_status
 no enable
  • enabled
  • disabled
The SLB virtual server status, such as enabled or disabled.
aliases: status
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 virtual server
- a10_virtual_server:
    host: a10.mydomain.com
    username: myadmin
    password: mypassword
    partition: mypartition
    virtual_server: vserver1
    virtual_server_ip: 1.1.1.1
    virtual_server_ports:
      - port: 80
        protocol: TCP
        service_group: sg-80-tcp
      - port: 443
        protocol: HTTPS
        service_group: sg-443-https
      - port: 8080
        protocol: http
        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_virtual
success string mynewvirtualserver

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.

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/a10_virtual_server_module.html