Skip to content

ns_configtemplate

Configuration for NetScaler configuration template resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
to_be_exported<Boolean>Read-writeSetting for enabling/disabling config audit diff report.
variable_vals<variable_values[]>Read-writeValues of Variables used in commands of the audit template.
isDefaultSchedule<Boolean>Read-writeScheduled specification for template or default polling interval.
commands<ns_command[]>Read-writeNS Configuration Commands.
name<String>Read-writeName of the configuration template.
Minimum length = 1
Maximum length = 128
variables<config_variable[]>Read-writeArray of variables used in commands of the configuration template.
description<String>Read-writeTemplate Description.
Minimum length = 1
Maximum length = 128
scheduleDetail<String>Read-writeSchedule Detail.
device_groups_db<String>Read-writeDevice Groups List Comma Seperated to store in DB.
last_updated_time<Integer>Read-writeLast Updated Time.
tenant_id<String>Read-writeTenant Id.
Minimum length = 1
Maximum length = 128
template_file<String>Read-writeTemplate File that is to be imported.
scheduleInfo<ns_configtemplate_scheduler>Read-writeScheduling information for audit template.
id<String>Read-writeId is system generated key for all the system users.
mail_profile<String>Read-writeMail profile name to send notification mail..
Minimum length = 1
Maximum length = 255
preview_commands<String[]>Read-writePreview of list of commands.
device_groups<String[]>Read-writeDevice Group Array for which audit template is added.
devices<String[]>Read-writeList of NS IP Address.
template_create_user<String>Read-onlyUser who created the template.

Operations

(click to see Properties)

IMPORT_VARIABLES_FILE| ADD| PREVIEW| DELETE| GET (ALL)| GET| MODIFY

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>.

import_variables_file

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate?action=import_variables_file;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_configtemplate: {
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"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>,
"display_name":<String_value>,
"type":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"command":<String_value>,
"parent_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>,
"display_name":<String_value>,
"type":<String_value>}],
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"devices":<String_value[]>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}

add

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_configtemplate: {
<b>"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"command":<String_value>,
"parent_name":<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>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"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>,
"display_name":<String_value>,
"type":<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>,
"display_name":<String_value>,
"type":<String_value>}],
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"description":<String_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}

preview

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate?action=preview;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_configtemplate: {
"to_be_exported":<Boolean_value>,
"variable_vals":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"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>,
"display_name":<String_value>,
"type":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"command":<String_value>,
"parent_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>,
"display_name":<String_value>,
"type":<String_value>}],
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"devices":<String_value[]>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}

modify

URL: https://<MGMT-IP>/nitro/v1/config/ns_configtemplate/id_value<String>

HTTP Method: null

Request Payload:

{ns_configtemplate:{
<b>"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"command":<String_value>,
"parent_name":<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>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"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>,
"display_name":<String_value>,
"type":<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>,
"display_name":<String_value>,
"type":<String_value>}],
"scheduleDetail":<String_value>,
"last_updated_time":<Integer_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"mail_profile":<String_value>,
"device_groups":<String_value[]>,
"isDefaultSchedule":<Boolean_value>,
"name":<String_value>,
"description":<String_value>,
"device_groups_db":<String_value>,
"preview_commands":<String_value[]>,
"scheduleInfo":<ns_configtemplate_scheduler_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_configtemplate":[{
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"device_values_mapping":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<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>}],
"isDefaultSchedule":<Boolean_value>,
"devicelistCombined":<String_value>,
"commands":[{
"index":<Integer_value>,
"parent_name":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<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>}],
"devicelist":<String_value>,
"description":<String_value>,
"scheduleDetail":<String_value>,
"device_groups_db":<String_value>,
"last_updated_time":<Integer_value>,
"template_create_user":<String_value>,
"tenant_id":<String_value>,
"template_file":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"preview_commands":<String_value>,
"device_groups":<String_value>,
"devices":<String_value>}]}