Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nspartition

August 17, 2023
Contributed by: 
C

Configuration for admin partition resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
partitionname <String> Read-write Name of the Partition. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

Minimum length = 1
maxbandwidth <Double> Read-write Maximum bandwidth, in Kbps, that the partition can consume. A zero value indicates the bandwidth is unrestricted on the partition and it can consume up to the system limits.

Default value: 10240
minbandwidth <Double> Read-write Minimum bandwidth, in Kbps, that the partition can consume. A zero value indicates the bandwidth is unrestricted on the partition and it can consume up to the system limits.

Default value: 10240
maxconn <Double> Read-write Maximum number of concurrent connections that can be open in the partition. A zero value indicates no limit on number of open connections.

Default value: 1024
maxmemlimit <Double> Read-write Maximum memory, in megabytes, allocated to the partition. A zero value indicates the memory is unlimited on the partition and it can consume up to the system limits.

Default value: 10

Minimum value = 0

Maximum value = 1048576
partitionmac <String> Read-write Special MAC address for the partition which is used for communication over shared vlans in this partition. If not specified, the MAC address is auto-generated.
force <Boolean> Read-write Switches to new admin partition without prompt for saving configuration. Configuration will not be saved.
save <Boolean> Read-write Switches to new admin partition without prompt for saving configuration. Configuration will be saved.
partitionid <Double> Read-only Partition Id.

Minimum value = 1
partitiontype <String> Read-only Type of the Partition.

Possible values = Default Partition, Current Partition
pmacinternal <Boolean> Read-only Partition MAC is generated internally.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • SWITCH
  • GET (ALL)
  • GET
  • COUNT

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"nspartition":{
<b>"partitionname":<String_value>,
</b>"maxbandwidth":<Double_value>,
"minbandwidth":<Double_value>,
"maxconn":<Double_value>,
"maxmemlimit":<Double_value>,
"partitionmac":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition/ partitionname_value<String> 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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"nspartition":{
<b>"partitionname":<String_value>,
</b>"maxbandwidth":<Double_value>,
"minbandwidth":<Double_value>,
"maxconn":<Double_value>,
"maxmemlimit":<Double_value>,
"partitionmac":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"nspartition":{
<b>"partitionname":<String_value>,
</b>"maxbandwidth":true,
"minbandwidth":true,
"maxconn":true,
"maxmemlimit":true,
"partitionmac":true
}}

<!--NeedCopy-->

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

Switch

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition? action=Switch HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"nspartition":{
<b>"partitionname":<String_value>,
</b>"force":<Boolean_value>,
"save":<Boolean_value>
}}

<!--NeedCopy-->

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/nspartition Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/nspartition? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/nspartition? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of nspartition resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/nspartition? view=summary

Use this query-parameter to get the summary output of nspartition resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/nspartition? pagesize=#no;pageno=#no

Use this query-parameter to get the nspartition resources in chunks.

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: 

{ "nspartition": [ {
"partitionname":<String_value>,
"partitionid":<Double_value>,
"partitiontype":<String_value>,
"maxbandwidth":<Double_value>,
"minbandwidth":<Double_value>,
"maxconn":<Double_value>,
"maxmemlimit":<Double_value>,
"partitionmac":<String_value>,
"pmacinternal":<Boolean_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition/ partitionname_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/nspartition/ partitionname_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/nspartition/ partitionname_value<String> ? view=summary

Use this query-parameter to get the summary output of nspartition resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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: 

{  "nspartition": [ {
"partitionname":<String_value>,
"partitionid":<Double_value>,
"partitiontype":<String_value>,
"maxbandwidth":<Double_value>,
"minbandwidth":<Double_value>,
"maxconn":<Double_value>,
"maxmemlimit":<Double_value>,
"partitionmac":<String_value>,
"pmacinternal":<Boolean_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nspartition? count=yes 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: 

{ "nspartition": [ { "__count": "#no"} ] }

<!--NeedCopy-->
nspartition
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.