Documentation

bigip_node – Manages F5 BIG-IP LTM nodes

Synopsis

  • Manages F5 BIG-IP LTM nodes.

Parameters

Parameter Choices/Defaults Comments
address
string
added in 2.2
IP address of the node. This can be either IPv4 or IPv6. When creating a new node, one of either address or fqdn must be provided. This parameter cannot be updated after it is set.

aliases: ip, host
availability_requirements
dictionary
added in 2.8
Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available.
at_least
integer
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 type of at_least is used.
This parameter will be ignored if a type of all is used.
type
-
    Choices:
  • all
  • at_least
Monitor rule type when monitors is specified.
When creating a new pool, if this value is not specified, the default of 'all' will be used.
connection_limit
integer
added in 2.7
Node connection limit. Setting this to 0 disables the limit.
description
string
Specifies descriptive text that identifies the node.
You can remove a description by either specifying an empty string, or by specifying the special value none.
dynamic_ratio
integer
added in 2.7
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 1 will be used.
fqdn
string
added in 2.5
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 lease one period; delineating the host from the domain. ex. host.domain.
FQDN names must end with a letter or a number.
When creating a new node, one of either address or fqdn must be provided. This parameter cannot be updated after it is set.

aliases: hostname
fqdn_address_type
string
added in 2.6
    Choices:
  • ipv4
  • ipv6
  • all
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 fqdn is specified, this parameter will default to ipv4.
This parameter cannot be changed after it has been set.
fqdn_auto_populate
boolean
added in 2.6
    Choices:
  • no
  • yes
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 yes, the system generates an ephemeral node for each IP address returned in response to a DNS query for the FQDN of the node. Additionally, when a DNS response indicates the IP address of an ephemeral node no longer exists, the system deletes the ephemeral node.
When no, the system resolves a DNS query for the FQDN of the node with the single IP address associated with the FQDN.
When creating a new node, if this parameter is not specified and fqdn is specified, this parameter will default to yes.
This parameter cannot be changed after it has been set.
fqdn_down_interval
integer
added in 2.6
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 fqdn is specified, this parameter will default to 5.
fqdn_up_interval
string
added in 2.6
Specifies the interval in 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 ttl to query based off of the TTL of the FQDN. The default TTL interval is akin to specifying 3600.
When creating a new node, if this parameter is not specified and fqdn is specified, this parameter will default to 3600.
monitor_type
string
    Choices:
  • and_list
  • m_of_n
  • single
Monitor rule type when monitors is specified. When creating a new pool, if this value is not specified, the default of 'and_list' will be used.
Both single and and_list are functionally identical since BIG-IP considers all monitors as "a list". BIG=IP either has a list of many, or it has a list of one. Where they differ is in the extra guards that single provides; namely that it only allows a single monitor.
monitors
list
added in 2.2
Specifies the health monitors that the system currently uses to monitor this node.
name
string / required
Specifies the name of the node.
partition
string
added in 2.5
Default:
"Common"
Device partition to manage resources on.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
provider
dictionary
added in 2.5
A dict object containing connection details.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP 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.
ssh_keyfile
path
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
timeout
integer
Default:
10
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
    Choices:
  • cli
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
quorum
integer
added in 2.2
Monitor quorum value when monitor_type is m_of_n.
rate_limit
integer
added in 2.7
Node rate limit (connections-per-second). Setting this to 0 disables the limit.
ratio
integer
added in 2.7
Node ratio weight. Valid values range from 1 through 100.
When creating a new node, if this parameter is not specified, the default of 1 will be used.
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
added in 2.2
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
state
string
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
  • offline
Specifies the current state of the node. enabled (All traffic allowed), specifies that system sends traffic to this node regardless of the node's state. disabled (Only persistent or active connections allowed), Specifies that the node can handle only persistent or active connections. offline (Only active connections allowed), Specifies that the node can handle only active connections. In all cases except absent, the node will be created if it does not yet exist.
Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their state to disabled or offline. They will remain in an *Unavailable - Enabled* state.
user
string / required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER.
validate_certs
boolean
added in 2.0
    Choices:
  • no
  • yes ←
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.

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 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 Returned Description
description
string
changed and success
Changed value for the description of the node.

Sample:
E-Commerce webserver in ORD
monitor_type
string
changed and success
Changed value for the monitor_type of the node.

Sample:
m_of_n
monitors
list
changed and success
Changed list of monitors for the node.

Sample:
['icmp', 'tcp_echo']
quorum
integer
changed and success
Changed value for the quorum of the node.

Sample:
1
session
string
changed and success
Changed value for the internal session of the node.

Sample:
user-disabled
state
string
changed and success
Changed value for the internal state of the node.

Sample:
m_of_n


Status

Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation you can edit this document to improve it.