UpgradeStatusInfo

UpgradeStatusInfo
UpgradeStatusInfo
JSON Example
{
    "_last_modified": "string",
    "after_reboot_rollback_fnc": "string",
    "after_reboot_task_name": "string",
    "clean": false,
    "duration": 0,
    "enable_patch_rollback": false,
    "enable_rollback": false,
    "end_time": "string",
    "enqueue_time": "string",
    "fips_mode": false,
    "history": [
        {
            "duration": 0,
            "end_time": "string",
            "ops": "string",
            "patch_version": "string",
            "se_upgrade_events": [
                {
                    "from_se_ref": "string",
                    "num_se": 0,
                    "num_se_group": 0,
                    "num_vs": 0,
                    "reason": [
                        "string"
                    ],
                    "se_group_ha_mode": "string",
                    "se_group_ref": "string",
                    "se_ref": "string",
                    "sub_tasks": [
                        "string"
                    ],
                    "task": "string",
                    "to_se_ref": "string",
                    "traffic_status": "string",
                    "vs_ref": "string"
                }
            ],
            "seg_status": {
                "controller_version": "string",
                "disrupted_vs_ref": [
                    "string"
                ],
                "duration": "string",
                "end_time": "string",
                "enqueue_time": "string",
                "ha_mode": "string",
                "in_progress": false,
                "notes": [
                    "string"
                ],
                "num_se": 0,
                "num_se_with_no_vs": 0,
                "num_se_with_vs_not_scaledout": 0,
                "num_se_with_vs_scaledout": 0,
                "num_vs": 0,
                "num_vs_disrupted": 0,
                "progress": 0,
                "reason": [
                    "string"
                ],
                "request_time": "string",
                "se_already_upgraded_at_start": [
                    "string"
                ],
                "se_disconnected_at_start": [
                    "string"
                ],
                "se_group_name": "string",
                "se_group_uuid": "string",
                "se_ip_missing_at_start": [
                    "string"
                ],
                "se_poweredoff_at_start": [
                    "string"
                ],
                "se_reboot_in_progress_ref": "string",
                "se_upgrade_completed": [
                    "string"
                ],
                "se_upgrade_errors": [
                    {
                        "from_se_ref": "string",
                        "num_se": 0,
                        "num_se_group": 0,
                        "num_vs": 0,
                        "reason": [
                            "string"
                        ],
                        "se_group_ha_mode": "string",
                        "se_group_ref": "string",
                        "se_ref": "string",
                        "sub_tasks": [
                            "string"
                        ],
                        "task": "string",
                        "to_se_ref": "string",
                        "traffic_status": "string",
                        "vs_ref": "string"
                    }
                ],
                "se_upgrade_failed": [
                    "string"
                ],
                "se_upgrade_in_progress": [
                    "string"
                ],
                "se_upgrade_not_started": [
                    "string"
                ],
                "se_upgrade_skip_suspended": [
                    "string"
                ],
                "se_upgrade_suspended": [
                    "string"
                ],
                "se_with_no_vs": [
                    "string"
                ],
                "se_with_vs_not_scaledout": [
                    "string"
                ],
                "se_with_vs_scaledout": [
                    "string"
                ],
                "start_time": "string",
                "state": "string",
                "tenant_ref": "string",
                "thread": "string",
                "traffic_status": "string",
                "vs_errors": [
                    {
                        "event_timestamp": {
                            "secs": 0,
                            "usecs": 0
                        },
                        "reason": [
                            "string"
                        ],
                        "se_group_ha_mode": "string",
                        "se_group_ref": "string",
                        "se_ref": "string",
                        "tenant_ref": "string",
                        "traffic_status": "string",
                        "vip_id": "string",
                        "vs_ref": "string"
                    }
                ],
                "vs_migrate_in_progress_ref": [
                    "string"
                ],
                "vs_scalein_in_progress_ref": [
                    "string"
                ],
                "vs_scaleout_in_progress_ref": [
                    "string"
                ],
                "worker": "string"
            },
            "start_time": "string",
            "state": {
                "last_changed_time": {
                    "secs": 0,
                    "usecs": 0
                },
                "reason": "string",
                "rebooted": false,
                "state": "string"
            },
            "statediff_ref": "string",
            "upgrade_events": [
                {
                    "nodes_events": [
                        {
                            "duration": 0,
                            "end_time": "string",
                            "ip": {
                                "addr": "string",
                                "type": "string"
                            },
                            "message": "string",
                            "start_time": "string",
                            "status": false,
                            "sub_tasks": [
                                "string"
                            ]
                        }
                    ],
                    "sub_events": [
                        {
                            "duration": 0,
                            "end_time": "string",
                            "ip": {
                                "addr": "string",
                                "type": "string"
                            },
                            "message": "string",
                            "start_time": "string",
                            "status": false,
                            "sub_tasks": [
                                "string"
                            ]
                        }
                    ],
                    "task": "string",
                    "task_name": "string"
                }
            ],
            "version": "string"
        }
    ],
    "image_path": "string",
    "image_ref": "string",
    "name": "string",
    "node_type": "string",
    "obj_cloud_ref": "string",
    "params": {
        "image_ref": "string",
        "patch_ref": "string",
        "se_group_options": {
            "action_on_error": "string",
            "disruptive": false
        },
        "se_group_resume_options": {
            "action_on_error": "string",
            "disruptive": false,
            "skip_suspended": false
        }
    },
    "patch_image_path": "string",
    "patch_image_ref": "string",
    "patch_list": [
        {
            "patch_image_path": "string",
            "patch_image_ref": "string",
            "patch_version": "string"
        }
    ],
    "patch_reboot": false,
    "patch_version": "string",
    "prev_image_path": "string",
    "prev_patch_image_path": "string",
    "prev_remote_image_ref": "string",
    "previous_image_ref": "string",
    "previous_patch_image_ref": "string",
    "previous_patch_list": [
        {
            "patch_image_path": "string",
            "patch_image_ref": "string",
            "patch_version": "string"
        }
    ],
    "previous_patch_version": "string",
    "previous_version": "string",
    "progress": 0,
    "reason": "string",
    "remote_image_ref": "string",
    "se_patch_image_path": "string",
    "se_patch_image_ref": "string",
    "se_upgrade_events": [
        {
            "from_se_ref": "string",
            "num_se": 0,
            "num_se_group": 0,
            "num_vs": 0,
            "reason": [
                "string"
            ],
            "se_group_ha_mode": "string",
            "se_group_ref": "string",
            "se_ref": "string",
            "sub_tasks": [
                "string"
            ],
            "task": "string",
            "to_se_ref": "string",
            "traffic_status": "string",
            "vs_ref": "string"
        }
    ],
    "seg_params": {
        "image_ref": "string",
        "patch_ref": "string",
        "se_group_options": {
            "action_on_error": "string",
            "disruptive": false
        },
        "se_group_resume_options": {
            "action_on_error": "string",
            "disruptive": false,
            "skip_suspended": false
        }
    },
    "seg_status": {
        "controller_version": "string",
        "disrupted_vs_ref": [
            "string"
        ],
        "duration": "string",
        "end_time": "string",
        "enqueue_time": "string",
        "ha_mode": "string",
        "in_progress": false,
        "notes": [
            "string"
        ],
        "num_se": 0,
        "num_se_with_no_vs": 0,
        "num_se_with_vs_not_scaledout": 0,
        "num_se_with_vs_scaledout": 0,
        "num_vs": 0,
        "num_vs_disrupted": 0,
        "progress": 0,
        "reason": [
            "string"
        ],
        "request_time": "string",
        "se_already_upgraded_at_start": [
            "string"
        ],
        "se_disconnected_at_start": [
            "string"
        ],
        "se_group_name": "string",
        "se_group_uuid": "string",
        "se_ip_missing_at_start": [
            "string"
        ],
        "se_poweredoff_at_start": [
            "string"
        ],
        "se_reboot_in_progress_ref": "string",
        "se_upgrade_completed": [
            "string"
        ],
        "se_upgrade_errors": [
            {
                "from_se_ref": "string",
                "num_se": 0,
                "num_se_group": 0,
                "num_vs": 0,
                "reason": [
                    "string"
                ],
                "se_group_ha_mode": "string",
                "se_group_ref": "string",
                "se_ref": "string",
                "sub_tasks": [
                    "string"
                ],
                "task": "string",
                "to_se_ref": "string",
                "traffic_status": "string",
                "vs_ref": "string"
            }
        ],
        "se_upgrade_failed": [
            "string"
        ],
        "se_upgrade_in_progress": [
            "string"
        ],
        "se_upgrade_not_started": [
            "string"
        ],
        "se_upgrade_skip_suspended": [
            "string"
        ],
        "se_upgrade_suspended": [
            "string"
        ],
        "se_with_no_vs": [
            "string"
        ],
        "se_with_vs_not_scaledout": [
            "string"
        ],
        "se_with_vs_scaledout": [
            "string"
        ],
        "start_time": "string",
        "state": "string",
        "tenant_ref": "string",
        "thread": "string",
        "traffic_status": "string",
        "vs_errors": [
            {
                "event_timestamp": {
                    "secs": 0,
                    "usecs": 0
                },
                "reason": [
                    "string"
                ],
                "se_group_ha_mode": "string",
                "se_group_ref": "string",
                "se_ref": "string",
                "tenant_ref": "string",
                "traffic_status": "string",
                "vip_id": "string",
                "vs_ref": "string"
            }
        ],
        "vs_migrate_in_progress_ref": [
            "string"
        ],
        "vs_scalein_in_progress_ref": [
            "string"
        ],
        "vs_scaleout_in_progress_ref": [
            "string"
        ],
        "worker": "string"
    },
    "start_time": "string",
    "state": {
        "last_changed_time": {
            "secs": 0,
            "usecs": 0
        },
        "reason": "string",
        "rebooted": false,
        "state": "string"
    },
    "statediff_ref": "string",
    "system": false,
    "system_report_refs": [
        "string"
    ],
    "tasks_completed": 0,
    "tenant_ref": "string",
    "total_tasks": 0,
    "upgrade_events": [
        {
            "nodes_events": [
                {
                    "duration": 0,
                    "end_time": "string",
                    "ip": {
                        "addr": "string",
                        "type": "string"
                    },
                    "message": "string",
                    "start_time": "string",
                    "status": false,
                    "sub_tasks": [
                        "string"
                    ]
                }
            ],
            "sub_events": [
                {
                    "duration": 0,
                    "end_time": "string",
                    "ip": {
                        "addr": "string",
                        "type": "string"
                    },
                    "message": "string",
                    "start_time": "string",
                    "status": false,
                    "sub_tasks": [
                        "string"
                    ]
                }
            ],
            "task": "string",
            "task_name": "string"
        }
    ],
    "upgrade_ops": "string",
    "upgrade_readiness": {
        "checks": [
            {
                "check_code": "string",
                "description": "string",
                "details": [
                    "string"
                ],
                "duration": 0,
                "end_time": "string",
                "error_details": [
                    "string"
                ],
                "start_time": "string",
                "state": "string"
            }
        ],
        "checks_completed": 0,
        "duration": 0,
        "end_time": "string",
        "image_ref": "string",
        "patch_image_ref": "string",
        "start_time": "string",
        "state": {
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "reason": "string",
            "rebooted": false,
            "state": "string"
        },
        "total_checks": 0,
        "upgrade_ops": "string"
    },
    "url": "string",
    "uuid": "string",
    "version": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
after_reboot_rollback_fnc
Optional

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.

string
after_reboot_task_name
Optional

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.

boolean
clean
Optional

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.

integer As int32 As int32
duration
Optional

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.

boolean
enable_patch_rollback
Optional

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.

boolean
enable_rollback
Optional

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.

string
end_time
Optional

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.

string
enqueue_time
Optional

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.

boolean
fips_mode
Optional

Fips mode for the entire system. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of OpsHistory
history
Optional

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.

string
image_path
Optional

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.

string
image_ref
Optional

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.

string
name
Optional

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.

string
node_type
Optional

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.

string
obj_cloud_ref
Optional

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

params

string
patch_image_path
Optional

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.

string
patch_image_ref
Optional

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.

array of PatchData
patch_list
Optional

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.

boolean
patch_reboot
Optional

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.

string
patch_version
Optional

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.

string
prev_image_path
Optional

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.

string
prev_patch_image_path
Optional

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.

string
prev_remote_image_ref
Optional

Remote image reference of previous base image. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
previous_image_ref
Optional

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.

string
previous_patch_image_ref
Optional

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.

array of PatchData
previous_patch_list
Optional

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.

string
previous_patch_version
Optional

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.

string
previous_version
Optional

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.

integer As uint32 As uint32
progress
Optional

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.

string
reason
Optional

Descriptive reason for the Upgrade state. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
remote_image_ref
Optional

Remote image reference of current base image. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
se_patch_image_path
Optional

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.

string
se_patch_image_ref
Optional

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

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

seg_params

seg_status
Optional

seg_status

string
start_time
Optional

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

state

string
statediff_ref
Optional

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.

boolean
system
Optional

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.

array of string
system_report_refs
Optional

Tracks the list of reports created for node. It is a reference to an object of type SystemReport. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
tasks_completed
Optional

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.

string
tenant_ref
Optional

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.

integer As int32 As int32
total_tasks
Optional

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.

array of EventMap
upgrade_events
Optional

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.

string
upgrade_ops
Optional

Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME, EVAL_UPGRADE, EVAL_PATCH, EVAL_ROLLBACK, EVAL_ROLLBACKPATCH, EVAL_SEGROUP_RESUME, EVAL_RESTORE, RESTORE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

upgrade_readiness
Optional

upgrade_readiness

string
url
Optional

url

string
uuid
Optional

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.

string
version
Optional

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.