f5networks.f5_modules.bigip_gtm_virtual_server module – Manages F5 BIG-IP GTM virtual 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_virtual_server
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages F5 BIG-IP GTM (now BIG-IP DNS) virtual servers. A GTM server can have many virtual servers associated with it. They are arranged in much the same way that pool members are to pools.
Parameters
Parameter |
Comments |
---|---|
Specifies the IP Address of the virtual server. When creating a new GTM virtual server, this parameter is required. |
|
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 virtual, if this value is not specified, the default of Choices:
|
|
Specifies resource thresholds or limit requirements at the server level. When you enable one or more limit settings, the system then uses that data to take servers in and out of service. You can define limits for any or all of the limit settings. However, when a server does not meet the resource threshold limit requirement, the system marks the entire server as unavailable and directs load balancing traffic to another resource. The limit settings available depend on the type of server. |
|
Whether or not the bits limit is enabled. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the maximum allowable data throughput rate for the virtual servers on the server, in bits per second. If the network traffic volume exceeds this limit, the system marks the server as unavailable. |
|
Whether or not the current connections limit is enabled. 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 virtual servers on the server. If the connections exceed this limit, the system marks the server as unavailable. |
|
Whether or not the packets limit is enabled. This parameter allows you to switch on or off the effect of the limit. Choices:
|
|
Specifies the maximum allowable data transfer rate for the virtual servers on the server, in packets per second. If the network traffic volume exceeds this limit, the system marks the server as unavailable. |
|
Specifies a link to assign to the server or virtual server. |
|
Specifies the health monitors the system currently uses to monitor this resource. When |
|
Specifies the name of the virtual server. |
|
Device partition to manage resources on. Default: |
|
Specifies the service port number for the virtual server or pool member. For example, the HTTP service is typically port 80. To specify all ports, use an When creating a new GTM virtual server, if this parameter is not specified, a default of |
|
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 name of the server the virtual server is associated with. |
|
When When Choices:
|
|
Specifies the translation IP address for the virtual server. To unset this parameter, use an empty string ( When creating a new GTM virtual server, if this parameter is not specified, a default of |
|
Specifies the translation port number or service name for the virtual server. To specify all ports, use an When creating a new GTM virtual server, if this parameter is not specified, a default of |
|
Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. |
|
Server which the dependant virtual server is part of. |
|
Virtual server to depend on. |
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: Enable virtual server
bigip_gtm_virtual_server:
server_name: server1
name: my-virtual-server
state: enabled
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 |
---|---|
The new address of the resource. Returned: changed Sample: |
|
The new availability requirement configurations for the resource. Returned: changed Sample: |
|
The new limit configurations for the resource. Returned: changed Sample: |
|
The new link value for the resource. Returned: changed Sample: |
|
The new list of monitors for the resource. Returned: changed Sample: |
|
The new port of the resource. Returned: changed Sample: |
|
The server name associated with the virtual server. Returned: changed Sample: |
|
The new translation address of the resource. Returned: changed Sample: |
|
The new translation port of the resource. Returned: changed Sample: |
|
The new list of virtual server dependencies for the resource. Returned: changed Sample: |