Steampunk Ansible Documentation - f5networks.f5_modules.bigip_gtm_topology_region (1.28.0) - module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

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

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Inputs

name:
description:
- Specifies the name of the region.
required: true
type: str

state:
choices:
- present
- absent
default: present
description:
- When C(state) is C(present), ensures the region exists.
- When C(state) is C(absent), ensures the region is removed.
type: str

provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules

partition:
default: Common
description:
- Device partition to manage resources on.
- Partition parameter is also taken into account when used in conjunction with C(pool),
C(data_center), and C(region) parameters.
type: str

region_members:
description:
- 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.
elements: dict
suboptions:
continent:
description:
- Specifies one of the seven continents, along with the C(Unknown) setting.
- Specifying C(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.
type: str
country:
description:
- The country name or code to use.
- In addition to the country full names, you may also specify their abbreviated
form, such as C(US) instead of C(United States).
- Valid country codes can be found here https://countrycode.org/.
type: str
datacenter:
description:
- Specifies the name of the GTM data center already defined in the configuration.
type: str
geo_isp:
description:
- Specifies a geolocation ISP.
type: str
isp:
choices:
- AOL
- BeijingCNC
- CNC
- ChinaEducationNetwork
- ChinaMobilNetwork
- ChinaRailwayTelcom
- ChinaTelecom
- ChinaUnicom
- Comcast
- Earthlink
- ShanghaiCNC
- ShanghaiTelecom
description:
- Specifies an Internet service provider.
type: str
negate:
default: false
description:
- 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.
type: bool
pool:
description:
- Specifies the name of the GTM pool already defined in the configuration.
type: str
region:
description:
- Specifies the name of region already defined in the configuration.
type: str
state:
description:
- Specifies a state in a given country.
type: str
subnet:
description:
- An IP address and network mask in the CIDR format.
type: str
type: list

Outputs

name:
  description: The name value of the GTM region.
  returned: changed
  sample: foobar
  type: str
region_members:
  description: The list of members of the GTM region.
  returned: changed
  sample:
  - continent: EU
  - country: PL
  type: list