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.19.0).

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 version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manages GTM (now BIG-IP DNS) Topology Regions.

Parameters

Parameter

Comments

name

string / required

Specifies the name of the region.

partition

string

Device partition to manage resources on.

Partition parameter is also taken into account when used in conjunction with pool, data_center, and region parameters.

Default: “Common”

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 yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • no ← (default)

  • yes

password

aliases: pass, pwd

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.

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • rest ← (default)

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.

Choices:

  • no

  • yes ← (default)

region_members

list / elements=dictionary

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.

continent

string

Specifies one of the seven continents, along with the Unknown setting.

Specifying Unknown forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request.

Full continent names and their abbreviated versions are supported.

country

string

The country name or code to use.

In addition to the country full names, you may also specify their abbreviated form, such as US instead of United States.

Valid country codes can be found here https://countrycode.org/.

datacenter

string

Specifies the name of the GTM data center already defined in the configuration.

geo_isp

string

Specifies a geolocation ISP.

isp

string

Specifies an Internet service provider.

Choices:

  • AOL

  • BeijingCNC

  • CNC

  • ChinaEducationNetwork

  • ChinaMobilNetwork

  • ChinaRailwayTelcom

  • ChinaTelecom

  • ChinaUnicom

  • Comcast

  • Earthlink

  • ShanghaiCNC

  • ShanghaiTelecom

negate

boolean

When set to c(yes), 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:

  • no ← (default)

  • yes

pool

string

Specifies the name of the GTM pool already defined in the configuration.

region

string

Specifies the name of region already defined in the configuration.

state

string

Specifies a state in a given country.

subnet

string

An IP address and network mask in the CIDR format.

state

string

When state is present, ensures the region exists.

When state is absent, ensures the region is removed.

Choices:

  • present ← (default)

  • absent

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: yes
      - 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

name

string

The name value of the GTM region.

Returned: changed

Sample: “foobar”

region_members

list / elements=string

The list of members of the GTM region.

Returned: changed

Sample: [{“continent”: “EU”}, {“country”: “PL”}]

Authors

  • Wojciech Wypior (@wojtek0806)