Skip to content

config_advice

Configuration for Config Advice resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
is_xendesktop<Boolean>Read-writeEnables search for Xen Desktop properties .
output_file<String>Read-writeFile Path.
is_pci<Boolean>Read-writeEnables search for PCI properties.
config_advice_results<config_advice_result[]>Read-writeconfig advice result.
ip_address<String>Read-writeIP Address.
id<String>Read-write.
command<String>Read-writeCommands.

Operations

(click to see Properties)

CUSTOM

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>.

custom

URL: https://<MGMT-IP>/nitro/v1/config/config_advice?action=custom;onerror=<String_value>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "config_advice":[{
"is_xendesktop":<Boolean_value>,
"output_file":<String_value>,
"is_pci":<Boolean_value>,
"config_advice_results":[{
"parent_name":<String_value>,
"modification_status_message":<String_value>,
"issue":<String_value>,
"parent_id":<String_value>,
"modification_status":<Boolean_value>,
"corrective_command":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"advice":<String_value>}],
"ip_address":<String_value>,
"id":<String_value>,
"command":<String_value>}]}