geodb_upgrade

Configuration for GeoDB database upgrade resource.

Read/write properties

status<String>

Status of Job In-Progress, Completed, Failed, Scheduled .
Maximum length = 128

message<String>

This is used to show an error message if the upgrade fails.

is_ipv6<Boolean>

True if select ipv6 block file to convert to NetScaler format.

provider_format<String>

Geodb upgrade supported provider format maxmind and NetScaler..

schedule_time_epoch<String>

Schedule time UTC epoch (string representation of 11 digit numbers)..

converted_file_name<String>

This is used to store the converted file name in NetScaler format.
Maximum length = 256

file_name<String>

Geodb file name.
Maximum length = 256

id<String>

Unique Id for geodb upgrade process. This is for internal use only, ignore when calling the POST API..

device_groups<String[]>

Device Group Array on which for which job is run.

is_file_details<Boolean>

True if required geodb file details.

upload_time<String>

Geodb file upload time to appliance.

devices<String[]>

Device IP Address Array on which job is run.

instance_failed_count<Integer>

Instance Failed Count.

instance_total_count<Integer>

Instance Total Count.

instance_pending_count<Integer>

Instance Pending Count.

percent_completed<Double>

Percentage completed upgrade.

filesize<Integer>

Geodb file size in bytes.

instance_completed_count<Integer>

Instance Completed Count.

instance_not_started_count<Integer>

Instances not yet started count.

Read only properties

tasklog_id<String>

Task Log Id of the geodb upgrade process. This is for internal use only, ignore when calling the POST API..

username<String>

User Name who is executing the geodb upgrade. This is for internal use only, ignore when calling the POST API..

timestamp<Integer>

Time of Creation of geodb upgrade. This is for internal use only, ignore when calling the POST API..

act_id<String>

Used to internally store activity Id of the geodb upgrade process.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

add modify delete get (all)get

add

URL:https://<MGMT-IP>/nitro/v2/config/geodb_upgrade?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"geodb_upgrade": {
      "instance_pending_count":<Integer_value>,
      "is_ipv6":<Boolean_value>,
      "devices":<String_value[]>,
      "is_file_details":<Boolean_value>,
      "instance_failed_count":<Integer_value>,
      "filesize":<Integer_value>,
      "schedule_time_epoch":<String_value>,
      "percent_completed":<Double_value>,
      "message":<String_value>,
      "provider_format":<String_value>,
      "file_name":<String_value>,
      "status":<String_value>,
      "instance_completed_count":<Integer_value>,
      "upload_time":<String_value>,
      "instance_not_started_count":<Integer_value>,
      "id":<String_value>,
      "converted_file_name":<String_value>,
      "instance_total_count":<Integer_value>,
      "device_groups":<String_value[]>}}

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "geodb_upgrade":[{
      "status":<String_value>,
      "tasklog_id":<String_value>,
      "device_groups_db":<String_value>,
      "devices_db":<String_value>,
      "message":<String_value>,
      "is_ipv6":<Boolean_value>,
      "provider_format":<String_value>,
      "schedule_time_epoch":<String_value>,
      "username":<String_value>,
      "timestamp":<Integer_value>,
      "act_id":<String_value>,
      "converted_file_name":<String_value>,
      "file_name":<String_value>,
      "id":<String_value>,
      "device_groups":<String_value>,
      "is_file_details":<Boolean_value>,
      "upload_time":<String_value>,
      "devices":<String_value>,
      "instance_failed_count":<Integer_value>,
      "instance_total_count":<Integer_value>,
      "instance_pending_count":<Integer_value>,
      "percent_completed":<Double_value>,
      "filesize":<Integer_value>,
      "instance_completed_count":<Integer_value>,
      "instance_not_started_count":<Integer_value>}]}

modify

URL:https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"geodb_upgrade":{
      "id":<String_value>,
      "converted_file_name":<String_value>,
      "instance_not_started_count":<Integer_value>,
      "device_groups":<String_value[]>,
      "instance_total_count":<Integer_value>,
      "file_name":<String_value>,
      "provider_format":<String_value>,
      "message":<String_value>,
      "upload_time":<String_value>,
      "instance_completed_count":<Integer_value>,
      "status":<String_value>,
      "schedule_time_epoch":<String_value>,
      "filesize":<Integer_value>,
      "instance_failed_count":<Integer_value>,
      "percent_completed":<Double_value>,
      "devices":<String_value[]>,
      "instance_pending_count":<Integer_value>,
      "is_ipv6":<Boolean_value>,
      "is_file_details":<Boolean_value>}}

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:JSON

delete

URL:https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/geodb_upgrade

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/geodb_upgrade?filter=property-name1:property-value1,property-name2:property-value2

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.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/geodb_upgrade?pagesize=#no&pageno=#no

Use this query-parameter to get the geodb_upgrade resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/geodb_upgrade?count=yes

Use this query-parameter to get the count of geodb_upgrade resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 Headers:

Content-Type:application/json

Response Payload:JSON

get

URL:https://<MGMT-IP>/nitro/v2/config/geodb_upgrade/id_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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 Headers:

Content-Type:application/json

Response Payload:JSON