NetScaler SDX 14.1 NITRO API Reference

ns_configtemplate

March 20, 2024

Contributed by:

Configuration for Citrix ADC configuration template resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
to_be_exported		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		Read-write	Slack profile name to send slack notification.. Minimum length = 1 Maximum length = 255
mail_export		Read-write	Setting for enabling/disabling config audit diff report for mail export.
template_file		Read-write	CSV file for importing variables.
send_report_only_when_diff		Read-write	Send notification report only when there is a diff.
id		Read-write	Id is system generated key for all the system users.
mail_profile		Read-write	Mail profile name to send notification mail.. Minimum length = 1 Maximum length = 255
slack_export		Read-write	Setting for enabling/disabling config audit diff report for slack export.
isDefaultSchedule		Read-write	Scheduled specification for template or default polling interval.
name		Read-write	Name of the configuration template. Minimum length = 1 Maximum length = 128
description		Read-write	Template Description. Minimum length = 1 Maximum length = 128
ignoresysuserpassword		Read-write	When set to true, ignores password difference in diff command output.
device_groups_db		Read-write	Device Groups List Comma separated to store in DB.
scheduleInfo		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		Read-only	Schedule Detail.
last_updated_time		Read-only	Last Updated Time.
tenant_id		Read-only	Tenant Id.
template_create_user		Read-only	User 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

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

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:

{"ns_configtemplate": {
"name":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"mail_export":<Boolean_value>,
"id":<String_value>,
"devices":<String_value[]>,
"send_report_only_when_diff":<Boolean_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"preview_commands":<String_value[]>,
"description":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_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>}],
"isDefaultSchedule":<Boolean_value>,
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_profile":<String_value>,
"device_groups_db":<String_value>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>,
"parent_id":<String_value>}],
"display_name":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}]}}

<!--NeedCopy-->

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:

{ "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>}]}

<!--NeedCopy-->

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:

{"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>,
"ignoresysuserpassword":<Boolean_value>,
"mail_export":<Boolean_value>,
"id":<String_value>,
"send_report_only_when_diff":<Boolean_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"preview_commands":<String_value[]>,
"description":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_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>}],
"isDefaultSchedule":<Boolean_value>,
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_profile":<String_value>,
"device_groups_db":<String_value>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>,
"parent_id":<String_value>}],
"display_name":<String_value>}]}}

<!--NeedCopy-->

Response Payload:

{ "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>}]}

<!--NeedCopy-->

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:

{"ns_configtemplate": {
"name":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"mail_export":<Boolean_value>,
"id":<String_value>,
"devices":<String_value[]>,
"send_report_only_when_diff":<Boolean_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"preview_commands":<String_value[]>,
"description":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_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>}],
"isDefaultSchedule":<Boolean_value>,
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_profile":<String_value>,
"device_groups_db":<String_value>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>,
"parent_id":<String_value>}],
"display_name":<String_value>}],
"commands":[{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"command":<String_value>}]}}

<!--NeedCopy-->

Response Payload:

{ "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>}]}

<!--NeedCopy-->

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 Payload:

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

<!--NeedCopy-->

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 Headers:

Content-Type:application/json

Response Payload:

{ "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>}]}

<!--NeedCopy-->

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 Headers:

Content-Type:application/json

Response Payload:

{ "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>}]}

<!--NeedCopy-->

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:

{"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>,
"name":<String_value>,
"ignoresysuserpassword":<Boolean_value>,
"mail_export":<Boolean_value>,
"send_report_only_when_diff":<Boolean_value>,
"slack_export":<Boolean_value>,
"device_groups":<String_value[]>,
"preview_commands":<String_value[]>,
"description":<String_value>,
"scheduleInfo":<ns_configtemplate_scheduler_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>}],
"isDefaultSchedule":<Boolean_value>,
"slack_profile":<String_value>,
"template_file":<String_value>,
"mail_profile":<String_value>,
"device_groups_db":<String_value>,
"to_be_exported":<Boolean_value>,
"variable_vals":[{
"parent_id":<String_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"value":<String_value>,
"name":<String_value>,
"description":<String_value>,
"type":<String_value>,
"valuex":<String_value>,
"device_values":[{
"parent_name":<String_value>,
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<String_value>,
"parent_id":<String_value>}],
"display_name":<String_value>}]}}

<!--NeedCopy-->

Response Payload:

{ "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>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns_configtemplate

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

ns_configtemplate

Properties

Operations

import_variables_file

add

preview

delete

get (all)

get

modify

In this article