bigip_gtm_monitor_firepass – Manages F5 BIG-IP GTM FirePass monitors — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_gtm_monitor_firepass – Manages F5 BIG-IP GTM FirePass monitors

New in version 2.6.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages F5 BIG-IP GTM FirePass monitors.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
cipher_list string |  | 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 integer |  | 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 boolean | 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 integer |  | 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 string |  | 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 integer |  | 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 string / required |  | Monitor name.
parent string | 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 string | Default: "Common" | Device partition to manage resources on.
port string |  | 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 integer |  | 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 dictionary added in 2.5 |  | A dict object containing connection details.
| auth_provider string |  | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
| 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 |  | 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`.
state string | Choices: present ← absent | When `present`, ensures that the monitor exists. When `absent`, ensures the monitor is removed.
target_password string |  | Specifies the password, if the monitored target requires authentication.
target_username string |  | Specifies the user name, if the monitored target requires authentication.
timeout integer |  | 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 string | 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.

## 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: Create a GTM FirePass monitor
      bigip_gtm_monitor_firepass:
        name: my_monitor
        ip: 1.1.1.1
        port: 80
        state: present
        provider:
          user: admin
          password: secret
          server: lb.mydomain.com
      delegate_to: localhost

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

    - name: Add FirePass monitor for all addresses, port 514
      bigip_gtm_monitor_firepass:
        name: my_monitor
        port: 514
        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 | Returned | Description
--- | --- | ---
cipher_list string | changed | The new value for the cipher list. Sample: +3DES:+kEDH
concurrency_limit integer | changed | The new value for the concurrency limit. Sample: 95
ignore_down_response boolean | changed | Whether to ignore the down response or not. Sample: True
interval integer | 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 integer | 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 integer | changed | The new timeout in which the system will timeout the monitor probe. Sample: 10
timeout integer | changed | The new timeout in which the remote system must respond to the monitor. Sample: 10

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

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

Hint

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