Avi UpgradeStatusInfo Object API
CLI ``` - show upgrade status detail - show upgrade status detail include_history ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /upgradestatusinfopost /upgradestatusinfodelete /upgradestatusinfo/{uuid}get /upgradestatusinfo/{uuid}patch /upgradestatusinfo/{uuid}put /upgradestatusinfo/{uuid}
Up
get /upgradestatusinfo
(upgradestatusinfoGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"seg_params" : "",
"image_ref" : "aeiou",
"previous_patch_list" : [ "" ],
"upgrade_events" : [ "" ],
"enable_rollback" : true,
"enqueue_time" : "aeiou",
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"prev_patch_image_path" : "aeiou",
"seg_status" : "",
"total_tasks" : 123,
"uuid" : "aeiou",
"_last_modified" : "aeiou",
"se_upgrade_events" : [ "" ],
"duration" : 123,
"node_type" : "aeiou",
"se_patch_image_ref" : "aeiou",
"previous_version" : "aeiou",
"previous_patch_version" : "aeiou",
"state" : "",
"upgrade_ops" : "aeiou",
"patch_version" : "aeiou",
"obj_cloud_ref" : "aeiou",
"se_patch_image_path" : "aeiou",
"prev_image_path" : "aeiou",
"previous_patch_image_ref" : "aeiou",
"end_time" : "aeiou",
"history" : [ {
"duration" : 123,
"start_time" : "aeiou",
"upgrade_events" : [ {
"task_name" : "aeiou",
"task" : "aeiou",
"sub_events" : [ "" ],
"nodes_events" : [ {
"duration" : 123,
"start_time" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"end_time" : "aeiou",
"sub_tasks" : [ "aeiou" ],
"message" : "aeiou",
"status" : true
} ]
} ],
"ops" : "aeiou",
"end_time" : "aeiou",
"seg_status" : {
"disrupted_vs_ref" : [ "aeiou" ],
"num_se_with_no_vs" : 123,
"reason" : [ "aeiou" ],
"enqueue_time" : "aeiou",
"notes" : [ "aeiou" ],
"se_upgrade_suspended" : [ "aeiou" ],
"se_upgrade_in_progress" : [ "aeiou" ],
"vs_scalein_in_progress_ref" : [ "aeiou" ],
"se_already_upgraded_at_start" : [ "aeiou" ],
"se_group_uuid" : "aeiou",
"se_reboot_in_progress_ref" : "aeiou",
"num_vs" : 123,
"vs_migrate_in_progress_ref" : [ "aeiou" ],
"se_upgrade_completed" : [ "aeiou" ],
"se_upgrade_errors" : [ "" ],
"duration" : "aeiou",
"in_progress" : true,
"request_time" : "aeiou",
"ha_mode" : "aeiou",
"se_ip_missing_at_start" : [ "aeiou" ],
"controller_version" : "aeiou",
"num_se_with_vs_not_scaledout" : 123,
"vs_scaleout_in_progress_ref" : [ "aeiou" ],
"num_vs_disrupted" : 123,
"traffic_status" : "aeiou",
"se_poweredoff_at_start" : [ "aeiou" ],
"vs_errors" : [ {
"reason" : [ "aeiou" ],
"se_group_ha_mode" : "aeiou",
"tenant_ref" : "aeiou",
"traffic_status" : "aeiou",
"vip_id" : "aeiou",
"event_timestamp" : {
"usecs" : 123456789,
"secs" : 123456789
},
"vs_ref" : "aeiou",
"se_group_ref" : "aeiou",
"se_ref" : "aeiou"
} ],
"state" : "aeiou",
"worker" : "aeiou",
"se_group_name" : "aeiou",
"end_time" : "aeiou",
"se_with_vs_scaledout" : [ "aeiou" ],
"thread" : "aeiou",
"se_disconnected_at_start" : [ "aeiou" ],
"start_time" : "aeiou",
"num_se" : 123,
"se_upgrade_not_started" : [ "aeiou" ],
"se_upgrade_skip_suspended" : [ "aeiou" ],
"num_se_with_vs_scaledout" : 123,
"tenant_ref" : "aeiou",
"se_upgrade_failed" : [ "aeiou" ],
"se_with_vs_not_scaledout" : [ "aeiou" ],
"progress" : 123,
"se_with_no_vs" : [ "aeiou" ]
},
"state" : {
"reason" : "aeiou",
"rebooted" : true,
"last_changed_time" : "",
"state" : "aeiou"
},
"statediff_ref" : "aeiou",
"patch_version" : "aeiou",
"version" : "aeiou",
"se_upgrade_events" : [ {
"reason" : [ "aeiou" ],
"to_se_ref" : "aeiou",
"vs_ref" : "aeiou",
"num_vs" : 123,
"se_group_ref" : "aeiou",
"from_se_ref" : "aeiou",
"num_se" : 123,
"se_group_ha_mode" : "aeiou",
"task" : "aeiou",
"num_se_group" : 123,
"sub_tasks" : [ "aeiou" ],
"traffic_status" : "aeiou",
"se_ref" : "aeiou"
} ]
} ],
"clean" : true,
"params" : {
"image_ref" : "aeiou",
"patch_ref" : "aeiou",
"se_group_resume_options" : {
"action_on_error" : "aeiou",
"disruptive" : true,
"skip_suspended" : true
},
"se_group_options" : {
"action_on_error" : "aeiou",
"disruptive" : true
}
},
"statediff_ref" : "aeiou",
"previous_image_ref" : "aeiou",
"version" : "aeiou",
"after_reboot_rollback_fnc" : "aeiou",
"url" : "aeiou",
"start_time" : "aeiou",
"patch_reboot" : true,
"patch_list" : [ {
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"patch_version" : "aeiou"
} ],
"system" : true,
"tasks_completed" : 123,
"image_path" : "aeiou",
"tenant_ref" : "aeiou",
"after_reboot_task_name" : "aeiou",
"fips_mode" : true,
"name" : "aeiou",
"progress" : 123,
"enable_patch_rollback" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UpgradeStatusInfoApiResponse
401
log in failed
Up
post /upgradestatusinfo
(upgradestatusinfoPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UpgradeStatusInfo object creation
Return type
Example data
Content-Type: application/json
{
"seg_params" : "",
"image_ref" : "aeiou",
"previous_patch_list" : [ "" ],
"upgrade_events" : [ "" ],
"enable_rollback" : true,
"enqueue_time" : "aeiou",
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"prev_patch_image_path" : "aeiou",
"seg_status" : "",
"total_tasks" : 123,
"uuid" : "aeiou",
"_last_modified" : "aeiou",
"se_upgrade_events" : [ "" ],
"duration" : 123,
"node_type" : "aeiou",
"se_patch_image_ref" : "aeiou",
"previous_version" : "aeiou",
"previous_patch_version" : "aeiou",
"state" : "",
"upgrade_ops" : "aeiou",
"patch_version" : "aeiou",
"obj_cloud_ref" : "aeiou",
"se_patch_image_path" : "aeiou",
"prev_image_path" : "aeiou",
"previous_patch_image_ref" : "aeiou",
"end_time" : "aeiou",
"history" : [ {
"duration" : 123,
"start_time" : "aeiou",
"upgrade_events" : [ {
"task_name" : "aeiou",
"task" : "aeiou",
"sub_events" : [ "" ],
"nodes_events" : [ {
"duration" : 123,
"start_time" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"end_time" : "aeiou",
"sub_tasks" : [ "aeiou" ],
"message" : "aeiou",
"status" : true
} ]
} ],
"ops" : "aeiou",
"end_time" : "aeiou",
"seg_status" : {
"disrupted_vs_ref" : [ "aeiou" ],
"num_se_with_no_vs" : 123,
"reason" : [ "aeiou" ],
"enqueue_time" : "aeiou",
"notes" : [ "aeiou" ],
"se_upgrade_suspended" : [ "aeiou" ],
"se_upgrade_in_progress" : [ "aeiou" ],
"vs_scalein_in_progress_ref" : [ "aeiou" ],
"se_already_upgraded_at_start" : [ "aeiou" ],
"se_group_uuid" : "aeiou",
"se_reboot_in_progress_ref" : "aeiou",
"num_vs" : 123,
"vs_migrate_in_progress_ref" : [ "aeiou" ],
"se_upgrade_completed" : [ "aeiou" ],
"se_upgrade_errors" : [ "" ],
"duration" : "aeiou",
"in_progress" : true,
"request_time" : "aeiou",
"ha_mode" : "aeiou",
"se_ip_missing_at_start" : [ "aeiou" ],
"controller_version" : "aeiou",
"num_se_with_vs_not_scaledout" : 123,
"vs_scaleout_in_progress_ref" : [ "aeiou" ],
"num_vs_disrupted" : 123,
"traffic_status" : "aeiou",
"se_poweredoff_at_start" : [ "aeiou" ],
"vs_errors" : [ {
"reason" : [ "aeiou" ],
"se_group_ha_mode" : "aeiou",
"tenant_ref" : "aeiou",
"traffic_status" : "aeiou",
"vip_id" : "aeiou",
"event_timestamp" : {
"usecs" : 123456789,
"secs" : 123456789
},
"vs_ref" : "aeiou",
"se_group_ref" : "aeiou",
"se_ref" : "aeiou"
} ],
"state" : "aeiou",
"worker" : "aeiou",
"se_group_name" : "aeiou",
"end_time" : "aeiou",
"se_with_vs_scaledout" : [ "aeiou" ],
"thread" : "aeiou",
"se_disconnected_at_start" : [ "aeiou" ],
"start_time" : "aeiou",
"num_se" : 123,
"se_upgrade_not_started" : [ "aeiou" ],
"se_upgrade_skip_suspended" : [ "aeiou" ],
"num_se_with_vs_scaledout" : 123,
"tenant_ref" : "aeiou",
"se_upgrade_failed" : [ "aeiou" ],
"se_with_vs_not_scaledout" : [ "aeiou" ],
"progress" : 123,
"se_with_no_vs" : [ "aeiou" ]
},
"state" : {
"reason" : "aeiou",
"rebooted" : true,
"last_changed_time" : "",
"state" : "aeiou"
},
"statediff_ref" : "aeiou",
"patch_version" : "aeiou",
"version" : "aeiou",
"se_upgrade_events" : [ {
"reason" : [ "aeiou" ],
"to_se_ref" : "aeiou",
"vs_ref" : "aeiou",
"num_vs" : 123,
"se_group_ref" : "aeiou",
"from_se_ref" : "aeiou",
"num_se" : 123,
"se_group_ha_mode" : "aeiou",
"task" : "aeiou",
"num_se_group" : 123,
"sub_tasks" : [ "aeiou" ],
"traffic_status" : "aeiou",
"se_ref" : "aeiou"
} ]
} ],
"clean" : true,
"params" : {
"image_ref" : "aeiou",
"patch_ref" : "aeiou",
"se_group_resume_options" : {
"action_on_error" : "aeiou",
"disruptive" : true,
"skip_suspended" : true
},
"se_group_options" : {
"action_on_error" : "aeiou",
"disruptive" : true
}
},
"statediff_ref" : "aeiou",
"previous_image_ref" : "aeiou",
"version" : "aeiou",
"after_reboot_rollback_fnc" : "aeiou",
"url" : "aeiou",
"start_time" : "aeiou",
"patch_reboot" : true,
"patch_list" : [ {
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"patch_version" : "aeiou"
} ],
"system" : true,
"tasks_completed" : 123,
"image_path" : "aeiou",
"tenant_ref" : "aeiou",
"after_reboot_task_name" : "aeiou",
"fips_mode" : true,
"name" : "aeiou",
"progress" : 123,
"enable_patch_rollback" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UpgradeStatusInfo
401
log in failed
Up
delete /upgradestatusinfo/{uuid}
(upgradestatusinfoUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /upgradestatusinfo/{uuid}
(upgradestatusinfoUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"seg_params" : "",
"image_ref" : "aeiou",
"previous_patch_list" : [ "" ],
"upgrade_events" : [ "" ],
"enable_rollback" : true,
"enqueue_time" : "aeiou",
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"prev_patch_image_path" : "aeiou",
"seg_status" : "",
"total_tasks" : 123,
"uuid" : "aeiou",
"_last_modified" : "aeiou",
"se_upgrade_events" : [ "" ],
"duration" : 123,
"node_type" : "aeiou",
"se_patch_image_ref" : "aeiou",
"previous_version" : "aeiou",
"previous_patch_version" : "aeiou",
"state" : "",
"upgrade_ops" : "aeiou",
"patch_version" : "aeiou",
"obj_cloud_ref" : "aeiou",
"se_patch_image_path" : "aeiou",
"prev_image_path" : "aeiou",
"previous_patch_image_ref" : "aeiou",
"end_time" : "aeiou",
"history" : [ {
"duration" : 123,
"start_time" : "aeiou",
"upgrade_events" : [ {
"task_name" : "aeiou",
"task" : "aeiou",
"sub_events" : [ "" ],
"nodes_events" : [ {
"duration" : 123,
"start_time" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"end_time" : "aeiou",
"sub_tasks" : [ "aeiou" ],
"message" : "aeiou",
"status" : true
} ]
} ],
"ops" : "aeiou",
"end_time" : "aeiou",
"seg_status" : {
"disrupted_vs_ref" : [ "aeiou" ],
"num_se_with_no_vs" : 123,
"reason" : [ "aeiou" ],
"enqueue_time" : "aeiou",
"notes" : [ "aeiou" ],
"se_upgrade_suspended" : [ "aeiou" ],
"se_upgrade_in_progress" : [ "aeiou" ],
"vs_scalein_in_progress_ref" : [ "aeiou" ],
"se_already_upgraded_at_start" : [ "aeiou" ],
"se_group_uuid" : "aeiou",
"se_reboot_in_progress_ref" : "aeiou",
"num_vs" : 123,
"vs_migrate_in_progress_ref" : [ "aeiou" ],
"se_upgrade_completed" : [ "aeiou" ],
"se_upgrade_errors" : [ "" ],
"duration" : "aeiou",
"in_progress" : true,
"request_time" : "aeiou",
"ha_mode" : "aeiou",
"se_ip_missing_at_start" : [ "aeiou" ],
"controller_version" : "aeiou",
"num_se_with_vs_not_scaledout" : 123,
"vs_scaleout_in_progress_ref" : [ "aeiou" ],
"num_vs_disrupted" : 123,
"traffic_status" : "aeiou",
"se_poweredoff_at_start" : [ "aeiou" ],
"vs_errors" : [ {
"reason" : [ "aeiou" ],
"se_group_ha_mode" : "aeiou",
"tenant_ref" : "aeiou",
"traffic_status" : "aeiou",
"vip_id" : "aeiou",
"event_timestamp" : {
"usecs" : 123456789,
"secs" : 123456789
},
"vs_ref" : "aeiou",
"se_group_ref" : "aeiou",
"se_ref" : "aeiou"
} ],
"state" : "aeiou",
"worker" : "aeiou",
"se_group_name" : "aeiou",
"end_time" : "aeiou",
"se_with_vs_scaledout" : [ "aeiou" ],
"thread" : "aeiou",
"se_disconnected_at_start" : [ "aeiou" ],
"start_time" : "aeiou",
"num_se" : 123,
"se_upgrade_not_started" : [ "aeiou" ],
"se_upgrade_skip_suspended" : [ "aeiou" ],
"num_se_with_vs_scaledout" : 123,
"tenant_ref" : "aeiou",
"se_upgrade_failed" : [ "aeiou" ],
"se_with_vs_not_scaledout" : [ "aeiou" ],
"progress" : 123,
"se_with_no_vs" : [ "aeiou" ]
},
"state" : {
"reason" : "aeiou",
"rebooted" : true,
"last_changed_time" : "",
"state" : "aeiou"
},
"statediff_ref" : "aeiou",
"patch_version" : "aeiou",
"version" : "aeiou",
"se_upgrade_events" : [ {
"reason" : [ "aeiou" ],
"to_se_ref" : "aeiou",
"vs_ref" : "aeiou",
"num_vs" : 123,
"se_group_ref" : "aeiou",
"from_se_ref" : "aeiou",
"num_se" : 123,
"se_group_ha_mode" : "aeiou",
"task" : "aeiou",
"num_se_group" : 123,
"sub_tasks" : [ "aeiou" ],
"traffic_status" : "aeiou",
"se_ref" : "aeiou"
} ]
} ],
"clean" : true,
"params" : {
"image_ref" : "aeiou",
"patch_ref" : "aeiou",
"se_group_resume_options" : {
"action_on_error" : "aeiou",
"disruptive" : true,
"skip_suspended" : true
},
"se_group_options" : {
"action_on_error" : "aeiou",
"disruptive" : true
}
},
"statediff_ref" : "aeiou",
"previous_image_ref" : "aeiou",
"version" : "aeiou",
"after_reboot_rollback_fnc" : "aeiou",
"url" : "aeiou",
"start_time" : "aeiou",
"patch_reboot" : true,
"patch_list" : [ {
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"patch_version" : "aeiou"
} ],
"system" : true,
"tasks_completed" : 123,
"image_path" : "aeiou",
"tenant_ref" : "aeiou",
"after_reboot_task_name" : "aeiou",
"fips_mode" : true,
"name" : "aeiou",
"progress" : 123,
"enable_patch_rollback" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UpgradeStatusInfo
401
log in failed
Up
patch /upgradestatusinfo/{uuid}
(upgradestatusinfoUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UpgradeStatusInfo object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"seg_params" : "",
"image_ref" : "aeiou",
"previous_patch_list" : [ "" ],
"upgrade_events" : [ "" ],
"enable_rollback" : true,
"enqueue_time" : "aeiou",
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"prev_patch_image_path" : "aeiou",
"seg_status" : "",
"total_tasks" : 123,
"uuid" : "aeiou",
"_last_modified" : "aeiou",
"se_upgrade_events" : [ "" ],
"duration" : 123,
"node_type" : "aeiou",
"se_patch_image_ref" : "aeiou",
"previous_version" : "aeiou",
"previous_patch_version" : "aeiou",
"state" : "",
"upgrade_ops" : "aeiou",
"patch_version" : "aeiou",
"obj_cloud_ref" : "aeiou",
"se_patch_image_path" : "aeiou",
"prev_image_path" : "aeiou",
"previous_patch_image_ref" : "aeiou",
"end_time" : "aeiou",
"history" : [ {
"duration" : 123,
"start_time" : "aeiou",
"upgrade_events" : [ {
"task_name" : "aeiou",
"task" : "aeiou",
"sub_events" : [ "" ],
"nodes_events" : [ {
"duration" : 123,
"start_time" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"end_time" : "aeiou",
"sub_tasks" : [ "aeiou" ],
"message" : "aeiou",
"status" : true
} ]
} ],
"ops" : "aeiou",
"end_time" : "aeiou",
"seg_status" : {
"disrupted_vs_ref" : [ "aeiou" ],
"num_se_with_no_vs" : 123,
"reason" : [ "aeiou" ],
"enqueue_time" : "aeiou",
"notes" : [ "aeiou" ],
"se_upgrade_suspended" : [ "aeiou" ],
"se_upgrade_in_progress" : [ "aeiou" ],
"vs_scalein_in_progress_ref" : [ "aeiou" ],
"se_already_upgraded_at_start" : [ "aeiou" ],
"se_group_uuid" : "aeiou",
"se_reboot_in_progress_ref" : "aeiou",
"num_vs" : 123,
"vs_migrate_in_progress_ref" : [ "aeiou" ],
"se_upgrade_completed" : [ "aeiou" ],
"se_upgrade_errors" : [ "" ],
"duration" : "aeiou",
"in_progress" : true,
"request_time" : "aeiou",
"ha_mode" : "aeiou",
"se_ip_missing_at_start" : [ "aeiou" ],
"controller_version" : "aeiou",
"num_se_with_vs_not_scaledout" : 123,
"vs_scaleout_in_progress_ref" : [ "aeiou" ],
"num_vs_disrupted" : 123,
"traffic_status" : "aeiou",
"se_poweredoff_at_start" : [ "aeiou" ],
"vs_errors" : [ {
"reason" : [ "aeiou" ],
"se_group_ha_mode" : "aeiou",
"tenant_ref" : "aeiou",
"traffic_status" : "aeiou",
"vip_id" : "aeiou",
"event_timestamp" : {
"usecs" : 123456789,
"secs" : 123456789
},
"vs_ref" : "aeiou",
"se_group_ref" : "aeiou",
"se_ref" : "aeiou"
} ],
"state" : "aeiou",
"worker" : "aeiou",
"se_group_name" : "aeiou",
"end_time" : "aeiou",
"se_with_vs_scaledout" : [ "aeiou" ],
"thread" : "aeiou",
"se_disconnected_at_start" : [ "aeiou" ],
"start_time" : "aeiou",
"num_se" : 123,
"se_upgrade_not_started" : [ "aeiou" ],
"se_upgrade_skip_suspended" : [ "aeiou" ],
"num_se_with_vs_scaledout" : 123,
"tenant_ref" : "aeiou",
"se_upgrade_failed" : [ "aeiou" ],
"se_with_vs_not_scaledout" : [ "aeiou" ],
"progress" : 123,
"se_with_no_vs" : [ "aeiou" ]
},
"state" : {
"reason" : "aeiou",
"rebooted" : true,
"last_changed_time" : "",
"state" : "aeiou"
},
"statediff_ref" : "aeiou",
"patch_version" : "aeiou",
"version" : "aeiou",
"se_upgrade_events" : [ {
"reason" : [ "aeiou" ],
"to_se_ref" : "aeiou",
"vs_ref" : "aeiou",
"num_vs" : 123,
"se_group_ref" : "aeiou",
"from_se_ref" : "aeiou",
"num_se" : 123,
"se_group_ha_mode" : "aeiou",
"task" : "aeiou",
"num_se_group" : 123,
"sub_tasks" : [ "aeiou" ],
"traffic_status" : "aeiou",
"se_ref" : "aeiou"
} ]
} ],
"clean" : true,
"params" : {
"image_ref" : "aeiou",
"patch_ref" : "aeiou",
"se_group_resume_options" : {
"action_on_error" : "aeiou",
"disruptive" : true,
"skip_suspended" : true
},
"se_group_options" : {
"action_on_error" : "aeiou",
"disruptive" : true
}
},
"statediff_ref" : "aeiou",
"previous_image_ref" : "aeiou",
"version" : "aeiou",
"after_reboot_rollback_fnc" : "aeiou",
"url" : "aeiou",
"start_time" : "aeiou",
"patch_reboot" : true,
"patch_list" : [ {
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"patch_version" : "aeiou"
} ],
"system" : true,
"tasks_completed" : 123,
"image_path" : "aeiou",
"tenant_ref" : "aeiou",
"after_reboot_task_name" : "aeiou",
"fips_mode" : true,
"name" : "aeiou",
"progress" : 123,
"enable_patch_rollback" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UpgradeStatusInfo
401
log in failed
Up
put /upgradestatusinfo/{uuid}
(upgradestatusinfoUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UpgradeStatusInfo object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"seg_params" : "",
"image_ref" : "aeiou",
"previous_patch_list" : [ "" ],
"upgrade_events" : [ "" ],
"enable_rollback" : true,
"enqueue_time" : "aeiou",
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"prev_patch_image_path" : "aeiou",
"seg_status" : "",
"total_tasks" : 123,
"uuid" : "aeiou",
"_last_modified" : "aeiou",
"se_upgrade_events" : [ "" ],
"duration" : 123,
"node_type" : "aeiou",
"se_patch_image_ref" : "aeiou",
"previous_version" : "aeiou",
"previous_patch_version" : "aeiou",
"state" : "",
"upgrade_ops" : "aeiou",
"patch_version" : "aeiou",
"obj_cloud_ref" : "aeiou",
"se_patch_image_path" : "aeiou",
"prev_image_path" : "aeiou",
"previous_patch_image_ref" : "aeiou",
"end_time" : "aeiou",
"history" : [ {
"duration" : 123,
"start_time" : "aeiou",
"upgrade_events" : [ {
"task_name" : "aeiou",
"task" : "aeiou",
"sub_events" : [ "" ],
"nodes_events" : [ {
"duration" : 123,
"start_time" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"end_time" : "aeiou",
"sub_tasks" : [ "aeiou" ],
"message" : "aeiou",
"status" : true
} ]
} ],
"ops" : "aeiou",
"end_time" : "aeiou",
"seg_status" : {
"disrupted_vs_ref" : [ "aeiou" ],
"num_se_with_no_vs" : 123,
"reason" : [ "aeiou" ],
"enqueue_time" : "aeiou",
"notes" : [ "aeiou" ],
"se_upgrade_suspended" : [ "aeiou" ],
"se_upgrade_in_progress" : [ "aeiou" ],
"vs_scalein_in_progress_ref" : [ "aeiou" ],
"se_already_upgraded_at_start" : [ "aeiou" ],
"se_group_uuid" : "aeiou",
"se_reboot_in_progress_ref" : "aeiou",
"num_vs" : 123,
"vs_migrate_in_progress_ref" : [ "aeiou" ],
"se_upgrade_completed" : [ "aeiou" ],
"se_upgrade_errors" : [ "" ],
"duration" : "aeiou",
"in_progress" : true,
"request_time" : "aeiou",
"ha_mode" : "aeiou",
"se_ip_missing_at_start" : [ "aeiou" ],
"controller_version" : "aeiou",
"num_se_with_vs_not_scaledout" : 123,
"vs_scaleout_in_progress_ref" : [ "aeiou" ],
"num_vs_disrupted" : 123,
"traffic_status" : "aeiou",
"se_poweredoff_at_start" : [ "aeiou" ],
"vs_errors" : [ {
"reason" : [ "aeiou" ],
"se_group_ha_mode" : "aeiou",
"tenant_ref" : "aeiou",
"traffic_status" : "aeiou",
"vip_id" : "aeiou",
"event_timestamp" : {
"usecs" : 123456789,
"secs" : 123456789
},
"vs_ref" : "aeiou",
"se_group_ref" : "aeiou",
"se_ref" : "aeiou"
} ],
"state" : "aeiou",
"worker" : "aeiou",
"se_group_name" : "aeiou",
"end_time" : "aeiou",
"se_with_vs_scaledout" : [ "aeiou" ],
"thread" : "aeiou",
"se_disconnected_at_start" : [ "aeiou" ],
"start_time" : "aeiou",
"num_se" : 123,
"se_upgrade_not_started" : [ "aeiou" ],
"se_upgrade_skip_suspended" : [ "aeiou" ],
"num_se_with_vs_scaledout" : 123,
"tenant_ref" : "aeiou",
"se_upgrade_failed" : [ "aeiou" ],
"se_with_vs_not_scaledout" : [ "aeiou" ],
"progress" : 123,
"se_with_no_vs" : [ "aeiou" ]
},
"state" : {
"reason" : "aeiou",
"rebooted" : true,
"last_changed_time" : "",
"state" : "aeiou"
},
"statediff_ref" : "aeiou",
"patch_version" : "aeiou",
"version" : "aeiou",
"se_upgrade_events" : [ {
"reason" : [ "aeiou" ],
"to_se_ref" : "aeiou",
"vs_ref" : "aeiou",
"num_vs" : 123,
"se_group_ref" : "aeiou",
"from_se_ref" : "aeiou",
"num_se" : 123,
"se_group_ha_mode" : "aeiou",
"task" : "aeiou",
"num_se_group" : 123,
"sub_tasks" : [ "aeiou" ],
"traffic_status" : "aeiou",
"se_ref" : "aeiou"
} ]
} ],
"clean" : true,
"params" : {
"image_ref" : "aeiou",
"patch_ref" : "aeiou",
"se_group_resume_options" : {
"action_on_error" : "aeiou",
"disruptive" : true,
"skip_suspended" : true
},
"se_group_options" : {
"action_on_error" : "aeiou",
"disruptive" : true
}
},
"statediff_ref" : "aeiou",
"previous_image_ref" : "aeiou",
"version" : "aeiou",
"after_reboot_rollback_fnc" : "aeiou",
"url" : "aeiou",
"start_time" : "aeiou",
"patch_reboot" : true,
"patch_list" : [ {
"patch_image_path" : "aeiou",
"patch_image_ref" : "aeiou",
"patch_version" : "aeiou"
} ],
"system" : true,
"tasks_completed" : 123,
"image_path" : "aeiou",
"tenant_ref" : "aeiou",
"after_reboot_task_name" : "aeiou",
"fips_mode" : true,
"name" : "aeiou",
"progress" : 123,
"enable_patch_rollback" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
UpgradeStatusInfo
401
log in failed
[ Jump to Methods ]
Table of Contents
EventMapIpAddrOpsHistoryPatchDataSeGroupOptionsSeGroupResumeOptionsSeGroupStatusSeUpgradeEventsTimeStampUpgradeEventUpgradeOpsParamUpgradeOpsStateUpgradeStatusInfoUpgradeStatusInfoApiResponseVsError
nodes_events (optional)
array[UpgradeEvent] List of all events node wise.(Not in use). Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sub_events (optional)
array[UpgradeEvent] List of all events node wise. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
task (optional)
String Enum representing the task.(Not in use). Enum options - PREPARE_FOR_SHUTDOWN, COPY_AND_VERIFY_IMAGE, INSTALL_IMAGE, POST_INSTALL_HOOKS, PREPARE_CONTROLLER_FOR_SHUTDOWN, STOP_CONTROLLER, EXTRACT_PATCH_IMAGE, EXECUTE_PRE_INSTALL_COMMANDS, INSTALL_PATCH_IMAGE, PREPARE_FOR_REBOOT_CONTROLLER_NODES, REBOOT_CONTROLLER_NODES, WAIT_FOR_ALL_CONTROLLER_NODES_ONLINE, PRE_UPGRADE_HOOKS, MIGRATE_CONFIG, START_PRIMARY_CONTROLLER, START_ALL_CONTROLLERS, POST_UPGRADE_HOOKS, EXECUTE_POST_INSTALL_COMMANDS, SET_CONTROLLER_UPGRADE_COMPLETED, STATE_NOT_USED_IN_V2, COMMIT_UPGRADE, UNKNOWN_TASK, PATCH_CONTROLLER_HEALTH_CHECK. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
task_name (optional)
String Name representing the task. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
duration (optional)
Integer Duration of Upgrade operation in seconds. Field introduced in 20.1.4. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
end_time (optional)
String End time of Upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ops (optional)
String Upgrade operation performed. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
patch_version (optional)
String Patch after the upgrade operation. . Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_upgrade_events (optional)
array[SeUpgradeEvents] ServiceEngineGroup/SE events for upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
seg_status (optional)
SeGroupStatus SeGroup status for the upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
start_time (optional)
String Start time of Upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
state (optional)
UpgradeOpsState Upgrade operation status. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
statediff_ref (optional)
String Record of Pre/Post snapshot captured for current upgrade operation. It is a reference to an object of type StatediffOperation. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
upgrade_events (optional)
array[EventMap] Controller events for Upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
version (optional)
String Image after the upgrade operation. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
patch_image_path (optional)
String Image path of current patch image. . Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_image_ref (optional)
String Image uuid for identifying the patch. It is a reference to an object of type Image. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_version (optional)
String Patch version. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
action_on_error (optional)
String The error recovery action configured for a SE Group. Enum options - ROLLBACK_UPGRADE_OPS_ON_ERROR, SUSPEND_UPGRADE_OPS_ON_ERROR, CONTINUE_UPGRADE_OPS_ON_ERROR. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disruptive (optional)
Boolean Disable non-disruptive mechanism. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
action_on_error (optional)
String The error recovery action configured for a SE Group. Enum options - ROLLBACK_UPGRADE_OPS_ON_ERROR, SUSPEND_UPGRADE_OPS_ON_ERROR, CONTINUE_UPGRADE_OPS_ON_ERROR. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disruptive (optional)
Boolean Allow disruptive mechanism. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
skip_suspended (optional)
Boolean Skip upgrade on suspended SE(s). Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_version (optional)
String Controller version. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
disrupted_vs_ref (optional)
array[String] It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
duration (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end_time (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enqueue_time (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ha_mode (optional)
String Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
in_progress (optional)
Boolean ServiceEngineGroup upgrade in progress. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
notes (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_se (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_se_with_no_vs (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_se_with_vs_not_scaledout (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_se_with_vs_scaledout (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_vs (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_vs_disrupted (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
progress (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
reason (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
request_time (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_already_upgraded_at_start (optional)
array[String] ServiceEngines are already upgraded before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_disconnected_at_start (optional)
array[String] ServiceEngines in disconnected state before starting the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_ip_missing_at_start (optional)
array[String] ServiceEngines local ip not present before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_poweredoff_at_start (optional)
array[String] ServiceEngines in poweredoff state before the upgrade. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_reboot_in_progress_ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_completed (optional)
array[String] ServiceEngines upgrade completed. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_errors (optional)
array[SeUpgradeEvents] ServiceEngineGroup upgrade errors. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_failed (optional)
array[String] ServiceEngines upgrade failed. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_in_progress (optional)
array[String] ServiceEngines upgrade in progress. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_not_started (optional)
array[String] ServiceEngines upgrade not started. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_skip_suspended (optional)
array[String] Service Engines that were in suspended state and were skipped upon Service Engine Group ugprade resumption. It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_suspended (optional)
array[String] Service Engines which triggered Service Engine Group to be in suspended state. It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_with_no_vs (optional)
array[String] It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_with_vs_not_scaledout (optional)
array[String] It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_with_vs_scaledout (optional)
array[String] It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start_time (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
state (optional)
String Enum options - SE_UPGRADE_PREVIEW, SE_UPGRADE_IN_PROGRESS, SE_UPGRADE_COMPLETE, SE_UPGRADE_ERROR, SE_UPGRADE_PRE_CHECKS, SE_IMAGE_INSTALL, SE_UPGRADE_IMAGE_NOT_FOUND, SE_ALREADY_UPGRADED, SE_REBOOT, SE_CONNECT_AFTER_REBOOT, SE_PRE_UPGRADE_TASKS, SE_POST_UPGRADE_TASKS, SE_WAIT_FOR_SWITCHOVER, SE_CHECK_SCALEDOUT_VS_EXISTS, SE_UPGRADE_SEMGR_REQUEST, SE_UPGRADE_SEMGR_SE_UNREACHABLE, SE_PRE_UPGRADE_SCALE_IN_OPS, SE_POST_UPGRADE_SCALE_OUT_OPS, SE_UPGRADE_SUSPENDED, SE_UPGRADE_START, SE_UPGRADE_PAUSED, SE_UPGRADE_FAILED, SE_UPGRADE_VERSION_CHECKS, SE_UPGRADE_CONNECTIVITY_CHECKS, SE_UPGRADE_VERIFY_VERSION, SE_UPGRADE_SKIP_RESUME_OPS, SE_UPGRADE_SEMGR_DONE, SEGROUP_UPGRADE_NOT_STARTED, SEGROUP_UPGRADE_ENQUEUED, SEGROUP_UPGRADE_ENQUEUE_FAILED, SEGROUP_UPGRADE_IN_PROGRESS, SEGROUP_UPGRADE_COMPLETE, SEGROUP_UPGRADE_ERROR, SEGROUP_UPGRADE_SUSPENDED, VS_DISRUPTED, VS_SCALEIN, VS_SCALEIN_ERROR, VS_SCALEIN_ERROR_RPC_FAILED, VS_SCALEOUT, VS_SCALEOUT_ERROR, VS_SCALEOUT_ERROR_RPC_FAILED, VS_SCALEOUT_ERROR_SE_NOT_READY, VS_MIGRATE, VS_MIGRATE_ERROR, VS_MIGRATE_BACK, VS_MIGRATE_BACK_ERROR, VS_MIGRATE_BACK_NOT_NEEDED, VS_MIGRATE_ERROR_NO_CANDIDATE_SE, VS_MIGRATE_ERROR_RPC_FAILED, VS_MIGRATE_BACK_ERROR_SE_NOT_READY, VS_MIGRATE_BACK_ERROR_RPC_FAILED, SEGROUP_PAUSE_PLACEMENT, SEGROUP_RESUME_PLACEMENT, SEGROUP_CLOUD_DISCOVERY, SEGROUP_IMAGE_GENERATION, SEGROUP_IMAGE_COPY_INSTALL_TO_SES, SEGROUP_SERIAL_SE_UPGRADE, SEGROUP_PARALLEL_SE_UPGRADE, SEGROUP_V2_TO_V1_ROLLBACK, SEGROUP_FAILED_SE_ERROR_RECOVERY, SEGROUP_SE_CONNECTIVITY_CHECKS, SEGROUP_UPGRADE_START, SEGROUP_WAIT_FOR_WARM_START_DONE, SEGROUP_PRE_SNAPSHOT, SEGROUP_POST_SNAPSHOT, SEGROUP_WAIT_FOR_SNAPSHOT_COLLECTION. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
thread (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
traffic_status (optional)
String Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_errors (optional)
array[VsError] VirtualService errors during the SeGroup upgrade. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_migrate_in_progress_ref (optional)
array[String] It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_scalein_in_progress_ref (optional)
array[String] It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_scaleout_in_progress_ref (optional)
array[String] It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
worker (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
from_se_ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_se (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_se_group (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_vs (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
reason (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_ha_mode (optional)
String Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_ref (optional)
String It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sub_tasks (optional)
array[String] List of sub_tasks executed. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
task (optional)
String Enum options - SE_UPGRADE_PREVIEW, SE_UPGRADE_IN_PROGRESS, SE_UPGRADE_COMPLETE, SE_UPGRADE_ERROR, SE_UPGRADE_PRE_CHECKS, SE_IMAGE_INSTALL, SE_UPGRADE_IMAGE_NOT_FOUND, SE_ALREADY_UPGRADED, SE_REBOOT, SE_CONNECT_AFTER_REBOOT, SE_PRE_UPGRADE_TASKS, SE_POST_UPGRADE_TASKS, SE_WAIT_FOR_SWITCHOVER, SE_CHECK_SCALEDOUT_VS_EXISTS, SE_UPGRADE_SEMGR_REQUEST, SE_UPGRADE_SEMGR_SE_UNREACHABLE, SE_PRE_UPGRADE_SCALE_IN_OPS, SE_POST_UPGRADE_SCALE_OUT_OPS, SE_UPGRADE_SUSPENDED, SE_UPGRADE_START, SE_UPGRADE_PAUSED, SE_UPGRADE_FAILED, SE_UPGRADE_VERSION_CHECKS, SE_UPGRADE_CONNECTIVITY_CHECKS, SE_UPGRADE_VERIFY_VERSION, SE_UPGRADE_SKIP_RESUME_OPS, SE_UPGRADE_SEMGR_DONE, SEGROUP_UPGRADE_NOT_STARTED, SEGROUP_UPGRADE_ENQUEUED, SEGROUP_UPGRADE_ENQUEUE_FAILED, SEGROUP_UPGRADE_IN_PROGRESS, SEGROUP_UPGRADE_COMPLETE, SEGROUP_UPGRADE_ERROR, SEGROUP_UPGRADE_SUSPENDED, VS_DISRUPTED, VS_SCALEIN, VS_SCALEIN_ERROR, VS_SCALEIN_ERROR_RPC_FAILED, VS_SCALEOUT, VS_SCALEOUT_ERROR, VS_SCALEOUT_ERROR_RPC_FAILED, VS_SCALEOUT_ERROR_SE_NOT_READY, VS_MIGRATE, VS_MIGRATE_ERROR, VS_MIGRATE_BACK, VS_MIGRATE_BACK_ERROR, VS_MIGRATE_BACK_NOT_NEEDED, VS_MIGRATE_ERROR_NO_CANDIDATE_SE, VS_MIGRATE_ERROR_RPC_FAILED, VS_MIGRATE_BACK_ERROR_SE_NOT_READY, VS_MIGRATE_BACK_ERROR_RPC_FAILED, SEGROUP_PAUSE_PLACEMENT, SEGROUP_RESUME_PLACEMENT, SEGROUP_CLOUD_DISCOVERY, SEGROUP_IMAGE_GENERATION, SEGROUP_IMAGE_COPY_INSTALL_TO_SES, SEGROUP_SERIAL_SE_UPGRADE, SEGROUP_PARALLEL_SE_UPGRADE, SEGROUP_V2_TO_V1_ROLLBACK, SEGROUP_FAILED_SE_ERROR_RECOVERY, SEGROUP_SE_CONNECTIVITY_CHECKS, SEGROUP_UPGRADE_START, SEGROUP_WAIT_FOR_WARM_START_DONE, SEGROUP_PRE_SNAPSHOT, SEGROUP_POST_SNAPSHOT, SEGROUP_WAIT_FOR_SNAPSHOT_COLLECTION. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
to_se_ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
traffic_status (optional)
String Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
secs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
usecs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
duration (optional)
Integer Time taken to complete upgrade event in seconds. Field introduced in 18.2.6. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
end_time (optional)
String Task end time. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip (optional)
IpAddr Ip of the node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
message (optional)
String Upgrade event message if any. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start_time (optional)
String Task start time. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status (optional)
Boolean Upgrade event status. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sub_tasks (optional)
array[String] Sub tasks executed on each node. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
image_ref (optional)
String Image uuid for identifying base image. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_ref (optional)
String Image uuid for identifying patch. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_options (optional)
SeGroupOptions This field identifies SE group options that need to be applied during the upgrade operations. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_resume_options (optional)
SeGroupResumeOptions Apply options while resuming SE group upgrade operations. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
last_changed_time (optional)
TimeStamp The last time the state changed. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason (optional)
String Descriptive reason for the state-change. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rebooted (optional)
Boolean State for keeping track of reboot status during upgrade operation. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
state (optional)
String The upgrade operations current fsm-state. Enum options - UPGRADE_FSM_INIT, UPGRADE_FSM_STARTED, UPGRADE_FSM_WAITING, UPGRADE_FSM_IN_PROGRESS, UPGRADE_FSM_ENQUEUED, UPGRADE_FSM_ERROR, UPGRADE_FSM_SUSPENDED, UPGRADE_FSM_ENQUEUE_FAILED, UPGRADE_FSM_PAUSED, UPGRADE_FSM_COMPLETED, UPGRADE_FSM_ABORT_IN_PROGRESS, UPGRADE_FSM_ABORTED, UPGRADE_FSM_SE_UPGRADE_IN_PROGRESS, UPGRADE_FSM_CONTROLLER_COMPLETED, UPGRADE_FSM_DUMMY_3, UPGRADE_FSM_DUMMY_4, UPGRADE_FSM_DUMMY_5. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
after_reboot_rollback_fnc (optional)
String Backward compatible abort function name. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
after_reboot_task_name (optional)
String Backward compatible task dict name. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
clean (optional)
Boolean Flag for clean installation. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
duration (optional)
Integer Duration of Upgrade operation in seconds. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
enable_patch_rollback (optional)
Boolean Check if the patch rollback is possible on this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable_rollback (optional)
Boolean Check if the rollback is possible on this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end_time (optional)
String End time of Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enqueue_time (optional)
String Enqueue time of Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fips_mode (optional)
Boolean Fips mode for the entire system. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
history (optional)
array[OpsHistory] Record of past operations on this node. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
image_path (optional)
String Image path of current base image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
image_ref (optional)
String Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
node_type (optional)
String Type of the system such as controller_cluster, se_group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_cloud_ref (optional)
String Cloud that this object belongs to. It is a reference to an object of type Cloud. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
params (optional)
UpgradeOpsParam Parameters associated with the Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_image_path (optional)
String Image path of current patch image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_image_ref (optional)
String Image uuid for identifying the current patch.Example Base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_list (optional)
array[PatchData] List of patches applied to this node. Example Base-image is 18.2.6 and a patch 6p1 is applied, then a patch 6p5 applied. This field will indicate the [{'6p1', '6p1_image_uuid'}, {'6p5', '6p5_image_uuid'}] value. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_reboot (optional)
Boolean Flag for patch op with reboot. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_version (optional)
String Current patch version applied to this node. Example Base-image is 18.2.6 and a patch 6p1 is applied, then this field will indicate the 6p1 value. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prev_image_path (optional)
String Image path of previous base image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prev_patch_image_path (optional)
String Image path of previous patch image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
previous_image_ref (optional)
String Image uuid for identifying previous base image.Example Base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate the 18.2.5 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
previous_patch_image_ref (optional)
String Image uuid for identifying previous patch.Example Base-image was 18.2.6 with a patch 6p1. Upgrade was initiated to 18.2.8 with patch 8p1. The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value. . It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
previous_patch_list (optional)
array[PatchData] List of patches applied to this node on previous major version. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
previous_patch_version (optional)
String Previous patch version applied to this node.Example Base-image was 18.2.6 with a patch 6p1. Upgrade was initiated to 18.2.8 with patch 8p1. The previous_image field will contain 18.2.6 and this field will indicate the 6p1 value. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
previous_version (optional)
String Previous version prior to upgrade.Example Base-image was 18.2.5 and an upgrade was done to 18.2.6, then this field will indicate the 18.2.5 value. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
progress (optional)
Integer Upgrade operations progress which holds value between 0-100. Allowed values are 0-100. Field introduced in 18.2.8, 20.1.1. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_patch_image_path (optional)
String Image path of se patch image.(required in case of reimage and upgrade + patch). Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_patch_image_ref (optional)
String Image uuid for identifying the current se patch required in case of system upgrade(re-image) with se patch. . It is a reference to an object of type Image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_upgrade_events (optional)
array[SeUpgradeEvents] ServiceEngineGroup upgrade errors. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
seg_params (optional)
UpgradeOpsParam se_patch may be different from the controller_patch. It has to be saved in the journal for subsequent consumption. The SeGroup params will be saved in the controller entry as seg_params. . Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
seg_status (optional)
SeGroupStatus Detailed SeGroup status. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start_time (optional)
String Start time of Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
state (optional)
UpgradeOpsState Current status of the Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
statediff_ref (optional)
String Record of Pre/Post snapshot captured for current upgrade operation. It is a reference to an object of type StatediffOperation. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
system (optional)
Boolean Flag is set only in the cluster if the upgrade is initiated as a system-upgrade. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tasks_completed (optional)
Integer Completed set of tasks in the Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tenant_ref (optional)
String Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
total_tasks (optional)
Integer Total number of tasks in the Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
upgrade_events (optional)
array[EventMap] Events performed for Upgrade operation. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
upgrade_ops (optional)
String Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID Identifier for the system such as cluster, se group and se. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
String Current base image applied to this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
event_timestamp (optional)
TimeStamp The time at which the error occurred. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_ha_mode (optional)
String Enum options - HA_MODE_SHARED_PAIR, HA_MODE_SHARED, HA_MODE_LEGACY_ACTIVE_STANDBY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_group_ref (optional)
String It is a reference to an object of type ServiceEngineGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_ref (optional)
String The SE on which the VS errored during scale-in/scale-out operations. It is a reference to an object of type ServiceEngine. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
traffic_status (optional)
String Enum options - TRAFFIC_DISRUPTED, TRAFFIC_NOT_DISRUPTED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vip_id (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.