Citrix ADC 12.1 NITRO API Reference

vpn

August 17, 2023

Contributed by:

Statistics for vpn.

Properties

(click to see Operations)

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

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/vpn

Query-parameters:

args

http://<Citrix-ADC-IP-address(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

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vpn": [ {
"staconnfailurerate":<Double_value>,
"totalcsconnsucc":<Double_value>,
"csnonhttpprobehitrate":<Double_value>,
"csgrtktvalidatenotstarted":<Double_value>,
"socksmethreqrcvd":<Double_value>,
"iipspillovermipusedrate":<Double_value>,
"iipfailedmipdisabled":<Double_value>,
"stamonsucc":<Double_value>,
"cshttpprobehitrate":<Double_value>,
"socksconnrespsentrate":<Double_value>,
"starequestsent":<Double_value>,
"socksservererrorrate":<Double_value>,
"csgrtktvalidatenotstartedrate":<Double_value>,
"winsrequesthitrate":<Double_value>,
"socksservererror":<Double_value>,
"socksmethresprcvdrate":<Double_value>,
"vpnlicensefail":<Double_value>,
"csgptktvalidatenotstarted":<Double_value>,
"socksconnreqrcvd":<Double_value>,
"totalfsrequest":<Double_value>,
"socksmethreqrcvdrate":<Double_value>,
"socksmethreqsentrate":<Double_value>,
"stamonrcvd":<Double_value>,
"cpsconnfailurerate":<Double_value>,
"iipdisabledmipdisabled":<Double_value>,
"cshttpprobehit":<Double_value>,
"iipspillovermipused":<Double_value>,
"stamonrcvdrate":<Double_value>,
"cpsconnsuccess":<Double_value>,
"stamonfailrate":<Double_value>,
"iipdisabledmipusedrate":<Double_value>,
"socksmethrespsentrate":<Double_value>,
"socksmethreqsent":<Double_value>,
"stamonsentrate":<Double_value>,
"icalicensefailurerate":<Double_value>,
"stamonsent":<Double_value>,
"staconnfailure":<Double_value>,
"socksconnreqrcvdrate":<Double_value>,
"socksclienterrorrate":<Double_value>,
"csgptktvalidatenotstartedrate":<Double_value>,
"csrequesthit":<Double_value>,
"winsrequesthit":<Double_value>,
"dnsreqhitrate":<Double_value>,
"socksconnresprcvd":<Double_value>,
"socksmethrespsent":<Double_value>,
"csconnsuccrate":<Double_value>,
"stamonsuccrate":<Double_value>,
"socksconnreqsent":<Double_value>,
"dnsreqhit":<Double_value>,
"staconnsuccessrate":<Double_value>,
"iipfailedmipusedrate":<Double_value>,
"staconnsuccess":<Double_value>,
"cfghtmlservedrate":<Double_value>,
"stamonfail":<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>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

vpn

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

vpn

Properties

Operations

get (all)

In this article