bigip_gtm_datacenter – Manage Datacenter configuration in BIG-IP

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.

Parameters

Parameter Choices/Defaults Comments
contact
string
The name of the contact for the data center.
description
string
The description of the data center.
location
string
The location of the data center.
name
string / required
The name of the data center.
partition
string
added in 2.5
 Default:
"Common"
Device partition to manage resources on.
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.
state
string
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
The virtual address state. If absent, an attempt to delete the virtual address will be made. This will only succeed if this virtual address is not in use by a virtual server. present creates the virtual address and enables it. If enabled, enable the virtual address if it exists. If disabled, create the virtual address if needed, and set state to disabled.

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 data center "New York"
  bigip_gtm_datacenter:
    name: New York
    location: 222 West 23rd
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Return Values

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

Key Returned Description
contact
string
changed
The contact that was set on the datacenter.

Sample:
description
string
changed
The description that was set for the datacenter.

Sample:
Datacenter in NYC
disabled
boolean
changed
Whether the datacenter is disabled or not.

Sample:
True
enabled
boolean
changed
Whether the datacenter is enabled or not

Sample:
True
location
string
changed
The location that is set for the datacenter.

Sample:
222 West 23rd
state
string
changed
State of the datacenter.

Sample:
disabled


Status

  • This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
  • This module is maintained by an Ansible Partner. [certified]

Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Hint

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