Download full document:

systementitydata

Configuration for entity data resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
type<String>Read-writeSpecify the entity type.
name<String>Read-writeSpecify the entity name.
alldeleted<Boolean>Read-writeSpecify this if you would like to delete information about all deleted entities from the database.
allinactive<Boolean>Read-writeSpecify this if you would like to delete information about all inactive entities from the database.
datasource<String>Read-writeSpecifies the source which contains all the stored counter values.
core<Integer>Read-writeSpecify core ID of the PE in nCore.
counters<String>Read-writeSpecify the counters to be collected.
starttime<String>Read-writeSpecify start time in mmddyyyyhhmm to start collecting values from that timestamp.
endtime<String>Read-writeSpecify end time in mmddyyyyhhmm upto which values have to be collected.
last<Integer>Read-writeLast is literal way of saying a certain time period from the current moment. Example: -last 1 hour, -last 1 day, et cetera.<br>Default value: 1
unit<String>Read-writeSpecify the time period from current moment. Example 1 x where x = hours/ days/ years.<br>Possible values = HOURS, DAYS, MONTHS
response<String>Read-only.
startupdate<Double>Read-only.
lastupdate<Double>Read-only.

Operations

(click to see Properties)

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

delete

URL: http://<NSIP>/nitro/v1/config/systementitydata

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/systementitydata/_value<>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/systementitydata

Query-parameters:

args

http://<NSIP>/nitro/v1/config/systementitydata?args= "type":<String_value>, "name":<String_value>, "counters":<String_value>, "starttime":<String_value>, "endtime":<String_value>, "last":<Integer_value>, "unit":<String_value>, "datasource":<String_value>, "core":<Integer_value>,

Use this query-parameter to get systementitydata resources based on additional properties.

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "systementitydata": [ {
      "type":<String_value>,
      "name":<String_value>,
      "counters":<String_value>,
      "starttime":<String_value>,
      "endtime":<String_value>,
      "last":<Integer_value>,
                  "unit":<String_value>,
      "datasource":<String_value>,
      "core":<Integer_value>,
      "response":<String_value>,
      "startupdate":<Double_value>,
      "lastupdate":<Double_value>

}]}