configuration_template
Configuration for Configuration Template resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| device_family | <String> | Read-write | Family of Devices for which config template is defined.. Minimum length = 1 Maximum length = 64 |
| parent_name | <String> | Read-write | . |
| commands | <config_command[]> | Read-write | Array of commands part of the configuration template. |
| name | <String> | Read-write | Name of configuration template. Minimum length = 1 Maximum length = 128 |
| variables | <config_variable[]> | Read-write | Array of variables used in commands of the configuration template. |
| description | <String> | Read-write | Description of configuration template. Minimum length = 1 Maximum length = 1024 |
| parent_id | <String> | Read-write | . |
| tenant_id | <String> | Read-write | Tenant Id. Minimum length = 1 Maximum length = 128 |
| id | <String> | Read-write | Id is system generated key for all the configuration templates. |
| category | <String> | Read-write | Category of configuration template. Minimum length = 1 Maximum length = 128 |
| is_inbuilt | <Boolean> | Read-only | true, if this template is in built. |
Operations
(click to see Properties)
ADD| DELETE| GET (ALL)| 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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/configuration_template?onerror=<String_value>
HTTP Method: null
Request Payload:
{configuration_template: {
"parent_id":<String_value>,
"category":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"commands":[{
"protocol":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"display_name":<String_value>,
"type":<String_value>}],
"tenant_id":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_value>,
"commands":[{
"protocol":<String_value>,
"index":<Integer_value>,
"parent_name":<String_value>,
"timeout":<Integer_value>,
"nitro_payload":<String_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"nitro_method":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"description":<String_value>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/configuration_template/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/configuration_template
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_value>,
"commands":[{
"protocol":<String_value>,
"index":<Integer_value>,
"parent_name":<String_value>,
"timeout":<Integer_value>,
"nitro_payload":<String_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"nitro_method":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"description":<String_value>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<String_value>}]}
modify
URL: https://<MGMT-IP>/nitro/v1/config/configuration_template/id_value<String>
HTTP Method: null
Request Payload:
{configuration_template:{
<b>"id":<String_value></b>,
"parent_id":<String_value>,
"category":<String_value>,
"parent_name":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"commands":[{
"protocol":<String_value>,
"nitro_method":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"command":<String_value>,
"parent_name":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}],
"variables":[{
<b>"name":<String_value></b>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"values_enum":<String_value[]>,
"values_enum_db":<String_value>,
"parent_name":<String_value>,
"description":<String_value>,
"display_name":<String_value>,
"type":<String_value>}],
"tenant_id":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_value>,
"commands":[{
"protocol":<String_value>,
"index":<Integer_value>,
"parent_name":<String_value>,
"timeout":<Integer_value>,
"nitro_payload":<String_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"nitro_method":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}],
"name":<String_value>,
"variables":[{
"parent_name":<String_value>,
"name":<String_value>,
"display_name":<String_value>,
"description":<String_value>,
"parent_id":<String_value>,
"required":<Boolean_value>,
"default_value":<String_value>,
"id":<String_value>,
"type":<String_value>,
"values_enum_db":<String_value>,
"values_enum":<String_value>}],
"description":<String_value>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<String_value>}]}