Skip to content

nspartition

Statistics for admin partition resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
partitionname<String>Read-writeName of the partition.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
maxbandwidth<Double>Read-onlyMaximum Banwidth allowed for the partition.
maxconnection<Double>Read-onlyMaximum Connection allowed for the partition.
maxmemory<Double>Read-onlyMaximum memory limit for the partition.
currentbandwidth<Double>Read-onlyCurrent Bandwidth usage for the partition.
currentconnections<Double>Read-onlyCurrent Connections on this partition.
memoryusagepcnt<Double>Read-onlyMemory usage(%) on this partition.
totaldrops<Double>Read-onlyTotal packet drops for the partition.
dropsrate<Double>Read-onlyRate (/s) counter for totaldrops
totaltokendrops<Double>Read-onlyTotal drops(KB) for the partition.
tokendropsrate<Double>Read-onlyRate (/s) counter for totaltokendrops
totalconnectiondrops<Double>Read-onlyTotal connection drops for the partition.
connectiondropsrate<Double>Read-onlyRate (/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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nspartition

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nspartition/partitionname_value><String>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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