You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

bigip_gtm_datacenter - Manage Datacenter configuration in BIG-IP¶

New in version 2.2.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis ¶

Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP

Requirements (on host that executes module)¶

f5-sdk

Options ¶

parameter	required	default	choices	comments
contact	no			The name of the contact for the data center.
description	no			The description of the data center.
enabled	no		True False	Whether the data center should be enabled. At least one of `state` and `enabled` are required.
location	no			The location of the data center.
name	yes			The name of the data center.
password	yes			The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable `F5_PASSWORD` is set.
server	yes			The BIG-IP host. This option can be omitted if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	no	443		The BIG-IP server port. This option can be omitted if the environment variable `F5_SERVER_PORT` is set.
state	no		present absent	The state of the datacenter on the BIG-IP. When `present`, guarantees that the data center exists. When `absent` removes the data center from the BIG-IP. `enabled` will enable the data center and `disabled` will ensure the data center is disabled. At least one of state and enabled are required.
user	yes			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	no	True	True False	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable `F5_VALIDATE_CERTS` is set.

Examples ¶

- name: Create data center "New York"
  bigip_gtm_datacenter:
      server: "big-ip"
      name: "New York"
      location: "222 West 23rd"
  delegate_to: localhost

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
contact	The contact that was set on the datacenter	changed	string	admin@root.local
description	The description that was set for the datacenter	changed	string	Datacenter in NYC
enabled	Whether the datacenter is enabled or not	changed	bool	True
location	The location that is set for the datacenter	changed	string	222 West 23rd
name	Name of the datacenter being manipulated	changed	string	foo

Notes ¶

Note

Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.