bigip_gtm_wide_ip - Manages F5 BIG-IP GTM wide ip¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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.16

Parameters ¶

Parameter		Choices/Defaults	Comments
aliases (added in 2.7)			Specifies alternate domain names for the web site content you are load balancing. You can use the same wildcard characters for aliases as you can for actual wide IP names.
irules (added in 2.6)			List of rules to be applied. If you want to remove all existing iRules, specify a single empty value; `""`. See the documentation for an example.
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 may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
pool_lb_method required (added in 2.5)		Choices: round-robin ratio topology global-availability global_availability round_robin	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. The `round_robin` value is deprecated and will be removed in Ansible 2.9. The `global_availability` value is deprecated and will be removed in Ansible 2.9. 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. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
	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 may omit this option by setting the environment variable `F5_SERVER`.
	user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
	server_port	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	password required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	validate_certs bool	Choices: no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
	transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required			The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port (added in 2.2)		Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
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 may omit this option by setting the environment variable `F5_USER`.
validate_certs bool (added in 2.0)		Choices: no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.

Notes ¶

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples ¶

- name: Set lb method
  bigip_gtm_wide_ip:
    server: lb.mydomain.com
    user: admin
    password: secret
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
  delegate_to: localhost

- name: Add iRules to the Wide IP
  bigip_gtm_wide_ip:
    server: lb.mydomain.com
    user: admin
    password: secret
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules:
      - irule1
      - irule2
  delegate_to: localhost

- name: Remove one iRule from the Virtual Server
  bigip_gtm_wide_ip:
    server: lb.mydomain.com
    user: admin
    password: secret
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules:
      - irule1
  delegate_to: localhost

- name: Remove all iRules from the Virtual Server
  bigip_gtm_wide_ip:
    server: lb.mydomain.com
    user: admin
    password: secret
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    irules: ""
  delegate_to: localhost

- name: Assign a pool with ratio to the Wide IP
  bigip_gtm_wide_ip:
    server: lb.mydomain.com
    user: admin
    password: secret
    pool_lb_method: round-robin
    name: my-wide-ip.example.com
    pools:
      - name: pool1
        ratio: 100
  delegate_to: localhost

Return Values ¶

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

Key	Returned	Description
aliases list	changed	Aliases set on the Wide IP. Sample: ['alias1.foo.com', '*.wildcard.domain']
irules list	changed	iRules set on the Wide IP. Sample: ['/Common/irule1', '/Common/irule2']
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 stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance ¶

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author ¶

Tim Rupp (@caphrim007)

Hint

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