bigip_virtual_server - Manages F5 BIG-IP LTM virtual servers

New in version 2.1.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is an Extras Module

Synopsis

Manages F5 BIG-IP LTM virtual servers via iControl SOAP API

Requirements (on host that executes module)

bigsuds

Options

parameter	required	default	choices	comments
all_profiles	no	None		List of all Profiles (HTTP,ClientSSL,ServerSSL,etc) that must be used by the virtual server
default_persistence_profile	no	None		Default Profile which manages the session persistence
description	no	None		Virtual server description.
destination	yes			Destination IP of the virtual server (only host is currently supported) . Required when state=present and vs does not exist. aliases: address, ip
name	yes			Virtual server name. aliases: vs
partition	no	Common		Partition
password	yes			BIG-IP password
pool	no	None		Default pool for the virtual server
port	no	None		Port of the virtual server . Required when state=present and vs does not exist
server	yes			BIG-IP host
snat	no	None		Source network address policy
state	no	present	present absent enabled disabled	Virtual Server state Absent, delete the VS if present present (and its synonym enabled), create if needed the VS and set state to enabled disabled, create if needed the VS and set state to disabled
user	yes			BIG-IP username
validate_certs	no	yes	yes no	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

## playbook task examples:

---
# file bigip-test.yml
# ...
  - name: Add VS
    local_action:
        module: bigip_virtual_server
        server: lb.mydomain.net
        user: admin
        password: secret
        state: present
        partition: MyPartition
        name: myvirtualserver
        destination: "{{ ansible_default_ipv4['address'] }}"
        port: 443
        pool: "{{ mypool }}"
        snat: Automap
        description: Test Virtual Server
        all_profiles:
            - http
            - clientssl

  - name: Modify Port of the Virtual Server
    local_action:
        module: bigip_virtual_server
        server: lb.mydomain.net
        user: admin
        password: secret
        state: present
        partition: MyPartition
        name: myvirtualserver
        port: 8080

  - name: Delete pool
    local_action:
        module: bigip_virtual_server
        server: lb.mydomain.net
        user: admin
        password: secret
        state: absent
        partition: MyPartition
        name: myvirtualserver

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
deleted	Name of a virtual server that was deleted	virtual server was successfully deleted on state=absent	string

Notes

Note

Requires BIG-IP software version >= 11

Note

F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)

Note

Best run as a local_action in your playbook

This is an Extras Module

For more information on what this means please read Extras Modules

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