25 lines
3.1 KiB
HTML
25 lines
3.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>cli_prompt</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">cli_prompt</p>
|
|
<P>Configuration for CLI Prompt string resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">promptString<span class="property_type"><String></span></p><p class="property_description">The prompt string. The following special values are allowed:
|
|
%! - will be replaced by the history event number
|
|
%u - will be replaced by the NetScaler SVM user name
|
|
%h - will be replaced by the NetScaler 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..</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/cli_prompt/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"cli_prompt":{<br><font color=#FF0000><b> "promptString":<String_value></b></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "cli_prompt":[{<br> "promptString":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|