f5networks.f5_modules.bigip_gtm_server module – Manages F5 BIG-IP GTM servers
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_server
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage BIG-IP GTM (now BIG-IP DNS) server configuration. This module is able to manipulate the server definitions in a BIG-IP.
Parameters
Parameter |
Comments |
---|---|
If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. |
|
Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a This parameter will be ignored if a type of either |
|
Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, the The value of this parameter should always be higher than, or equal to, the value of This parameter is only relevant when a This parameter will be ignored if a type of either |
|
Specifies the minimum number of probes that must succeed for this server to be declared up. When creating a new virtual server, if this parameter is specified, then the The value of this parameter should always be lower than, or equal to, the value of This parameter is only relevant when a This parameter will be ignored if a type of either |
|
Monitor rule type when When creating a new pool, if this value is not specified, the default of all will be used. Choices:
|
|
Data center to which the server belongs. When creating a new GTM server, this value is required. |
|
Lists the self IP addresses and translations for each device. When creating a new GTM server, this value is required. This list is a complex list that specifies a number of keys. The The The Specifying duplicate |
|
Specifies whether the Global Traffic Manager uses this BIG-IP system to conduct a variety of probes before delegating traffic to it. |
|
Specifies the system verifies the logical network route between a data center server and a local DNS server. Choices:
|
|
Specifies the system verifies that an application on a server is running, by remotely running the application using an external service checker program. Choices:
|
|
Specifies the system checks the performance of a server running an SNMP agent. Choices:
|
|
Specifies resource thresholds or limit requirements at the pool member level. When you enable one or more limit settings, the system then uses that data to take members in and out of service. You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load balancing traffic to another resource. |
|
Whether the bits limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the maximum allowable data throughput rate for the member, in bits per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. |
|
Whether the current connections limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the maximum number of concurrent connections, combined, for all of the members. If the connections exceed this limit, the system marks the server as unavailable. |
|
Whether the CPU limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. |
|
Whether the memory limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. |
|
Whether the packets limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the maximum allowable data transfer rate for the member, in packets per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. |
|
Specifies whether the system auto-discovers the links for this server. When creating a new GTM server, if this parameter is not specified, the default value If you set this parameter to Choices:
|
|
Specifies the health monitors the system currently uses to monitor this resource. When |
|
The name of the server. If the virtual server is auto-discovered from the LTM,then the partition name needs to be included as part of the virtual server name when referencing from the module e.g. “/Common/vsname”. |
|
Device partition to manage resources on. Default: |
|
Specifies the type of prober to use to monitor this server’s resources when the preferred prober is not available. This option is ignored in From The choices are mutually exclusive with prober_preference parameter, with the exception of the Choices:
|
|
Specifies the name of the prober pool to use to monitor this server’s resources. In The format of the name can be either be prepended by partition ( In |
|
Specifies the type of prober to use to monitor this server’s resources. This option is ignored in From Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the server type. The server type determines the metrics the system can collect from the server. When creating a new GTM server, the default value Choices:
|
|
The server state. If Choices:
|
|
Specifies whether the system auto-discovers the virtual servers for this server. When creating a new GTM server, if this parameter is not specified, the default value Choices:
|
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 server "GTM_Server"
bigip_gtm_server:
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- name: server_1
address: 1.1.1.1
- name: server_2
address: 2.2.2.1
translation: 192.168.2.1
- name: server_2
address: 2.2.2.2
- name: server_3
addresses:
- address: 3.3.3.1
- address: 3.3.3.2
- name: server_4
addresses:
- address: 4.4.4.1
translation: 192.168.14.1
- address: 4.4.4.2
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create server "GTM_Server" with expanded keys
bigip_gtm_server:
server: lb.mydomain.com
user: admin
password: secret
name: GTM_Server
datacenter: /Common/New York
server_type: bigip
link_discovery: disabled
virtual_server_discovery: disabled
devices:
- name: server_1
address: 1.1.1.1
- name: server_2
address: 2.2.2.1
translation: 192.168.2.1
- name: server_2
address: 2.2.2.2
- name: server_3
addresses:
- address: 3.3.3.1
- address: 3.3.3.2
- name: server_4
addresses:
- address: 4.4.4.1
translation: 192.168.14.1
- address: 4.4.4.2
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 |
---|---|
Whether the bits limit is enabled. Returned: changed Sample: |
|
The new bits_enabled limit. Returned: changed Sample: |
|
Whether the connections limit is enabled. Returned: changed Sample: |
|
The new connections_limit limit. Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new list of monitors for the resource. Returned: changed Sample: |
|
Whether the packets limit is enabled. Returned: changed Sample: |
|
The new packets_limit limit. Returned: changed Sample: |
|
The new type of the server. Returned: changed Sample: |
|
The new Returned: changed Sample: |