Documentation

bigip_gtm_monitor_firepass - Manages F5 BIG-IP GTM FirePass monitors

New in version 2.6.

Synopsis

  • Manages F5 BIG-IP GTM FirePass monitors.

Requirements

The below requirements are needed on the host that executes this module.

  • f5-sdk >= 3.0.9

Parameters

Parameter Choices/Defaults Comments
cipher_list
Specifies the list of ciphers for this monitor.
The items in the cipher list are separated with the colon : symbol.
When creating a new monitor, if this parameter is not specified, the default list is HIGH:!ADH.
concurrency_limit
Specifies the maximum percentage of licensed connections currently in use under which the monitor marks the Secure Access Manager system up.
As an example, a setting of 95 percent means that the monitor marks the Secure Access Manager system up until 95 percent of licensed connections are in use.
When the number of in-use licensed connections exceeds 95 percent, the monitor marks the Secure Access Manager system down.
When creating a new monitor, if this parameter is not specified, the default is 95.
ignore_down_response
    Choices:
  • no
  • yes
Specifies that the monitor allows more than one probe attempt per interval.
When yes, specifies that the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down.
When no, specifies that the monitor immediately marks an object down when it receives a down response.
When creating a new monitor, if this parameter is not provided, then the default value will be no.
interval
The interval specifying how frequently the monitor instance of this template will run.
If this parameter is not provided when creating a new monitor, then the default value will be 30.
This value must be less than the timeout value.
ip
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'.
If this value is an IP address, then a port number must be specified.
max_load_average
Specifies the number that the monitor uses to mark the Secure Access Manager system up or down.
The system compares the Max Load Average setting against a one-minute average of the Secure Access Manager system load.
When the Secure Access Manager system-load average falls within the specified Max Load Average, the monitor marks the Secure Access Manager system up.
When the average exceeds the setting, the monitor marks the system down.
When creating a new monitor, if this parameter is not specified, the default is 12.
name
required
Monitor name.
parent Default:
/Common/firepass_gtm
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the tcp parent on the Common partition.
partition Default:
Common
Device partition to manage resources on.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
port
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '*'. Note that if specifying an IP address, a value between 1 and 65535 must be specified.
probe_timeout
Specifies the number of seconds after which the system times out the probe request to the system.
When creating a new monitor, if this parameter is not provided, then the default value will be 5.
provider
(added in 2.5)
A dict object containing connection details.
ssh_keyfile
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout 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.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
user
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
server_port Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
password
required
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.

aliases: pass, pwd
validate_certs
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.
transport
required
    Choices:
  • rest
  • cli ←
Configures the transport connection to use when connecting to the remote device.
server
required
The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
 Default:
443
The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set.
state
    Choices:
  • present ←
  • absent
When present, ensures that the monitor exists.
When absent, ensures the monitor is removed.
target_password
Specifies the password, if the monitored target requires authentication.
target_username
Specifies the user name, if the monitored target requires authentication.
timeout
The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second.
If this parameter is not provided when creating a new monitor, then the default value will be 90.
update_password
    Choices:
  • always ←
  • on_create
always will update passwords if the target_password is specified.
on_create will only set the password for newly created monitors.
user
required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set.

Notes

Note

Examples

- name: Create a GTM FirePass monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Remove FirePass Monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
  delegate_to: localhost

- name: Add FirePass monitor for all addresses, port 514
  bigip_gtm_monitor_firepass:
    name: my_monitor
    server: lb.mydomain.com
    user: admin
    port: 514
    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
cipher_list
string
 changed
The new value for the cipher list.

Sample:
+3DES:+kEDH
concurrency_limit
int
 changed
The new value for the concurrency limit.

Sample:
95
ignore_down_response
bool
 changed
Whether to ignore the down response or not.

Sample:
True
interval
int
 changed
The new interval in which to run the monitor check.

Sample:
2
ip
string
 changed
The new IP of IP/port definition.

Sample:
10.12.13.14
max_load_average
int
 changed
The new value for the max load average.

Sample:
12
parent
string
 changed
New parent template of the monitor.

Sample:
firepass_gtm
port
string
 changed
The new port the monitor checks the resource on.

Sample:
8080
probe_timeout
int
 changed
The new timeout in which the system will timeout the monitor probe.

Sample:
10
timeout
int
 changed
The new timeout in which the remote system must respond to the monitor.

Sample:
10


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Tim Rupp (@caphrim007)

Hint

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