Skip to content

nscapacity

Configuration for capacity resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
bandwidth <Double> Read-write System bandwidth limit.
platform <String> Read-write appliance platform type.

Possible values = VS10, VE10, VP10, VS25, VE25, VP25, VS200, VE200, VP200, VS1000, VE1000, VP1000, VS3000, VE3000, VP3000, VS5000, VE5000, VP5000, VS8000, VE8000, VP8000, VS10000, VE10000, VP10000, VS15000, VE15000, VP15000, VS25000, VE25000, VP25000, VS40000, VE40000, VP40000, VS100000, VE100000, VP100000, CP1000
vcpu <Boolean> Read-write licensed using vcpu pool.
edition <String> Read-write Product edition.

Possible values = Standard, Enterprise, Platinum
unit <String> Read-write Bandwidth unit.

Possible values = Gbps, Mbps
nodeid <Double> Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
actualbandwidth <Double> Read-only Bandwith in MBPS.
vcpucount <Double> Read-only number of vCPUs licensed.

Minimum value = 1

Maximum value = 20
maxvcpucount <Double> Read-only number of max vCPUs.

Minimum value = 1

Maximum value = 20
maxbandwidth <Double> Read-only Maximum Bandwidth.
minbandwidth <Double> Read-only Minimum Bandwidth.
instancecount <Double> Read-only VPX will consume one instance and MPX will consume zero instance.

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • 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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nscapacity":{
      "bandwidth":<Double_value>,
      "platform":<String_value>,
      "vcpu":<Boolean_value>,
      "edition":<String_value>,
      "unit":<String_value>
}}

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/nscapacity? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nscapacity":{
      "bandwidth":true,
      "platform":true,
      "vcpu":true
}}

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/nscapacity

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/nscapacity? args=nodeid: <Double_value>

Use this query-parameter to get nscapacity 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:

{ "nscapacity": [ {
nodeid:<Double_value>      "actualbandwidth":<Double_value>,
      "platform":<String_value>,
      "vcpucount":<Double_value>,
      "maxvcpucount":<Double_value>,
      "edition":<String_value>,
      "unit":<String_value>,
      "bandwidth":<Double_value>,
      "maxbandwidth":<Double_value>,
      "minbandwidth":<Double_value>,
      "instancecount":<Double_value>
}]}