Documentation

bigip_gtm_wide_ip - Manages F5 BIG-IP GTM wide ip.

New in version 2.0.

Synopsis

  • Manages F5 BIG-IP GTM wide ip.

Options

parameter required default choices comments
lb_method
yes
  • round-robin
  • ratio
  • topology
  • global-availability
Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a wide IP.
name
yes
Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias wide_ip but this is deprecated and will be removed in a future Ansible version.

aliases: wide_ip
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
(added in 2.4)
no present
  • present
  • absent
  • disabled
  • enabled
When present or enabled, ensures that the Wide IP exists and is enabled. When absent, ensures that the Wide IP has been removed. When disabled, ensures that the Wide IP exists and is disabled.
type
(added in 2.4)
no
  • a
  • aaaa
  • cname
  • mx
  • naptr
  • srv
Specifies the type of wide IP. GTM wide IPs need to be keyed by query type in addition to name, since pool members need different attributes depending on the response RDATA they are meant to supply. This value is required if you are using BIG-IP versions >= 12.0.0.
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: Set lb method
  bigip_gtm_wide_ip:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
      lb_method: "round-robin"
      name: "my-wide-ip.example.com"
  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
state
The new state of the wide IP.
changed string disabled
lb_method
The new load balancing method used by the wide IP.
changed string topology


Notes

Note

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

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.