Skip to content
Was this article helpful?

devicewise_detail_summary

Configuration for Ns event devices summary resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
is_agent <Boolean> Read-write Is this device acting as Gateway..
memory_usage <Double> Read-write memory usage of a device.
cityname <String> Read-write City Name.

Maximum length = 255
agent_name <String> Read-write Agent Name.

Maximum length = 255
agent_id <String> Read-write Agent Id.

Maximum length = 255
throughput <Double> Read-write Assign throughput in Mbps to VM Instance.
type <String> Read-write Type of device, (Xen | NS).

Minimum length = 1

Maximum length = 64
instances <String> Read-only Total number of devices managed by this agent.
agent_ip_address <String> Read-only Total number of devices deployed city wise...
total_events <Integer> Read-only Total minor events..
tenant_id <String> Read-only Tenant Id.
vm_cpu_usage <Double> Read-only CPU Usage (%) of VM Instance.
ip_address <String> Read-only Total number of devices deployed city wise...
instance_state <String> Read-only State of device, UP only if device accessible.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/devicewise_detail_summary

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/devicewise_detail_summary ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of devicewise_detail_summary resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/devicewise_detail_summary ?pagesize=#no;pageno=#no

Use this query-parameter to get the devicewise_detail_summary resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/devicewise_detail_summary ?count=yes

Use this query-parameter to get the count of devicewise_detail_summary resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "devicewise_detail_summary":[{
      "instances":<String_value>,
      "is_agent":<Boolean_value>,
      "memory_usage":<Double_value>,
      "agent_ip_address":<String_value>,
      "total_events":<Integer_value>,
      "cityname":<String_value>,
      "tenant_id":<String_value>,
      "agent_name":<String_value>,
      "agent_id":<String_value>,
      "vm_cpu_usage":<Double_value>,
      "throughput":<Double_value>,
      "ip_address":<String_value>,
      "instance_state":<String_value>,
      "type":<String_value>}]}
Was this article helpful?