APIRef_tm_ltm_monitor_module-score¶

mgmt/tm/ltm/monitor/module-score

Module score monitor configuration.

REST Endpoints

Collection URI: /mgmt/tm/ltm/monitor/module-score
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/ltm/monitor/module-score/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, partition, subPath

Properties

Name	Type	Required	Access	Description
`appService`	string	optional	read/write	The application service to which the object belongs.
`debug`	string	optional	read/write	Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. You can use the log information to help diagnose and troubleshoot unsuccessful health checks. The default value is no.
`defaultsFrom`	string	optional	read/write	Specifies the name of the monitor from which you want the custom monitor to inherit settings. The default value is module_score.
`description`	string	optional	read/write	User defined description.
`destination`	string	optional	read/write
`interval`	integer	optional	read/write	Specifies the frequency at which the system issues the monitor check. The default value is 10 seconds.
`tmPartition`	string	optional	read/write	Displays the administrative partition within which the monitor resides.
`pool`	string	optional	read/write	Specifies a Local Traffic Manager pool name. Use this option if you want the system to set dynamic ratios on a pool member instead of on the associated node for the pool member. The default value is none.
`snmpCommunity`	string	optional	read/write	Specifies the identifier for the SNMP community. The default value is public.
`snmpIpAddress`	string	required	read/write	Specifies the IP address of the SNMP server. The default value is none.
`snmpPort`	integer	optional	read/write	Specifies the port associated with the SNMP server. The default value is 161.
`snmpVersion`	string	optional	read/write	Specifies the SNMP version in use by the system. The default value is v2c.
`timeUntilUp`	integer	optional	read/write	Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. The default setting is 0.
`timeout`	integer	optional	read/write	Specifies the number of seconds the target has in which to respond to the monitor request. The default value 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. Also, if the target responds with a RESET packet, the system immediately flags the target as down without waiting for the timeout interval to expire.
`upInterval`	integer	optional	read/write	Specifies how often in seconds that the system issues the monitor check when the node is up. The default value is the same as the (down) interval.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.