ADC NITRO APIs
vpn
Statistics for vpn.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| indexhtmlhit |
|
Read-only | Number of requests for VPN login page. |
| indexhtmlnoserved |
|
Read-only | Number of failures to display VPN login page. |
| cfghtmlserved |
|
Read-only | Number of client configuration requests received by VPN server. |
| cfghtmlservedrate |
|
Read-only | Rate (/s) counter for cfghtmlserved |
| dnsreqhit |
|
Read-only | Number of DNS queries resolved by VPN server. |
| dnsreqhitrate |
|
Read-only | Rate (/s) counter for dnsreqhit |
| winsrequesthit |
|
Read-only | Number of WINS queries resolved by VPN server. |
| winsrequesthitrate |
|
Read-only | Rate (/s) counter for winsrequesthit |
| csrequesthit |
|
Read-only | Number of SSL VPN tunnels formed between VPN server and client. |
| csrequesthitrate |
|
Read-only | Rate (/s) counter for csrequesthit |
| csnonhttpprobehit |
|
Read-only | Number of probes from VPN to back-end non-HTTP servers that have been accessed by the VPN client. |
| csnonhttpprobehitrate |
|
Read-only | Rate (/s) counter for csnonhttpprobehit |
| cshttpprobehit |
|
Read-only | Number of probes from VPN to back-end HTTP servers that have been accessed by the VPN client. |
| cshttpprobehitrate |
|
Read-only | Rate (/s) counter for cshttpprobehit |
| totalcsconnsucc |
|
Read-only | Number of successful probes to all back-end servers. |
| csconnsuccrate |
|
Read-only | Rate (/s) counter for totalcsconnsucc |
| totalfsrequest |
|
Read-only | Number of file system requests received by VPN server. |
| fsrequestrate |
|
Read-only | Rate (/s) counter for totalfsrequest |
| vpnlicensefail |
|
Read-only | Number of users not able to login because of license unavailability. |
| svpnhttpdtotalrequests |
|
Read-only | Total number of requests from VPN to Apache |
| svpnhttpdtotalresponses |
|
Read-only | Total number of responses from Apache for VPN |
| svpnhttpdtotalrequestscachehits |
|
Read-only | Total number of vpn requests to Apache hitting cache |
| svpnhttpdcurserverconnectionsopen |
|
Read-only | Number of current VPN to Apache open server connections |
| svpnreqwaftotblock |
|
Read-only | Total Number of requests that are blocked as part of Appfw Validation for VPN |
| iipdisabledmipused |
|
Read-only | Number of times SNIP is used as IIP is disabled. |
| iipdisabledmipusedrate |
|
Read-only | Rate (/s) counter for iipdisabledmipused |
| iipfailedmipused |
|
Read-only | Number of times SNIP is used as IIP assignment failed. |
| iipfailedmipusedrate |
|
Read-only | Rate (/s) counter for iipfailedmipused |
| iipspillovermipused |
|
Read-only | Number of times SNIP is used on IIP Spillover. |
| iipspillovermipusedrate |
|
Read-only | Rate (/s) counter for iipspillovermipused |
| iipdisabledmipdisabled |
|
Read-only | Both IIP and SNIP is disabled. |
| iipdisabledmipdisabledrate |
|
Read-only | Rate (/s) counter for iipdisabledmipdisabled |
| iipfailedmipdisabled |
|
Read-only | Number of times IIP assignment failed and SNIP is disabled. |
| iipfailedmipdisabledrate |
|
Read-only | Rate (/s) counter for iipfailedmipdisabled |
| csgtotalconnectedusers |
|
Read-only | Number of total users connected across VPN vservers |
| csgconnectedusersrate |
|
Read-only | Rate (/s) counter for csgtotalconnectedusers |
| socksmethreqrcvd |
|
Read-only | Number of received SOCKS method request. |
| socksmethreqrcvdrate |
|
Read-only | Rate (/s) counter for socksmethreqrcvd |
| socksmethreqsent |
|
Read-only | Number of sent SOCKS method request. |
| socksmethreqsentrate |
|
Read-only | Rate (/s) counter for socksmethreqsent |
| socksmethresprcvd |
|
Read-only | Number of received SOCKS method response. |
| socksmethresprcvdrate |
|
Read-only | Rate (/s) counter for socksmethresprcvd |
| socksmethrespsent |
|
Read-only | Number of sent SOCKS method response. |
| socksmethrespsentrate |
|
Read-only | Rate (/s) counter for socksmethrespsent |
| socksconnreqrcvd |
|
Read-only | Number of received SOCKS connect request. |
| socksconnreqrcvdrate |
|
Read-only | Rate (/s) counter for socksconnreqrcvd |
| socksconnreqsent |
|
Read-only | Number of sent SOCKS connect request. |
| socksconnreqsentrate |
|
Read-only | Rate (/s) counter for socksconnreqsent |
| socksconnresprcvd |
|
Read-only | Number of received SOCKS connect response. |
| socksconnresprcvdrate |
|
Read-only | Rate (/s) counter for socksconnresprcvd |
| socksconnrespsent |
|
Read-only | Number of sent SOCKS connect response. |
| socksconnrespsentrate |
|
Read-only | Rate (/s) counter for socksconnrespsent |
| socksservererror |
|
Read-only | Number of SOCKS server error. |
| socksservererrorrate |
|
Read-only | Rate (/s) counter for socksservererror |
| socksclienterror |
|
Read-only | Number of SOCKS client error. |
| socksclienterrorrate |
|
Read-only | Rate (/s) counter for socksclienterror |
| staconnsuccess |
|
Read-only | Number of STA connection success. |
| staconnsuccessrate |
|
Read-only | Rate (/s) counter for staconnsuccess |
| staconnfailure |
|
Read-only | Number of STA connection failure. |
| staconnfailurerate |
|
Read-only | Rate (/s) counter for staconnfailure |
| cpsconnsuccess |
|
Read-only | Number of CPS connection success. |
| cpsconnsuccessrate |
|
Read-only | Rate (/s) counter for cpsconnsuccess |
| cpsconnfailure |
|
Read-only | Number of CPS connection failure. |
| cpsconnfailurerate |
|
Read-only | Rate (/s) counter for cpsconnfailure |
| starequestsent |
|
Read-only | Number of STA request sent. |
| starequestsentrate |
|
Read-only | Rate (/s) counter for starequestsent |
| staresponserecvd |
|
Read-only | Number of STA response received. |
| staresponserecvdrate |
|
Read-only | Rate (/s) counter for staresponserecvd |
| icalicensefailure |
|
Read-only | Number of ICA license failure. |
| icalicensefailurerate |
|
Read-only | Rate (/s) counter for icalicensefailure |
| stamonsent |
|
Read-only | Number of STA monitor requests sent. |
| stamonsentrate |
|
Read-only | Rate (/s) counter for stamonsent |
| stamonrcvd |
|
Read-only | Number of STA monitor responses recieved. |
| stamonrcvdrate |
|
Read-only | Rate (/s) counter for stamonrcvd |
| stamonsucc |
|
Read-only | Number of STA monitor successful responses. |
| stamonsuccrate |
|
Read-only | Rate (/s) counter for stamonsucc |
| stamonfail |
|
Read-only | Number of STA monitor failed responses. |
| stamonfailrate |
|
Read-only | Rate (/s) counter for stamonfail |
| csgptktvalidatenotstarted |
|
Read-only | Total number of STA server lookup failures for auth-id in primary ticket |
| csgptktvalidatenotstartedrate |
|
Read-only | Rate (/s) counter for csgptktvalidatenotstarted |
| csgrtktvalidatenotstarted |
|
Read-only | Total number of STA server lookup failures for auth-id in redundant ticket |
| csgrtktvalidatenotstartedrate |
|
Read-only | Rate (/s) counter for csgrtktvalidatenotstarted |
| totalsbprequest |
|
Read-only | Number of securebrowse requests received |
| sbprequestrate |
|
Read-only | Rate (/s) counter for totalsbprequest |
| totalsbpsaasrequest |
|
Read-only | Number of securebrowse requests received for saas apps |
| sbpsaasrequestrate |
|
Read-only | Rate (/s) counter for totalsbpsaasrequest |
| totalsbpwebrequest |
|
Read-only | Number of securebrowse requests received for web apps |
| sbpwebrequestrate |
|
Read-only | Rate (/s) counter for totalsbpwebrequest |
| totalsbprequestsuccess |
|
Read-only | Number of securebrowse requests succeeded |
| sbprequestsuccessrate |
|
Read-only | Rate (/s) counter for totalsbprequestsuccess |
| totalsbpsaasrequestsuccess |
|
Read-only | Number of securebrowse requests succeeded for saas apps |
| sbpsaasrequestsuccessrate |
|
Read-only | Rate (/s) counter for totalsbpsaasrequestsuccess |
| totalsbpwebrequestsuccess |
|
Read-only | Number of securebrowse requests succeeded for web apps |
| sbpwebrequestsuccessrate |
|
Read-only | Rate (/s) counter for totalsbpwebrequestsuccess |
| totalsbprequestfailure |
|
Read-only | Number of securebrowse requests failed |
| sbprequestfailurerate |
|
Read-only | Rate (/s) counter for totalsbprequestfailure |
| totalsbpsaasrequestfailure |
|
Read-only | Number of securebrowse requests failed for saas apps |
| sbpsaasrequestfailurerate |
|
Read-only | Rate (/s) counter for totalsbpsaasrequestfailure |
| totalsbpwebrequestfailure |
|
Read-only | Number of securebrowse requests failed for web apps |
| sbpwebrequestfailurerate |
|
Read-only | Rate (/s) counter for totalsbpwebrequestfailure |
| totalsbpdnsrequestfailure |
|
Read-only | Number of DNS failures while using securebrowse protocol |
| sbpdnsrequestfailurerate |
|
Read-only | Rate (/s) counter for totalsbpdnsrequestfailure |
| totalsbpbackendconnectionfailure |
|
Read-only | Number of backend connection failure while using securebrowse requests |
| sbpbackendconnectionfailurerate |
|
Read-only | Rate (/s) counter for totalsbpbackendconnectionfailure |
| totalsbpconnectorfailure |
|
Read-only | Number of times not able to reach connector using securebrowse protocol |
| sbpconnectorfailurerate |
|
Read-only | Rate (/s) counter for totalsbpconnectorfailure |
| totalcvpnrequest |
|
Read-only | Number of cvpn requests received |
| cvpnrequestrate |
|
Read-only | Rate (/s) counter for totalcvpnrequest |
| totalcvpnsaasrequest |
|
Read-only | Number of cvpn requests received for saas apps |
| cvpnsaasrequestrate |
|
Read-only | Rate (/s) counter for totalcvpnsaasrequest |
| totalcvpnwebrequest |
|
Read-only | Number of cvpn requests received for web apps |
| cvpnwebrequestrate |
|
Read-only | Rate (/s) counter for totalcvpnwebrequest |
| totalcvpnrequestsuccess |
|
Read-only | Number of cvpn requests succeeded |
| cvpnrequestsuccessrate |
|
Read-only | Rate (/s) counter for totalcvpnrequestsuccess |
| totalcvpnsaasrequestsuccess |
|
Read-only | Number of cvpn requests succeeded for saas apps |
| cvpnsaasrequestsuccessrate |
|
Read-only | Rate (/s) counter for totalcvpnsaasrequestsuccess |
| totalcvpnwebrequestsuccess |
|
Read-only | Number of cvpn requests succeeded for web apps |
| cvpnwebrequestsuccessrate |
|
Read-only | Rate (/s) counter for totalcvpnwebrequestsuccess |
| totalcvpnrequestfailure |
|
Read-only | Number of cvpn requests failed |
| cvpnrequestfailurerate |
|
Read-only | Rate (/s) counter for totalcvpnrequestfailure |
| totalcvpnsaasrequestfailure |
|
Read-only | Number of cvpn requests failed for saas apps |
| cvpnsaasrequestfailurerate |
|
Read-only | Rate (/s) counter for totalcvpnsaasrequestfailure |
| totalcvpnwebrequestfailure |
|
Read-only | Number of cvpn requests failed for web apps |
| cvpnwebrequestfailurerate |
|
Read-only | Rate (/s) counter for totalcvpnwebrequestfailure |
| totalcvpndnsrequestfailure |
|
Read-only | Number of DNS failures while using cvpn |
| cvpndnsrequestfailurerate |
|
Read-only | Rate (/s) counter for totalcvpndnsrequestfailure |
| totalcvpnbackendconnectionfailure |
|
Read-only | Number of backend connection failure while using cvpn |
| cvpnbackendconnectionfailurerate |
|
Read-only | Rate (/s) counter for totalcvpnbackendconnectionfailure |
| totalcvpnconnectorfailure |
|
Read-only | Number of times not able to reach connector using cvpn |
| cvpnconnectorfailurerate |
|
Read-only | Rate (/s) counter for totalcvpnconnectorfailure |
| totaldirectaccessrequest |
|
Read-only | Number of directaccess requests received |
| directaccessrequestrate |
|
Read-only | Rate (/s) counter for totaldirectaccessrequest |
| totaldirectaccessrequestsuccess |
|
Read-only | Number of directaccess requests succeeded |
| directaccessrequestsuccessrate |
|
Read-only | Rate (/s) counter for totaldirectaccessrequestsuccess |
| totaldirectaccessrequestfailure |
|
Read-only | Number of directaccess requests failed |
| directaccessrequestfailurerate |
|
Read-only | Rate (/s) counter for totaldirectaccessrequestfailure |
| totaldirectaccessconnectorfailure |
|
Read-only | Number of times not able to reach connector using Directaccess |
| directaccessconnectorfailurerate |
|
Read-only | Rate (/s) counter for totaldirectaccessconnectorfailure |
Operations
(click to see Properties )
- GET (ALL)
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:// <netscaler-ip-address> /nitro/v1/stat/vpn
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/stat/vpn? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Integer_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get vpn resources based on additional properties.
attrs
http:// <netscaler-ip-address> /nitro/v1/stat/vpn? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response:
HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "vpn": [ {
"socksclienterrorrate":<Double_value>,
"iipdisabledmipusedrate":<Double_value>,
"iipfailedmipdisabled":<Double_value>,
"staconnsuccessrate":<Double_value>,
"stamonsentrate":<Double_value>,
"stamonsent":<Double_value>,
"csrequesthit":<Double_value>,
"totalsbprequestsuccess":<Double_value>,
"cvpnsaasrequestrate":<Double_value>,
"sbpbackendconnectionfailurerate":<Double_value>,
"totalcsconnsucc":<Double_value>,
"staresponserecvd":<Double_value>,
"cfghtmlservedrate":<Double_value>,
"cvpnsaasrequestsuccessrate":<Double_value>,
"socksconnresprcvd":<Double_value>,
"vpnlicensefail":<Double_value>,
"directaccessconnectorfailurerate":<Double_value>,
"socksconnresprcvdrate":<Double_value>,
"fsrequestrate":<Double_value>,
"socksmethreqrcvd":<Double_value>,
"directaccessrequestfailurerate":<Double_value>,
"totalcvpnsaasrequest":<Double_value>,
"dnsreqhit":<Double_value>,
"sbprequestsuccessrate":<Double_value>,
"totalcvpnrequestfailure":<Double_value>,
"totalcvpnrequestsuccess":<Double_value>,
"socksmethreqrcvdrate":<Double_value>,
"svpnreqwaftotblock":<Double_value>,
"cpsconnfailure":<Double_value>,
"socksclienterror":<Double_value>,
"totaldirectaccessrequestfailure":<Double_value>,
"staresponserecvdrate":<Double_value>,
"totaldirectaccessrequestsuccess":<Double_value>,
"winsrequesthit":<Double_value>,
"cvpnsaasrequestfailurerate":<Double_value>,
"starequestsentrate":<Double_value>,
"iipspillovermipused":<Double_value>,
"totalcvpnwebrequestfailure":<Double_value>,
"sbpwebrequestsuccessrate":<Double_value>,
"socksconnreqrcvdrate":<Double_value>,
"stamonrcvd":<Double_value>,
"stamonrcvdrate":<Double_value>,
"totalcvpnwebrequest":<Double_value>,
"totalcvpnconnectorfailure":<Double_value>,
"totalsbpbackendconnectionfailure":<Double_value>,
"totalsbpsaasrequestsuccess":<Double_value>,
"totalsbpsaasrequest":<Double_value>,
"iipdisabledmipused":<Double_value>,
"sbpwebrequestrate":<Double_value>,
"iipspillovermipusedrate":<Double_value>,
"staconnfailure":<Double_value>,
"totalsbprequestfailure":<Double_value>,
"totalfsrequest":<Double_value>,
"sbpsaasrequestfailurerate":<Double_value>,
"socksservererror":<Double_value>,
"indexhtmlhit":<Double_value>,
"cvpnrequestfailurerate":<Double_value>,
"totalsbpwebrequest":<Double_value>,
"socksmethresprcvd":<Double_value>,
"socksservererrorrate":<Double_value>,
"totalcvpnwebrequestsuccess":<Double_value>,
"directaccessrequestrate":<Double_value>,
"cvpnbackendconnectionfailurerate":<Double_value>,
"csgrtktvalidatenotstartedrate":<Double_value>,
"socksconnreqrcvd":<Double_value>,
"csrequesthitrate":<Double_value>,
"socksmethresprcvdrate":<Double_value>,
"totalcvpnsaasrequestfailure":<Double_value>,
"sbpdnsrequestfailurerate":<Double_value>,
"totalsbpwebrequestfailure":<Double_value>,
"cpsconnsuccessrate":<Double_value>,
"cshttpprobehitrate":<Double_value>,
"csnonhttpprobehitrate":<Double_value>,
"csgptktvalidatenotstarted":<Double_value>,
"stamonfail":<Double_value>,
"stamonfailrate":<Double_value>,
"socksmethreqsent":<Double_value>,
"csconnsuccrate":<Double_value>,
"totalsbprequest":<Double_value>,
"iipfailedmipusedrate":<Double_value>,
"csgptktvalidatenotstartedrate":<Double_value>,
"directaccessrequestsuccessrate":<Double_value>,
"staconnsuccess":<Double_value>,
"iipfailedmipdisabledrate":<Double_value>,
"cfghtmlserved":<Double_value>,
"csnonhttpprobehit":<Double_value>,
"totaldirectaccessrequest":<Double_value>,
"svpnhttpdtotalrequests":<Double_value>,
"svpnhttpdcurserverconnectionsopen":<Double_value>,
"iipfailedmipused":<Double_value>,
"winsrequesthitrate":<Double_value>,
"csgtotalconnectedusers":<Double_value>,
"stamonsuccrate":<Double_value>,
"stamonsucc":<Double_value>,
"socksconnrespsent":<Double_value>,
"cvpnwebrequestrate":<Double_value>,
"totalsbpdnsrequestfailure":<Double_value>,
"totalsbpconnectorfailure":<Double_value>,
"cpsconnfailurerate":<Double_value>,
"svpnhttpdtotalrequestscachehits":<Double_value>,
"socksmethreqsentrate":<Double_value>,
"totalcvpndnsrequestfailure":<Double_value>,
"sbpwebrequestfailurerate":<Double_value>,
"csgrtktvalidatenotstarted":<Double_value>,
"totalcvpnrequest":<Double_value>,
"socksconnrespsentrate":<Double_value>,
"totalsbpsaasrequestfailure":<Double_value>,
"icalicensefailure":<Double_value>,
"cvpnwebrequestfailurerate":<Double_value>,
"sbpconnectorfailurerate":<Double_value>,
"socksmethrespsent":<Double_value>,
"cvpndnsrequestfailurerate":<Double_value>,
"cvpnwebrequestsuccessrate":<Double_value>,
"totalsbpwebrequestsuccess":<Double_value>,
"staconnfailurerate":<Double_value>,
"totalcvpnbackendconnectionfailure":<Double_value>,
"sbpsaasrequestrate":<Double_value>,
"dnsreqhitrate":<Double_value>,
"socksmethrespsentrate":<Double_value>,
"icalicensefailurerate":<Double_value>,
"cvpnconnectorfailurerate":<Double_value>,
"indexhtmlnoserved":<Double_value>,
"socksconnreqsentrate":<Double_value>,
"starequestsent":<Double_value>,
"sbprequestrate":<Double_value>,
"cvpnrequestrate":<Double_value>,
"totaldirectaccessconnectorfailure":<Double_value>,
"cshttpprobehit":<Double_value>,
"cpsconnsuccess":<Double_value>,
"socksconnreqsent":<Double_value>,
"sbpsaasrequestsuccessrate":<Double_value>,
"sbprequestfailurerate":<Double_value>,
"cvpnrequestsuccessrate":<Double_value>,
"iipdisabledmipdisabledrate":<Double_value>,
"svpnhttpdtotalresponses":<Double_value>,
"iipdisabledmipdisabled":<Double_value>,
"csgconnectedusersrate":<Double_value>,
"totalcvpnsaasrequestsuccess":<Double_value>
}]}
<!--NeedCopy-->
vpn
In this article
Copied!
Failed!