Last updated on: 2023-11-07 03:27:18.
bigip_gtm_global – Manages global GTM settings¶
New in version 1.0.0.
Synopsis¶
- Manages global BIG-IP GTM (now BIG-IP DNS) settings. These settings include general, load balancing, and metrics related settings.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments | |
|---|---|---|---|---|
|
provider
dictionary
added in 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. |
||
|
password
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.aliases: pass, pwd |
|||
|
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
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT. |
||
|
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 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. |
||
|
synchronization
boolean
|
|
Specifies whether this system is a member of a synchronization group.
When you enable synchronization, the system periodically queries other systems in the synchronization group to obtain and distribute configuration and metrics collection updates.
The synchronization group may contain systems configured as Global Traffic Manager (DNS) and Link Controller systems.
|
||
|
synchronization_group_name
string
|
Specifies the name of the synchronization group to which the system belongs.
|
|||
|
synchronize_zone_files
boolean
|
|
Specifies the system synchronizes Domain Name System (DNS) zone files among the synchronization group members.
|
||
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: Configure synchronization settings
bigip_gtm_global:
synchronization: true
synchronization_group_name: my-group
synchronize_zone_files: true
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
synchronization
boolean
|
changed |
The synchronization setting on the system.
Sample:
True
|
|
synchronization_group_name
string
|
changed |
The synchronization group name.
Sample:
my-group
|
|
synchronize_zone_files
string
|
changed |
Whether or not the system will synchronize zone files.
Sample:
my-group
|