bigip_gtm_topology_region – Manages GTM Topology Regions

New in version 2.8.

Synopsis
Parameters
Notes
Examples
Return Values
Status

Synopsis

Manages GTM Topology Regions.

Parameters

Parameter		Choices/Defaults	Comments
name - / required			Specifies the name of the region.
partition string		Default: "Common"	Device partition to manage resources on. Partition parameter is also taken into account when used in conjunction with `pool`, `data_center`, and `region` parameters.
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
provider dictionary added in 2.5			A dict object containing connection details.
	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	Default: 10	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`.
region_members list			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 `none` value is specified the region members list will be 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 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 region, when the request source does not match. Only a single list entry can be specified together with negate.
	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.
server string / required			The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port integer added in 2.2		Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
state string		Choices: present ← absent	When `state` is `present`, ensures that the region exists. When `state` is `absent`, ensures that the region is removed.
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 added in 2.0		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`.

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 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	Returned	Description
name string	changed	The name value of the GTM region. Sample: foobar
region_members list	changed	The list of members of the GTM region. Sample: [{'continent': 'EU'}, {'country': 'PL'}]

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.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_gtm_topology_region_module.html