f5networks.f5_modules.bigip_gtm_datacenter module – Manage Datacenter configuration in BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.32.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_gtm_datacenter.

New in f5networks.f5_modules 1.0.0

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

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

Device partition to manage resources on.

Default: "Common"

provider

dictionary

added in f5networks.f5_modules 1.0.0

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 yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • false ← (default)

  • true

password

aliases: pass, pwd

string / required

The password for the user account used to connect to the BIG-IP or the BIG-IQ.

You may omit this option by setting the environment variable F5_PASSWORD.

server

string / required

The BIG-IP host or the BIG-IQ host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • "rest" ← (default)

user

string / required

The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device.

You may omit this option by setting the environment variable F5_USER.

validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

state

string

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, enables the virtual address if it exists. If disabled, creates the virtual address if needed, and sets state to disabled.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "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 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 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

Description

contact

string

The contact that was set on the datacenter.

Returned: changed

Sample: "admin@root.local"

description

string

The description for the datacenter.

Returned: changed

Sample: "Datacenter in NYC"

disabled

boolean

Whether the datacenter is disabled or not.

Returned: changed

Sample: true

enabled

boolean

Whether the datacenter is enabled or not.

Returned: changed

Sample: true

location

string

The location for the datacenter.

Returned: changed

Sample: "222 West 23rd"

state

string

State of the datacenter.

Returned: changed

Sample: "disabled"

Authors

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)