ns_configtemplate

Configuration for NetScaler configuration template resource.

Read/write properties

commands<ns_command[]>

NetScaler Configuration Commands.

to_be_exported<Boolean>

Setting for enabling/disabling config audit diff report.

template_file<String>

CSV file for importing variables.

id<String>

Id is system generated key for all the system users.

isDefaultSchedule<Boolean>

Scheduled specification for template or default polling interval.

mail_profile<String>

Mail profile name to send notification mail..
Minimum length = 1
Maximum length = 255

description<String>

Template Description.
Minimum length = 1
Maximum length = 128

variables<config_variable[]>

Array of variables used in commands of the configuration template.

variable_vals<variable_values[]>

Values of Variables used in commands of the audit template.

scheduleInfo<ns_configtemplate_scheduler>

Scheduling information for audit template.

name<String>

Name of the configuration template.
Minimum length = 1
Maximum length = 128

ignoresysuserpassword<Boolean>

When set to true, ignores password difference in diff command output.

device_groups_db<String>

Device Groups List Comma separated to store in DB.

slack_export<Boolean>

Setting for enabling/disabling config audit diff report for slack export.

send_report_only_when_diff<Boolean>

Send notification report only when there is a diff.

mail_export<Boolean>

Setting for enabling/disabling config audit diff report for mail export.

slack_profile<String>

Slack profile name to send slack notification..
Minimum length = 1
Maximum length = 255

devices<String[]>

List of NetScaler IP Address.

preview_commands<String[]>

Preview of list of commands.

device_groups<String[]>

Device Group Array for which audit template is added.

Read only properties

template_create_user<String>

User who created the template.

tenant_id<String>

Tenant Id.

ns_configtemplate_create_user<String>

User who created the template.

last_updated_time<Integer>

Last Updated Time.

scheduleDetail<String>

Schedule Detail.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

modify preview get (all)get import_variables_file delete add

modify

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

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_configtemplate":{
      "commands":[{
      "id":<String_value>,
      "parent_id":<String_value>,
      "parent_name":<String_value>,
      "command":<String_value>}],
      "id":<String_value>,
      "devices":<String_value[]>,
      "send_report_only_when_diff":<Boolean_value>,
      "device_groups":<String_value[]>,
      "slack_profile":<String_value>,
      "mail_export":<Boolean_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "device_groups_db":<String_value>,
      "preview_commands":<String_value[]>,
      "slack_export":<Boolean_value>,
      "description":<String_value>,
      "mail_profile":<String_value>,
      "isDefaultSchedule":<Boolean_value>,
      "name":<String_value>,
      "scheduleInfo":<ns_configtemplate_scheduler_value>,
      "variable_vals":[{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "parent_name":<String_value>,
      "default_value":<String_value>,
      "values_enum_db":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "device":<String_value>,
      "value":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>}],
      "parent_id":<String_value>,
      "display_name":<String_value>}],
      "variables":[{
      "name":<String_value>,
      "parent_name":<String_value>,
      "valuex":<String_value>,
      "values_enum":<String_value[]>,
      "id":<String_value>,
      "required":<Boolean_value>,
      "type":<String_value>,
      "description":<String_value>,
      "display_name":<String_value>,
      "parent_id":<String_value>,
      "values_enum_db":<String_value>,
      "default_value":<String_value>}],
      "to_be_exported":<Boolean_value>,
      "template_file":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{
      "commands":[{
      "index":<Integer_value>,
      "parent_name":<String_value>,
      "id":<String_value>,
      "parent_id":<String_value>,
      "command":<String_value>}],
      "to_be_exported":<Boolean_value>,
      "devicelistCombined":<String_value>,
      "template_file":<String_value>,
      "devicelist":<String_value>,
      "id":<String_value>,
      "template_create_user":<String_value>,
      "isDefaultSchedule":<Boolean_value>,
      "mail_profile":<String_value>,
      "description":<String_value>,
      "variables":[{
      "valuex":<String_value>,
      "values_enum":<String_value>,
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "required":<Boolean_value>,
      "type":<String_value>,
      "id":<String_value>,
      "parent_id":<String_value>,
      "description":<String_value>,
      "values_enum_db":<String_value>,
      "default_value":<String_value>,
      "name":<String_value>}],
      "variable_vals":[{
      "description":<String_value>,
      "value":<String_value>,
      "device_values":[{
      "value":<String_value>,
      "id":<String_value>,
      "device":<String_value>,
      "parent_name":<String_value>,
      "device_group":<String_value>,
      "parent_id":<String_value>,
      "valuex":<String_value>}],
      "parent_id":<String_value>,
      "name":<String_value>,
      "default_value":<String_value>,
      "values_enum_db":<String_value>,
      "parent_name":<String_value>,
      "display_name":<String_value>,
      "valuex":<String_value>,
      "device_values_mapping":<String_value>,
      "id":<String_value>,
      "type":<String_value>}],
      "scheduleInfo":<ns_configtemplate_scheduler_value>,
      "name":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "device_groups_db":<String_value>,
      "tenant_id":<String_value>,
      "ns_configtemplate_create_user":<String_value>,
      "slack_export":<Boolean_value>,
      "send_report_only_when_diff":<Boolean_value>,
      "mail_export":<Boolean_value>,
      "last_updated_time":<Integer_value>,
      "slack_profile":<String_value>,
      "scheduleDetail":<String_value>,
      "devices":<String_value>,
      "preview_commands":<String_value>,
      "device_groups":<String_value>}]}

preview

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_configtemplate": {
      "device_groups_db":<String_value>,
      "slack_export":<Boolean_value>,
      "preview_commands":<String_value[]>,
      "device_groups":<String_value[]>,
      "send_report_only_when_diff":<Boolean_value>,
      "slack_profile":<String_value>,
      "commands":[{
      "id":<String_value>,
      "parent_id":<String_value>,
      "parent_name":<String_value>,
      "command":<String_value>}],
      "to_be_exported":<Boolean_value>,
      "template_file":<String_value>,
      "isDefaultSchedule":<Boolean_value>,
      "description":<String_value>,
      "scheduleInfo":<ns_configtemplate_scheduler_value>,
      "name":<String_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "mail_export":<Boolean_value>,
      "id":<String_value>,
      "devices":<String_value[]>,
      "mail_profile":<String_value>,
      "variables":[{
      "name":<String_value>,
      "parent_name":<String_value>,
      "valuex":<String_value>,
      "values_enum":<String_value[]>,
      "id":<String_value>,
      "required":<Boolean_value>,
      "type":<String_value>,
      "description":<String_value>,
      "display_name":<String_value>,
      "parent_id":<String_value>,
      "values_enum_db":<String_value>,
      "default_value":<String_value>}],
      "variable_vals":[{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "parent_name":<String_value>,
      "default_value":<String_value>,
      "values_enum_db":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "device":<String_value>,
      "value":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>}],
      "parent_id":<String_value>,
      "display_name":<String_value>}]}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

get (all)

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

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_configtemplate resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?pagesize=#no&pageno=#no

Use this query-parameter to get the ns_configtemplate resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?count=yes

Use this query-parameter to get the count of ns_configtemplate resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

get

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

import_variables_file

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_configtemplate": {
      "mail_export":<Boolean_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "variable_vals":[{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "parent_name":<String_value>,
      "default_value":<String_value>,
      "values_enum_db":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "device":<String_value>,
      "value":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>}],
      "parent_id":<String_value>,
      "display_name":<String_value>}],
      "variables":[{
      "name":<String_value>,
      "parent_name":<String_value>,
      "valuex":<String_value>,
      "values_enum":<String_value[]>,
      "id":<String_value>,
      "required":<Boolean_value>,
      "type":<String_value>,
      "description":<String_value>,
      "display_name":<String_value>,
      "parent_id":<String_value>,
      "values_enum_db":<String_value>,
      "default_value":<String_value>}],
      "mail_profile":<String_value>,
      "devices":<String_value[]>,
      "id":<String_value>,
      "slack_profile":<String_value>,
      "send_report_only_when_diff":<Boolean_value>,
      "device_groups":<String_value[]>,
      "preview_commands":<String_value[]>,
      "slack_export":<Boolean_value>,
      "device_groups_db":<String_value>,
      "name":<String_value>,
      "scheduleInfo":<ns_configtemplate_scheduler_value>,
      "description":<String_value>,
      "isDefaultSchedule":<Boolean_value>,
      "template_file":<String_value>,
      "to_be_exported":<Boolean_value>,
      "commands":[{
      "id":<String_value>,
      "parent_id":<String_value>,
      "parent_name":<String_value>,
      "command":<String_value>}]}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

add

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"ns_configtemplate": {
      "commands":[{
      "id":<String_value>,
      "parent_id":<String_value>,
      "parent_name":<String_value>,
      "command":<String_value>}],
      "name":<String_value>,
      "devices":<String_value[]>,
      "mail_export":<Boolean_value>,
      "ignoresysuserpassword":<Boolean_value>,
      "variables":[{
      "name":<String_value>,
      "parent_name":<String_value>,
      "valuex":<String_value>,
      "values_enum":<String_value[]>,
      "id":<String_value>,
      "required":<Boolean_value>,
      "type":<String_value>,
      "description":<String_value>,
      "display_name":<String_value>,
      "parent_id":<String_value>,
      "values_enum_db":<String_value>,
      "default_value":<String_value>}],
      "variable_vals":[{
      "name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "parent_name":<String_value>,
      "default_value":<String_value>,
      "values_enum_db":<String_value>,
      "device_values":[{
      "id":<String_value>,
      "device":<String_value>,
      "value":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>}],
      "parent_id":<String_value>,
      "display_name":<String_value>}],
      "mail_profile":<String_value>,
      "id":<String_value>,
      "slack_profile":<String_value>,
      "device_groups":<String_value[]>,
      "send_report_only_when_diff":<Boolean_value>,
      "slack_export":<Boolean_value>,
      "preview_commands":<String_value[]>,
      "device_groups_db":<String_value>,
      "scheduleInfo":<ns_configtemplate_scheduler_value>,
      "isDefaultSchedule":<Boolean_value>,
      "description":<String_value>,
      "template_file":<String_value>,
      "to_be_exported":<Boolean_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON