Skip to content


Configuration for NS HA Pair Configure Template resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
nssecondary_ip_address<String>Read-writeSecondary HA Node NSIP Address.
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 =
secondary_nodeid<Integer>Read-writeSecondary Node ID.
Maximum value =
execute_sequentially<Boolean>Read-writeTrue if configuration template is to be applied to devices sequentially.
nsprimary_ip_address<String>Read-writePrimary HA Node NSIP Address.
Minimum length = 1
Maximum length = 64
clip<String>Read-writeCluster IPAddress.
Minimum length = 1
Maximum length = 64
primary_ip_address<String>Read-writePrimary HA Node IP Address.
Minimum length = 1
Maximum length = 64
configCoordinator<String>Read-writeNode to be designated as Config Coordinator - primary or secondary.
scheduleTimesEpoch<String>Read-writeSchedule time epoch (string representation of 11 digit numbers)..
secondary_ip_address<String>Read-writeSecondary HA Node IP Address.
Minimum length = 1
Maximum length = 64
Maximum length = 128
primary_nodeid<Integer>Read-writePrmiary Node ID.
Maximum value =
on_error<String>Read-writeBehaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT.
Minimum length = 1
Maximum length = 16
inc_enabled<Boolean>Read-writeTurn on INC mode on self node.
scheduleId<String>Read-writescheduleId is used to refer maintenaince schedule task.
mail_profiles<String>Read-writeComma seperated list of Mail profiles.
act_id<String>Read-onlyActivity Id.


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

HTTP Method: null

Response Payload:

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