f5networks.f5_modules.bigip_gtm_wide_ip – Manages F5 BIG-IP GTM Wide IP
f5networks.f5_modules.bigip_gtm_wide_ip – Manages F5 BIG-IP GTM Wide IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_wide_ip
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manages the F5 BIG-IP GTM (now BIG-IP DNS) Wide IP.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aliases list / elements=string |
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 / elements=string |
List of rules to be applied. If you want to remove all existing iRules, specify a single empty value; | ||
last_resort_pool string |
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 | ||
name string / required |
Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias
| ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
persist_cidr_ipv4 integer |
Specifies a mask used to group IPv4 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. | ||
persist_cidr_ipv6 integer |
Specifies a mask used to group IPv6 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. | ||
persistence boolean |
|
When When | |
persistence_ttl integer |
Specifies the time to maintain a connection between an local DNS and a particular virtual server. | ||
pool_lb_method string |
|
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.
| |
pools list / elements=dictionary |
The pools you want associated with the Wide IP. If | ||
name string / required |
The name of the pool to include. | ||
order integer |
Order of the pool in relation to other pools attached to this Wide IP. Pool order is significant when the Global Availability load balancing method is used. When | ||
ratio integer |
Ratio for the pool. The system uses this number with the Ratio load balancing method. When | ||
provider dictionary added in 1.0.0 of f5networks.f5_modules |
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. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
state string |
|
When When When | |
type string |
|
Specifies the type of Wide IP. GTM Wide IPs need to be keyed by query type in addition to name, because 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 f5_modules 1.4.
- 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 f5networks.f5_modules.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
order: 2
- name: pool1
ratio: 100
order: 1
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Assign a pool with persistence to the Wide IP
bigip_gtm_wide_ip:
pool_lb_method: round-robin
name: my-wide-ip.example.com
pools:
- name: pool1
persistence: yes
persist_cidr_ipv4: 24
persist_cidr_ipv6: 120
persistence_ttl: 3500
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 / elements=string |
changed |
Aliases set on the Wide IP.
Sample: ['alias1.foo.com', '*.wildcard.domain'] |
irules list / elements=string |
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 |
persist_cidr_ipv4 integer |
changed |
Specifies a mask used to group IPv4 LDNS addresses.
Sample: 32 |
persist_cidr_ipv6 integer |
changed |
Specifies a mask used to group IPv6 LDNS addresses.
Sample: 128 |
persistence boolean |
changed |
Whether pool connections will be persisted.
|
persistence_ttl integer |
changed |
Specifies the persistence TTL between an local DNS and a particular virtual server.
Sample: 3600 |
state string |
changed |
The new state of the Wide IP.
Sample: disabled |
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_gtm_wide_ip_module.html