bigip_gtm_wide_ip – Manages F5 BIG-IP GTM wide ip
Synopsis
- Manages F5 BIG-IP GTM wide ip.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aliases
list
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
list
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.
|
||
last_resort_pool
string
added in 2.8
|
Specifies which GTM pool, for the system to use as the last resort pool for the wide IP.
The valid pools for this parameter are those with the
type specified in this module.
|
||
name
string /
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
string
added in 2.5
|
Default:
"Common"
|
Device partition to manage resources on.
|
|
pool_lb_method
string /
required
added in 2.5
|
|
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
list
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.
|
||
name
string /
required
|
The name of the pool to include.
|
||
ratio
integer
|
Ratio for the pool.
The system uses this number with the Ratio load balancing method.
|
||
provider
dictionary
added in 2.5
|
A dict object containing connection details.
|
||
auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
||
password
string /
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 |
||
server
string /
required
|
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER .
|
||
server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT .
|
|
ssh_keyfile
path
|
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
integer
|
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.
|
||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
user
string /
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
boolean
|
|
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 .
|
|
state
string
added in 2.4
|
|
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
string
added in 2.4
|
|
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.
|
Notes
Note
- Support for TMOS versions below v12.x has been deprecated for this module, and will be removed in Ansible 2.12.
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- 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: pool_lb_method: round-robin name: my-wide-ip.example.com provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add iRules to the Wide IP bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com irules: - irule1 - irule2 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove one iRule from the Virtual Server bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com irules: - irule1 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove all iRules from the Virtual Server bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com irules: "" provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Assign a pool with ratio to the Wide IP bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com pools: - name: pool1 ratio: 100 provider: user: admin password: secret server: lb.mydomain.com 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 guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_gtm_wide_ip_module.html