bigip_virtual_address - Manage LTM virtual addresses on a BIG-IP.

New in version 2.4.

Synopsis

  • Manage LTM virtual addresses on a BIG-IP.

Options

parameter required default choices comments
address
 yes
Virtual address. This value cannot be modified after it is set.
aliases: name
advertise_route
 no
  • always
  • when_all_available
  • when_any_available
Specifies what routes of the virtual address the system advertises. When when_any_available, advertises the route when any virtual server is available. When when_all_available, advertises the route when all virtual servers are available. When (always), always advertises the route regardless of the virtual servers available.
arp_state
 no
  • enabled
  • disabled
Specifies whether the system accepts ARP requests. When (disabled), specifies that the system does not accept ARP requests. Note that both ARP and ICMP Echo must be disabled in order for forwarding virtual servers using that virtual address to forward ICMP packets. If (enabled), then the packets are dropped.
auto_delete
 no
  • enabled
  • disabled
Specifies whether the system automatically deletes the virtual address with the deletion of the last associated virtual server. When disabled, specifies that the system leaves the virtual address even when all associated virtual servers have been deleted. When creating the virtual address, the default value is enabled.
connection_limit
 no
Specifies the number of concurrent connections that the system allows on this virtual address.
icmp_echo
 no
  • enabled
  • disabled
  • selective
Specifies how the systems sends responses to (ICMP) echo requests on a per-virtual address basis for enabling route advertisement. When enabled, the BIG-IP system intercepts ICMP echo request packets and responds to them directly. When disabled, the BIG-IP system passes ICMP echo requests through to the backend servers. When (selective), causes the BIG-IP system to internally enable or disable responses based on virtual server state; when_any_available, when_all_available, or C(always, regardless of the state of any virtual servers.
netmask
 no 255.255.255.255
Netmask of the provided virtual address. This value cannot be modified after it is set.
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.
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
The virtual address state. If absent, an attempt to delete the virtual address will be made. This will only succeed if this virtual address is not in use by a virtual server. present creates the virtual address and enables it. If enabled, enable the virtual address if it exists. If disabled, create the virtual address if needed, and set state to disabled.
use_route_advertisement
 no
  • True
  • False
Specifies whether the system uses route advertisement for this virtual address. When disabled, the system does not advertise routes for this virtual address.
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.

Examples

- name: Add virtual address
  bigip_virtual_address:
      server: "lb.mydomain.net"
      user: "admin"
      password: "secret"
      state: "present"
      partition: "Common"
      address: "10.10.10.10"
  delegate_to: localhost

- name: Enable route advertisement on the virtual address
  bigip_virtual_address:
      server: "lb.mydomain.net"
      user: "admin"
      password: "secret"
      state: "present"
      address: "10.10.10.10"
      use_route_advertisement: yes
  delegate_to: localhost

Return Values

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

name description returned type sample
address
The address of the virtual address.
 created int 2345
arp_state
The new way the virtual address handles ARP requests.
 changed string disabled
auto_delete
New setting for auto deleting virtual address.
 changed string enabled
connection_limit
The new connection limit of the virtual address.
 changed int 1000
icmp_echo
New ICMP echo setting applied to virtual address.
 changed string disabled
netmask
The netmask of the virtual address.
 created int 2345
state
The new state of the virtual address.
 changed string disabled
use_route_advertisement
The new setting for whether to use route advertising or not.
 changed bool True

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • Requires the netaddr Python package on the host. This is as easy as pip install netaddr.

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/bigip_virtual_address_module.html