Try SpotterManages BIG-IP SNMP data collecting agent (DCA) monitors
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0The 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).
- 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
name:
description:
- Monitor name.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the monitor exists.
- When C(absent), ensures the monitor is removed.
type: str
parent:
default: /Common/snmp_dca
description:
- The parent template of this monitor template. Once this value has been set, it cannot
be changed. By default, this value is the C(snmp_dca) parent on the C(Common) partition.
type: str
timeout:
description:
- Specifies the number of seconds the target has in which to respond to the monitor
request. When creating a new monitor, the default is C(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
C(timeout) and C(time_until_up) combine to control when a resource is set to up.
type: int
version:
choices:
- v1
- v2c
description:
- Specifies the version of SNMP the host server uses. When creating a new monitor,
the default is C(v1). When C(v1), specifies the host server uses SNMP version 1.
When C(v2c), specifies that the host server uses SNMP version 2c.
type: str
interval:
description:
- 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 C(10).
type: int
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
community:
description:
- 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 C(public). This
value is case sensitive.
type: str
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
agent_type:
choices:
- UCD
- WIN2000
- GENERIC
description:
- Specifies the SNMP agent running on the monitored server. When creating a new monitor,
the default is C(UCD) (UC-Davis).
type: str
description:
description:
- Specifies descriptive text that identifies the monitor.
type: str
cpu_threshold:
description:
- Specifies the maximum acceptable CPU usage on the target server. When creating a
new monitor, the default is C(80) percent.
type: int
time_until_up:
description:
- 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 C(0).
type: int
disk_threshold:
description:
- Specifies the maximum acceptable disk usage on the target server. When creating
a new monitor, the default is C(90) percent.
type: int
cpu_coefficient:
description:
- 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 C(1.5).
type: str
disk_coefficient:
description:
- 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 C(2.0).
type: str
memory_threshold:
description:
- Specifies the maximum acceptable memory usage on the target server. When creating
a new monitor, the default is C(70) percent.
type: int
memory_coefficient:
description:
- 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 C(1.0).
type: str
agent_type:
description: The new agent type to be used by the monitor.
returned: changed
sample: UCD
type: str
community:
description: The new community for the monitor.
returned: changed
sample: foobar
type: str
cpu_coefficient:
description: The new CPU coefficient.
returned: changed
sample: 2.4
type: float
cpu_threshold:
description: The new CPU threshold.
returned: changed
sample: 85
type: int
description:
description: The description of the monitor.
returned: changed
sample: Important Monitor
type: str
disk_coefficient:
description: The new disk coefficient.
returned: changed
sample: 10.2
type: float
disk_threshold:
description: The new disk threshold.
returned: changed
sample: 34
type: int
interval:
description: The new interval at which to run the monitor check.
returned: changed
sample: 2
type: int
memory_coefficient:
description: The new memory coefficient.
returned: changed
sample: 6.4
type: float
memory_threshold:
description: The new memory threshold.
returned: changed
sample: 50
type: int
parent:
description: New parent template of the monitor.
returned: changed
sample: snmp_dca
type: str
time_until_up:
description: The new time in which to mark a system as up after first successful
response.
returned: changed
sample: 2
type: int
timeout:
description: The new timeout in which the remote system must respond to the monitor.
returned: changed
sample: 10
type: int
version:
description: The new new SNMP version to be used by the monitor.
returned: changed
sample: v2c
type: str