Download full document:

nspartition

Statistics for admin partition resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
partitionname	<String>	Read-write	Name of the partition.<br>Minimum length = 1
clearstats	<String>	Read-write	Clear the statsistics / counters.<br>Possible values = basic, full
minbandwidth	<Double>	Read-only	Minimum Bandwidth required by the partition.
maxbandwidth	<Double>	Read-only	Maximum Banwidth allowed for the partition.
maxconnection	<Double>	Read-only	Maximum Connection allowed for the partition.
maxmemory	<Double>	Read-only	Maximum memory limit for the partition.
currentbandwidth	<Double>	Read-only	Current Bandwidth usage for the partition.
currentconnections	<Double>	Read-only	Current Connections on this partition.
memoryusagepcnt	<Double>	Read-only	Memory usage(%) on this partition.
totaldrops	<Double>	Read-only	Total packet drops for the partition.
dropsrate	<Double>	Read-only	Rate (/s) counter for totaldrops
totaltokendrops	<Double>	Read-only	Total drops(KB) for the partition.
tokendropsrate	<Double>	Read-only	Rate (/s) counter for totaltokendrops
totalconnectiondrops	<Double>	Read-only	Total connection drops for the partition.
connectiondropsrate	<Double>	Read-only	Rate (/s) counter for totalconnectiondrops

Operations

(click to see Properties)

GET (ALL) | GET

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: http://<netscaler-ip-address>/nitro/v1/stat/nspartition

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/nspartition?args=partitionname:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get nspartition 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nspartition": [ {
      "partitionname":<String_value>,
      "currentconnections":<Double_value>,
      "tokendropsrate":<Double_value>,
      "totaltokendrops":<Double_value>,
      "maxbandwidth":<Double_value>,
      "minbandwidth":<Double_value>,
      "totaldrops":<Double_value>,
      "connectiondropsrate":<Double_value>,
      "totalconnectiondrops":<Double_value>,
      "dropsrate":<Double_value>,
      "currentbandwidth":<Double_value>,
      "maxconnection":<Double_value>,
      "maxmemory":<Double_value>,
      "memoryusagepcnt":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/stat/nspartition/partitionname_value><String>