f5networks.f5_modules.bigip_monitor_snmp_dca module – Manages BIG-IP SNMP data collecting agent (DCA) monitors
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_monitor_snmp_dca
.
New in f5networks.f5_modules 1.0.0
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).
Parameters
Parameter |
Comments |
---|---|
Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is Choices:
|
|
Specifies the community name the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is |
|
Specifies the coefficient 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 |
|
Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is |
|
Specifies descriptive text that identifies the monitor. |
|
Specifies the coefficient 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 |
|
Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is |
|
Specifies the frequency, in seconds, 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 |
|
Specifies the coefficient 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 |
|
Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is |
|
Monitor name. |
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the Default: |
|
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:
|
|
When When Choices:
|
|
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 |
|
Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is |
|
Specifies the version of SNMP the host server uses. When creating a new monitor, the default is Choices:
|
Notes
Note
Requires BIG-IP software version >= 12
This module does not support the
variables
option because it is broken in the REST API and does not function correctly intmsh
; 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 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: Create SNMP DCS monitor
bigip_monitor_snmp_dca:
name: my_monitor
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove TCP Echo Monitor
bigip_monitor_snmp_dca:
name: my_monitor
state: absent
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 |
---|---|
The new agent type to be used by the monitor. Returned: changed Sample: |
|
The new community for the monitor. Returned: changed Sample: |
|
The new CPU coefficient. Returned: changed Sample: |
|
The new CPU threshold. Returned: changed Sample: |
|
The description of the monitor. Returned: changed Sample: |
|
The new disk coefficient. Returned: changed Sample: |
|
The new disk threshold. Returned: changed Sample: |
|
The new interval at which to run the monitor check. Returned: changed Sample: |
|
The new memory coefficient. Returned: changed Sample: |
|
The new memory threshold. Returned: changed Sample: |
|
New parent template of the monitor. Returned: changed Sample: |
|
The new time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |
|
The new new SNMP version to be used by the monitor. Returned: changed Sample: |