Steampunk Ansible Documentation - f5networks.f5_modules.bigip_gtm_topology_record (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 Records. Once created, only topology record C(weight) can be modified.

Usage examples

Scanned by Steampunk Spotter

- name: Create an IP Subnet and an ISP based topology record
  bigip_gtm_topology_record:
    source:
      - subnet: 192.168.1.0/24
    destination:
      - isp: AOL
    weight: 10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Create a region and a pool based topology record
  bigip_gtm_topology_record:
    source:
      - region: Foo
    destination:
      - pool: FooPool
    partition: FooBar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

- name: Create a negative region and a negative data center based topology record
  bigip_gtm_topology_record:
    source:
      - region: Baz
      - negate: true
    destination:
      - datacenter: Baz-DC
      - negate: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

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

source:
description:
- Specifies the origination of an incoming DNS request.
required: true
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:
- Specifies a country.
- 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
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 record, when the request
source does not match.
type: bool
region:
description:
- Specifies the name of region already defined in the configuration.
type: str
state:
description:
- Specifies a state in a given country.
- This parameter requires the C(country) option.
type: str
subnet:
description:
- An IP address and network mask in the CIDR format.
type: str
type: dict

weight:
description:
- Specifies the weight of the topology record.
- The system finds the weight of the first topology record that matches the server
object (pool or pool member) and the local DNS. The system then assigns that weight
as the topology score for that server object.
- The system load balances to the server object with the highest topology score.
- If the system finds no topology record that matches both the server object and the
local DNS, then the system assigns that server object a zero score.
- If the option is not specified when the record is created the system will set it
at a default value of C(1)
- Valid range is (0 - 4294967295)
type: int

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 taken into account when used in conjunction with C(pool),
C(data_center), and C(region) parameters, otherwise it is ignored.
type: str

destination:
description:
- Specifies where the system directs the incoming DNS request.
required: true
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:
- Specifies a country.
- Full continent names and their abbreviated versions are supported.
type: str
datacenter:
description:
- Specifies the name of 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 record, when the request
destination does not match.
type: bool
pool:
description:
- Specifies the name of 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.
- This parameter requires the C(country) option.
type: str
subnet:
description:
- An IP address and network mask in the CIDR format.
type: str
type: dict

Outputs

weight:
  description: The weight of the topology record.
  returned: changed
  sample: 20
  type: int