Skip to content
Was this article helpful?


Configuration for System Resources available for a tenant resource.


(click to see Operations )

Name Data Type Permissions Description
available_disk_size <Double> Read-write Available disk size.
max_plt_bw <Integer> Read-write Max Allowed Platinum bandwidth Mbps.
max_cpu_cores <Integer> Read-write Maximum number of CPU Cores.

Minimum value = 1

Maximum value =
parent_id <String> Read-write .
max_scu <Integer> Read-write Available number of Symmetric Crypto Units.
tenant_id <String> Read-write Id of the parent tenant.
max_disk_size <Double> Read-write Maximum Disk Space.
max_instances <Integer> Read-write Maximum number of Instances.

Minimum value = 1

Maximum value =
id <String> Read-write .
parent_name <String> Read-write .
available_instances <Integer> Read-write Available number of instances.

Maximum value =
max_std_bw <Integer> Read-write Max Allowed Standard bandwidth Mbps.
max_memory <Double> Read-write Maximum Memory.
max_ent_bw <Integer> Read-write Max Allowed Enterprise bandwidth Mbps.
available_memory <Double> Read-write Available memory.
max_ssl_cards <Integer> Read-write Maximum number of SSL cores.
available_cpu_cores <Integer> Read-write Available number of CPU Cores.

Maximum value =
max_acu <Integer> Read-write Available number of Asymmetric Crypto Units.
available_scu <Integer> Read-only Available number of Symmetric Crypto Units.
max_pps <String> Read-only Maximum PPS .
available_std_bw <Integer> Read-only Available Standard bandwidth in Mbps.
available_pps <String> Read-only Available PPS.
available_throughput <String> Read-only Available Throughput in Mbps.
available_acu <Integer> Read-only Available number of Asymmetric Crypto Units.
max_throughput <String> Read-only Maximum Throughput in Mbps.
available_ent_bw <Integer> Read-only Available Enterprise bandwidth in Mbps.
available_ssl_cards <Integer> Read-only Available number of SSL Cores.
available_plt_bw <Integer> Read-only Available Platinum bandwidth in Mbps.


(click to see Properties )

    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

    The following parameters can be used in the nitro request : onerror <String_value>

    Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

    Default value: EXIT

    Possible values = EXIT, CONTINUE

    Was this article helpful?