Skip to content


Configuration for NS MPX Cluster Template resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
cco<String>Read-writeCCO IP address.
clip<String>Read-writeCluster IPAddress.
Minimum length = 1
Maximum length = 64
backplane<String>Read-writeBackplane Interface.
Minimum length = 1
Maximum length = 32
clusterid<Integer>Read-writeCluster Id.
Minimum value = 1
Maximum value =
devices<String[]>Read-writeDevice IP Address Array on which template is applied.


(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:


    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:



    Note: In such cases, make sure that the request header DOES not include the following:



Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_mpxcluster_template

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_mpxcluster_template":[{