If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

If the method succeeds, message is NULL else message contains Error/Warning message.

List of lbmonitors

Name of the monitor.

Type of monitor that you want to create.

The frequency at which the probe is sent to the service.

monitor interval units

The interval for which the system waits before it marks the probe as FAILED.

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.

monitor response timeout units

Maximum number of probes to send to establish the state of a service for which a monitoring probe failed.

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.

The number of failures after which the system generates a SNMP trap.

Number of consecutive successful probes required to transition a service's state from DOWN to UP.

The duration in seconds for which the system waits to make the next probe once the service is marked as DOWN.

Unit of measurement for the Down Time parameter. Cannot be changed after the monitor is created.

The TCP/UDP port to which the probe is sent.

The state of the monitor.

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.

The state of the monitor for transparent devices.

The state of the monitor for tunneled devices.

TOS setting.

TOS ID

The state of the secure monitoring of services.

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 method and the show lb monitor method 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.

The response codes.

The HTTP request that is sent to the server.

The RTSP request that is sent to the server.

The string that is sent to the service.

The string that is expected from the server to mark the server as UP.

Domain name to resolve as part of monitoring the DNS service (for example, example.com).

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.

Username on the RADIUS/NNTP/FTP/FTP-EXTENDED/MYSQL/POP3/CITRIX-XD-DDC/CITRIX-WI-EXTENDED/CITRIX-XNC-ECV/CITRIX-XDM/MQTT server. This user name is used in the probe.

Password used in RADIUS/NNTP/FTP/FTP-EXTENDED/MYSQL/POP3/LDAP/CITRIX-XD-DDC/CITRIX-WI-EXTENDED/CITRIX-XNC-ECV/CITRIX-XDM/MQTT server monitoring.

Secondary password that users might have to provide to log on to the Access Gateway server. Applicable to CITRIX-AG monitors.

Logonpoint name used in Citrix AAC login page monitoring.

Version number of the Citrix Advanced Access Control Logon Agent. Required by the CITRIX-AAC-LAS monitor.

Validate the credentials of the Xen Desktop DDC server user. Applicable to monitors of type CITRIX-XD-DDC.

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.

Authentication key (shared secret text string) for RADIUS clients and servers to exchange. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.

NAS-Identifier to send in the Access-Request packet. Applicable to monitors of type RADIUS.

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.

Account Type to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Source ip with which the packet will go out . Applicable to monitors of type RADIUS_ACCOUNTING.

Called Station Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Calling Stations Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Account Session ID to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

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.

State of LRTM configuration on the monitor.

State of LRTM configuration on the monitor as STRING.

Deviation from the learnt response time for Dynamic Response Time monitoring.

Unit of measurement for the Deviation parameter. Cannot be changed after the monitor is created.

Response timeout of the DRTM enabled monitor , calculated dynamically based on the history and current response time.

Interval between monitoring probes for DRTM enabled monitor , calculated dynamically based monitor response time.

Path and name of the script to execute. The script must be available on the Citrix ADC, in the /nsconfig/monitors/ directory.

String of arguments for the script. The string is copied verbatim into the request.

List of arguments for the script which should be secure

IP address of the dispatcher to which to send the probe.

Port number on which the dispatcher listens for the monitoring probe.

SIP URI string to send to the service (for example, sip:sip.test). Applicable only to monitors of type SIP-UDP.

Specifies SIP method to be used for the query

Maximum number of hops a sip monitor packet can go.

Specifies SIP user to be registered

The string that is sent to the service. Applicable to HTTP ,HTTP-ECV and RTSP monitor types.

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.

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.

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.

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.

The distinguished name with which an LDAP monitor can perform the Bind operation on the LDAP server. Optional. Applicable to LDAP monitors.

Filter criteria for the LDAP query. Optional.

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.

Name of the database to connect to during authentication.

Name of the service identifier that is used to connect to the Oracle database during authentication.

SQL query for a MYSQL-ECV or MSSQL-ECV monitor. Sent to the database server after the server authenticates the connection.

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").

SNMP OID for SNMP monitors.

Community name for SNMP monitors.

Threshold for SNMP monitors.

SNMP version to be used for SNMP monitoring.

Metric name in the metric table, whose setting is changed

Metric table, whose setting is changed

Metric table to which to bind metrics, to be used only for output purposes.

Threshold to be used for that metric.

The weight for the specified service metric with respect to others.

Name of the application used to determine the state of the service. Applicable to monitors of type CITRIX-XML-SERVICE.

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.

Store Name. For monitors of type STOREFRONT, STORENAME is an optional argument defining storefront service store name. Applicable to STOREFRONT monitors.

Enable/Disable probing for Account Service. Applicable only to Store Front monitors. For multi-tenancy configuration users my skip account service

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.

Hostname in the FQDN format (Example: porche.cars.org). Applicable to STOREFRONT monitors.
NOTE: This attribute is deprecated.

Giving the unit of the metric

Name of the network profile.

Version of MSSQL server that is to be monitored.

Origin-Host value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Origin-Realm value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

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.

Vendor-Id value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Product-Name value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Firmware-Revision value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

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.

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.

Inband-Security-Id for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

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.

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.

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.

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.

KCD Account used by MSSQL monitor

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.

Code expected when the server is under maintenance

String expected from the server for the service to be marked as trofs. Applicable to HTTP-ECV/TCP-ECV monitors.

SSL Profile associated with the monitor

The name of the certificate bound to the monitor.

The rule for use of CRL corresponding to this CA certificate during client authentication. If crlCheck is set to Mandatory, the system will deny all SSL clients if the CRL is missing, expired - NextUpdate date is in the past, or is incomplete with remote CRL refresh enabled. If crlCheck is set to optional, the system will allow SSL clients in the above error cases.However, in any case if the client certificate is revoked in the CRL, the SSL client will be denied access.

The state of the CRL check parameter. (Mandatory/Optional)

The state of the OCSP check parameter. (Mandatory/Optional)

Client id to be used in Connect method

Version of MQTT protocol used in connect message, default is version 3.1.1 [4]

Option to enable or disable gRPC health check service.

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.

Option to specify gRPC service name on which gRPC health check need to be performed