f5networks.f5_modules.bigip_node module – Manages F5 BIG-IP LTM nodes
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_node
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages F5 BIG-IP LTM nodes.
Parameters
Parameter |
Comments |
---|---|
IP address of the node. This can be either IPv4 or IPv6. When creating a new node, you must provide one of either |
|
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 |
|
Monitor rule type when When creating a new pool, if this value is not specified, the default of ‘all’ will be used. Choices:
|
|
Node connection limit. Setting this to |
|
Specifies descriptive text that identifies the node. You can remove a description by either specifying an empty string, or by specifying the special value |
|
The dynamic ratio number for the node. Used for dynamic ratio load balancing. When creating a new node, if this parameter is not specified, the default of |
|
FQDN name of the node. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are “A” to “Z”, “a” to “z”, “0” to “9”, the hyphen (“-”) and the period (“.”). FQDN names must include at least one period; delineating the host from the domain. For example, FQDN names must end with a letter or a number. When creating a new node, you must provide one of either |
|
Specifies whether the FQDN of the node resolves to an IPv4 or IPv6 address. When creating a new node, if this parameter is not specified and This parameter cannot be changed after it has been set. Choices:
|
|
Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. When When When creating a new node, if this parameter is not specified and This parameter cannot be changed after it has been set. Choices:
|
|
Specifies the interval in which a query occurs, when the DNS server is down. The associated monitor continues polling as long as the DNS server is down. When creating a new node, if this parameter is not specified and |
|
Specifies the interval at which a query occurs, when the DNS server is up. The associated monitor attempts to probe three times, and marks the server down if it there is no response within the span of three times the interval value, in seconds. This parameter accepts a value of When creating a new node, if this parameter is not specified and |
|
Specifies the health monitors the system currently uses to monitor this node. |
|
Specifies the name of the node. |
|
Device partition to manage resources on. Default: |
|
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:
|
|
Node rate limit (connections-per-second). Setting this to |
|
Node ratio weight. Valid values range from 1 through 100. When creating a new node, if this parameter is not specified, the default of |
|
Specifies the current state of the node. Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their 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: Add node
bigip_node:
host: 10.20.30.40
name: 10.20.30.40
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add node with a single 'ping' monitor
bigip_node:
host: 10.20.30.40
name: mytestserver
monitors:
- /Common/icmp
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Modify node description
bigip_node:
name: 10.20.30.40
description: Our best server yet
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Delete node
bigip_node:
state: absent
name: 10.20.30.40
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Force node offline
bigip_node:
state: disabled
name: 10.20.30.40
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add node by their FQDN
bigip_node:
fqdn: foo.bar.com
name: foobar.net
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Changed value for the description of the node. Returned: changed and success Sample: |
|
Changed list of monitors for the node. Returned: changed and success Sample: |
|
Changed value for the internal session of the node. Returned: changed and success Sample: |
|
Changed value for the internal state of the node. Returned: changed and success Sample: |