Product Documentation

ca

Sep 08, 2016

Statistics for ca.

Properties (click to see Operations)

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

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://<netscaler-ip-address>/nitro/v1/stat/ca

Query-parameters:

args

http://<netscaler-ip-address>/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 NetScaler-specific errors). The response payload provides details of the error

Response 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>
}]}