43 lines
68 KiB
HTML
43 lines
68 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>ns_configtemplate</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">ns_configtemplate</p>
|
|
<P>Configuration for NetScaler configuration template resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">commands<span class="property_type"><ns_command[]></span></p><p class="property_description">NetScaler Configuration Commands.</p>
|
|
<p class="property_name">to_be_exported<span class="property_type"><Boolean></span></p><p class="property_description">Setting for enabling/disabling config audit diff report.</p>
|
|
<p class="property_name">template_file<span class="property_type"><String></span></p><p class="property_description">CSV file for importing variables.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the system users.</p>
|
|
<p class="property_name">isDefaultSchedule<span class="property_type"><Boolean></span></p><p class="property_description">Scheduled specification for template or default polling interval.</p>
|
|
<p class="property_name">mail_profile<span class="property_type"><String></span></p><p class="property_description">Mail profile name to send notification mail..<br> Minimum length = 1<br> Maximum length = 255</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Template Description.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">variables<span class="property_type"><config_variable[]></span></p><p class="property_description">Array of variables used in commands of the configuration template.</p>
|
|
<p class="property_name">variable_vals<span class="property_type"><variable_values[]></span></p><p class="property_description">Values of Variables used in commands of the audit template.</p>
|
|
<p class="property_name">scheduleInfo<span class="property_type"><ns_configtemplate_scheduler></span></p><p class="property_description">Scheduling information for audit template.</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of the configuration template.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">ignoresysuserpassword<span class="property_type"><Boolean></span></p><p class="property_description">When set to true, ignores password difference in diff command output.</p>
|
|
<p class="property_name">device_groups_db<span class="property_type"><String></span></p><p class="property_description">Device Groups List Comma separated to store in DB.</p>
|
|
<p class="property_name">slack_export<span class="property_type"><Boolean></span></p><p class="property_description">Setting for enabling/disabling config audit diff report for slack export.</p>
|
|
<p class="property_name">send_report_only_when_diff<span class="property_type"><Boolean></span></p><p class="property_description">Send notification report only when there is a diff.</p>
|
|
<p class="property_name">mail_export<span class="property_type"><Boolean></span></p><p class="property_description">Setting for enabling/disabling config audit diff report for mail export.</p>
|
|
<p class="property_name">slack_profile<span class="property_type"><String></span></p><p class="property_description">Slack profile name to send slack notification..<br> Minimum length = 1<br> Maximum length = 255</p>
|
|
<p class="property_name">devices<span class="property_type"><String[]></span></p><p class="property_description">List of NetScaler IP Address.</p>
|
|
<p class="property_name">preview_commands<span class="property_type"><String[]></span></p><p class="property_description">Preview of list of commands.</p>
|
|
<p class="property_name">device_groups<span class="property_type"><String[]></span></p><p class="property_description">Device Group Array for which audit template is added.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">template_create_user<span class="property_type"><String></span></p><p class="property_description">User who created the template.</p>
|
|
<p class="property_name">tenant_id<span class="property_type"><String></span></p><p class="property_description">Tenant Id.</p>
|
|
<p class="property_name">ns_configtemplate_create_user<span class="property_type"><String></span></p><p class="property_description">User who created the template.</p>
|
|
<p class="property_name">last_updated_time<span class="property_type"><Integer></span></p><p class="property_description">Last Updated Time.</p>
|
|
<p class="property_name">scheduleDetail<span class="property_type"><String></span></p><p class="property_description">Schedule Detail.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#modify" class="operation">modify</a><a href="#preview" class="operation">preview</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#import_variables_file" class="operation">import_variables_file</a><a href="#delete" class="operation">delete</a><a href="#add" class="operation">add</a><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ns_configtemplate":{<br><font color=#FF0000><b> "commands":[{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "command":<String_value></font>}]</b></font>,<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#FF0000><b> "devices":<String_value[]></b></font>,<br><font color=#000000> "send_report_only_when_diff":<Boolean_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "mail_export":<Boolean_value></font>,<br><font color=#000000> "ignoresysuserpassword":<Boolean_value></font>,<br><font color=#000000> "device_groups_db":<String_value></font>,<br><font color=#000000> "preview_commands":<String_value[]></font>,<br><font color=#000000> "slack_export":<Boolean_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "isDefaultSchedule":<Boolean_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br><font color=#000000> "variable_vals":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>}]</font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>}]</font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "values_enum":<String_value[]></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "required":<Boolean_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>}]</font>,<br><font color=#000000> "to_be_exported":<Boolean_value></font>,<br><font color=#000000> "template_file":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p><p class="heading"><a name="preview">preview</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?action=preview&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ns_configtemplate": {<br><font color=#000000> "device_groups_db":<String_value></font>,<br><font color=#000000> "slack_export":<Boolean_value></font>,<br><font color=#000000> "preview_commands":<String_value[]></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "send_report_only_when_diff":<Boolean_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "commands":[{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "command":<String_value></font>}]</font>,<br><font color=#000000> "to_be_exported":<Boolean_value></font>,<br><font color=#000000> "template_file":<String_value></font>,<br><font color=#000000> "isDefaultSchedule":<Boolean_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "ignoresysuserpassword":<Boolean_value></font>,<br><font color=#000000> "mail_export":<Boolean_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "values_enum":<String_value[]></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "required":<Boolean_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>}]</font>,<br><font color=#000000> "variable_vals":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>}]</font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>}]</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">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.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_configtemplate resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_configtemplate resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p><p class="heading"><a name="import_variables_file">import_variables_file</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?action=import_variables_file&onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ns_configtemplate": {<br><font color=#000000> "mail_export":<Boolean_value></font>,<br><font color=#000000> "ignoresysuserpassword":<Boolean_value></font>,<br><font color=#000000> "variable_vals":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>}]</font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>}]</font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "values_enum":<String_value[]></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "required":<Boolean_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>}]</font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "send_report_only_when_diff":<Boolean_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "preview_commands":<String_value[]></font>,<br><font color=#000000> "slack_export":<Boolean_value></font>,<br><font color=#000000> "device_groups_db":<String_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "isDefaultSchedule":<Boolean_value></font>,<br><font color=#000000> "template_file":<String_value></font>,<br><font color=#000000> "to_be_exported":<Boolean_value></font>,<br><font color=#000000> "commands":[{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "command":<String_value></font>}]</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/ns_configtemplate?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ns_configtemplate": {<br><font color=#FF0000><b> "commands":[{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "command":<String_value></font>}]</b></font>,<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#FF0000><b> "devices":<String_value[]></b></font>,<br><font color=#000000> "mail_export":<Boolean_value></font>,<br><font color=#000000> "ignoresysuserpassword":<Boolean_value></font>,<br><font color=#000000> "variables":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "values_enum":<String_value[]></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "required":<Boolean_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>}]</font>,<br><font color=#000000> "variable_vals":[{<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "default_value":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "device_values":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "device":<String_value></font>,<br><font color=#000000> "value":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "device_group":<String_value></font>}]</font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>}]</font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "send_report_only_when_diff":<Boolean_value></font>,<br><font color=#000000> "slack_export":<Boolean_value></font>,<br><font color=#000000> "preview_commands":<String_value[]></font>,<br><font color=#000000> "device_groups_db":<String_value></font>,<br><font color=#000000> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br><font color=#000000> "isDefaultSchedule":<Boolean_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "template_file":<String_value></font>,<br><font color=#000000> "to_be_exported":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ns_configtemplate":[{<br> "commands":[{<br> "index":<Integer_value></font>,<br> "parent_name":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "command":<String_value></font>}],<br> "to_be_exported":<Boolean_value></font>,<br> "devicelistCombined":<String_value></font>,<br> "template_file":<String_value></font>,<br> "devicelist":<String_value></font>,<br> "id":<String_value></font>,<br> "template_create_user":<String_value></font>,<br> "isDefaultSchedule":<Boolean_value></font>,<br> "mail_profile":<String_value></font>,<br> "description":<String_value></font>,<br> "variables":[{<br> "valuex":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "type":<String_value></font>,<br> "id":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "default_value":<String_value></font>,<br> "name":<String_value></font>}],<br> "variable_vals":[{<br> "description":<String_value></font>,<br> "value":<String_value></font>,<br> "device_values":[{<br> "value":<String_value></font>,<br> "id":<String_value></font>,<br> "device":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "device_group":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "valuex":<String_value></font>}],<br> "parent_id":<String_value></font>,<br> "name":<String_value></font>,<br> "default_value":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "valuex":<String_value></font>,<br> "device_values_mapping":<String_value></font>,<br> "id":<String_value></font>,<br> "type":<String_value></font>}],<br> "scheduleInfo":<ns_configtemplate_scheduler_value></font>,<br> "name":<String_value></font>,<br> "ignoresysuserpassword":<Boolean_value></font>,<br> "device_groups_db":<String_value></font>,<br> "tenant_id":<String_value></font>,<br> "ns_configtemplate_create_user":<String_value></font>,<br> "slack_export":<Boolean_value></font>,<br> "send_report_only_when_diff":<Boolean_value></font>,<br> "mail_export":<Boolean_value></font>,<br> "last_updated_time":<Integer_value></font>,<br> "slack_profile":<String_value></font>,<br> "scheduleDetail":<String_value></font>,<br> "devices":<String_value></font>,<br> "preview_commands":<String_value></font>,<br> "device_groups":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|