34 lines
7.4 KiB
HTML
34 lines
7.4 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>db_cert</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">db_cert</p>
|
|
<P>Configuration for NetScaler db certificate File resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">db_root_cert<span class="property_type"><String></span></p><p class="property_description">Server Certificate Name.<br> Minimum length = 1<br> Maximum length = 256</p>
|
|
<p class="property_name">db_server_cert<span class="property_type"><String></span></p><p class="property_description">Server Certificate Name.<br> Minimum length = 1<br> Maximum length = 256</p>
|
|
<p class="property_name">db_server_key<span class="property_type"><String></span></p><p class="property_description">Server Key.<br> Minimum length = 1<br> Maximum length = 256</p>
|
|
<p class="property_name">fingerprint<span class="property_type"><String></span></p><p class="property_description">SHA-1 Fingerprint of NetScaler Console database Certificate.<br> Minimum length = 1<br> Maximum length = 512</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">subjaltname<span class="property_type"><String></span></p><p class="property_description">Comma separated Subject Alternative Names.</p>
|
|
<p class="property_name">signature_algorithm<span class="property_type"><String></span></p><p class="property_description">Signature Algorithm.</p>
|
|
<p class="property_name">public_key_size<span class="property_type"><Integer></span></p><p class="property_description">Public Key Size.</p>
|
|
<p class="property_name">version<span class="property_type"><String></span></p><p class="property_description">Version.</p>
|
|
<p class="property_name">status<span class="property_type"><String></span></p><p class="property_description">Tells whether the certificate is still valid or not.</p>
|
|
<p class="property_name">valid_from<span class="property_type"><String></span></p><p class="property_description">Valid From.</p>
|
|
<p class="property_name">days_to_expiry<span class="property_type"><Integer></span></p><p class="property_description">Days before database certificate expires.</p>
|
|
<p class="property_name">serial_number<span class="property_type"><String></span></p><p class="property_description">Serial Number.</p>
|
|
<p class="property_name">valid_to<span class="property_type"><String></span></p><p class="property_description">Valid To.</p>
|
|
<p class="property_name">public_key_algorithm<span class="property_type"><String></span></p><p class="property_description">Public Key Algorithm.</p>
|
|
<p class="property_name">issuer<span class="property_type"><String></span></p><p class="property_description">Issuer.</p>
|
|
<p class="property_name">subject<span class="property_type"><String></span></p><p class="property_description">Subject.</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><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/db_cert</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/db_cert<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 db_cert 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/db_cert<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the db_cert resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/db_cert<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of db_cert 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>, "db_cert":[{<br> "subjaltname":<String_value></font>,<br> "signature_algorithm":<String_value></font>,<br> "public_key_size":<Integer_value></font>,<br> "version":<String_value></font>,<br> "db_root_cert":<String_value></font>,<br> "db_server_cert":<String_value></font>,<br> "status":<String_value></font>,<br> "valid_from":<String_value></font>,<br> "days_to_expiry":<Integer_value></font>,<br> "serial_number":<String_value></font>,<br> "cert_format":<String_value></font>,<br> "db_server_key":<String_value></font>,<br> "valid_to":<String_value></font>,<br> "fingerprint":<String_value></font>,<br> "public_key_algorithm":<String_value></font>,<br> "issuer":<String_value></font>,<br> "subject":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|