UpdateSummary Class

Details about ongoing updates and availability of updates on the device.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

UpdateSummary(*, device_version_number: str | None = None, friendly_device_version_name: str | None = None, device_last_scanned_date_time: datetime | None = None, last_completed_scan_job_date_time: datetime | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
device_version_number
str

The current version of the device in format: 1.2.17312.13.",.

Default value: None
friendly_device_version_name
str

The current version of the device in text format.

Default value: None
device_last_scanned_date_time

The last time when a scan was done on the device.

Default value: None
last_completed_scan_job_date_time

The time when the last scan job was completed (success/cancelled/failed) on the appliance.

Default value: None

Variables

Name Description
id
str

The path ID that uniquely identifies the object.

name
str

The object name.

type
str

The hierarchical type of the object.

device_version_number
str

The current version of the device in format: 1.2.17312.13.",.

friendly_device_version_name
str

The current version of the device in text format.

device_last_scanned_date_time

The last time when a scan was done on the device.

last_completed_scan_job_date_time

The time when the last scan job was completed (success/cancelled/failed) on the appliance.

last_completed_download_job_date_time

The time when the last Download job was completed (success/cancelled/failed) on the appliance.

last_completed_install_job_date_time

The time when the last Install job was completed (success/cancelled/failed) on the appliance.

total_number_of_updates_available
int

The number of updates available for the current device version as per the last device scan.

total_number_of_updates_pending_download
int

The total number of items pending download.

total_number_of_updates_pending_install
int

The total number of items pending install.

reboot_behavior

Indicates if updates are available and at least one of the updates needs a reboot. Known values are: "NeverReboots", "RequiresReboot", and "RequestReboot".

ongoing_update_operation

The current update operation. Known values are: "None", "Scan", "Download", and "Install".

in_progress_download_job_id
str

The job ID of the download job in progress.

in_progress_install_job_id
str

The job ID of the install job in progress.

in_progress_download_job_started_date_time

The time when the currently running download (if any) started.

in_progress_install_job_started_date_time

The time when the currently running install (if any) started.

update_titles

The list of updates available for install.

total_update_size_in_bytes

The total size of updates available for download in bytes.