ADM NITRO APIs

configuration_template

June 20, 2023

Contributed by:

Configuration for Configuration Template resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
device_family		Read-write	Family of Devices i.e. ns, sdx, cbwanopt for which config template is defined.. Minimum length = 1 Maximum length = 64
parent_name		Read-write	Parent name of configuration template.
commands	<config_command[]>	Read-write	Array of commands part of the configuration template.
name		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		Read-write	Description of configuration template. Minimum length = 1 Maximum length = 1024
parent_id		Read-write	Parent Id of configuration template.
tenant_id		Read-write	Tenant Id. Minimum length = 1 Maximum length = 128
id		Read-write	Id is system generated key for all the configuration templates.
category		Read-write	Category of configuration template. Minimum length = 1 Maximum length = 128
is_inbuilt		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

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

{"configuration_template": {
"category":<String_value>,
"name":<String_value>,
"description":<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>}],
"tenant_id":<String_value>,
"parent_id":<String_value>,
"id":<String_value>,
"parent_name":<String_value>,
"device_family":<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>}]}}

<!--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, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_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>,
"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>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<String_value>}]}

<!--NeedCopy-->

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

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

<!--NeedCopy-->

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

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_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>,
"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>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<String_value>}]}

<!--NeedCopy-->

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:

{"configuration_template":{
<b>"id":<String_value></b>,
"category":<String_value>,
"name":<String_value>,
"description":<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>}],
"tenant_id":<String_value>,
"parent_id":<String_value>,
"parent_name":<String_value>,
"device_family":<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>}]}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "configuration_template":[{
"device_family":<String_value>,
"parent_name":<String_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>,
"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>,
"parent_id":<String_value>,
"is_visible":<Boolean_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_inbuilt":<Boolean_value>,
"category":<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

configuration_template

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

configuration_template

Properties

Operations

add

delete

get (all)

modify

In this article