< Back
New-NSmonitor
Post
NAME New-NSmonitor
SYNOPSIS
The new-NSmonitor creates a monitor.
SYNTAX
New-NSmonitor -name <string> [-action <string>] [-alertretries <int>] [-application <string>] [-attribute
<string>] [-basedn <string>] [-binddn <string>] [-customheaders <string>] [-destip <string>] [-destport <ushort>]
[-domain <string>] [-downtime <int>] [-failureretries <int>] [-filter <string>] [-httprequest <string>] [-interval
<int>] [-ipaddress <string[]>] [-lrtm <string>] [-password <string>] [-query <string>] [-querytype <string>]
[-radaccounttype <uint>] [-radkey <string>] [-radnasid <string>] [-radnasip <string>] [-recv <string>] [-respcode
<string[]>] [-resptimeout <int>] [-retries <int>] [-returnobject <SwitchParameter>] [-reverse <string>]
[-scriptargs <string>] [-scriptname <string>] [-secure <string>] [-send <string>] [-session <nitro_service>]
[-storefrontacctservice <string>] [-storefrontcheckbackendservices <string>] [-storename <string>] [-type
<string>] [-username <string>] [<CommonParameters>]
DESCRIPTION
Use the new-NSmonitor to create a monitor. Monitors can be used by load balancing and GSLB. Depending on the type,
some parameters will need to be provided.
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Provide the name of the monitor.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-type <string>
Provide the type of the monitor. 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
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-action <string>
Provide the action for the monitor. The default of "DOWN" will mark the service/service group down when the
monitor fails. "LOG" will only it, and "NONE" will take any action, however counts are still tracked.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-secure <string>
Set to "YES" if the target is a secure service for example https or LDAPS. Only for TCP based monitors, cannot
be used by the CITRIX-AG monitor that is already secure by default.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-scriptname <string>
Specify the script name if using a script in the monitor. The script must be installed on the NetScaler in
/nsconfig/monitors. Example: "nsldap.pl" for LDAP monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-scriptargs <string>
Some scripts can use arguments. Specify them using this parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-basedn <string>
Provide the baseDN for an LDAP monitor. Ex. "DC=domain,DC=com"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-binddn <string>
Provide the bind for an LDAP monitor. This refers to the account used to connect to LDAP. It must have read
permissions. Ex. "user@domain.com"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-filter <string>
Provide a filter for the LDAP monitor. When monitoring Active Directory, set this to "CN=Builtin" and set the
baseDN to the root of the domain like "DC=domain,DC=com".
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-attribute <string>
Specify the attribute to search for use with the LDAP monitor. Usually not required when using Active
Directory.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-password <string>
Specify the password of the user account set with the binddn parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-application <string>
Provide the name of the application. ONLY for CITRIX-XML-SERVICE monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-domain <string>
Provide the domain name, for XenDesktop DDC monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storename <string>
Provide the storename, only for monitoring storefront servers
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storefrontacctservice <string>
Enable probing of StoreFront Account Service. Either "YES" or "NO". Default "YES". Only for StoreFront
monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storefrontcheckbackendservices <string>
Enable probing of services running on storefront server. Either "YES" or "NO". Default "NO". Only for
StoreFront monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-httprequest <string>
Specify the request for HTTP monitors. Ex, "HEAD/"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-respcode <string[]>
Specify an array of strings containing the response codes to mark a service as up. The most common is "200"
which means OK.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-customheaders <string>
Specify the the custom header for HTTP monitors. Ex, "HEAD/"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-send <string>
The send string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-recv <string>
The receive string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-query <string>
The query for a DNS monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-querytype <string>
The querytype for a DNS monitor. Possible values = Address, Zone, AAAA
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipaddress <string[]>
Provide a string array containing value IP address responses for a DNS monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-destip <string>
Provide a destination IP
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-destport <ushort>
Provide a destination port
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-interval <int>
Required? false
Position? named
Default value 5
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-downtime <int>
Required? false
Position? named
Default value 30
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-retries <int>
Required? false
Position? named
Default value 3
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-alertretries <int>
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-failureretries <int>
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-resptimeout <int>
Required? false
Position? named
Default value 2
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-lrtm <string>
Enable probing of least response time. Either "ENABLED" or "DISABLED". Default "DISABLED"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-reverse <string>
Reverse the monitor. Failure of the monitor marks the service as up and vice versa. Valid options are "YES" or
"NO". Default "NO"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radaccounttype <uint>
Account status type for RADIUS_ACCOUNTING monitors.
Required? false
Position? named
Default value 1
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radkey <string>
Radius Key for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radnasid <string>
NAS ID for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radnasip <string>
NAS IP for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-username <string>
Specify a username. Used by several monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Provide the name of the monitor.
System.String
Provide the type of the monitor. 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
System.String
Provide the action for the monitor. The default of "DOWN" will mark the service/service group down when the
monitor fails. "LOG" will only it, and "NONE" will take any action, however counts are still tracked.
System.String
Set to "YES" if the target is a secure service for example https or LDAPS. Only for TCP based monitors, cannot
be used by the CITRIX-AG monitor that is already secure by default.
System.String
Specify the script name if using a script in the monitor. The script must be installed on the NetScaler in
/nsconfig/monitors. Example: "nsldap.pl" for LDAP monitors
System.String
Some scripts can use arguments. Specify them using this parameter.
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
System.String
Provide the baseDN for an LDAP monitor. Ex. "DC=domain,DC=com"
System.String
Provide the bind for an LDAP monitor. This refers to the account used to connect to LDAP. It must have read
permissions. Ex. "user@domain.com"
System.String
Provide a filter for the LDAP monitor. When monitoring Active Directory, set this to "CN=Builtin" and set the
baseDN to the root of the domain like "DC=domain,DC=com".
System.String
Specify the attribute to search for use with the LDAP monitor. Usually not required when using Active
Directory.
System.String
Specify the password of the user account set with the binddn parameter.
System.String
Provide the name of the application. ONLY for CITRIX-XML-SERVICE monitors.
System.String
Provide the domain name, for XenDesktop DDC monitors
System.String
Provide the storename, only for monitoring storefront servers
System.String
Enable probing of StoreFront Account Service. Either "YES" or "NO". Default "YES". Only for StoreFront
monitors.
System.String
Enable probing of services running on storefront server. Either "YES" or "NO". Default "NO". Only for
StoreFront monitors.
System.String
Specify the request for HTTP monitors. Ex, "HEAD/"
System.String[]
Specify an array of strings containing the response codes to mark a service as up. The most common is "200"
which means OK.
System.String
Specify the the custom header for HTTP monitors. Ex, "HEAD/"
System.String
The send string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
System.String
The receive string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
System.String
The query for a DNS monitor.
System.String
The querytype for a DNS monitor. Possible values = Address, Zone, AAAA
System.String[]
Provide a string array containing value IP address responses for a DNS monitor.
System.String
Provide a destination IP
System.UInt16
Provide a destination port
System.Int32
System.Int32
System.Int32
System.Int32
System.Int32
System.Int32
System.String
Enable probing of least response time. Either "ENABLED" or "DISABLED". Default "DISABLED"
System.String
Reverse the monitor. Failure of the monitor marks the service as up and vice versa. Valid options are "YES" or
"NO". Default "NO"
System.UInt32
Account status type for RADIUS_ACCOUNTING monitors.
System.String
Radius Key for a radius monitor.
System.String
NAS ID for a radius monitor.
System.String
NAS IP for a radius monitor.
System.String
Specify a username. Used by several monitors.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.lb.lbmonitor
---------- EXAMPLE 1 ----------
Creating a DNS monitornew-nsmonitor -session $session -name "LB-DNS-mon" -type "DNS" -query "domain.com"
-querytype "zone" -radAccountType 5
---------- EXAMPLE 2 ----------
Creating an LDAP monitor to monitor Active Directory LDAP servers (DC)new-nsmonitor -session $session -name
"LB-LDAPS-mon" -type "LDAP" -scriptname "nsldap.pl" -basedn "DC=domain,DC=com" -binddn "administrator@domain.com"
-filter "CN=Builtin" -password "password"
RELATED LINKS
SYNOPSIS
The new-NSmonitor creates a monitor.
SYNTAX
New-NSmonitor -name <string> [-action <string>] [-alertretries <int>] [-application <string>] [-attribute
<string>] [-basedn <string>] [-binddn <string>] [-customheaders <string>] [-destip <string>] [-destport <ushort>]
[-domain <string>] [-downtime <int>] [-failureretries <int>] [-filter <string>] [-httprequest <string>] [-interval
<int>] [-ipaddress <string[]>] [-lrtm <string>] [-password <string>] [-query <string>] [-querytype <string>]
[-radaccounttype <uint>] [-radkey <string>] [-radnasid <string>] [-radnasip <string>] [-recv <string>] [-respcode
<string[]>] [-resptimeout <int>] [-retries <int>] [-returnobject <SwitchParameter>] [-reverse <string>]
[-scriptargs <string>] [-scriptname <string>] [-secure <string>] [-send <string>] [-session <nitro_service>]
[-storefrontacctservice <string>] [-storefrontcheckbackendservices <string>] [-storename <string>] [-type
<string>] [-username <string>] [<CommonParameters>]
DESCRIPTION
Use the new-NSmonitor to create a monitor. Monitors can be used by load balancing and GSLB. Depending on the type,
some parameters will need to be provided.
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Provide the name of the monitor.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-type <string>
Provide the type of the monitor. 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
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-action <string>
Provide the action for the monitor. The default of "DOWN" will mark the service/service group down when the
monitor fails. "LOG" will only it, and "NONE" will take any action, however counts are still tracked.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-secure <string>
Set to "YES" if the target is a secure service for example https or LDAPS. Only for TCP based monitors, cannot
be used by the CITRIX-AG monitor that is already secure by default.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-scriptname <string>
Specify the script name if using a script in the monitor. The script must be installed on the NetScaler in
/nsconfig/monitors. Example: "nsldap.pl" for LDAP monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-scriptargs <string>
Some scripts can use arguments. Specify them using this parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-basedn <string>
Provide the baseDN for an LDAP monitor. Ex. "DC=domain,DC=com"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-binddn <string>
Provide the bind for an LDAP monitor. This refers to the account used to connect to LDAP. It must have read
permissions. Ex. "user@domain.com"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-filter <string>
Provide a filter for the LDAP monitor. When monitoring Active Directory, set this to "CN=Builtin" and set the
baseDN to the root of the domain like "DC=domain,DC=com".
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-attribute <string>
Specify the attribute to search for use with the LDAP monitor. Usually not required when using Active
Directory.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-password <string>
Specify the password of the user account set with the binddn parameter.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-application <string>
Provide the name of the application. ONLY for CITRIX-XML-SERVICE monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-domain <string>
Provide the domain name, for XenDesktop DDC monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storename <string>
Provide the storename, only for monitoring storefront servers
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storefrontacctservice <string>
Enable probing of StoreFront Account Service. Either "YES" or "NO". Default "YES". Only for StoreFront
monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-storefrontcheckbackendservices <string>
Enable probing of services running on storefront server. Either "YES" or "NO". Default "NO". Only for
StoreFront monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-httprequest <string>
Specify the request for HTTP monitors. Ex, "HEAD/"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-respcode <string[]>
Specify an array of strings containing the response codes to mark a service as up. The most common is "200"
which means OK.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-customheaders <string>
Specify the the custom header for HTTP monitors. Ex, "HEAD/"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-send <string>
The send string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-recv <string>
The receive string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-query <string>
The query for a DNS monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-querytype <string>
The querytype for a DNS monitor. Possible values = Address, Zone, AAAA
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipaddress <string[]>
Provide a string array containing value IP address responses for a DNS monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-destip <string>
Provide a destination IP
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-destport <ushort>
Provide a destination port
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-interval <int>
Required? false
Position? named
Default value 5
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-downtime <int>
Required? false
Position? named
Default value 30
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-retries <int>
Required? false
Position? named
Default value 3
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-alertretries <int>
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-failureretries <int>
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-resptimeout <int>
Required? false
Position? named
Default value 2
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-lrtm <string>
Enable probing of least response time. Either "ENABLED" or "DISABLED". Default "DISABLED"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-reverse <string>
Reverse the monitor. Failure of the monitor marks the service as up and vice versa. Valid options are "YES" or
"NO". Default "NO"
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radaccounttype <uint>
Account status type for RADIUS_ACCOUNTING monitors.
Required? false
Position? named
Default value 1
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radkey <string>
Radius Key for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radnasid <string>
NAS ID for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-radnasip <string>
NAS IP for a radius monitor.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-username <string>
Specify a username. Used by several monitors.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Provide the name of the monitor.
System.String
Provide the type of the monitor. 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
System.String
Provide the action for the monitor. The default of "DOWN" will mark the service/service group down when the
monitor fails. "LOG" will only it, and "NONE" will take any action, however counts are still tracked.
System.String
Set to "YES" if the target is a secure service for example https or LDAPS. Only for TCP based monitors, cannot
be used by the CITRIX-AG monitor that is already secure by default.
System.String
Specify the script name if using a script in the monitor. The script must be installed on the NetScaler in
/nsconfig/monitors. Example: "nsldap.pl" for LDAP monitors
System.String
Some scripts can use arguments. Specify them using this parameter.
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
System.String
Provide the baseDN for an LDAP monitor. Ex. "DC=domain,DC=com"
System.String
Provide the bind for an LDAP monitor. This refers to the account used to connect to LDAP. It must have read
permissions. Ex. "user@domain.com"
System.String
Provide a filter for the LDAP monitor. When monitoring Active Directory, set this to "CN=Builtin" and set the
baseDN to the root of the domain like "DC=domain,DC=com".
System.String
Specify the attribute to search for use with the LDAP monitor. Usually not required when using Active
Directory.
System.String
Specify the password of the user account set with the binddn parameter.
System.String
Provide the name of the application. ONLY for CITRIX-XML-SERVICE monitors.
System.String
Provide the domain name, for XenDesktop DDC monitors
System.String
Provide the storename, only for monitoring storefront servers
System.String
Enable probing of StoreFront Account Service. Either "YES" or "NO". Default "YES". Only for StoreFront
monitors.
System.String
Enable probing of services running on storefront server. Either "YES" or "NO". Default "NO". Only for
StoreFront monitors.
System.String
Specify the request for HTTP monitors. Ex, "HEAD/"
System.String[]
Specify an array of strings containing the response codes to mark a service as up. The most common is "200"
which means OK.
System.String
Specify the the custom header for HTTP monitors. Ex, "HEAD/"
System.String
The send string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
System.String
The receive string for TCP-ECV, HTTP-ECV and UDP-ECV monitors
System.String
The query for a DNS monitor.
System.String
The querytype for a DNS monitor. Possible values = Address, Zone, AAAA
System.String[]
Provide a string array containing value IP address responses for a DNS monitor.
System.String
Provide a destination IP
System.UInt16
Provide a destination port
System.Int32
System.Int32
System.Int32
System.Int32
System.Int32
System.Int32
System.String
Enable probing of least response time. Either "ENABLED" or "DISABLED". Default "DISABLED"
System.String
Reverse the monitor. Failure of the monitor marks the service as up and vice versa. Valid options are "YES" or
"NO". Default "NO"
System.UInt32
Account status type for RADIUS_ACCOUNTING monitors.
System.String
Radius Key for a radius monitor.
System.String
NAS ID for a radius monitor.
System.String
NAS IP for a radius monitor.
System.String
Specify a username. Used by several monitors.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.lb.lbmonitor
---------- EXAMPLE 1 ----------
Creating a DNS monitornew-nsmonitor -session $session -name "LB-DNS-mon" -type "DNS" -query "domain.com"
-querytype "zone" -radAccountType 5
---------- EXAMPLE 2 ----------
Creating an LDAP monitor to monitor Active Directory LDAP servers (DC)new-nsmonitor -session $session -name
"LB-LDAPS-mon" -type "LDAP" -scriptname "nsldap.pl" -basedn "DC=domain,DC=com" -binddn "administrator@domain.com"
-filter "CN=Builtin" -password "password"
RELATED LINKS