Documentation

bigip_monitor_snmp_dca - Manages BIG-IP SNMP data collecting agent (DCA) monitors

New in version 2.5.

Synopsis

  • The BIG-IP has an SNMP data collecting agent (DCA) that can query remote SNMP agents of various types, including the UC Davis agent (UCD) and the Windows 2000 Server agent (WIN2000).

Requirements

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

  • f5-sdk >= 3.0.16

Parameters

Parameter Choices/Defaults Comments
agent_type
    Choices:
  • UCD
  • WIN2000
  • GENERIC
Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is UCD (UC-Davis).
community
Specifies the community name that the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is public. Note that this value is case sensitive.
cpu_coefficient
Specifies the coefficient that the system uses to calculate the weight of the CPU threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is 1.5.
cpu_threshold
Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is 80 percent.
description
Specifies descriptive text that identifies the monitor.
disk_coefficient
Specifies the coefficient that the system uses to calculate the weight of the disk threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is 2.0.
disk_threshold
Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is 90 percent.
interval
Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, the default is 10.
memory_coefficient
Specifies the coefficient that the system uses to calculate the weight of the memory threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is 1.0.
memory_threshold
Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is 70 percent.
name
required
Monitor name.
parent Default:
/Common/snmp_dca
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the snmp_dca 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 may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
provider
(added in 2.5)
Default:
None
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.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
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 may omit this option by setting the environment variable F5_SERVER.
user
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.
server_port Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
password
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
validate_certs
bool
    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.
transport
required
    Choices:
  • rest
  • cli ←
Configures the transport connection to use when connecting to the remote device.
server
required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
(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
(added in 2.5)
    Choices:
  • present ←
  • absent
When present, ensures that the monitor exists.
When absent, ensures the monitor is removed.
time_until_up
Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. When creating a new monitor, the default is 0.
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is 30 seconds. 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'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that timeout and time_until_up combine to control when a resource is set to up.
user
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
bool

(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.
version
    Choices:
  • v1
  • v2c
Specifies the version of SNMP that the host server uses. When creating a new monitor, the default is v1. When v1, specifies that the host server uses SNMP version 1. When v2c, specifies that the host server uses SNMP version 2c.

Notes

Note

  • Requires BIG-IP software version >= 12
  • This module does not support the variables option because this option is broken in the REST API and does not function correctly in tmsh; for example you cannot remove user-defined params. Therefore, there is no way to automatically configure it.
  • For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • 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 SNMP DCS monitor
  bigip_monitor_snmp_dca:
    state: present
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_monitor
  delegate_to: localhost

- name: Remove TCP Echo Monitor
  bigip_monitor_snmp_dca:
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_monitor
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
agent_type
string
changed
The new agent type to be used by the monitor.

Sample:
UCD
community
string
changed
The new community for the monitor.

Sample:
foobar
cpu_coefficient
float
changed
The new CPU coefficient.

Sample:
2.4
cpu_threshold
int
changed
The new CPU threshold.

Sample:
85
description
str
changed
The description of the monitor.

Sample:
Important Monitor
disk_coefficient
float
changed
The new disk coefficient.

Sample:
10.2
disk_threshold
int
changed
The new disk threshold.

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

Sample:
2
memory_coefficient
float
changed
The new memory coefficient.

Sample:
6.4
memory_threshold
int
changed
The new memory threshold.

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

Sample:
snmp_dca
time_until_up
int
changed
The new time in which to mark a system as up after first successful response.

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

Sample:
10
version
string
changed
The new new SNMP version to be used by the monitor.

Sample:
v2c


Status

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

Maintenance

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author

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

Hint

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