vpn
Statistics for vpn.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats | <String> | Read-write | Clear the statsistics / counters.<br>Possible values = basic, full |
| indexhtmlhit | <Double> | Read-only | Number of requests for VPN login page. |
| indexhtmlnoserved | <Double> | Read-only | Number of failures to display VPN login page. |
| cfghtmlserved | <Double> | Read-only | Number of client configuration requests received by VPN server. |
| cfghtmlservedrate | <Double> | Read-only | Rate (/s) counter for cfghtmlserved |
| dnsreqhit | <Double> | Read-only | Number of DNS queries resolved by VPN server. |
| dnsreqhitrate | <Double> | Read-only | Rate (/s) counter for dnsreqhit |
| winsrequesthit | <Double> | Read-only | Number of WINS queries resolved by VPN server. |
| winsrequesthitrate | <Double> | Read-only | Rate (/s) counter for winsrequesthit |
| csrequesthit | <Double> | Read-only | Number of SSL VPN tunnels formed between VPN server and client. |
| csrequesthitrate | <Double> | Read-only | Rate (/s) counter for csrequesthit |
| csnonhttpprobehit | <Double> | Read-only | Number of probes from VPN to back-end non-HTTP servers that have been accessed by the VPN client. |
| csnonhttpprobehitrate | <Double> | Read-only | Rate (/s) counter for csnonhttpprobehit |
| cshttpprobehit | <Double> | Read-only | Number of probes from VPN to back-end HTTP servers that have been accessed by the VPN client. |
| cshttpprobehitrate | <Double> | Read-only | Rate (/s) counter for cshttpprobehit |
| totalcsconnsucc | <Double> | Read-only | Number of successful probes to all back-end servers. |
| csconnsuccrate | <Double> | Read-only | Rate (/s) counter for totalcsconnsucc |
| totalfsrequest | <Double> | Read-only | Number of file system requests received by VPN server. |
| fsrequestrate | <Double> | Read-only | Rate (/s) counter for totalfsrequest |
| iipdisabledmipused | <Double> | Read-only | Number of times MIP is used as IIP is disabled. |
| iipdisabledmipusedrate | <Double> | Read-only | Rate (/s) counter for iipdisabledmipused |
| iipfailedmipused | <Double> | Read-only | Number of times MIP is used as IIP assignment failed. |
| iipfailedmipusedrate | <Double> | Read-only | Rate (/s) counter for iipfailedmipused |
| iipspillovermipused | <Double> | Read-only | Number of times MIP is used on IIP Spillover. |
| iipspillovermipusedrate | <Double> | Read-only | Rate (/s) counter for iipspillovermipused |
| iipdisabledmipdisabled | <Double> | Read-only | Both IIP and MIP is disabled. |
| iipdisabledmipdisabledrate | <Double> | Read-only | Rate (/s) counter for iipdisabledmipdisabled |
| iipfailedmipdisabled | <Double> | Read-only | Number of times IIP assignment failed and MIP is disabled. |
| iipfailedmipdisabledrate | <Double> | Read-only | Rate (/s) counter for iipfailedmipdisabled |
| socksmethreqrcvd | <Double> | Read-only | Number of received SOCKS method request. |
| socksmethreqrcvdrate | <Double> | Read-only | Rate (/s) counter for socksmethreqrcvd |
| socksmethreqsent | <Double> | Read-only | Number of sent SOCKS method request. |
| socksmethreqsentrate | <Double> | Read-only | Rate (/s) counter for socksmethreqsent |
| socksmethresprcvd | <Double> | Read-only | Number of received SOCKS method response. |
| socksmethresprcvdrate | <Double> | Read-only | Rate (/s) counter for socksmethresprcvd |
| socksmethrespsent | <Double> | Read-only | Number of sent SOCKS method response. |
| socksmethrespsentrate | <Double> | Read-only | Rate (/s) counter for socksmethrespsent |
| socksconnreqrcvd | <Double> | Read-only | Number of received SOCKS connect request. |
| socksconnreqrcvdrate | <Double> | Read-only | Rate (/s) counter for socksconnreqrcvd |
| socksconnreqsent | <Double> | Read-only | Number of sent SOCKS connect request. |
| socksconnreqsentrate | <Double> | Read-only | Rate (/s) counter for socksconnreqsent |
| socksconnresprcvd | <Double> | Read-only | Number of received SOCKS connect response. |
| socksconnresprcvdrate | <Double> | Read-only | Rate (/s) counter for socksconnresprcvd |
| socksconnrespsent | <Double> | Read-only | Number of sent SOCKS connect response. |
| socksconnrespsentrate | <Double> | Read-only | Rate (/s) counter for socksconnrespsent |
| socksservererror | <Double> | Read-only | Number of SOCKS server error. |
| socksservererrorrate | <Double> | Read-only | Rate (/s) counter for socksservererror |
| socksclienterror | <Double> | Read-only | Number of SOCKS client error. |
| socksclienterrorrate | <Double> | Read-only | Rate (/s) counter for socksclienterror |
| staconnsuccess | <Double> | Read-only | Number of STA connection success. |
| staconnsuccessrate | <Double> | Read-only | Rate (/s) counter for staconnsuccess |
| staconnfailure | <Double> | Read-only | Number of STA connection failure. |
| staconnfailurerate | <Double> | Read-only | Rate (/s) counter for staconnfailure |
| cpsconnsuccess | <Double> | Read-only | Number of CPS connection success. |
| cpsconnsuccessrate | <Double> | Read-only | Rate (/s) counter for cpsconnsuccess |
| cpsconnfailure | <Double> | Read-only | Number of CPS connection failure. |
| cpsconnfailurerate | <Double> | Read-only | Rate (/s) counter for cpsconnfailure |
| starequestsent | <Double> | Read-only | Number of STA request sent. |
| starequestsentrate | <Double> | Read-only | Rate (/s) counter for starequestsent |
| staresponserecvd | <Double> | Read-only | Number of STA response received. |
| staresponserecvdrate | <Double> | Read-only | Rate (/s) counter for staresponserecvd |
| icalicensefailure | <Double> | Read-only | Number of ICA license failure. |
| icalicensefailurerate | <Double> | Read-only | Rate (/s) counter for icalicensefailure |
Operations
(click to see Properties)
Some options that you can use for each operations:
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
get (all)
URL: http://NS_IP/nitro/v1/stat/vpn
Query-parameters:
args
http://<NSIP>/nitro/v1/stat/vpn?args= detail:<Boolean_value>, fullvalues:<Boolean_value>, ntimes:<Double_value>, logfile:<String_value>, clearstats:<String_value>,
Use this query-parameter to get vpn resources based on additional properties.
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "vpn": [ {
"staconnfailurerate":<Double_value>,
"totalcsconnsucc":<Double_value>,
"csnonhttpprobehitrate":<Double_value>,
"socksmethreqrcvd":<Double_value>,
"iipspillovermipusedrate":<Double_value>,
"iipfailedmipdisabled":<Double_value>,
"cshttpprobehitrate":<Double_value>,
"socksconnrespsentrate":<Double_value>,
"starequestsent":<Double_value>,
"socksservererrorrate":<Double_value>,
"winsrequesthitrate":<Double_value>,
"socksservererror":<Double_value>,
"socksmethresprcvdrate":<Double_value>,
"socksconnreqrcvd":<Double_value>,
"totalfsrequest":<Double_value>,
"socksmethreqrcvdrate":<Double_value>,
"socksmethreqsentrate":<Double_value>,
"cpsconnfailurerate":<Double_value>,
"iipdisabledmipdisabled":<Double_value>,
"cshttpprobehit":<Double_value>,
"iipspillovermipused":<Double_value>,
"cpsconnsuccess":<Double_value>,
"iipdisabledmipusedrate":<Double_value>,
"socksmethrespsentrate":<Double_value>,
"socksmethreqsent":<Double_value>,
"icalicensefailurerate":<Double_value>,
"staconnfailure":<Double_value>,
"socksconnreqrcvdrate":<Double_value>,
"socksclienterrorrate":<Double_value>,
"csrequesthit":<Double_value>,
"winsrequesthit":<Double_value>,
"dnsreqhitrate":<Double_value>,
"socksconnresprcvd":<Double_value>,
"socksmethrespsent":<Double_value>,
"csconnsuccrate":<Double_value>,
"socksconnreqsent":<Double_value>,
"dnsreqhit":<Double_value>,
"staconnsuccessrate":<Double_value>,
"iipfailedmipusedrate":<Double_value>,
"staconnsuccess":<Double_value>,
"cfghtmlservedrate":<Double_value>,
"staresponserecvdrate":<Double_value>,
"cpsconnfailure":<Double_value>,
"csrequesthitrate":<Double_value>,
"csnonhttpprobehit":<Double_value>,
"iipfailedmipdisabledrate":<Double_value>,
"cpsconnsuccessrate":<Double_value>,
"socksconnresprcvdrate":<Double_value>,
"indexhtmlnoserved":<Double_value>,
"fsrequestrate":<Double_value>,
"indexhtmlhit":<Double_value>,
"cfghtmlserved":<Double_value>,
"icalicensefailure":<Double_value>,
"staresponserecvd":<Double_value>,
"socksclienterror":<Double_value>,
"iipdisabledmipdisabledrate":<Double_value>,
"socksconnrespsent":<Double_value>,
"socksmethresprcvd":<Double_value>,
"iipdisabledmipused":<Double_value>,
"iipfailedmipused":<Double_value>,
"socksconnreqsentrate":<Double_value>,
"starequestsentrate":<Double_value>
}]}