a10_virtual_server – Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ virtual servers — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# a10_virtual_server – Manage A10 Networks AX/SoftAX/Thunder/vThunder devices’ virtual servers

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

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

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
client_cert path |  | PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, `client_key` is not required.
client_key path |  | PEM formatted file that contains your private key to be used for SSL client authentication. If `client_cert` contains both the certificate and key, this option is not required.
force boolean | Choices: no ← yes | If `yes` do not get a cached copy. Alias `thirsty` has been deprecated and will be removed in 2.13. aliases: thirsty
force_basic_auth boolean | Choices: no ← yes | Credentials specified with url_username and url_password should be passed in HTTP Header.
host string / required |  | Hostname or IP of the A10 Networks device.
http_agent string | Default: "ansible-httpget" | Header to identify as, generally appears in web server logs.
partition - |  | set active-partition
password string / required |  | Password for the `username` account. aliases: pass, pwd
state - | Choices: present ← absent | If the specified virtual server should exist.
url string |  | HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
url_password string |  | The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used.
url_username string |  | The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords
use_proxy boolean | Choices: no yes ← | If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
username string / required |  | An account with administrator privileges. aliases: admin, user
validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates.
virtual_server - / required |  | The SLB (Server Load Balancing) virtual server name. aliases: vip, virtual
virtual_server_ip - |  | The SLB virtual server IPv4 address. aliases: ip, address
virtual_server_ports - |  | 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 - | Choices: enabled disabled Default: "enable" | The SLB virtual server status, such as enabled or disabled. aliases: status
write_config boolean | Choices: no ← yes | 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`.

## Notes

Note

- Requires A10 Networks aXAPI 2.1.
- Requires A10 Networks aXAPI 2.1.

## 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, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
content string | success | the full info regarding the slb_virtual Sample: mynewvirtualserver

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Eric Chou (@ericchou1)
- Mischa Peters (@mischapeters)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.