Skip to content

systementitydata

Configuration for entity data resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
type <String> Read-write Specify the entity type.
name <String> Read-write Specify the entity name.
alldeleted <Boolean> Read-write Specify this if you would like to delete information about all deleted entities from the database.
allinactive <Boolean> Read-write Specify this if you would like to delete information about all inactive entities from the database.
datasource <String> Read-write Specifies the source which contains all the stored counter values.
core <Integer> Read-write Specify core ID of the PE in nCore.
counters <String> Read-write Specify the counters to be collected.
starttime <String> Read-write Specify start time in mmddyyyyhhmm to start collecting values from that timestamp.
endtime <String> Read-write Specify end time in mmddyyyyhhmm upto which values have to be collected.
last <Integer> Read-write Last is literal way of saying a certain time period from the current moment. Example: -last 1 hour, -last 1 day, et cetera.

Default value: 1
unit <String> Read-write Specify the time period from current moment. Example 1 x where x = hours/ days/ years.

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:// <netscaler-ip-address> /nitro/v1/config/systementitydata

Query-parameters:

args=type: <String_value> ,name: <String_value> ,alldeleted: <Boolean_value> ,allinactive: <Boolean_value> ,datasource: <String_value> ,core: <Integer_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/systementitydata

Query-parameters:

args

http:// <netscaler-ip-address> /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

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 Header:

Content-Type:application/json

Response Payload:

{ "systementitydata": [ {
<b>type:<String_value>,</b><b>name:<String_value>,</b><b>counters:<String_value>,</b>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>
}]}