Collect_NetScaler_vpn

The Collect_NetScaler_vpn collection extension collects data from a Citrix NetScaler (specifically, the vpn statistics).

  • Type: Collection

  • Source of data: Citrix NetScaler NitroAPI: /nitro/v1/stat/vpn

  • Tables created: CitrixNetScalervpn

  • Log files created: Collect_NetScaler_vpn.log

Columns

The following table explains the columns created by Collect_NetScaler_vpn:

Name

Type

Display Name

Description

name

String

name

This is the NetScaler device.

indexhtmlhit

Double

indexhtmlhit

Number of requests for VPN login page.

indexhtmlnoserved

Double

indexhtmlnoserved

Number of failures to display VPN login page.

cfghtmlserved

Double

cfghtmlserved

Number of client configuration requests received by VPN server.

cfghtmlservedrate

Double

cfghtmlservedrate

Rate (/s) counter for cfghtmlserved.

dnsreqhit

Double

dnsreqhit

Number of DNS queries resolved by VPN server.

dnsreqhitrate

Double

dnsreqhitrate

Rate (/s) counter for dnsreqhit.

winsrequesthit

Double

winsrequesthit

Number of WINS queries resolved by VPN server.

winsrequesthitrate

Double

winsrequesthitrate

Rate (/s) counter for winsrequesthit.

csrequesthit

Double

csrequesthit

Number of SSL VPN tunnels formed between VPN server and client.

csrequesthitrate

Double

csrequesthitrate

Rate (/s) counter for csrequesthit.

csnonhttpprobehit

Double

csnonhttpprobehit

Number of probes from VPN to back-end non-HTTP servers that have been accessed by the VPN client.

csnonhttpprobehitrate

Double

csnonhttpprobehitrate

Rate (/s) counter for csnonhttpprobehit.

cshttpprobehit

Double

cshttpprobehit

Number of probes from VPN to back-end HTTP servers that have been accessed by the VPN client.

cshttpprobehitrate

Double

cshttpprobehitrate

Rate (/s) counter for cshttpprobehit.

totalcsconnsucc

Double

totalcsconnsucc

Number of successful probes to all back-end servers.

csconnsuccrate

Double

csconnsuccrate

Rate (/s) counter for totalcsconnsucc.

totalfsrequest

Double

totalfsrequest

Number of file system requests received by VPN server.

fsrequestrate

Double

fsrequestrate

Rate (/s) counter for totalfsrequest.

vpnlicensefail

Double

vpnlicensefail

Number of users not able to login because of license unavailability.

iipdisabledmipused

Double

iipdisabledmipused

Number of times SNIP is used as IIP is disabled.

iipdisabledmipusedrate

Double

iipdisabledmipusedrate

Rate (/s) counter for iipdisabledmipused.

iipfailedmipused

Double

iipfailedmipused

Number of times SNIP is used as IIP assignment failed.

iipfailedmipusedrate

Double

iipfailedmipusedrate

Rate (/s) counter for iipfailedmipused.

iipspillovermipused

Double

iipspillovermipused

Number of times SNIP is used on IIP Spillover.

iipspillovermipusedrate

Double

iipspillovermipusedrate

Rate (/s) counter for iipspillovermipused.

iipdisabledmipdisabled

Double

iipdisabledmipdisabled

Both IIP and SNIP is disabled.

iipdisabledmipdisabledrate

Double

iipdisabledmipdisabledrate

Rate (/s) counter for iipdisabledmipdisabled.

iipfailedmipdisabled

Double

iipfailedmipdisabled

Number of times IIP assignment failed and SNIP is disabled.

iipfailedmipdisabledrate

Double

iipfailedmipdisabledrate

Rate (/s) counter for iipfailedmipdisabled.

socksmethreqrcvd

Double

socksmethreqrcvd

Number of received SOCKS method request.

socksmethreqrcvdrate

Double

socksmethreqrcvdrate

Rate (/s) counter for socksmethreqrcvd.

socksmethreqsent

Double

socksmethreqsent

Number of sent SOCKS method request.

socksmethreqsentrate

Double

socksmethreqsentrate

Rate (/s) counter for socksmethreqsent.

socksmethresprcvd

Double

socksmethresprcvd

Number of received SOCKS method response.

socksmethresprcvdrate

Double

socksmethresprcvdrate

Rate (/s) counter for socksmethresprcvd.

socksmethrespsent

Double

socksmethrespsent

Number of sent SOCKS method response.

socksmethrespsentrate

Double

socksmethrespsentrate

Rate (/s) counter for socksmethrespsent.

socksconnreqrcvd

Double

socksconnreqrcvd

Number of received SOCKS connect request.

socksconnreqrcvdrate

Double

socksconnreqrcvdrate

Rate (/s) counter for socksconnreqrcvd.

socksconnreqsent

Double

socksconnreqsent

Number of sent SOCKS connect request.

socksconnreqsentrate

Double

socksconnreqsentrate

Rate (/s) counter for socksconnreqsent.

socksconnresprcvd

Double

socksconnresprcvd

Number of received SOCKS connect response.

socksconnresprcvdrate

Double

socksconnresprcvdrate

Rate (/s) counter for socksconnresprcvd.

socksconnrespsent

Double

socksconnrespsent

Number of sent SOCKS connect response.

socksconnrespsentrate

Double

socksconnrespsentrate

Rate (/s) counter for socksconnrespsent.

socksservererror

Double

socksservererror

Number of SOCKS server error.

socksservererrorrate

Double

socksservererrorrate

Rate (/s) counter for socksservererror.

socksclienterror

Double

socksclienterror

Number of SOCKS client error.

socksclienterrorrate

Double

socksclienterrorrate

Rate (/s) counter for socksclienterror.

staconnsuccess

Double

staconnsuccess

Number of STA connection success.

staconnsuccessrate

Double

staconnsuccessrate

Rate (/s) counter for staconnsuccess.

staconnfailure

Double

staconnfailure

Number of STA connection failure.

staconnfailurerate

Double

staconnfailurerate

Rate (/s) counter for staconnfailure.

cpsconnsuccess

Double

cpsconnsuccess

Number of CPS connection success.

cpsconnsuccessrate

Double

cpsconnsuccessrate

Rate (/s) counter for cpsconnsuccess.

cpsconnfailure

Double

cpsconnfailure

Number of CPS connection failure.

cpsconnfailurerate

Double

cpsconnfailurerate

Rate (/s) counter for cpsconnfailure.

starequestsent

Double

starequestsent

Number of STA request sent.

starequestsentrate

Double

starequestsentrate

Rate (/s) counter for starequestsent.

staresponserecvd

Double

staresponserecvd

Number of STA response received.

staresponserecvdrate

Double

staresponserecvdrate

Rate (/s) counter for staresponserecvd.

icalicensefailure

Double

icalicensefailure

Number of ICA license failure.

icalicensefailurerate

Double

icalicensefailurerate

Rate (/s) counter for icalicensefailure.

stamonsent

Double

stamonsent

Number of STA monitor requests sent.

stamonsentrate

Double

stamonsentrate

Rate (/s) counter for stamonsent.

stamonrcvd

Double

stamonrcvd

Number of STA monitor responses received.

stamonrcvdrate

Double

stamonrcvdrate

Rate (/s) counter for stamonrcvd.

stamonsucc

Double

stamonsucc

Number of STA monitor successful responses.

stamonsuccrate

Double

stamonsuccrate

Rate (/s) counter for stamonsucc.

stamonfail

Double

stamonfail

Number of STA monitor failed responses.

stamonfailrate

Double

stamonfailrate

Rate (/s) counter for stamonfail.

csgptktvalidatenotstarted

Double

csgptktvalidatenotstarted

Total number of STA server lookup failures for auth-id in primary ticket.

csgptktvalidatenotstartedrate

Double

csgptktvalidatenotstartedrate

Rate (/s) counter for csgptktvalidatenotstarted.

csgrtktvalidatenotstarted

Double

csgrtktvalidatenotstarted

Total number of STA server lookup failures for auth-id in redundant ticket.

csgrtktvalidatenotstartedrate

Double

csgrtktvalidatenotstartedrate

Rate (/s) counter for csgrtktvalidatenotstarted.

Files

The following files are created for Collect_NetScaler_vpn:

  • Collect_NetScaler_vpn.bat: Calls the PowerShell script that is doing the actual collection.

  • Collect_NetScaler_vpn.metadata: Collection extension instructions used by SysTrack.

  • Collect_NetScaler_vpn.ps1: PowerShell script that does the collections.