29 lines
10 KiB
HTML
29 lines
10 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>config_variable</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">config_variable</p>
|
|
<P>Configuration for Configuration Variables for use in configuration template resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">parent_name<span class="property_type"><String></span></p><p class="property_description">Parent name of config variable.</p>
|
|
<p class="property_name">values_enum_db<span class="property_type"><String></span></p><p class="property_description">Comma separated list of possible values of variable.</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Variable name.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">display_name<span class="property_type"><String></span></p><p class="property_description">Display name of configuration variable.<br> Minimum length = 1<br> Maximum length = 1024</p>
|
|
<p class="property_name">parent_id<span class="property_type"><String></span></p><p class="property_description">Parent Id of config variable.</p>
|
|
<p class="property_name">type<span class="property_type"><String></span></p><p class="property_description">Type of Variable Text Field, Numeric Text Field, Choice, File, IP Addrss Field, Password Field.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">default_value<span class="property_type"><String></span></p><p class="property_description">Default Value of configuration variable.</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Description of configuration variable.<br> Minimum length = 1<br> Maximum length = 1024</p>
|
|
<p class="property_name">values_enum<span class="property_type"><String[]></span></p><p class="property_description">Possible Values values for choice type variable.</p>
|
|
<p class="property_name">required<span class="property_type"><Boolean></span></p><p class="property_description">If it is required argument for command then true else false..</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all config variable.</p>
|
|
<p class="property_name">valuex<span class="property_type"><String></span></p><p class="property_description">Secure Value of the Variable to be used for all device ips/groups.</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="#get_all" class="operation">get (all)</a><a href="#add" class="operation">add</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_variable</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_variable<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of config_variable resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_variable<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the config_variable resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/config_variable<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of config_variable resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<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">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 Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "config_variable":[{<br> "parent_name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "valuex":<String_value></font>}]}</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/config_variable?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</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">{"config_variable": {<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "values_enum_db":<String_value></font>,<br><font color=#000000> "display_name":<String_value></font>,<br><font color=#000000> "values_enum":<String_value[]></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "valuex":<String_value></font>,<br><font color=#000000> "type":<String_value></font>,<br><font color=#000000> "required":<Boolean_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "default_value":<String_value></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>, "config_variable":[{<br> "parent_name":<String_value></font>,<br> "values_enum_db":<String_value></font>,<br> "name":<String_value></font>,<br> "display_name":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "type":<String_value></font>,<br> "default_value":<String_value></font>,<br> "description":<String_value></font>,<br> "values_enum":<String_value></font>,<br> "required":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "valuex":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|