ADC NITRO APIs

systementitydata

August 17, 2023

Contributed by:

Configuration for entity data resource.

Properties

(click to see Operations )

Name	Permissions	Description
type	Read-write	Specify the entity type.
name	Read-write	Specify the entity name.
alldeleted	Read-write	Specify this if you would like to delete information about all deleted entities from the database.
allinactive	Read-write	Specify this if you would like to delete information about all inactive entities from the database.
datasource	Read-write	Specifies the source which contains all the stored counter values.
core	Read-write	Specify core ID of the PE in nCore.
counters	Read-write	Specify the counters to be collected.
starttime	Read-write	Specify start time in mmddyyyyhhmm to start collecting values from that timestamp.
endtime	Read-write	Specify end time in mmddyyyyhhmm upto which values have to be collected.
last	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	Read-write	Specify the time period from current moment. Example 1 x where x = hours/ days/ years. Possible values = HOURS, DAYS, MONTHS
response	Read-only	.
startupdate	Read-only	.
lastupdate	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>

</b>

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

systementitydata

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

systementitydata

Properties

Operations

delete

get (all)

In this article