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.

Requirements

The below requirements are needed on the host that executes this module.

  • f5-sdk >= 3.0.9

Parameters

Parameter Choices/Defaults Comments
name
required
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
partition
(added in 2.5)
Default:
Common
Device partition to manage resources on.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
pool_lb_method
required

(added in 2.5)
    Choices:
  • 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.

aliases: lb_method
pools
(added in 2.5)
The pools that you want associated with the Wide IP.
If ratio is not provided when creating a new Wide IP, it will default to 1.
ratio
Ratio for the pool.
The system uses this number with the Ratio load balancing method.
name
required
The name of the pool to include
provider
(added in 2.5)
Default:
None
A dict object containing connection details.
ssh_keyfile
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout Default:
10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
user
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
server_port Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
validate_certs
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.
transport
required
    Choices:
  • rest
  • cli ←
Configures the transport connection to use when connecting to the remote device.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
state
(added in 2.4)
    Choices:
  • 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)
    Choices:
  • 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
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.

Notes

Note

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

Key Returned Description
lb_method
string
changed
The new load balancing method used by the wide IP.

Sample:
topology
state
string
changed
The new state of the wide IP.

Sample:
disabled


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Tim Rupp (@caphrim007)

Hint

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