Parameter |
Choices/Defaults |
Comments |
agent_type
string
|
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
string
|
|
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 public . This value is case sensitive.
|
cpu_coefficient
string
|
|
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 1.5 .
|
cpu_threshold
integer
|
|
Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is 80 percent.
|
description
string
|
|
Specifies descriptive text that identifies the monitor.
|
disk_coefficient
string
|
|
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 2.0 .
|
disk_threshold
integer
|
|
Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is 90 percent.
|
interval
integer
|
|
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 10 .
|
memory_coefficient
string
|
|
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 1.0 .
|
memory_threshold
integer
|
|
Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is 70 percent.
|
name
string
/ required
|
|
Monitor name.
|
parent
string
|
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
string
|
Default:
"Common"
|
Device partition to manage resources on.
|
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
|
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.
|
|
no_f5_teem
boolean
|
|
If yes , TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM .
|
|
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 .
|
|
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
|
|
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
|
|
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 the monitor exists.
When absent , ensures the monitor is removed.
|
time_until_up
integer
|
|
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
integer
|
|
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.
|
version
string
|
|
Specifies the version of SNMP the host server uses. When creating a new monitor, the default is v1 . When v1 , specifies the host server uses SNMP version 1. When v2c , specifies that the host server uses SNMP version 2c.
|