config_command

Configuration for Configuration Commands for use in configuration template resource.

Read/write properties

nitro_payload<String>

NITRO Request Payload.

nitro_resource<String>

NITRO Resource Name.
Minimum length = 1
Maximum length = 128

index<Integer>

Index that stores the position of the command in a command array.

rollback_command<String>

Rollback Command String.

command<String>

Command String for Protocols SSH|SCP|SFTP.

id<String>

Id is system generated key for all config command.

nitro_method<String>

NITRO Request Method: POST|PUT|DELETE.
Minimum length = 1
Maximum length = 32

parent_name<String>

Parent name of config command.

protocol<String>

Protocol used by Configuration Command: SSH|SCP|SFTP.
Minimum length = 1
Maximum length = 32

parent_id<String>

Parent Id of config command.

timeout<Integer>

Command Timeout in secs.
Maximum value =

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

add get (all)

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>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"config_command": {
      "id":<String_value>,
      "rollback_command":<String_value>,
      "parent_name":<String_value>,
      "index":<Integer_value>,
      "nitro_payload":<String_value>,
      "parent_id":<String_value>,
      "nitro_method":<String_value>,
      "protocol":<String_value>,
      "command":<String_value>,
      "nitro_resource":<String_value>,
      "timeout":<Integer_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

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_command":[{
      "nitro_payload":<String_value>,
      "nitro_resource":<String_value>,
      "index":<Integer_value>,
      "rollback_command":<String_value>,
      "command":<String_value>,
      "id":<String_value>,
      "nitro_method":<String_value>,
      "parent_name":<String_value>,
      "protocol":<String_value>,
      "parent_id":<String_value>,
      "timeout":<Integer_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