Invoke-ADCAddLbmonitor

SYNOPSIS

Add Load Balancing configuration Object.

SYNTAX

Invoke-ADCAddLbmonitor [-Monitorname] <String> [-Type] <String> [[-Action] <String>] [[-Respcode] <String[]>]
 [[-Httprequest] <String>] [[-Rtsprequest] <String>] [[-Customheaders] <String>] [[-Maxforwards] <Double>]
 [[-Sipmethod] <String>] [[-Sipuri] <String>] [[-Sipreguri] <String>] [[-Send] <String>] [[-Recv] <String>]
 [[-Query] <String>] [[-Querytype] <String>] [[-Scriptname] <String>] [[-Scriptargs] <String>]
 [[-Secureargs] <String>] [[-Dispatcherip] <String>] [[-Dispatcherport] <Int32>] [[-Username] <String>]
 [[-Password] <String>] [[-Secondarypassword] <String>] [[-Logonpointname] <String>] [[-Lasversion] <String>]
 [[-Radkey] <String>] [[-Radnasid] <String>] [[-Radnasip] <String>] [[-Radaccounttype] <Double>]
 [[-Radframedip] <String>] [[-Radapn] <String>] [[-Radmsisdn] <String>] [[-Radaccountsession] <String>]
 [[-Lrtm] <String>] [[-Deviation] <Double>] [[-Units1] <String>] [[-Interval] <Int32>] [[-Units3] <String>]
 [[-Resptimeout] <Int32>] [[-Units4] <String>] [[-Resptimeoutthresh] <Double>] [[-Retries] <Int32>]
 [[-Failureretries] <Int32>] [[-Alertretries] <Int32>] [[-Successretries] <Int32>] [[-Downtime] <Int32>]
 [[-Units2] <String>] [[-Destip] <String>] [[-Destport] <Int32>] [[-State] <String>] [[-Reverse] <String>]
 [[-Transparent] <String>] [[-Iptunnel] <String>] [[-Tos] <String>] [[-Tosid] <Double>] [[-Secure] <String>]
 [[-Validatecred] <String>] [[-Domain] <String>] [[-Ipaddress] <String[]>] [[-Group] <String>]
 [[-Filename] <String>] [[-Basedn] <String>] [[-Binddn] <String>] [[-Filter] <String>] [[-Attribute] <String>]
 [[-Database] <String>] [[-Oraclesid] <String>] [[-Sqlquery] <String>] [[-Evalrule] <String>]
 [[-Mssqlprotocolversion] <String>] [[-Snmpoid] <String>] [[-Snmpcommunity] <String>]
 [[-Snmpthreshold] <String>] [[-Snmpversion] <String>] [[-Metrictable] <String>] [[-Application] <String>]
 [[-Sitepath] <String>] [[-Storename] <String>] [[-Storefrontacctservice] <String>] [[-Hostname] <String>]
 [[-Netprofile] <String>] [[-Originhost] <String>] [[-Originrealm] <String>] [[-Hostipaddress] <String>]
 [[-Vendorid] <Double>] [[-Productname] <String>] [[-Firmwarerevision] <Double>]
 [[-Authapplicationid] <Double[]>] [[-Acctapplicationid] <Double[]>] [[-Inbandsecurityid] <String>]
 [[-Supportedvendorids] <Double[]>] [[-Vendorspecificvendorid] <Double>]
 [[-Vendorspecificauthapplicationids] <Double[]>] [[-Vendorspecificacctapplicationids] <Double[]>]
 [[-Kcdaccount] <String>] [[-Storedb] <String>] [[-Storefrontcheckbackendservices] <String>]
 [[-Trofscode] <Double>] [[-Trofsstring] <String>] [[-Sslprofile] <String>] [[-Mqttclientidentifier] <String>]
 [[-Mqttversion] <Double>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for monitor resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddLbmonitor -monitorname <string> -type <string>

An example how to add lbmonitor configuration Object(s).

PARAMETERS

-Monitorname

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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, 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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: DOWN
Accept pipeline input: False
Accept wildcard characters: False

-Respcode

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.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Httprequest

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Rtsprequest

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Customheaders

Custom header string to include in the monitoring probes.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Maxforwards

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.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Sipmethod

SIP method to use for the query. Applicable only to monitors of type SIP-UDP. Possible values = OPTIONS, INVITE, REGISTER

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sipuri

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sipreguri

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Send

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Recv

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Query

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Querytype

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Scriptname

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Scriptargs

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Secureargs

List of arguments for the script which should be secure.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Dispatcherip

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Dispatcherport

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Username

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Secondarypassword

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Logonpointname

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lasversion

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radkey

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radnasid

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radnasip

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radaccounttype

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Radframedip

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radapn

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radmsisdn

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Radaccountsession

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lrtm

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Units1

Unit of measurement for the Deviation parameter. Cannot be changed after the monitor is created. Possible values = SEC, MSEC, MIN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: SEC
Accept pipeline input: False
Accept wildcard characters: False

-Interval

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 38
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False

-Units3

monitor interval units. Possible values = SEC, MSEC, MIN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 39
Default value: SEC
Accept pipeline input: False
Accept wildcard characters: False

-Resptimeout

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.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 40
Default value: 2
Accept pipeline input: False
Accept wildcard characters: False

-Units4

monitor response timeout units. Possible values = SEC, MSEC, MIN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 41
Default value: SEC
Accept pipeline input: False
Accept wildcard characters: False

-Resptimeoutthresh

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.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 42
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Retries

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 43
Default value: 3
Accept pipeline input: False
Accept wildcard characters: False

-Failureretries

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.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 44
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Alertretries

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 45
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Successretries

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 46
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Downtime

Time duration for which to wait before probing a service that has been marked as DOWN. Expressed in milliseconds, seconds, or minutes.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 47
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False

-Units2

Unit of measurement for the Down Time parameter. Cannot be changed after the monitor is created. Possible values = SEC, MSEC, MIN

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 48
Default value: SEC
Accept pipeline input: False
Accept wildcard characters: False

-Destip

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 49
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Destport

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.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 50
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-State

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. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 51
Default value: ENABLED
Accept pipeline input: False
Accept wildcard characters: False

-Reverse

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. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 52
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-Transparent

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. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 53
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-Iptunnel

Send the monitoring probe to the service through an IP tunnel. A destination IP address must be specified. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 54
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-Tos

Probe the service by encoding the destination IP address in the IP TOS (6) bits. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 55
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tosid

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 56
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Secure

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. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 57
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-Validatecred

Validate the credentials of the Xen Desktop DDC server user. Applicable to monitors of type CITRIX-XD-DDC. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 58
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 59
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ipaddress

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.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 60
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Group

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 61
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filename

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 62
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Basedn

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 63
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Binddn

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 64
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Filter criteria for the LDAP query. Optional.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 65
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 66
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Database

Name of the database to connect to during authentication.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 67
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Oraclesid

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 68
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sqlquery

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 69
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Evalrule

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 70
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mssqlprotocolversion

Version of MSSQL server that is to be monitored. Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 71
Default value: 70
Accept pipeline input: False
Accept wildcard characters: False

-Snmpoid

SNMP OID for SNMP monitors.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 72
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Snmpcommunity

Community name for SNMP monitors.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 73
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Snmpthreshold

Threshold for SNMP monitors.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 74
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Snmpversion

SNMP version to be used for SNMP monitors. Possible values = V1, V2

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 75
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Metrictable

Metric table to which to bind metrics.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 76
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Application

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 77
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sitepath

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 78
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Storename

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 79
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Storefrontacctservice

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 80
Default value: YES
Accept pipeline input: False
Accept wildcard characters: False

-Hostname

Hostname in the FQDN format (Example: porche.cars.org). Applicable to STOREFRONT monitors.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 81
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Netprofile

Name of the network profile.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 82
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Originhost

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 83
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Originrealm

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 84
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hostipaddress

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 85
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vendorid

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 86
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Productname

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 87
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Firmwarerevision

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 88
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Authapplicationid

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.

Type: Double[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 89
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Acctapplicationid

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.

Type: Double[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 90
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Inbandsecurityid

Inband-Security-Id for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. Possible values = NO_INBAND_SECURITY, TLS

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 91
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Supportedvendorids

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.

Type: Double[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 92
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vendorspecificvendorid

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.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 93
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Vendorspecificauthapplicationids

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.

Type: Double[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 94
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vendorspecificacctapplicationids

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.

Type: Double[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 95
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Kcdaccount

KCD Account used by MSSQL monitor.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 96
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Storedb

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 97
Default value: DISABLED
Accept pipeline input: False
Accept wildcard characters: False

-Storefrontcheckbackendservices

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. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 98
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-Trofscode

Code expected when the server is under maintenance.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 99
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Trofsstring

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 100
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sslprofile

SSL Profile associated with the monitor.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 101
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mqttclientidentifier

Client id to be used in Connect command.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 102
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mqttversion

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

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 103
Default value: 4
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created lbmonitor item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCAddLbmonitor Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/lb/lbmonitor/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.