config_advice

Configuration for Config Advice resource.

Read/write properties

is_xendesktop<Boolean>

Enables search for Xen Desktop properties .

config_advice_results<config_advice_result[]>

config advice result.

is_pci<Boolean>

Enables search for PCI properties.

id<String>

System generated key.

ip_address<String>

IP Address.

command<String>

Commands.

output_file<String>

File Path.

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

custom

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

{"config_advice": {
      "is_xendesktop":<Boolean_value>,
      "command":<String_value>,
      "config_advice_results":[{
      "issue":<String_value>,
      "id":<String_value>,
      "advice":<String_value>,
      "severity":<String_value>,
      "category":<String_value>,
      "modification_status":<Boolean_value>,
      "corrective_command":<String_value>,
      "modification_status_message":<String_value>}],
      "id":<String_value>,
      "output_file":<String_value>,
      "is_pci":<Boolean_value>,
      "ip_address":<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>, "config_advice":[{
      "is_xendesktop":<Boolean_value>,
      "config_advice_results":[{
      "modification_status_message":<String_value>,
      "severity":<String_value>,
      "id":<String_value>,
      "parent_id":<String_value>,
      "issue":<String_value>,
      "category":<String_value>,
      "modification_status":<Boolean_value>,
      "parent_name":<String_value>,
      "corrective_command":<String_value>,
      "advice":<String_value>}],
      "is_pci":<Boolean_value>,
      "id":<String_value>,
      "ip_address":<String_value>,
      "command":<String_value>,
      "output_file":<String_value>}]}