Skip to content

config_command

Configuration for Configuration Commands for use in configuration template resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
protocol<String>Read-writeProtocol used by Configuration Command: SSH|SCP|SFTP|NITRO.
Minimum length = 1
Maximum length = 32
index<Integer>Read-writeIndex that stores the position of the command in a command array.
parent_name<String>Read-write.
timeout<Integer>Read-writeCommand Timeout in secs.
Maximum value =
nitro_payload<String>Read-writeNITRO Request Payload.
nitro_resource<String>Read-writeNITRO Resource Name.
Minimum length = 1
Maximum length = 128
id<String>Read-write.
nitro_method<String>Read-writeNITRO Request Method: POST|PUT|DELETE.
Minimum length = 1
Maximum length = 32
command<String>Read-writeCommand String for Protocols SSH|SCP|SFTP.
parent_id<String>Read-write.

Operations

(click to see Properties)

ADD

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/config_command?onerror=<String_value>

HTTP Method: null

Request Payload:

{config_command: {
"protocol":<String_value>,
"parent_id":<String_value>,
"timeout":<Integer_value>,
"id":<String_value>,
"nitro_resource":<String_value>,
"parent_name":<String_value>,
"nitro_method":<String_value>,
"command":<String_value>,
"nitro_payload":<String_value>,
"index":<Integer_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "config_command":[{
"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>}]}