adc_script

Configuration for adc script running resource.

Read/write properties

timeout<Integer>

timeout.

script_directory<String>

script directory.

output_file_paths<String[]>

Array of output files.

stats<adc_script_stats>

Array of stats.

status<String>

status of the current adc script.

filename<String>

file name.

id<String>

adc script id.

adc_id<String>

adc id.

exit_code<String>

exit code.

report_id<String>

report id.

command<String>

command.

output_files<adc_script_output_file[]>

Array of output files.

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

runget (all)

run

URL:https://<MGMT-IP>/nitro/v2/config/adc_script?action=run&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:JSON

{"adc_script": {
      "stats":<adc_script_stats_value>,
      "output_file_paths":<String_value[]>,
      "timeout":<Integer_value>,
      "adc_id":<String_value>,
      "command":<String_value>,
      "exit_code":<String_value>,
      "filename":<String_value>,
      "output_files":[{
      "file_path":<String_value>,
      "contents":<String_value>,
      "format":<String_value>}]
,
      "id":<String_value>,
      "report_id":<String_value>,
      "status":<String_value>,
      "script_directory":<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

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "adc_script":[{
      "timeout":<Integer_value>,
      "script_directory":<String_value>,
      "output_file_paths":<String_value>,
      "stats":<adc_script_stats_value>,
      "status":<String_value>,
      "filename":<String_value>,
      "id":<String_value>,
      "adc_id":<String_value>,
      "exit_code":<String_value>,
      "report_id":<String_value>,
      "command":<String_value>,
      "output_files":[{
      "contents":<String_value>
      "format":<String_value>
      "file_path":<String_value>}]}]}

get (all)

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

Query-parameters:

filter

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

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

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

count

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

Use this query-parameter to get the count of adc_script 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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "adc_script":[{
      "timeout":<Integer_value>,
      "script_directory":<String_value>,
      "output_file_paths":<String_value>,
      "stats":<adc_script_stats_value>,
      "status":<String_value>,
      "filename":<String_value>,
      "id":<String_value>,
      "adc_id":<String_value>,
      "exit_code":<String_value>,
      "report_id":<String_value>,
      "command":<String_value>,
      "output_files":[{
      "contents":<String_value>
      "format":<String_value>
      "file_path":<String_value>}]}]}