config_template_temp
Configuration for Configuration Template Temporary Resource resource.
Related information
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| commands_str | <String> | Read-write | Configuration Template Commands separated by new line character. |
| device_family | <String> | Read-write | Family (ns/sdx/cbwanopt) of Devices for which config template is defined.. Minimum length = 1 Maximum length = 64 |
| variable_vals | <variable_values[]> | Read-write | Values of Variables used in commands of the configuration template. |
| commands | <config_command[]> | Read-write | Array of commands part of the configuration template. |
| name | <String> | Read-write | Name of config template based on action. Minimum length = 1 Maximum length = 128 |
| template_info | <configuration_template> | Read-write | Configuration Template to be executed/scheduled. |
| duration | <String> | Read-write | Duration today/last_1_day/last_1_week/current_month/last_1_month of Interval for which configuration changes are recorded. |
| variables | <config_variable[]> | Read-write | Array of variables used in commands of the configuration template. |
| description | <String> | Read-write | Description of config template. Minimum length = 1 Maximum length = 1024 |
| end_time | <Double> | Read-write | End Time of Interval for which configuration changes are recorded. |
| id | <String> | Read-write | Id is system generated key for all the configuration templates. |
| ip_address | <String> | Read-write | IP Address for which configuration temaplte generated/requested. Minimum length = 1 Maximum length = 64 |
| file_location_path | <String> | Read-write | File Location on Client for upload/download. |
| file_name | <String> | Read-write | File Name. |
| template_file | <String> | Read-write | Template File that is to be imported. |
| templates | <String[]> | Read-write | Templates List that are to be imported. |
Operations
(click to see Properties )
- ADD
- IMPORT_POST_UPGRADE_PRE_FAILOVER_SCRIPT_FILE
- GET (ALL)
- DELETE
- UPLOAD
- IMPORT_POST_UPGRADE_SCRIPT_FILE
- DOWNLOAD
- IMPORT_PRE_UPGRADE_SCRIPT_FILE
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=yesIf any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,To do this, you must specify the username and password in the request header of the NITRO request as follows:X-NITRO-USER: <username>X-NITRO-PASS: <password>Note: In such cases, make sure that the request header DOES not include the following:Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green
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
add
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"config_template_temp": {
"name":<String_value>,
"template_info":<configuration_template_value>,
"description":<String_value>,
"commands_str":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"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>}],
"file_location_path":<String_value>,
"end_time":<Double_value>,
"template_file":<String_value>,
"file_name":<String_value>,
"id":<String_value>,
"device_family":<String_value>,
"duration":<String_value>,
"templates":<String_value[]>,
"variable_vals":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"parent_id":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<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":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"ip_address":<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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_template_temp":[{
"commands_str":<String_value>,
"device_family":<String_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>}],
"start_time":<Double_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"name":<String_value>,
"template_info":<configuration_template_value>,
"duration":<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>}],
"description":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"template_file":<String_value>,
"templates":<String_value>}]}
import_post_upgrade_pre_failover_script_file
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp?action=import_post_upgrade_pre_failover_script_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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"config_template_temp": {
"name":<String_value>,
"template_info":<configuration_template_value>,
"description":<String_value>,
"commands_str":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"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>}],
"file_location_path":<String_value>,
"end_time":<Double_value>,
"template_file":<String_value>,
"file_name":<String_value>,
"id":<String_value>,
"device_family":<String_value>,
"duration":<String_value>,
"templates":<String_value[]>,
"variable_vals":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"parent_id":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<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":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"ip_address":<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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_template_temp":[{
"commands_str":<String_value>,
"device_family":<String_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>}],
"start_time":<Double_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"name":<String_value>,
"template_info":<configuration_template_value>,
"duration":<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>}],
"description":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"template_file":<String_value>,
"templates":<String_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/config_template_temp ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of config_template_temp 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/config_template_temp ?pagesize=#no;pageno=#no Use this query-parameter to get the config_template_temp resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/config_template_temp ?count=yes Use this query-parameter to get the count of config_template_temp resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_template_temp":[{
"commands_str":<String_value>,
"device_family":<String_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>}],
"start_time":<Double_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"name":<String_value>,
"template_info":<configuration_template_value>,
"duration":<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>}],
"description":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"template_file":<String_value>,
"templates":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp/id_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
import_post_upgrade_script_file
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp?action=import_post_upgrade_script_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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"config_template_temp": {
"name":<String_value>,
"template_info":<configuration_template_value>,
"description":<String_value>,
"commands_str":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"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>}],
"file_location_path":<String_value>,
"end_time":<Double_value>,
"template_file":<String_value>,
"file_name":<String_value>,
"id":<String_value>,
"device_family":<String_value>,
"duration":<String_value>,
"templates":<String_value[]>,
"variable_vals":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"parent_id":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<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":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"ip_address":<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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_template_temp":[{
"commands_str":<String_value>,
"device_family":<String_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>}],
"start_time":<Double_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"name":<String_value>,
"template_info":<configuration_template_value>,
"duration":<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>}],
"description":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"template_file":<String_value>,
"templates":<String_value>}]}
import_pre_upgrade_script_file
URL: https://<MGMT-IP>/nitro/v2/config/config_template_temp?action=import_pre_upgrade_script_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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"config_template_temp": {
"name":<String_value>,
"template_info":<configuration_template_value>,
"description":<String_value>,
"commands_str":<String_value>,
"variables":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"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>}],
"file_location_path":<String_value>,
"end_time":<Double_value>,
"template_file":<String_value>,
"file_name":<String_value>,
"id":<String_value>,
"device_family":<String_value>,
"duration":<String_value>,
"templates":<String_value[]>,
"variable_vals":[{
<b>"name":<String_value></b>,
"valuex":<String_value>,
"parent_id":<String_value>,
"device_values":[{
"value":<String_value>,
"id":<String_value>,
"device":<String_value>,
"device_group":<String_value>,
"valuex":<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":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"ip_address":<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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "config_template_temp":[{
"commands_str":<String_value>,
"device_family":<String_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>}],
"start_time":<Double_value>,
"commands":[{
"protocol":<String_value>,
"rollback_command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"index":<Integer_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>}],
"name":<String_value>,
"template_info":<configuration_template_value>,
"duration":<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>}],
"description":<String_value>,
"end_time":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>,
"file_location_path":<String_value>,
"file_name":<String_value>,
"template_file":<String_value>,
"templates":<String_value>}]}
upload
URL: https://<MGMT-IP>/nitro/v2/upload/config_template_temp HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
Multi-part form data with File Stream
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 }