Skip to content

device

Configuration for AF Device Report table resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
__count<Double>Read-writecount..
cache_hits<Double>Read-writeTotal requests to this APP for cache hits in given sampled timeframe..
http_content_type_name<String>Read-writeHTTP Content TYPE Name..
Maximum length = 256
total_bytes_cache_bypass<Double>Read-writeCache Bypass total bytes accounted by this URL in sampled timeframe..
ic_non_cache_hits<Double>Read-writeTotal requests to this APP for cache bypass in given sampled timeframe..
id<String>Read-writeId is NetScaler IP Address.
Minimum length = 1
Maximum length = 64
total_bytes_cache_miss<Double>Read-writeCache Miss total bytes accounted by this URL in sampled timeframe..
ic_miss<Double>Read-writeTotal requests to this APP for cache miss in given sampled timeframe..
cache_miss<Double>Read-writeTotal requests to this APP for cache miss in given sampled timeframe..
name<String>Read-writeName of NetScaler Instance.
Minimum length = 1
Maximum length = 128
total_bytes<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
percent_bw_saved<Double>Read-writePercentage of bw save to this APP in given sampled timeframe..
total_bytes_ic_hits<Double>Read-writeIC Cache Hits total bytes accounted by this URL in sampled timeframe..
total_bytes_cache_hits<Double>Read-writeCache Hits total bytes accounted by this URL in sampled timeframe..
ic_no_store_reason<String>Read-writeic_no_store_reason..
Maximum length = 256
max_transaction_time<Double>Read-writeLast Transaction Time for this URL in the sampled timeframe..
cache_bypass<Double>Read-writeTotal requests to this APP for cache bypass in given sampled timeframe..
total_bytes_ic_miss<Double>Read-writeCache Miss total bytes accounted by this URL in sampled timeframe..
ip_address<String>Read-writeNetscaler IP Address..
Minimum length = 1
Maximum length = 64
percentage_usage<Double>Read-writePercentage_usage of this APP in given sampled timeframe..
ic_hits<Double>Read-writeTotal requests to this APP for cache hits in given sampled timeframe..
total_bytes_ic_reval<Double>Read-writeCache Reval total bytes accounted by this URL in sampled timeframe..
rpt_sample_time<Double>Read-writeReport Sample time..
ic_utilization<Double>Read-writeTotal IC utilization in given sampled timeframe..
ic_reval<Double>Read-writeTotal requests to this APP for cache bypass in given sampled timeframe..
total_requests<Double>Read-writeTotal Requests for this device in given sampled timeframe..
http_media_type_name<String>Read-writeHTTP MEDIA TYPE Name..
Maximum length = 30

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: https://<MGMT-IP>/nitro/v1/config/device

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device":[{
"__count":<Double_value>,
"cache_hits":<Double_value>,
"http_content_type_name":<String_value>,
"total_bytes_cache_bypass":<Double_value>,
"ic_non_cache_hits":<Double_value>,
"id":<String_value>,
"total_bytes_cache_miss":<Double_value>,
"operating_system_name":<String_value>,
"ic_miss":<Double_value>,
"vpn_user_name":<String_value>,
"cache_miss":<Double_value>,
"name":<String_value>,
"http_req_method_name":<String_value>,
"total_bytes":<Double_value>,
"user_agent_name":<String_value>,
"percent_bw_saved":<Double_value>,
"client_ip_address":<String_value>,
"total_bytes_ic_hits":<Double_value>,
"total_bytes_cache_hits":<Double_value>,
"ic_no_store_reason":<String_value>,
"http_resp_status_name":<String_value>,
"max_transaction_time":<Double_value>,
"uri_url":<String_value>,
"cache_bypass":<Double_value>,
"total_bytes_ic_miss":<Double_value>,
"app_unit_name":<String_value>,
"ip_address":<String_value>,
"percentage_usage":<Double_value>,
"ic_hits":<Double_value>,
"server_ip_address":<String_value>,
"total_bytes_ic_reval":<Double_value>,
"rpt_sample_time":<Double_value>,
"domain_name":<String_value>,
"ic_utilization":<Double_value>,
"ic_reval":<Double_value>,
"total_requests":<Double_value>,
"http_media_type_name":<String_value>}]}