Citrix ADC 12.1 NITRO API Reference

ca

Statistics for ca.

Properties

(click to see Operations)

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.
Possible values = basic, full
caaunindentifiedbyteshr Read-only This tells the hit ratio of unindentified bytes
caiosbyteshr Read-only This tells the hit ratio of IOS bytes
caotherbyteshr Read-only This tells the hit ratio of Other device
calaptpdsktpbyteshr Read-only This tells the hit ratio of laptop_desktop bytes
caandroidbyteshr Read-only This tells the hit ratio of 3GP bytes
ca3gpvidcachebyteshr Read-only This tells the hit ratio of 3GP bytes
camp4vidcachebyteshr Read-only This tells the hit ratio of MP4 bytes
caflvvidcachebyteshr Read-only This tells the hit ratio of FLV bytes
caaacaudiocachebyteshr Read-only This tells the hit ratio AAC bytes served
caadtsaudiocachebyteshr Read-only This tells the byte hit ratio of ADTS bytes
caaplelivestrmngplvidcachebyteshr Read-only This tells the byte hit ratio of AppleLive Playlist bytes
caapplelivestrmngvidcachebyteshr Read-only This tells the total number of AppleLive bytes
camsftsmthstrmngplvidcabyteshr Read-only This tells the byte hit ratio of MicrosoftSmoothStreaming Playlist bytes
camsftsmthstrmngvidcabyteshr Read-only This tells the Bytes hit ratio of MicrosoftSmoothStreaming bytes .
caunidentifiedhr Read-only This tells the hit ratio of android requests
caioshr Read-only This tells the hit ratio of ios requests
caotherhr Read-only This tells the hit ratio of other mobile device requests
calaptopdesktphr Read-only This tells the hit ratio of laptop/desktop requests
caandroidhr Read-only This tells the hit ratio of android requests
ca3gpvidhr Read-only This tells the total number of 3GP requests
cacmp4vidhr Read-only This tells the hit ratio of MP4 requests
cacflvvidhr Read-only This tells the hit ratio of FLV requests
cacaacaudiohr Read-only This tells the hit ratio of AAC requests
cacadtsaudiohr Read-only This tells the Hit Ratio of ADTS requests
cacapplelivestreamingplaylistvidhr Read-only This tells the hit ratio of AppleLive Playlist requests
cacapplelivestreamingvidhr Read-only This tells the hit ratio of AppleLive requests
cacmsftsmthstrmplvidhr Read-only This tells the hit ratio of MicrosoftSmoothStreaming Playlist requests
camsftsmthstrmvidhr Read-only This tells the hit ratio of MicrosoftSmoothStreaming requests
catotother Read-only
catotvideo Read-only
catotaudio Read-only
catotobjstored Read-only
calookuphitrate Read-only Rate (/s) counter for catotlookuphit
catotgetobjreq Read-only
catotrequests Read-only
camsftsmthstrmvid Read-only This tells the total number of MicrosoftSmoothStreaming requests served by Citrix ADC
camsftsmthstrmvidrate Read-only Rate (/s) counter for camsftsmthstrmvid
cacmsftsmthstrmvid Read-only This tells the total number of MicrosoftSmoothStreaming requests served from cache
cacmsftsmthstrmvidrate Read-only Rate (/s) counter for cacmsftsmthstrmvid
camsftsmthstrvid Read-only This tells the total number of MicrosoftSmoothStreaming Playlist requests served by Citrix ADC
camsftsmthstrvidrate Read-only Rate (/s) counter for camsftsmthstrvid
cacmsftsmthstrmplvid Read-only This tells the total number of MicrosoftSmoothStreaming Playlist requests served from cache
cacmsftsmthstrmplvidrate Read-only Rate (/s) counter for cacmsftsmthstrmplvid
cacaplelivestrmngvid Read-only This tells the total number of AppleLive requests served by Citrix ADC
cacaplelivestrmngvidrate Read-only Rate (/s) counter for cacaplelivestrmngvid
cacapplelivestreamingvid Read-only This tells the total number of AppleLive requests served from cache
cacapplelivestreamingvidrate Read-only Rate (/s) counter for cacapplelivestreamingvid
cacapplelivestrmngvid Read-only This tells the total number of AppleLive Playlist requests served by Citrix ADC
cacapplelivestrmngvidrate Read-only Rate (/s) counter for cacapplelivestrmngvid
cacapplelivestreamingplaylistvid Read-only This tells the total number of AppleLive Playlist requests served from cache
cacapplelivestreamingplaylistvidrate Read-only Rate (/s) counter for cacapplelivestreamingplaylistvid
caadtsaudio Read-only This tells the total number of ADTS requests served by Citrix ADC
caadtsaudiorate Read-only Rate (/s) counter for caadtsaudio
cacadtsaudio Read-only This tells the total number of ADTS requests served from cache
cacadtsaudiorate Read-only Rate (/s) counter for cacadtsaudio
caaacaudio Read-only This tells the total number of AAC requests served by Citrix ADC
caaacaudiorate Read-only Rate (/s) counter for caaacaudio
cacaacaudio Read-only This tells the total number of AAC requests served from cache
cacaacaudiorate Read-only Rate (/s) counter for cacaacaudio
caflvvid Read-only This tells the total number of FLV requests served by Citrix ADC
caflvvidrate Read-only Rate (/s) counter for caflvvid
cacflvvid Read-only This tells the total number of FLV requests served from cache
cacflvvidrate Read-only Rate (/s) counter for cacflvvid
camp4vid Read-only This tells the total number of MP4 requests served by Citrix ADC
camp4vidrate Read-only Rate (/s) counter for camp4vid
cacmp4vid Read-only This tells the total number of MP4 requests served from cache
cacmp4vidrate Read-only Rate (/s) counter for cacmp4vid
ca3pvid Read-only This tells the total number of 3GP requests served by Citrix ADC
ca3pvidrate Read-only Rate (/s) counter for ca3pvid
ca3gpvid Read-only This tells the hit ratio of 3GP requests served from cache
ca3gpvidrate Read-only Rate (/s) counter for ca3gpvid
camsftsmthstrmvidbytes Read-only This tells the total number of MicrosoftSmoothStreaming bytes served by Citrix ADC
camsftsmthstrmvidbytesrate Read-only Rate (/s) counter for camsftsmthstrmvidbytes
camicrosoftsmoothstreamingvidcachebytes Read-only This tells the total number of MicrosoftSmoothStreaming bytes served from cache.
camicrosoftsmoothstreamingvidcachebytesrate Read-only Rate (/s) counter for camicrosoftsmoothstreamingvidcachebytes
camsftsmthstrmplvidbytes Read-only This tells the total number of MicrosoftSmoothStreaming Playlist bytes served by Citrix ADC
camsftsmthstrmplvidbytesrate Read-only Rate (/s) counter for camsftsmthstrmplvidbytes
camicrosoftsmoothstreamingplaylistvidcachebytes Read-only This tells the total number of MicrosoftSmoothStreaming Playlist bytes served from cache
camicrosoftsmoothstreamingplaylistvidcachebytesrate Read-only Rate (/s) counter for camicrosoftsmoothstreamingplaylistvidcachebytes
caapplelivestreamingvidbytes Read-only This tells the total number of AppleLive bytes served by Citrix ADC
caapplelivestreamingvidbytesrate Read-only Rate (/s) counter for caapplelivestreamingvidbytes
caapplelivestreamingvidcachebytes Read-only This tells the total number of AppleLive bytes served from cache
caapplelivestreamingvidcachebytesrate Read-only Rate (/s) counter for caapplelivestreamingvidcachebytes
caapplelivestreamingplaylistvidbytes Read-only This tells the total number of AppleLive Playlist bytes served by Citrix ADC
caapplelivestreamingplaylistvidbytesrate Read-only Rate (/s) counter for caapplelivestreamingplaylistvidbytes
caapplelivestreamingplaylistvidcachebytes Read-only This tells the total number of AppleLive Playlist bytes served from cache
caapplelivestreamingplaylistvidcachebytesrate Read-only Rate (/s) counter for caapplelivestreamingplaylistvidcachebytes
caadtsaudiobytes Read-only This tells the total number of ADTS bytes served by Citrix ADC
caadtsaudiobytesrate Read-only Rate (/s) counter for caadtsaudiobytes
caadtsaudiocachebytes Read-only This tells the total number of ADTS bytes served from cache
caadtsaudiocachebytesrate Read-only Rate (/s) counter for caadtsaudiocachebytes
caaacaudiobytes Read-only This tells the total number of AAC bytes served by Citrix ADC
caaacaudiobytesrate Read-only Rate (/s) counter for caaacaudiobytes
caaacaudiocachebytes Read-only This tells the total number of AAC bytes served from cache
caaacaudiocachebytesrate Read-only Rate (/s) counter for caaacaudiocachebytes
caflvvidbytes Read-only This tells the total number of FLV bytes served by Citrix ADC
caflvvidbytesrate Read-only Rate (/s) counter for caflvvidbytes
caflvvidcachebytes Read-only This tells the total number of FLV bytes served from cache
caflvvidcachebytesrate Read-only Rate (/s) counter for caflvvidcachebytes
camp4vidbytes Read-only This tells the total number of MP4 bytes served by Citrix ADC
camp4vidbytesrate Read-only Rate (/s) counter for camp4vidbytes
camp4vidcachebytes Read-only This tells the total number of MP4 bytes served from cache
camp4vidcachebytesrate Read-only Rate (/s) counter for camp4vidcachebytes
ca3gpvidbytes Read-only This tells the total number of 3GP bytes served by Citrix ADC
ca3gpvidbytesrate Read-only Rate (/s) counter for ca3gpvidbytes
ca3gpvidcachebytes Read-only This tells the total number of 3GP bytes served from cache
ca3gpvidcachebytesrate Read-only Rate (/s) counter for ca3gpvidcachebytes
caandroid Read-only Total number of android requests to Citrix ADC
caandroidrate Read-only Rate (/s) counter for caandroid
calaptopdesktp Read-only Total number of laptop/desktop requests to Citrix ADC
calaptopdesktprate Read-only Rate (/s) counter for calaptopdesktp
caios Read-only Total number of iOs requests to Citrix ADC
caiosrate Read-only Rate (/s) counter for caios
caother Read-only Total number of other mobile device requests to Citrix ADC
caotherrate Read-only Rate (/s) counter for caother
caunidentified Read-only Total number of unidentified requests to Citrix ADC
caunidentifiedrate Read-only Rate (/s) counter for caunidentified
caandroidcache Read-only This tells android requests served from cache
caandroidcacherate Read-only Rate (/s) counter for caandroidcache
caioscache Read-only This tells iOS requests served from cache
caioscacherate Read-only Rate (/s) counter for caioscache
caothercache Read-only This tells Other device requests served from cache
caothercacherate Read-only Rate (/s) counter for caothercache
calaptopdesktpcache Read-only This tells laptop/desktop requests served from cache
calaptopdesktpcacherate Read-only Rate (/s) counter for calaptopdesktpcache
caunidentifiedcache Read-only This tells unidentified device requests served from cache
caunidentifiedcacherate Read-only Rate (/s) counter for caunidentifiedcache
caandroidbytes Read-only This tells the total number of Android bytes served by Citrix ADC
caandroidbytesrate Read-only Rate (/s) counter for caandroidbytes
caiosbytes Read-only This tells the total number of IOS bytes served by Citrix ADC
caiosbytesrate Read-only Rate (/s) counter for caiosbytes
caotherbytes Read-only This tells the total number of Other mobile device bytes served by Citrix ADC
caotherbytesrate Read-only Rate (/s) counter for caotherbytes
caalptopdsktpbytes Read-only This tells the total number of Laptop/desktop bytes served by Citrix ADC
caalptopdsktpbytesrate Read-only Rate (/s) counter for caalptopdsktpbytes
caunidentifiedbytes Read-only This tells the total number of unidentified device bytes served by Citrix ADC
caunidentifiedbytesrate Read-only Rate (/s) counter for caunidentifiedbytes
caandroididcachebytes Read-only This tells the total number of Android bytes served from cache
caandroididcachebytesrate Read-only Rate (/s) counter for caandroididcachebytes
caiosidcachebytes Read-only This tells the total number of IOS bytes served from cache
caiosidcachebytesrate Read-only Rate (/s) counter for caiosidcachebytes
caotherididcachebytes Read-only This tells the total number of other device bytes served from cache
caotherididcachebytesrate Read-only Rate (/s) counter for caotherididcachebytes
calaptpdektpbytes Read-only This tells the total number of Laptop/desktop bytes served from cache
calaptpdektpbytesrate Read-only Rate (/s) counter for calaptpdektpbytes
caaunindentifiedbytes Read-only This tells the total number of unindentified device bytes served from cache
caaunindentifiedbytesrate Read-only Rate (/s) counter for caaunindentifiedbytes

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/ca

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/ca?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get ca 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:


{ "ca": [ {
"caaacaudiocachebytes":<Double_value>,
"camsftsmthstrmvidhr":<Double_value>,
"caflvvidrate":<Double_value>,
"cacmsftsmthstrmplvid":<Double_value>,
"camp4vidbytesrate":<Double_value>,
"camsftsmthstrmngplvidcabyteshr":<Double_value>,
"caapplelivestreamingplaylistvidbytesrate":<Double_value>,
"catotvideo":<Double_value>,
"caaacaudiobytes":<Double_value>,
"calookuphitrate":<Double_value>,
"cacapplelivestreamingplaylistvid":<Double_value>,
"cacmp4vidhr":<Double_value>,
"cacapplelivestreamingvidhr":<Double_value>,
"caflvvidbytesrate":<Double_value>,
"catotobjstored":<Double_value>,
"ca3gpvidcachebytesrate":<Double_value>,
"caaacaudiocachebyteshr":<Double_value>,
"caadtsaudiobytes":<Double_value>,
"cacadtsaudio":<Double_value>,
"caaudiorate":<Double_value>,
"cacapplelivestreamingplaylistvidrate":<Double_value>,
"caaplelivestrmngplvidcachebyteshr":<Double_value>,
"caotherididcachebytes":<Double_value>,
"calaptpdsktpbyteshr":<Double_value>,
"caflvvidcachebytes":<Double_value>,
"caalptopdsktpbytesrate":<Double_value>,
"cacflvvidrate":<Double_value>,
"caaunindentifiedbyteshr":<Double_value>,
"caapplelivestreamingplaylistvidcachebytes":<Double_value>,
"catotrequests":<Double_value>,
"cacflvvidhr":<Double_value>,
"caadtsaudiocachebyteshr":<Double_value>,
"caiosbytesrate":<Double_value>,
"cacmp4vidrate":<Double_value>,
"catotlookuphit":<Double_value>,
"caadtsaudiobytesrate":<Double_value>,
"ca3pvid":<Double_value>,
"calaptopdesktpcache":<Double_value>,
"camsftsmthstrmplvidbytes":<Double_value>,
"caiosidcachebytesrate":<Double_value>,
"ca3gpvidbytesrate":<Double_value>,
"caunidentifiedcache":<Double_value>,
"caapplelivestreamingvidcachebytesrate":<Double_value>,
"caapplelivestreamingvidbytes":<Double_value>,
"caflvvidcachebyteshr":<Double_value>,
"caaunindentifiedbytesrate":<Double_value>,
"caios":<Double_value>,
"caiosrate":<Double_value>,
"caandroidbytes":<Double_value>,
"caotherrate":<Double_value>,
"caflvvidbytes":<Double_value>,
"calaptpdektpbytes":<Double_value>,
"caapplelivestreamingplaylistvidcachebytesrate":<Double_value>,
"camsftsmthstrmplvidbytesrate":<Double_value>,
"caaacaudiorate":<Double_value>,
"ca3gpvidhr":<Double_value>,
"calaptopdesktprate":<Double_value>,
"camp4vidrate":<Double_value>,
"cacadtsaudiohr":<Double_value>,
"cacapplelivestrmngvid":<Double_value>,
"caaacaudiocachebytesrate":<Double_value>,
"caapplelivestreamingvidbytesrate":<Double_value>,
"cacaplelivestrmngvidrate":<Double_value>,
"caunidentifiedhr":<Double_value>,
"cagetobjreqrate":<Double_value>,
"camp4vidcachebyteshr":<Double_value>,
"calaptopdesktphr":<Double_value>,
"camsftsmthstrmvidbytesrate":<Double_value>,
"camsftsmthstrmngvidcabyteshr":<Double_value>,
"camicrosoftsmoothstreamingplaylistvidcachebytes":<Double_value>,
"caiosbytes":<Double_value>,
"calaptopdesktp":<Double_value>,
"caothercacherate":<Double_value>,
"camp4vidcachebytesrate":<Double_value>,
"cacaacaudiohr":<Double_value>,
"caotherididcachebytesrate":<Double_value>,
"camsftsmthstrmvidbytes":<Double_value>,
"cacmsftsmthstrmplvidhr":<Double_value>,
"calaptopdesktpcacherate":<Double_value>,
"ca3gpvidbytes":<Double_value>,
"caotherbytes":<Double_value>,
"carequestsrate":<Double_value>,
"caunidentifiedbytesrate":<Double_value>,
"ca3gpvidcachebyteshr":<Double_value>,
"caadtsaudiocachebytes":<Double_value>,
"caadtsaudio":<Double_value>,
"caadtsaudiocachebytesrate":<Double_value>,
"ca3gpvidrate":<Double_value>,
"caioscache":<Double_value>,
"caaunindentifiedbytes":<Double_value>,
"cacapplelivestreamingplaylistvidhr":<Double_value>,
"caunidentified":<Double_value>,
"caandroid":<Double_value>,
"caapplelivestreamingplaylistvidbytes":<Double_value>,
"camp4vidbytes":<Double_value>,
"caunidentifiedrate":<Double_value>,
"cacaacaudio":<Double_value>,
"cacflvvid":<Double_value>,
"catotgetobjreq":<Double_value>,
"caotherbyteshr":<Double_value>,
"caioshr":<Double_value>,
"calaptpdektpbytesrate":<Double_value>,
"caandroididcachebytes":<Double_value>,
"caflvvid":<Double_value>,
"cacadtsaudiorate":<Double_value>,
"caandroidbyteshr":<Double_value>,
"caandroididcachebytesrate":<Double_value>,
"cacmp4vid":<Double_value>,
"caandroidbytesrate":<Double_value>,
"cacmsftsmthstrmplvidrate":<Double_value>,
"caadtsaudiorate":<Double_value>,
"camp4vid":<Double_value>,
"caunidentifiedcacherate":<Double_value>,
"caandroidcacherate":<Double_value>,
"cavideorate":<Double_value>,
"camicrosoftsmoothstreamingplaylistvidcachebytesrate":<Double_value>,
"caaacaudio":<Double_value>,
"catotother":<Double_value>,
"cacapplelivestreamingvidrate":<Double_value>,
"cacapplelivestreamingvid":<Double_value>,
"caandroidhr":<Double_value>,
"cacmsftsmthstrmvidrate":<Double_value>,
"caioscacherate":<Double_value>,
"caunidentifiedbytes":<Double_value>,
"caandroidrate":<Double_value>,
"cacaacaudiorate":<Double_value>,
"cacmsftsmthstrmvid":<Double_value>,
"camicrosoftsmoothstreamingvidcachebytes":<Double_value>,
"caother":<Double_value>,
"caalptopdsktpbytes":<Double_value>,
"caothercache":<Double_value>,
"camsftsmthstrvid":<Double_value>,
"camp4vidcachebytes":<Double_value>,
"ca3gpvid":<Double_value>,
"cacapplelivestrmngvidrate":<Double_value>,
"camicrosoftsmoothstreamingvidcachebytesrate":<Double_value>,
"catoherrate":<Double_value>,
"caotherhr":<Double_value>,
"camsftsmthstrmvidrate":<Double_value>,
"camsftsmthstrvidrate":<Double_value>,
"ca3gpvidcachebytes":<Double_value>,
"caaacaudiobytesrate":<Double_value>,
"camsftsmthstrmvid":<Double_value>,
"cacaplelivestrmngvid":<Double_value>,
"caapplelivestrmngvidcachebyteshr":<Double_value>,
"ca3pvidrate":<Double_value>,
"caandroidcache":<Double_value>,
"caflvvidcachebytesrate":<Double_value>,
"caiosidcachebytes":<Double_value>,
"caotherbytesrate":<Double_value>,
"caapplelivestreamingvidcachebytes":<Double_value>,
"caiosbyteshr":<Double_value>,
"catotaudio":<Double_value>
}]}

<!--NeedCopy-->
ca