- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_gtm_topology_record – Manages GTM Topology Records

New in version 2.8.

- Synopsis

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Manages GTM Topology Records. Once created, only topology record `weight` can be modified.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
destination dictionary / required |  | Specifies where the system directs the incoming DNS request.
| 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 |  | Specifies a country. Full continent names and their abbreviated versions are supported.
| datacenter string |  | Specifies the name of GTM data center already defined in the configuration.
| geo_isp string |  | Specifies a geolocation ISP
| isp string | Choices: AOL BeijingCNC CNC ChinaEducationNetwork ChinaMobilNetwork ChinaRailwayTelcom ChinaTelecom ChinaUnicom Comcast Earthlink ShanghaiCNC ShanghaiTelecom | Specifies an Internet service provider.
| negate boolean | Choices: no ← yes | When set to c(yes) the system selects this topology record, when the request destination does not match.
| pool string |  | Specifies the name of 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. This parameter requires country option to be provided.
| subnet string |  | An IP address and network mask in the CIDR format.
partition string | Default: "Common" | Device partition to manage resources on. Partition parameter is taken into account when used in conjunction with `pool`, `data_center`, and `region` parameters, it is ignored otherwise.
provider dictionary added in 2.5 |  | 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.
| 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 `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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 | Choices: cli rest ← | 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 `F5_USER`.
| validate_certs boolean | Choices: no yes ← | 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`.
source dictionary / required |  | Specifies the origination of an incoming DNS request.
| 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 |  | Specifies a country. 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/.
| geo_isp string |  | Specifies a geolocation ISP
| isp string | Choices: AOL BeijingCNC CNC ChinaEducationNetwork ChinaMobilNetwork ChinaRailwayTelcom ChinaTelecom ChinaUnicom Comcast Earthlink ShanghaiCNC ShanghaiTelecom | Specifies an Internet service provider.
| negate boolean | Choices: no ← yes | When set to c(yes) the system selects this topology record, when the request source does not match.
| region string |  | Specifies the name of region already defined in the configuration.
| state string |  | Specifies a state in a given country. This parameter requires country option to be provided.
| subnet string |  | An IP address and network mask in the CIDR format.
state string | Choices: present ← absent | When `state` is `present`, ensures that the record exists. When `state` is `absent`, ensures that the record is removed.
weight integer |  | 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 `1` Valid range is (0 - 4294967295)

## 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 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 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

    - 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

    - name: Create a negative region and a negative data center based topology record
      bigip_gtm_topology_record:
        source:
          - region: Baz
          - negate: yes
        destination:
          - datacenter: Baz-DC
          - negate: yes
        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 | Returned | Description
--- | --- | ---
weight integer | changed | The weight of the topology record. Sample: 20

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by an Ansible Partner. [certified]

### Authors

- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.