f5networks.f5_modules.bigip_gtm_topology_region module – Manages GTM Topology Regions
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_topology_region
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages GTM (now BIG-IP DNS) Topology Regions.
Parameters
Parameter |
Comments |
---|---|
Specifies the name of the region. |
|
Device partition to manage resources on. Partition parameter is also taken into account when used in conjunction with Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the list of region members. This list of members is all or nothing, in order to add or remove a member, you must specify the entire list of members. The list will override what is on the device, if different. If you specify an empty list, the region members list is removed. |
|
Specifies one of the seven continents, along with the Specifying Full continent names and their abbreviated versions are supported. |
|
The country name or code to use. In addition to the country full names, you may also specify their abbreviated form, such as Valid country codes can be found here https://countrycode.org/. |
|
Specifies the name of the GTM data center already defined in the configuration. |
|
Specifies a geolocation ISP. |
|
Specifies an Internet service provider. Choices:
|
|
When set to c(true), the system selects this topology region when the request source does not match. Only a single list entry can be specified together with negate. Choices:
|
|
Specifies the name of the GTM pool already defined in the configuration. |
|
Specifies the name of region already defined in the configuration. |
|
Specifies a state in a given country. |
|
An IP address and network mask in the CIDR format. |
|
When When Choices:
|
Notes
Note
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: Create topology region
bigip_gtm_topology_region:
name: foobar
region_members:
- country: CN
negate: true
- datacenter: baz
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify topology region
bigip_gtm_topology_region:
name: foobar
region_members:
- continent: EU
- country: PL
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The name value of the GTM region. Returned: changed Sample: |
|
The list of members of the GTM region. Returned: changed Sample: |