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.

bigip_gtm_virtual_server - Manages F5 BIG-IP GTM virtual servers¶

New in version 2.2.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Manages F5 BIG-IP GTM virtual servers

Requirements (on host that executes module)¶

bigsuds

Options ¶

parameter	required	default	choices	comments
host	no	None		Virtual server host aliases: address
password	yes			The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable `F5_PASSWORD` is set.
port	no	None		Virtual server port
server	yes			The BIG-IP host. This option can be omitted if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	no	443		The BIG-IP server port. This option can be omitted if the environment variable `F5_SERVER_PORT` is set.
state	no	present	present absent enabled disabled	Virtual server state
user	yes			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	no	True	True False	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable `F5_VALIDATE_CERTS` is set.
virtual_server_name	yes			Virtual server name
virtual_server_server	yes			Virtual server server

Examples ¶

- name: Enable virtual server
  local_action: >
    bigip_gtm_virtual_server
    server=192.0.2.1
    user=admin
    password=mysecret
    virtual_server_name=myname
    virtual_server_server=myserver
    state=enabled

Notes ¶

Note

Requires BIG-IP software version >= 11.4
F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)
Best run as a local_action in your playbook
Tested with manager and above account privilege level

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.