ns_hapair_template
Configuration for NS HA Pair Configure Template resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| nssecondary_ip_address | <String> | Read-write | Secondary HA Node NSIP Address. Minimum length = 1 Maximum length = 64 |
| backplane | <String> | Read-write | Backplane Interface. Minimum length = 1 Maximum length = 32 |
| clusterid | <Integer> | Read-write | Cluster Id. Minimum value = 1 Maximum value = |
| secondary_nodeid | <Integer> | Read-write | Secondary Node ID. Maximum value = |
| execute_sequentially | <Boolean> | Read-write | True if configuration template is to be applied to devices sequentially. |
| nsprimary_ip_address | <String> | Read-write | Primary HA Node NSIP Address. Minimum length = 1 Maximum length = 64 |
| clip | <String> | Read-write | Cluster IPAddress. Minimum length = 1 Maximum length = 64 |
| primary_ip_address | <String> | Read-write | Primary HA Node IP Address. Minimum length = 1 Maximum length = 64 |
| configCoordinator | <String> | Read-write | Node to be designated as Config Coordinator - primary or secondary. |
| scheduleTimesEpoch | <String> | Read-write | Schedule time epoch (string representation of 11 digit numbers).. |
| secondary_ip_address | <String> | Read-write | Secondary HA Node IP Address. Minimum length = 1 Maximum length = 64 |
| name | <String> | Read-write | Name. Maximum length = 128 |
| primary_nodeid | <Integer> | Read-write | Prmiary Node ID. Maximum value = |
| on_error | <String> | Read-write | Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT. Minimum length = 1 Maximum length = 16 |
| inc_enabled | <Boolean> | Read-write | Turn on INC mode on self node. |
| scheduleId | <String> | Read-write | scheduleId is used to refer maintenaince schedule task. |
| mail_profiles | <String> | Read-write | Comma seperated list of Mail profiles. |
| act_id | <String> | Read-only | Activity Id. |
Operations
(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>.
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":[{
"nssecondary_ip_address":<String_value>,
"backplane":<String_value>,
"clusterid":<Integer_value>,
"secondary_nodeid":<Integer_value>,
"execute_sequentially":<Boolean_value>,
"nsprimary_ip_address":<String_value>,
"act_id":<String_value>,
"clip":<String_value>,
"primary_ip_address":<String_value>,
"configCoordinator":<String_value>,
"scheduleTimesEpoch":<String_value>,
"secondary_ip_address":<String_value>,
"name":<String_value>,
"primary_nodeid":<Integer_value>,
"on_error":<String_value>,
"inc_enabled":<Boolean_value>,
"scheduleId":<String_value>,
"mail_profiles":<String_value>,
"sync_operation":<Boolean_value>}]}