41 lines
25 KiB
HTML
41 lines
25 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>geodb_upgrade</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">geodb_upgrade</p>
|
|
<P>Configuration for GeoDB database upgrade resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">status<span class="property_type"><String></span></p><p class="property_description">Status of Job In-Progress, Completed, Failed, Scheduled .<br> Maximum length = 128</p>
|
|
<p class="property_name">message<span class="property_type"><String></span></p><p class="property_description">This is used to show an error message if the upgrade fails.</p>
|
|
<p class="property_name">is_ipv6<span class="property_type"><Boolean></span></p><p class="property_description">True if select ipv6 block file to convert to NetScaler format.</p>
|
|
<p class="property_name">provider_format<span class="property_type"><String></span></p><p class="property_description">Geodb upgrade supported provider format maxmind and NetScaler..</p>
|
|
<p class="property_name">schedule_time_epoch<span class="property_type"><String></span></p><p class="property_description">Schedule time UTC epoch (string representation of 11 digit numbers)..</p>
|
|
<p class="property_name">converted_file_name<span class="property_type"><String></span></p><p class="property_description">This is used to store the converted file name in NetScaler format.<br> Maximum length = 256</p>
|
|
<p class="property_name">file_name<span class="property_type"><String></span></p><p class="property_description">Geodb file name.<br> Maximum length = 256</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Unique Id for geodb upgrade process. This is for internal use only, ignore when calling the POST API..</p>
|
|
<p class="property_name">device_groups<span class="property_type"><String[]></span></p><p class="property_description">Device Group Array on which for which job is run.</p>
|
|
<p class="property_name">is_file_details<span class="property_type"><Boolean></span></p><p class="property_description">True if required geodb file details.</p>
|
|
<p class="property_name">upload_time<span class="property_type"><String></span></p><p class="property_description">Geodb file upload time to appliance.</p>
|
|
<p class="property_name">devices<span class="property_type"><String[]></span></p><p class="property_description">Device IP Address Array on which job is run.</p>
|
|
<p class="property_name">instance_failed_count<span class="property_type"><Integer></span></p><p class="property_description">Instance Failed Count.</p>
|
|
<p class="property_name">instance_total_count<span class="property_type"><Integer></span></p><p class="property_description">Instance Total Count.</p>
|
|
<p class="property_name">instance_pending_count<span class="property_type"><Integer></span></p><p class="property_description">Instance Pending Count.</p>
|
|
<p class="property_name">percent_completed<span class="property_type"><Double></span></p><p class="property_description">Percentage completed upgrade.</p>
|
|
<p class="property_name">filesize<span class="property_type"><Integer></span></p><p class="property_description">Geodb file size in bytes.</p>
|
|
<p class="property_name">instance_completed_count<span class="property_type"><Integer></span></p><p class="property_description">Instance Completed Count.</p>
|
|
<p class="property_name">instance_not_started_count<span class="property_type"><Integer></span></p><p class="property_description">Instances not yet started count.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">tasklog_id<span class="property_type"><String></span></p><p class="property_description">Task Log Id of the geodb upgrade process. This is for internal use only, ignore when calling the POST API..</p>
|
|
<p class="property_name">username<span class="property_type"><String></span></p><p class="property_description">User Name who is executing the geodb upgrade. This is for internal use only, ignore when calling the POST API..</p>
|
|
<p class="property_name">timestamp<span class="property_type"><Integer></span></p><p class="property_description">Time of Creation of geodb upgrade. This is for internal use only, ignore when calling the POST API..</p>
|
|
<p class="property_name">act_id<span class="property_type"><String></span></p><p class="property_description">Used to internally store activity Id of the geodb upgrade process.</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="#add" class="operation">add</a><a href="#modify" class="operation">modify</a><a href="#delete" class="operation">delete</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/geodb_upgrade?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">{"geodb_upgrade": {<br><font color=#000000> "instance_pending_count":<Integer_value></font>,<br><font color=#000000> "is_ipv6":<Boolean_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "is_file_details":<Boolean_value></font>,<br><font color=#000000> "instance_failed_count":<Integer_value></font>,<br><font color=#000000> "filesize":<Integer_value></font>,<br><font color=#000000> "schedule_time_epoch":<String_value></font>,<br><font color=#000000> "percent_completed":<Double_value></font>,<br><font color=#000000> "message":<String_value></font>,<br><font color=#000000> "provider_format":<String_value></font>,<br><font color=#000000> "file_name":<String_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "instance_completed_count":<Integer_value></font>,<br><font color=#000000> "upload_time":<String_value></font>,<br><font color=#000000> "instance_not_started_count":<Integer_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "converted_file_name":<String_value></font>,<br><font color=#000000> "instance_total_count":<Integer_value></font>,<br><font color=#000000> "device_groups":<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>, "geodb_upgrade":[{<br> "status":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "message":<String_value></font>,<br> "is_ipv6":<Boolean_value></font>,<br> "provider_format":<String_value></font>,<br> "schedule_time_epoch":<String_value></font>,<br> "username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "act_id":<String_value></font>,<br> "converted_file_name":<String_value></font>,<br> "file_name":<String_value></font>,<br> "id":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "is_file_details":<Boolean_value></font>,<br> "upload_time":<String_value></font>,<br> "devices":<String_value></font>,<br> "instance_failed_count":<Integer_value></font>,<br> "instance_total_count":<Integer_value></font>,<br> "instance_pending_count":<Integer_value></font>,<br> "percent_completed":<Double_value></font>,<br> "filesize":<Integer_value></font>,<br> "instance_completed_count":<Integer_value></font>,<br> "instance_not_started_count":<Integer_value></font>}]}</p><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String></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">{"geodb_upgrade":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "converted_file_name":<String_value></font>,<br><font color=#000000> "instance_not_started_count":<Integer_value></font>,<br><font color=#000000> "device_groups":<String_value[]></font>,<br><font color=#000000> "instance_total_count":<Integer_value></font>,<br><font color=#000000> "file_name":<String_value></font>,<br><font color=#000000> "provider_format":<String_value></font>,<br><font color=#000000> "message":<String_value></font>,<br><font color=#000000> "upload_time":<String_value></font>,<br><font color=#000000> "instance_completed_count":<Integer_value></font>,<br><font color=#000000> "status":<String_value></font>,<br><font color=#000000> "schedule_time_epoch":<String_value></font>,<br><font color=#000000> "filesize":<Integer_value></font>,<br><font color=#000000> "instance_failed_count":<Integer_value></font>,<br><font color=#000000> "percent_completed":<Double_value></font>,<br><font color=#000000> "devices":<String_value[]></font>,<br><font color=#000000> "instance_pending_count":<Integer_value></font>,<br><font color=#000000> "is_ipv6":<Boolean_value></font>,<br><font color=#000000> "is_file_details":<Boolean_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>, "geodb_upgrade":[{<br> "status":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "message":<String_value></font>,<br> "is_ipv6":<Boolean_value></font>,<br> "provider_format":<String_value></font>,<br> "schedule_time_epoch":<String_value></font>,<br> "username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "act_id":<String_value></font>,<br> "converted_file_name":<String_value></font>,<br> "file_name":<String_value></font>,<br> "id":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "is_file_details":<Boolean_value></font>,<br> "upload_time":<String_value></font>,<br> "devices":<String_value></font>,<br> "instance_failed_count":<Integer_value></font>,<br> "instance_total_count":<Integer_value></font>,<br> "instance_pending_count":<Integer_value></font>,<br> "percent_completed":<Double_value></font>,<br> "filesize":<Integer_value></font>,<br> "instance_completed_count":<Integer_value></font>,<br> "instance_not_started_count":<Integer_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</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 Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p><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/geodb_upgrade</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/geodb_upgrade<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 geodb_upgrade 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/geodb_upgrade<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the geodb_upgrade resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/geodb_upgrade<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of geodb_upgrade 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>, "geodb_upgrade":[{<br> "status":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "message":<String_value></font>,<br> "is_ipv6":<Boolean_value></font>,<br> "provider_format":<String_value></font>,<br> "schedule_time_epoch":<String_value></font>,<br> "username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "act_id":<String_value></font>,<br> "converted_file_name":<String_value></font>,<br> "file_name":<String_value></font>,<br> "id":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "is_file_details":<Boolean_value></font>,<br> "upload_time":<String_value></font>,<br> "devices":<String_value></font>,<br> "instance_failed_count":<Integer_value></font>,<br> "instance_total_count":<Integer_value></font>,<br> "instance_pending_count":<Integer_value></font>,<br> "percent_completed":<Double_value></font>,<br> "filesize":<Integer_value></font>,<br> "instance_completed_count":<Integer_value></font>,<br> "instance_not_started_count":<Integer_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String></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>, "geodb_upgrade":[{<br> "status":<String_value></font>,<br> "tasklog_id":<String_value></font>,<br> "device_groups_db":<String_value></font>,<br> "devices_db":<String_value></font>,<br> "message":<String_value></font>,<br> "is_ipv6":<Boolean_value></font>,<br> "provider_format":<String_value></font>,<br> "schedule_time_epoch":<String_value></font>,<br> "username":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "act_id":<String_value></font>,<br> "converted_file_name":<String_value></font>,<br> "file_name":<String_value></font>,<br> "id":<String_value></font>,<br> "device_groups":<String_value></font>,<br> "is_file_details":<Boolean_value></font>,<br> "upload_time":<String_value></font>,<br> "devices":<String_value></font>,<br> "instance_failed_count":<Integer_value></font>,<br> "instance_total_count":<Integer_value></font>,<br> "instance_pending_count":<Integer_value></font>,<br> "percent_completed":<Double_value></font>,<br> "filesize":<Integer_value></font>,<br> "instance_completed_count":<Integer_value></font>,<br> "instance_not_started_count":<Integer_value></font>}]}</p>
|
|
</body>
|
|
</html>
|