ADC NITRO APIs

lbmonitor

May 23, 2024

Contributed by:

Configuration for monitor resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
monitorname		Read-write	Name for the monitor. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my monitor” or ‘my monitor’). Minimum length = 1
type		Read-write	Type of monitor that you want to create. Possible values = PING, TCP, HTTP, TCP-ECV, HTTP-ECV, UDP-ECV, DNS, FTP, LDNS-PING, LDNS-TCP, LDNS-DNS, RADIUS, USER, HTTP-INLINE, SIP-UDP, SIP-TCP, LOAD, FTP-EXTENDED, SMTP, SNMP, NNTP, MYSQL, MYSQL-ECV, MSSQL-ECV, ORACLE-ECV, LDAP, POP3, CITRIX-XML-SERVICE, CITRIX-WEB-INTERFACE, DNS-TCP, RTSP, ARP, CITRIX-AG, CITRIX-AAC-LOGINPAGE, CITRIX-AAC-LAS, CITRIX-XD-DDC, ND6, CITRIX-WI-EXTENDED, DIAMETER, RADIUS_ACCOUNTING, STOREFRONT, APPC, SMPP, CITRIX-XNC-ECV, CITRIX-XDM, CITRIX-STA-SERVICE, CITRIX-STA-SERVICE-NHOP, MQTT, HTTP2
action		Read-write	Action to perform when the response to an inline monitor (a monitor of type HTTP-INLINE) indicates that the service is down. A service monitored by an inline monitor is considered DOWN if the response code is not one of the codes that have been specified for the Response Code parameter. Available settings function as follows NONE - Do not take any action. However, the show service command and the show lb monitor command indicate the total number of responses that were checked and the number of consecutive error responses received after the last successful probe. LOG - Log the event in NSLOG or SYSLOG. DOWN - Mark the service as being down, and then do not direct any traffic to the service until the configured down time has expired. Persistent connections to the service are terminated as soon as the service is marked as DOWN. Also, log the event in NSLOG or SYSLOG. Default value: DOWN Possible values = NONE, LOG, DOWN
respcode	<String[]>	Read-write	Response codes for which to mark the service as UP. For any other response code, the action performed depends on the monitor type. HTTP monitors and RADIUS monitors mark the service as DOWN, while HTTP-INLINE monitors perform the action indicated by the Action parameter.
httprequest		Read-write	HTTP request to send to the server (for example, “HEAD /file.html”).
rtsprequest		Read-write	RTSP request to send to the server (for example, “OPTIONS *”).
customheaders		Read-write	Custom header string to include in the monitoring probes.
maxforwards		Read-write	Maximum number of hops that the SIP request used for monitoring can traverse to reach the server. Applicable only to monitors of type SIP-UDP. Default value: 1 Minimum value = 0 Maximum value = 255
sipmethod		Read-write	SIP method to use for the query. Applicable only to monitors of type SIP-UDP. Possible values = OPTIONS, INVITE, REGISTER
sipuri		Read-write	SIP URI string to send to the service (for example, sip:sip.test). Applicable only to monitors of type SIP-UDP. Minimum length = 1
sipreguri		Read-write	SIP user to be registered. Applicable only if the monitor is of type SIP-UDP and the SIP Method parameter is set to REGISTER. Minimum length = 1
send		Read-write	String to send to the service. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.
recv		Read-write	String expected from the server for the service to be marked as UP. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.
query		Read-write	Domain name to resolve as part of monitoring the DNS service (for example, example.com).
querytype		Read-write	Type of DNS record for which to send monitoring queries. Set to Address for querying A records, AAAA for querying AAAA records, and Zone for querying the SOA record. Possible values = Address, Zone, AAAA
scriptname		Read-write	Path and name of the script to execute. The script must be available on the Citrix ADC, in the /nsconfig/monitors/ directory. Minimum length = 1
scriptargs		Read-write	String of arguments for the script. The string is copied verbatim into the request.
secureargs		Read-write	List of arguments for the script which should be secure.
dispatcherip		Read-write	IP address of the dispatcher to which to send the probe.
dispatcherport		Read-write	Port number on which the dispatcher listens for the monitoring probe.
username		Read-write	User name with which to probe the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC or CITRIX-XDM server. Minimum length = 1
password		Read-write	Password that is required for logging on to the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC-ECV or CITRIX-XDM server. Used in conjunction with the user name specified for the User Name parameter. Minimum length = 1
secondarypassword		Read-write	Secondary password that users might have to provide to log on to the Access Gateway server. Applicable to CITRIX-AG monitors.
logonpointname		Read-write	Name of the logon point that is configured for the Citrix Access Gateway Advanced Access Control software. Required if you want to monitor the associated login page or Logon Agent. Applicable to CITRIX-AAC-LAS and CITRIX-AAC-LOGINPAGE monitors.
lasversion		Read-write	Version number of the Citrix Advanced Access Control Logon Agent. Required by the CITRIX-AAC-LAS monitor.
radkey		Read-write	Authentication key (shared secret text string) for RADIUS clients and servers to exchange. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING. Minimum length = 1
radnasid		Read-write	NAS-Identifier to send in the Access-Request packet. Applicable to monitors of type RADIUS. Minimum length = 1
radnasip		Read-write	Network Access Server (NAS) IP address to use as the source IP address when monitoring a RADIUS server. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.
radaccounttype		Read-write	Account Type to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING. Default value: 1 Minimum value = 0 Maximum value = 15
radframedip		Read-write	Source ip with which the packet will go out . Applicable to monitors of type RADIUS_ACCOUNTING.
radapn		Read-write	Called Station Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING. Minimum length = 1
radmsisdn		Read-write	Calling Stations Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING. Minimum length = 1
radaccountsession		Read-write	Account Session ID to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING. Minimum length = 1
lrtm		Read-write	Calculate the least response times for bound services. If this parameter is not enabled, the appliance does not learn the response times of the bound services. Also used for LRTM load balancing. Possible values = ENABLED, DISABLED
deviation		Read-write	Time value added to the learned average response time in dynamic response time monitoring (DRTM). When a deviation is specified, the appliance learns the average response time of bound services and adds the deviation to the average. The final value is then continually adjusted to accommodate response time variations over time. Specified in milliseconds, seconds, or minutes. Minimum value = 0 Maximum value = 20939
units1		Read-write	Unit of measurement for the Deviation parameter. Cannot be changed after the monitor is created. Default value: SEC Possible values = SEC, MSEC, MIN
interval		Read-write	Time interval between two successive probes. Must be greater than the value of Response Time-out. Default value: 5 Minimum value = 1 Maximum value = 20940
units3		Read-write	monitor interval units. Default value: SEC Possible values = SEC, MSEC, MIN
resptimeout		Read-write	Amount of time for which the appliance must wait before it marks a probe as FAILED. Must be less than the value specified for the Interval parameter. Note: For UDP-ECV monitors for which a receive string is not configured, response timeout does not apply. For UDP-ECV monitors with no receive string, probe failure is indicated by an ICMP port unreachable error received from the service. Default value: 2 Minimum value = 1 Maximum value = 20939
units4		Read-write	monitor response timeout units. Default value: SEC Possible values = SEC, MSEC, MIN
resptimeoutthresh		Read-write	Response time threshold, specified as a percentage of the Response Time-out parameter. If the response to a monitor probe has not arrived when the threshold is reached, the appliance generates an SNMP trap called monRespTimeoutAboveThresh. After the response time returns to a value below the threshold, the appliance generates a monRespTimeoutBelowThresh SNMP trap. For the traps to be generated, the “MONITOR-RTO-THRESHOLD” alarm must also be enabled. Minimum value = 0 Maximum value = 100
retries		Read-write	Maximum number of probes to send to establish the state of a service for which a monitoring probe failed. Default value: 3 Minimum value = 1 Maximum value = 127
failureretries		Read-write	Number of retries that must fail, out of the number specified for the Retries parameter, for a service to be marked as DOWN. For example, if the Retries parameter is set to 10 and the Failure Retries parameter is set to 6, out of the ten probes sent, at least six probes must fail if the service is to be marked as DOWN. The default value of 0 means that all the retries must fail if the service is to be marked as DOWN. Minimum value = 0 Maximum value = 32
alertretries		Read-write	Number of consecutive probe failures after which the appliance generates an SNMP trap called monProbeFailed. Minimum value = 0 Maximum value = 32
successretries		Read-write	Number of consecutive successful probes required to transition a service’s state from DOWN to UP. Default value: 1 Minimum value = 1 Maximum value = 32
downtime		Read-write	Time duration for which to wait before probing a service that has been marked as DOWN. Expressed in milliseconds, seconds, or minutes. Default value: 30 Minimum value = 1 Maximum value = 20939
units2		Read-write	Unit of measurement for the Down Time parameter. Cannot be changed after the monitor is created. Default value: SEC Possible values = SEC, MSEC, MIN
destip		Read-write	IP address of the service to which to send probes. If the parameter is set to 0, the IP address of the server to which the monitor is bound is considered the destination IP address.
destport		Read-write	TCP or UDP port to which to send the probe. If the parameter is set to 0, the port number of the service to which the monitor is bound is considered the destination port. For a monitor of type USER, however, the destination port is the port number that is included in the HTTP request sent to the dispatcher. Does not apply to monitors of type PING.
state		Read-write	State of the monitor. The DISABLED setting disables not only the monitor being configured, but all monitors of the same type, until the parameter is set to ENABLED. If the monitor is bound to a service, the state of the monitor is not taken into account when the state of the service is determined. Default value: ENABLED Possible values = ENABLED, DISABLED
reverse		Read-write	Mark a service as DOWN, instead of UP, when probe criteria are satisfied, and as UP instead of DOWN when probe criteria are not satisfied. Default value: NO Possible values = YES, NO
transparent		Read-write	The monitor is bound to a transparent device such as a firewall or router. The state of a transparent device depends on the responsiveness of the services behind it. If a transparent device is being monitored, a destination IP address must be specified. The probe is sent to the specified IP address by using the MAC address of the transparent device. Default value: NO Possible values = YES, NO
iptunnel		Read-write	Send the monitoring probe to the service through an IP tunnel. A destination IP address must be specified. Default value: NO Possible values = YES, NO
tos		Read-write	Probe the service by encoding the destination IP address in the IP TOS (6) bits. Possible values = YES, NO
tosid		Read-write	The TOS ID of the specified destination IP. Applicable only when the TOS parameter is set. Minimum value = 1 Maximum value = 63
secure		Read-write	Use a secure SSL connection when monitoring a service. Applicable only to TCP based monitors. The secure option cannot be used with a CITRIX-AG monitor, because a CITRIX-AG monitor uses a secure connection by default. Default value: NO Possible values = YES, NO
validatecred		Read-write	Validate the credentials of the Xen Desktop DDC server user. Applicable to monitors of type CITRIX-XD-DDC. Default value: NO Possible values = YES, NO
domain		Read-write	Domain in which the XenDesktop Desktop Delivery Controller (DDC) servers or Web Interface servers are present. Required by CITRIX-XD-DDC and CITRIX-WI-EXTENDED monitors for logging on to the DDC servers and Web Interface servers, respectively.
ipaddress	<String[]>	Read-write	Set of IP addresses expected in the monitoring response from the DNS server, if the record type is A or AAAA. Applicable to DNS monitors. Minimum length = 1
group		Read-write	Name of a newsgroup available on the NNTP service that is to be monitored. The appliance periodically generates an NNTP query for the name of the newsgroup and evaluates the response. If the newsgroup is found on the server, the service is marked as UP. If the newsgroup does not exist or if the search fails, the service is marked as DOWN. Applicable to NNTP monitors. Minimum length = 1
filename		Read-write	Name of a file on the FTP server. The appliance monitors the FTP service by periodically checking the existence of the file on the server. Applicable to FTP-EXTENDED monitors. Minimum length = 1
basedn		Read-write	The base distinguished name of the LDAP service, from where the LDAP server can begin the search for the attributes in the monitoring query. Required for LDAP service monitoring. Minimum length = 1
binddn		Read-write	The distinguished name with which an LDAP monitor can perform the Bind operation on the LDAP server. Optional. Applicable to LDAP monitors. Minimum length = 1
filter		Read-write	Filter criteria for the LDAP query. Optional. Minimum length = 1
attribute		Read-write	Attribute to evaluate when the LDAP server responds to the query. Success or failure of the monitoring probe depends on whether the attribute exists in the response. Optional. Minimum length = 1
database		Read-write	Name of the database to connect to during authentication. Minimum length = 1
oraclesid		Read-write	Name of the service identifier that is used to connect to the Oracle database during authentication. Minimum length = 1
sqlquery		Read-write	SQL query for a MYSQL-ECV or MSSQL-ECV monitor. Sent to the database server after the server authenticates the connection. Minimum length = 1
evalrule		Read-write	Expression that evaluates the database server’s response to a MYSQL-ECV or MSSQL-ECV monitoring query. Must produce a Boolean result. The result determines the state of the server. If the expression returns TRUE, the probe succeeds. For example, if you want the appliance to evaluate the error message to determine the state of the server, use the rule MYSQL.RES.ROW(10) .TEXT_ELEM(2).EQ(“MySQL”).
mssqlprotocolversion		Read-write	Version of MSSQL server that is to be monitored. Default value: 70 Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014
Snmpoid		Read-write	SNMP OID for SNMP monitors. Minimum length = 1
snmpcommunity		Read-write	Community name for SNMP monitors. Minimum length = 1
snmpthreshold		Read-write	Threshold for SNMP monitors. Minimum length = 1
snmpversion		Read-write	SNMP version to be used for SNMP monitors. Possible values = V1, V2
metrictable		Read-write	Metric table to which to bind metrics. Minimum length = 1 Maximum length = 99
application		Read-write	Name of the application used to determine the state of the service. Applicable to monitors of type CITRIX-XML-SERVICE. Minimum length = 1
sitepath		Read-write	URL of the logon page. For monitors of type CITRIX-WEB-INTERFACE, to monitor a dynamic page under the site path, terminate the site path with a slash (/). Applicable to CITRIX-WEB-INTERFACE, CITRIX-WI-EXTENDED and CITRIX-XDM monitors. Minimum length = 1
storename		Read-write	Store Name. For monitors of type STOREFRONT, STORENAME is an optional argument defining storefront service store name. Applicable to STOREFRONT monitors. Minimum length = 1
storefrontacctservice		Read-write	Enable/Disable probing for Account Service. Applicable only to Store Front monitors. For multi-tenancy configuration users my skip account service. Default value: YES Possible values = YES, NO
hostname		Read-write	Hostname in the FQDN format (Example: porche.cars.org). Applicable to STOREFRONT monitors. Minimum length = 1
netprofile		Read-write	Name of the network profile. Minimum length = 1 Maximum length = 127
originhost		Read-write	Origin-Host value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. Minimum length = 1
originrealm		Read-write	Origin-Realm value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. Minimum length = 1
hostipaddress		Read-write	Host-IP-Address value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. If Host-IP-Address is not specified, the appliance inserts the mapped IP (MIP) address or subnet IP (SNIP) address from which the CER request (the monitoring probe) is sent. Minimum length = 1
vendorid		Read-write	Vendor-Id value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.
productname		Read-write	Product-Name value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. Minimum length = 1
firmwarerevision		Read-write	Firmware-Revision value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.
authapplicationid	<Double[]>	Read-write	List of Auth-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring CER message. Minimum value = 0 Maximum value = 4294967295
acctapplicationid	<Double[]>	Read-write	List of Acct-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message. Minimum value = 0 Maximum value = 4294967295
inbandsecurityid		Read-write	Inband-Security-Id for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. Possible values = NO_INBAND_SECURITY, TLS
supportedvendorids	<Double[]>	Read-write	List of Supported-Vendor-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum eight of these AVPs are supported in a monitoring message. Minimum value = 1 Maximum value = 4294967295
vendorspecificvendorid		Read-write	Vendor-Id to use in the Vendor-Specific-Application-Id grouped attribute-value pair (AVP) in the monitoring CER message. To specify Auth-Application-Id or Acct-Application-Id in Vendor-Specific-Application-Id, use vendorSpecificAuthApplicationIds or vendorSpecificAcctApplicationIds, respectively. Only one Vendor-Id is supported for all the Vendor-Specific-Application-Id AVPs in a CER monitoring message. Minimum value = 1
vendorspecificauthapplicationids	<Double[]>	Read-write	List of Vendor-Specific-Auth-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message. The specified value is combined with the value of vendorSpecificVendorId to obtain the Vendor-Specific-Application-Id AVP in the CER monitoring message. Minimum value = 0 Maximum value = 4294967295
vendorspecificacctapplicationids	<Double[]>	Read-write	List of Vendor-Specific-Acct-Application-Id attribute value pairs (AVPs) to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message. The specified value is combined with the value of vendorSpecificVendorId to obtain the Vendor-Specific-Application-Id AVP in the CER monitoring message. Minimum value = 0 Maximum value = 4294967295
kcdaccount		Read-write	KCD Account used by MSSQL monitor. Minimum length = 1 Maximum length = 32
storedb		Read-write	Store the database list populated with the responses to monitor probes. Used in database specific load balancing if MSSQL-ECV/MYSQL-ECV monitor is configured. Default value: DISABLED Possible values = ENABLED, DISABLED
storefrontcheckbackendservices		Read-write	This option will enable monitoring of services running on storefront server. Storefront services are monitored by probing to a Windows service that runs on the Storefront server and exposes details of which storefront services are running. Default value: NO Possible values = YES, NO
trofscode		Read-write	Code expected when the server is under maintenance.
trofsstring		Read-write	String expected from the server for the service to be marked as trofs. Applicable to HTTP-ECV/TCP-ECV monitors.
sslprofile		Read-write	SSL Profile associated with the monitor. Minimum length = 1 Maximum length = 127
mqttclientidentifier		Read-write	Client id to be used in Connect command.
mqttversion		Read-write	Version of MQTT protocol used in connect message, default is version 3.1.1 [4]. Default value: 4 Minimum value = 3
grpchealthcheck		Read-write	Option to enable or disable gRPC health check service. Default value: NO Possible values = YES, NO
grpcstatuscode	<Double[]>	Read-write	gRPC status codes for which to mark the service as UP. The default value is 12(health check unimplemented). If the gRPC status code 0 is received from the backend this configuration is ignored.
grpcservicename		Read-write	Option to specify gRPC service name on which gRPC health check need to be performed.
metric		Read-write	Metric name in the metric table, whose setting is changed. A value zero disables the metric and it will not be used for load calculation. Minimum length = 1 Maximum length = 37
metricthreshold		Read-write	Threshold to be used for that metric.
metricweight		Read-write	The weight for the specified service metric with respect to others. Minimum value = 1 Maximum value = 100
servicename		Read-write	The name of the service to which the monitor is bound. Minimum length = 1
servicegroupname		Read-write	The name of the service group to which the monitor is to be bound. Minimum length = 1
lrtmconf		Read-only	State of LRTM configuration on the monitor.
lrtmconfstr		Read-only	State of LRTM configuration on the monitor as STRING. Possible values = ENABLED, DISABLED
dynamicresponsetimeout		Read-only	Response timeout of the DRTM enabled monitor , calculated dynamically based on the history and current response time.
dynamicinterval		Read-only	Interval between monitoring probes for DRTM enabled monitor , calculated dynamically based monitor response time.
multimetrictable	<String[]>	Read-only	Metric table to which to bind metrics, to be used only for output purposes.
dup_state		Read-only	. Default value: ENABLED Possible values = ENABLED, DISABLED
dup_weight		Read-only	. Default value: 1 Minimum value = 1 Maximum value = 100
weight		Read-only	. Minimum value = 1 Maximum value = 100
__count		Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
ENABLE
DISABLE
GET (ALL)
GET
COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbmonitor":{
<b>"monitorname":<String_value>,
</b><b>"type":<String_value>,
</b>"action":<String_value>,
"respcode":<String[]_value>,
"httprequest":<String_value>,
"rtsprequest":<String_value>,
"customheaders":<String_value>,
"maxforwards":<Double_value>,
"sipmethod":<String_value>,
"sipuri":<String_value>,
"sipreguri":<String_value>,
"send":<String_value>,
"recv":<String_value>,
"query":<String_value>,
"querytype":<String_value>,
"scriptname":<String_value>,
"scriptargs":<String_value>,
"secureargs":<String_value>,
"dispatcherip":<String_value>,
"dispatcherport":<Integer_value>,
"username":<String_value>,
"password":<String_value>,
"secondarypassword":<String_value>,
"logonpointname":<String_value>,
"lasversion":<String_value>,
"radkey":<String_value>,
"radnasid":<String_value>,
"radnasip":<String_value>,
"radaccounttype":<Double_value>,
"radframedip":<String_value>,
"radapn":<String_value>,
"radmsisdn":<String_value>,
"radaccountsession":<String_value>,
"lrtm":<String_value>,
"deviation":<Double_value>,
"units1":<String_value>,
"interval":<Integer_value>,
"units3":<String_value>,
"resptimeout":<Integer_value>,
"units4":<String_value>,
"resptimeoutthresh":<Double_value>,
"retries":<Integer_value>,
"failureretries":<Integer_value>,
"alertretries":<Integer_value>,
"successretries":<Integer_value>,
"downtime":<Integer_value>,
"units2":<String_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"state":<String_value>,
"reverse":<String_value>,
"transparent":<String_value>,
"iptunnel":<String_value>,
"tos":<String_value>,
"tosid":<Double_value>,
"secure":<String_value>,
"validatecred":<String_value>,
"domain":<String_value>,
"ipaddress":<String[]_value>,
"group":<String_value>,
"filename":<String_value>,
"basedn":<String_value>,
"binddn":<String_value>,
"filter":<String_value>,
"attribute":<String_value>,
"database":<String_value>,
"oraclesid":<String_value>,
"sqlquery":<String_value>,
"evalrule":<String_value>,
"mssqlprotocolversion":<String_value>,
"Snmpoid":<String_value>,
"snmpcommunity":<String_value>,
"snmpthreshold":<String_value>,
"snmpversion":<String_value>,
"metrictable":<String_value>,
"application":<String_value>,
"sitepath":<String_value>,
"storename":<String_value>,
"storefrontacctservice":<String_value>,
"hostname":<String_value>,
"netprofile":<String_value>,
"originhost":<String_value>,
"originrealm":<String_value>,
"hostipaddress":<String_value>,
"vendorid":<Double_value>,
"productname":<String_value>,
"firmwarerevision":<Double_value>,
"authapplicationid":<Double[]_value>,
"acctapplicationid":<Double[]_value>,
"inbandsecurityid":<String_value>,
"supportedvendorids":<Double[]_value>,
"vendorspecificvendorid":<Double_value>,
"vendorspecificauthapplicationids":<Double[]_value>,
"vendorspecificacctapplicationids":<Double[]_value>,
"kcdaccount":<String_value>,
"storedb":<String_value>,
"storefrontcheckbackendservices":<String_value>,
"trofscode":<Double_value>,
"trofsstring":<String_value>,
"sslprofile":<String_value>,
"mqttclientidentifier":<String_value>,
"mqttversion":<Double_value>,
"grpchealthcheck":<String_value>,
"grpcstatuscode":<Double[]_value>,
"grpcservicename":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor/ monitorname_value<String> Query-parameters: args= type:<String_value>, respcode: <String[]_value>

</b>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbmonitor":{
<b>"monitorname":<String_value>,
</b><b>"type":<String_value>,
</b>"action":<String_value>,
"respcode":<String[]_value>,
"httprequest":<String_value>,
"rtsprequest":<String_value>,
"customheaders":<String_value>,
"maxforwards":<Double_value>,
"sipmethod":<String_value>,
"sipreguri":<String_value>,
"sipuri":<String_value>,
"send":<String_value>,
"recv":<String_value>,
"query":<String_value>,
"querytype":<String_value>,
"username":<String_value>,
"password":<String_value>,
"secondarypassword":<String_value>,
"logonpointname":<String_value>,
"lasversion":<String_value>,
"radkey":<String_value>,
"radnasid":<String_value>,
"radnasip":<String_value>,
"radaccounttype":<Double_value>,
"radframedip":<String_value>,
"radapn":<String_value>,
"radmsisdn":<String_value>,
"radaccountsession":<String_value>,
"lrtm":<String_value>,
"deviation":<Double_value>,
"units1":<String_value>,
"scriptname":<String_value>,
"scriptargs":<String_value>,
"secureargs":<String_value>,
"validatecred":<String_value>,
"domain":<String_value>,
"dispatcherip":<String_value>,
"dispatcherport":<Integer_value>,
"interval":<Integer_value>,
"units3":<String_value>,
"resptimeout":<Integer_value>,
"units4":<String_value>,
"resptimeoutthresh":<Double_value>,
"retries":<Integer_value>,
"failureretries":<Integer_value>,
"alertretries":<Integer_value>,
"successretries":<Integer_value>,
"downtime":<Integer_value>,
"units2":<String_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"state":<String_value>,
"reverse":<String_value>,
"transparent":<String_value>,
"iptunnel":<String_value>,
"tos":<String_value>,
"tosid":<Double_value>,
"secure":<String_value>,
"ipaddress":<String[]_value>,
"group":<String_value>,
"filename":<String_value>,
"basedn":<String_value>,
"binddn":<String_value>,
"filter":<String_value>,
"attribute":<String_value>,
"database":<String_value>,
"oraclesid":<String_value>,
"sqlquery":<String_value>,
"evalrule":<String_value>,
"Snmpoid":<String_value>,
"snmpcommunity":<String_value>,
"snmpthreshold":<String_value>,
"snmpversion":<String_value>,
"metrictable":<String_value>,
"metric":<String_value>,
"metricthreshold":<Double_value>,
"metricweight":<Double_value>,
"application":<String_value>,
"sitepath":<String_value>,
"storename":<String_value>,
"storefrontacctservice":<String_value>,
"storefrontcheckbackendservices":<String_value>,
"hostname":<String_value>,
"netprofile":<String_value>,
"mssqlprotocolversion":<String_value>,
"originhost":<String_value>,
"originrealm":<String_value>,
"hostipaddress":<String_value>,
"vendorid":<Double_value>,
"productname":<String_value>,
"firmwarerevision":<Double_value>,
"authapplicationid":<Double[]_value>,
"acctapplicationid":<Double[]_value>,
"inbandsecurityid":<String_value>,
"supportedvendorids":<Double[]_value>,
"vendorspecificvendorid":<Double_value>,
"vendorspecificauthapplicationids":<Double[]_value>,
"vendorspecificacctapplicationids":<Double[]_value>,
"kcdaccount":<String_value>,
"storedb":<String_value>,
"trofscode":<Double_value>,
"trofsstring":<String_value>,
"sslprofile":<String_value>,
"mqttclientidentifier":<String_value>,
"mqttversion":<Double_value>,
"grpchealthcheck":<String_value>,
"grpcstatuscode":<Double[]_value>,
"grpcservicename":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbmonitor":{
<b>"monitorname":<String_value>,
</b><b>"type":<String_value>,
</b>"ipaddress":true,
"scriptname":true,
"destport":true,
"netprofile":true,
"sslprofile":true,
"action":true,
"respcode":true,
"httprequest":true,
"rtsprequest":true,
"customheaders":true,
"maxforwards":true,
"sipmethod":true,
"sipreguri":true,
"send":true,
"recv":true,
"query":true,
"querytype":true,
"username":true,
"password":true,
"secondarypassword":true,
"logonpointname":true,
"lasversion":true,
"radkey":true,
"radnasid":true,
"radnasip":true,
"radaccounttype":true,
"radframedip":true,
"radapn":true,
"radmsisdn":true,
"radaccountsession":true,
"lrtm":true,
"deviation":true,
"scriptargs":true,
"secureargs":true,
"validatecred":true,
"domain":true,
"dispatcherip":true,
"dispatcherport":true,
"interval":true,
"resptimeout":true,
"resptimeoutthresh":true,
"retries":true,
"failureretries":true,
"alertretries":true,
"successretries":true,
"downtime":true,
"destip":true,
"state":true,
"reverse":true,
"transparent":true,
"iptunnel":true,
"tos":true,
"tosid":true,
"secure":true,
"group":true,
"filename":true,
"basedn":true,
"binddn":true,
"filter":true,
"attribute":true,
"database":true,
"oraclesid":true,
"sqlquery":true,
"Snmpoid":true,
"snmpcommunity":true,
"snmpthreshold":true,
"snmpversion":true,
"metrictable":true,
"mssqlprotocolversion":true,
"originhost":true,
"originrealm":true,
"hostipaddress":true,
"vendorid":true,
"productname":true,
"firmwarerevision":true,
"authapplicationid":true,
"acctapplicationid":true,
"inbandsecurityid":true,
"supportedvendorids":true,
"vendorspecificvendorid":true,
"vendorspecificauthapplicationids":true,
"vendorspecificacctapplicationids":true,
"kcdaccount":true,
"storedb":true,
"trofscode":true,
"trofsstring":true,
"mqttclientidentifier":true,
"mqttversion":true,
"grpchealthcheck":true,
"grpcstatuscode":true,
"grpcservicename":true
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? action=enable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbmonitor":{
"servicename":<String_value>,
"servicegroupname":<String_value>,
"monitorname":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? action=disable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbmonitor":{
"servicename":<String_value>,
"servicegroupname":<String_value>,
"monitorname":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? args=monitorname: <String_value> ,type: <String_value>

Use this query-parameter to get lbmonitor resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of lbmonitor resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? view=summary

Use this query-parameter to get the summary output of lbmonitor resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? pagesize=#no;pageno=#no

Use this query-parameter to get the lbmonitor resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "lbmonitor": [ {
monitorname:<String_value>,type:<String_value>"interval":<Integer_value>,
"units3":<String_value>,
"resptimeout":<Integer_value>,
"resptimeoutthresh":<Double_value>,
"units4":<String_value>,
"retries":<Integer_value>,
"failureretries":<Integer_value>,
"alertretries":<Integer_value>,
"successretries":<Integer_value>,
"downtime":<Integer_value>,
"units2":<String_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"state":<String_value>,
"reverse":<String_value>,
"transparent":<String_value>,
"iptunnel":<String_value>,
"tos":<String_value>,
"tosid":<Double_value>,
"secure":<String_value>,
"action":<String_value>,
"respcode":<String[]_value>,
"httprequest":<String_value>,
"rtsprequest":<String_value>,
"send":<String_value>,
"recv":<String_value>,
"query":<String_value>,
"querytype":<String_value>,
"username":<String_value>,
"password":<String_value>,
"secondarypassword":<String_value>,
"logonpointname":<String_value>,
"lasversion":<String_value>,
"validatecred":<String_value>,
"domain":<String_value>,
"radkey":<String_value>,
"radnasid":<String_value>,
"radnasip":<String_value>,
"radaccounttype":<Double_value>,
"radframedip":<String_value>,
"radapn":<String_value>,
"radmsisdn":<String_value>,
"radaccountsession":<String_value>,
"lrtm":<String_value>,
"lrtmconf":<Integer_value>,
"lrtmconfstr":<String_value>,
"deviation":<Double_value>,
"units1":<String_value>,
"dynamicresponsetimeout":<Integer_value>,
"dynamicinterval":<Integer_value>,
"scriptname":<String_value>,
"scriptargs":<String_value>,
"secureargs":<String_value>,
"dispatcherip":<String_value>,
"dispatcherport":<Integer_value>,
"sipuri":<String_value>,
"sipmethod":<String_value>,
"maxforwards":<Double_value>,
"sipreguri":<String_value>,
"customheaders":<String_value>,
"ipaddress":<String[]_value>,
"group":<String_value>,
"filename":<String_value>,
"basedn":<String_value>,
"binddn":<String_value>,
"filter":<String_value>,
"attribute":<String_value>,
"database":<String_value>,
"oraclesid":<String_value>,
"sqlquery":<String_value>,
"evalrule":<String_value>,
"Snmpoid":<String_value>,
"snmpcommunity":<String_value>,
"snmpthreshold":<String_value>,
"snmpversion":<String_value>,
"metric":<String_value>,
"metrictable":<String_value>,
"multimetrictable":<String[]_value>,
"metricthreshold":<Double_value>,
"metricweight":<Double_value>,
"application":<String_value>,
"sitepath":<String_value>,
"storename":<String_value>,
"storefrontacctservice":<String_value>,
"storefrontcheckbackendservices":<String_value>,
"hostname":<String_value>,
"netprofile":<String_value>,
"mssqlprotocolversion":<String_value>,
"originhost":<String_value>,
"originrealm":<String_value>,
"hostipaddress":<String_value>,
"vendorid":<Double_value>,
"productname":<String_value>,
"firmwarerevision":<Double_value>,
"authapplicationid":<Double[]_value>,
"acctapplicationid":<Double[]_value>,
"inbandsecurityid":<String_value>,
"supportedvendorids":<Double[]_value>,
"vendorspecificvendorid":<Double_value>,
"vendorspecificauthapplicationids":<Double[]_value>,
"vendorspecificacctapplicationids":<Double[]_value>,
"servicename":<String_value>,
"dup_state":<String_value>,
"dup_weight":<Double_value>,
"servicegroupname":<String_value>,
"weight":<Double_value>,
"kcdaccount":<String_value>,
"storedb":<String_value>,
"trofscode":<Double_value>,
"trofsstring":<String_value>,
"sslprofile":<String_value>,
"mqttclientidentifier":<String_value>,
"mqttversion":<Double_value>,
"grpchealthcheck":<String_value>,
"grpcstatuscode":<Double[]_value>,
"grpcservicename":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor/ monitorname_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor/ monitorname_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor/ monitorname_value<String> ? view=summary

Use this query-parameter to get the summary output of lbmonitor resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "lbmonitor": [ {
monitorname:<String_value>,type:<String_value>"interval":<Integer_value>,
"units3":<String_value>,
"resptimeout":<Integer_value>,
"resptimeoutthresh":<Double_value>,
"units4":<String_value>,
"retries":<Integer_value>,
"failureretries":<Integer_value>,
"alertretries":<Integer_value>,
"successretries":<Integer_value>,
"downtime":<Integer_value>,
"units2":<String_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"state":<String_value>,
"reverse":<String_value>,
"transparent":<String_value>,
"iptunnel":<String_value>,
"tos":<String_value>,
"tosid":<Double_value>,
"secure":<String_value>,
"action":<String_value>,
"respcode":<String[]_value>,
"httprequest":<String_value>,
"rtsprequest":<String_value>,
"send":<String_value>,
"recv":<String_value>,
"query":<String_value>,
"querytype":<String_value>,
"username":<String_value>,
"password":<String_value>,
"secondarypassword":<String_value>,
"logonpointname":<String_value>,
"lasversion":<String_value>,
"validatecred":<String_value>,
"domain":<String_value>,
"radkey":<String_value>,
"radnasid":<String_value>,
"radnasip":<String_value>,
"radaccounttype":<Double_value>,
"radframedip":<String_value>,
"radapn":<String_value>,
"radmsisdn":<String_value>,
"radaccountsession":<String_value>,
"lrtm":<String_value>,
"lrtmconf":<Integer_value>,
"lrtmconfstr":<String_value>,
"deviation":<Double_value>,
"units1":<String_value>,
"dynamicresponsetimeout":<Integer_value>,
"dynamicinterval":<Integer_value>,
"scriptname":<String_value>,
"scriptargs":<String_value>,
"secureargs":<String_value>,
"dispatcherip":<String_value>,
"dispatcherport":<Integer_value>,
"sipuri":<String_value>,
"sipmethod":<String_value>,
"maxforwards":<Double_value>,
"sipreguri":<String_value>,
"customheaders":<String_value>,
"ipaddress":<String[]_value>,
"group":<String_value>,
"filename":<String_value>,
"basedn":<String_value>,
"binddn":<String_value>,
"filter":<String_value>,
"attribute":<String_value>,
"database":<String_value>,
"oraclesid":<String_value>,
"sqlquery":<String_value>,
"evalrule":<String_value>,
"Snmpoid":<String_value>,
"snmpcommunity":<String_value>,
"snmpthreshold":<String_value>,
"snmpversion":<String_value>,
"metric":<String_value>,
"metrictable":<String_value>,
"multimetrictable":<String[]_value>,
"metricthreshold":<Double_value>,
"metricweight":<Double_value>,
"application":<String_value>,
"sitepath":<String_value>,
"storename":<String_value>,
"storefrontacctservice":<String_value>,
"storefrontcheckbackendservices":<String_value>,
"hostname":<String_value>,
"netprofile":<String_value>,
"mssqlprotocolversion":<String_value>,
"originhost":<String_value>,
"originrealm":<String_value>,
"hostipaddress":<String_value>,
"vendorid":<Double_value>,
"productname":<String_value>,
"firmwarerevision":<Double_value>,
"authapplicationid":<Double[]_value>,
"acctapplicationid":<Double[]_value>,
"inbandsecurityid":<String_value>,
"supportedvendorids":<Double[]_value>,
"vendorspecificvendorid":<Double_value>,
"vendorspecificauthapplicationids":<Double[]_value>,
"vendorspecificacctapplicationids":<Double[]_value>,
"servicename":<String_value>,
"dup_state":<String_value>,
"dup_weight":<Double_value>,
"servicegroupname":<String_value>,
"weight":<Double_value>,
"kcdaccount":<String_value>,
"storedb":<String_value>,
"trofscode":<Double_value>,
"trofsstring":<String_value>,
"sslprofile":<String_value>,
"mqttclientidentifier":<String_value>,
"mqttversion":<Double_value>,
"grpchealthcheck":<String_value>,
"grpcstatuscode":<Double[]_value>,
"grpcservicename":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbmonitor? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "lbmonitor": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

lbmonitor

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

lbmonitor

Properties

Operations

add

delete

update

unset

enable

disable

get (all)

get

count

In this article