f5networks.f5_modules.bigip_gtm_topology_record – Manages GTM Topology Records
f5networks.f5_modules.bigip_gtm_topology_record – Manages GTM Topology Records
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_topology_record
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manages GTM (now BIG-IP DNS) 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 Specifying 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 |
|
Specifies an Internet service provider. | |
negate boolean |
|
When set to | |
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 the | ||
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 | |
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 You may omit this option by setting the environment variable | |
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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. | |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
source dictionary / required |
Specifies the origination of an incoming DNS request. | ||
continent string |
Specifies one of the seven continents, along with the Specifying 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 Valid country codes can be found here https://countrycode.org/. | ||
geo_isp string |
Specifies a geolocation ISP. | ||
isp string |
|
Specifies an Internet service provider. | |
negate boolean |
|
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 the | ||
subnet string |
An IP address and network mask in the CIDR format. | ||
state string |
|
When When | |
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 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 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 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 |
Authors
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_gtm_topology_record_module.html