Skip to content
Was this article helpful?

cli_prompt

Configuration for CLI Prompt string resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
promptString <String> Read-write The prompt string. The following special values are allowed: %! - will be replaced by the history event number %u - will be replaced by the Citrix ADC SVM user name %h - will be replaced by the Citrix ADC SVM hostname %t - will be replaced by the current time (12 hr) %T - will be replaced by the current time (24 hr) %d - will be replaced by the current date (yy/mm/dd) This is a mandatory argument..

Operations

(click to see Properties )

  • UPDATE

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

update

URL: https://<MGMT-IP>/nitro/v2/config/cli_prompt/ HTTPS Method: PUT

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:

{"cli_prompt":{
<b>"promptString":<String_value></b>}}

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, "cli_prompt":[{
"promptString":<String_value>}]}
Was this article helpful?