Resource Type: netscaler_lbmonitor

Defined in:

lib/puppet/type/netscaler_lbmonitor.rb

Providers:

rest

Overview

Manage service on the NetScaler appliance. If the service is domain based, before you create the service, create the server entry by using the add server command. Then, in this command, specify the Server parameter.

Properties

• account_application_ids

  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.

  Maximum value: 4294967295

• account_session_id

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

• account_type

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

  Default value: 1

  Maximum value: 15

• action

  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.

  Possible values: NONE, LOG, DOWN

  Default value: SM_DOWN

• application_name

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

• attribute

  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.

• authentication_application_ids

  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.

  Maximum value: 4294967295

• base_dn

  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.

• bind_dn

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

• called_station_id

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

• calling_station_id

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

• check_backend_services
• custom_header

  Custom header string to include in the monitoring probes.

• database

  Name of the database to connect to during authentication.

• destination_ip

  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.

• destination_port

  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.

• deviation

  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.

  Maximum value: 20939000

• dispatcher_ip

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

• dispatcher_port

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

• domain

  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.

• down_time

  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: 20939000

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• expression

  Default syntax 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”).

• failure_retries

  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.

  Maximum value: 32

• file_name

  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.

• filter

  Filter criteria for the LDAP query. Optional.

• firmware_revision

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

• framed_ip

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

• group_name

  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.

• host_ip

  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.

• http_request

  HTTP request to send to the server (for example, “HEAD /file.html”).

• inband_security_id

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

  Possible values: NO_INBAND_SECURITY, TLS

• interval

  Time interval between two successive probes. Must be greater than the value of Response Time-out.

  Default value: 5

  Minimum value: 1

  Maximum value: 20940000

• ip_address

  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.

• ip_tunnel
• kcd_account

  KCD Account used by MSSQL monitor

• logon_agent_service_version

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

• logon_point_name

  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.

• lrtm
• max_forwards

  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

  Maximum value: 255

• metric_table

  Metric table to which to bind metrics.

• nas_id

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

• nas_ip

  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.

• net_profile

  Name of the network profile.

• origin_host

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

• origin_realm

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

• password

  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.

• product_name

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

• protocol_version

  Version of MSSQL server that is to be monitored.

  Possible values: 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012

  Default value: TDS_PROT_70

• query

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

• query_type

  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

• radius_key

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

• receive_string

  String expected from the server for the service to be marked as UP. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

• resp_timeout_threshold

  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.

  Maximum value: 100

• response_codes

  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.

• response_timeout

  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: 20939000

• retries

  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

• reverse
• rtsp_request

  RTSP request to send to the server (for example, “OPTIONS *”).

• script_arguments

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

• script_name

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

• secondary_password

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

• secure
• send_string

  String to send to the service. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

• sid

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

• sip_method

  SIP method to use for the query. Applicable only to monitors of type SIP-UDP.

  Possible values: OPTIONS, INVITE, REGISTER

• sip_reg_uri

  SIP user to be registered. Applicable only if the monitor is of type SIP-UDP and the SIP Method parameter is set to REGISTER.

• sip_uri

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

• site_path

  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.

• snmp_alert_retries

  Number of consecutive probe failures after which the appliance generates an SNMP trap called monProbeFailed.

  Maximum value: 32

• snmp_community

  Community name for SNMP monitors.

• snmp_oid

  SNMP OID for SNMP monitors.

• snmp_threshold

  Threshold for SNMP monitors.

• snmp_version

  SNMP version to be used for SNMP monitors.

  Possible values: V1, V2

• sql_query

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

• state
• store_db

  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.

  Possible values: ENABLED, DISABLED

• store_name

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

• storefront_account_service

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

  Possible values: YES, NO

  Default value: YES

• success_retries

  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

• supported_vendor_ids

  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

• tos
• tos_id

  The TOS ID of the specified destination IP. Applicable only when the TOS parameter is set.

  Minimum value: 1

  Maximum value: 63

• transparent
• type

  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, 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, CITRIX-XNC-ECV, CITRIX-XDM

• user_name

  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.

• validate_credentials
• vendor_id

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

• vendor_specific_vendor_id

  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

Parameters

• name (namevar)
• provider

  The specific backend to use for this ‘netscaler_lbmonitor` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.