Skip to content
Was this article helpful?

config_command

Configuration for Configuration Commands for use in configuration template resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
protocol <String> Read-write Protocol used by Configuration Command: SSH|SCP|SFTP.

Minimum length = 1

Maximum length = 32
rollback_command <String> Read-write Rollback Command String.
parent_name <String> Read-write Parent name of config command.
nitro_payload <String> Read-write NITRO Request Payload.
nitro_method <String> Read-write NITRO Request Method: POST|PUT|DELETE.

Minimum length = 1

Maximum length = 32
parent_id <String> Read-write Parent Id of config command.
index <Integer> Read-write Index that stores the position of the command in a command array.
timeout <Integer> Read-write Command Timeout in secs.

Maximum value =
id <String> Read-write Id is system generated key for all config command.
nitro_resource <String> Read-write NITRO Resource Name.

Minimum length = 1

Maximum length = 128
command <String> Read-write Command String for Protocols SSH|SCP|SFTP.

Operations

(click to see Properties )

  • ADD
  • GET (ALL)

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/config_command?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_command": {
      "timeout":<Integer_value>,
      "nitro_method":<String_value>,
      "command":<String_value>,
      "index":<Integer_value>,
      "protocol":<String_value>,
      "parent_id":<String_value>,
      "nitro_resource":<String_value>,
      "id":<String_value>,
      "parent_name":<String_value>,
      "rollback_command":<String_value>,
      "nitro_payload":<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_command":[{
      "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>}]}

get (all)

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

Query-parameters:

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

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

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

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

Use this query-parameter to get the count of config_command 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_command":[{
      "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>}]}
Was this article helpful?