configuration_template

Configuration for Configuration Template resource.

Read/write properties

tenant_id<String>

Tenant Id.
Minimum length = 1
Maximum length = 128

id<String>

Id is system generated key for all the configuration templates.

parent_id<String>

Parent Id of configuration template.

device_family<String>

Family of Devices i.e. ns, sdx for which config template is defined..
Minimum length = 1
Maximum length = 64

category<String>

Category of configuration template.
Minimum length = 1
Maximum length = 128

variables<config_variable[]>

Array of variables used in commands of the configuration template.

commands<config_command[]>

Array of commands part of the configuration template.

description<String>

Description of configuration template.
Minimum length = 1
Maximum length = 1024

parent_name<String>

Parent name of configuration template.

name<String>

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

Read only properties

is_inbuilt<Boolean>

true, if this template is in built.

Operations

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

The following parameters can be used in the nitro request :

onerror <String_value>

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

get (all)delete add modify

get (all)

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

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of configuration_template 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/configuration_template?pagesize=#no&pageno=#no

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

count

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

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "configuration_template":[{
      "tenant_id":<String_value>,
      "is_visible":<Boolean_value>,
      "id":<String_value>,
      "parent_id":<String_value>,
      "device_family":<String_value>,
      "category":<String_value>,
      "variables":[{
      "required":<Boolean_value>,
      "values_enum":<String_value>,
      "type":<String_value>,
      "default_value":<String_value>,
      "description":<String_value>,
      "valuex":<String_value>,
      "id":<String_value>,
      "display_name":<String_value>,
      "parent_name":<String_value>,
      "name":<String_value>,
      "values_enum_db":<String_value>,
      "parent_id":<String_value>}],
      "commands":[{
      "parent_name":<String_value>,
      "timeout":<Integer_value>,
      "protocol":<String_value>,
      "parent_id":<String_value>,
      "nitro_resource":<String_value>,
      "index":<Integer_value>,
      "rollback_command":<String_value>,
      "nitro_payload":<String_value>,
      "nitro_method":<String_value>,
      "id":<String_value>,
      "command":<String_value>}],
      "description":<String_value>,
      "parent_name":<String_value>,
      "name":<String_value>,
      "is_inbuilt":<Boolean_value>}]}

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

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

Response Payload:JSON

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

add

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"configuration_template": {
      "description":<String_value>,
      "commands":[{
      "timeout":<Integer_value>,
      "parent_id":<String_value>,
      "nitro_resource":<String_value>,
      "index":<Integer_value>,
      "nitro_payload":<String_value>,
      "command":<String_value>,
      "parent_name":<String_value>,
      "protocol":<String_value>,
      "rollback_command":<String_value>,
      "id":<String_value>,
      "nitro_method":<String_value>}],
      "variables":[{
      "name":<String_value>,
      "valuex":<String_value>,
      "type":<String_value>,
      "description":<String_value>,
      "required":<Boolean_value>,
      "parent_id":<String_value>,
      "id":<String_value>,
      "default_value":<String_value>,
      "values_enum":<String_value[]>,
      "values_enum_db":<String_value>,
      "parent_name":<String_value>,
      "display_name":<String_value>}],
      "category":<String_value>,
      "parent_id":<String_value>,
      "device_family":<String_value>,
      "tenant_id":<String_value>,
      "name":<String_value>,
      "id":<String_value>,
      "parent_name":<String_value>}}

Response:

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

Response Payload:JSON

modify

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

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"configuration_template":{
      "id":<String_value>,
      "variables":[{
      "name":<String_value>,
      "valuex":<String_value>,
      "type":<String_value>,
      "description":<String_value>,
      "required":<Boolean_value>,
      "parent_id":<String_value>,
      "id":<String_value>,
      "default_value":<String_value>,
      "values_enum":<String_value[]>,
      "values_enum_db":<String_value>,
      "parent_name":<String_value>,
      "display_name":<String_value>}],
      "commands":[{
      "timeout":<Integer_value>,
      "parent_id":<String_value>,
      "nitro_resource":<String_value>,
      "index":<Integer_value>,
      "nitro_payload":<String_value>,
      "command":<String_value>,
      "parent_name":<String_value>,
      "protocol":<String_value>,
      "rollback_command":<String_value>,
      "id":<String_value>,
      "nitro_method":<String_value>}],
      "description":<String_value>,
      "category":<String_value>,
      "tenant_id":<String_value>,
      "parent_id":<String_value>,
      "device_family":<String_value>,
      "name":<String_value>,
      "parent_name":<String_value>}}

Response:

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

Response Payload:JSON