ns_configtemplate
Properties
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| to_be_exported | <Boolean> | Read-write | Setting for enabling/disabling config audit diff report. |
| variable_vals | <variable_values[]> | Read-write | Values of Variables used in commands of the audit template. |
| commands | <ns_command[]> | Read-write | Citrix ADC Configuration Commands. |
| variables | <config_variable[]> | Read-write | Array of variables used in commands of the configuration template. |
| slack_profile | <String> | Read-write | Slack profile name to send slack notification.. Minimum length = 1 Maximum length = 255 |
| mail_export | <Boolean> | Read-write | Setting for enabling/disabling config audit diff report for mail export. |
| template_file | <String> | Read-write | CSV file for importing variables. |
| send_report_only_when_diff | <Boolean> | Read-write | Send notification report only when there is a diff. |
| id | <String> | Read-write | Id is system generated key for all the system users. |
| mail_profile | <String> | Read-write | Mail profile name to send notification mail.. Minimum length = 1 Maximum length = 255 |
| slack_export | <Boolean> | Read-write | Setting for enabling/disabling config audit diff report for slack export. |
| isDefaultSchedule | <Boolean> | Read-write | Scheduled specification for template or default polling interval. |
| name | <String> | Read-write | Name of the configuration template. Minimum length = 1 Maximum length = 128 |
| description | <String> | Read-write | Template Description. Minimum length = 1 Maximum length = 128 |
| ignoresysuserpassword | <Boolean> | Read-write | When set to true, ignores password difference in diff command output. |
| device_groups_db | <String> | Read-write | Device Groups List Comma separated to store in DB. |
| scheduleInfo | <ns_configtemplate_scheduler> | Read-write | Scheduling information for audit template. |
| preview_commands | <String[]> | Read-write | Preview of list of commands. |
| device_groups | <String[]> | Read-write | Device Group Array for which audit template is added. |
| devices | <String[]> | Read-write | List of Citrix ADC IP Address. |
| scheduleDetail | <String> | Read-only | Schedule Detail. |
| last_updated_time | <Integer> | Read-only | Last Updated Time. |
| tenant_id | <String> | Read-only | Tenant Id. |
| template_create_user | <String> | Read-only | User who created the template. |
Operations
- IMPORT_VARIABLES_FILE
- ADD
- PREVIEW
- DELETE
- GET (ALL)
- GET
- MODIFY
-
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=yesIf 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
import_variables_file
{"ns_configtemplate": {
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>}],
"display_name":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>}],
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_export":<Boolean_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"devices":<String_value[]>,
"ignoresysuserpassword":<Boolean_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}
add
{"ns_configtemplate": {
<b>"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}]</b>,
<b>"name":<String_value></b>,
<b>"devices":<String_value[]></b>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>}],
"display_name":<String_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>}],
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_export":<Boolean_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}
preview
{"ns_configtemplate": {
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>}],
"display_name":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>}],
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_export":<Boolean_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"devices":<String_value[]>,
"ignoresysuserpassword":<Boolean_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}
delete
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
get (all)
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}
get
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}
modify
{"ns_configtemplate":{
<b>"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}]</b>,
<b>"id":<String_value></b>,
<b>"devices":<String_value[]></b>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>}],
"display_name":<String_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>}],
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_export":<Boolean_value>,
"send_report_only_when_diff":<Boolean_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"valuex":<String_value>,
"device_group":<String_value>,
"device":<String_value>,
"parent_id":<String_value>}],
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>}],
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"valuex":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"slack_profile":<String_value>,
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"mail_export":<Boolean_value>,
"template_file":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"slack_export":<Boolean_value>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"devicelist":<String_value>,
"description":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"template_create_user":<String_value>,
"device_groups_db":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}