API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- Overview
- Get started
- Security
- Use cases
- Session management
- License management
- Console management
- Repository profile management
- Cluster profile management
- Firmware repository inventory management
- Firmware inventory management
- Firmware update management
- System profile management
- Host management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
Table 75. Cluster or host level firmware update job (continued)
Parameter Description
Force reboot: Apply updates and force reboot without
entering maintenance mode. Applicable for vSphere and
datacenter host level.
NOTE: If you select the Next reboot
or Force reboot options, the following
parameters are not applicable: exitMaintenanceMode,
migratePoweredOffAndSuspendedVMs,
enterMaintenanceModetimeout,
enterMaintenanceModeOption
preCheck Prerequisites check before firmware update.
Ensure that prerequisites checks are met in your environment:
For vSAN host and cluster:
DRS is enabled
Host is not already in maintenance mode
vSAN data objects are healthy
For vSphere host and cluster:
DRS is enabled.
The possible input value is true or false. Default value is true
if the required value is not entered. For cluster-level firmware
update, the only allowed value is true.
hostId Host ID. You can update only 64 hosts. To get the host ID,
run /Services/ConsoleService/Consoles/{id}
clusterId Cluster ID. To get the cluster ID, run /Services/
ConsoleService/Consoles/{id}.
bundleId Bundle ID. To get the bundle ID,
run /Services/RepositoryManagementService/
RepositoryData?bundleId={bundleId}
packageIDs package ID. To get the package ID, run /Services/
UpdateService/FWReport.
Package ID of the up-to-date components are not supported
and firmware update job fails.
exitMaintenanceMode Exit maintenance mode after firmware update completes. If
you disable this option, host remains in maintenance mode.
migratePoweredOffAndSuspendedVMs Move powered-off and suspended virtual machines to other
hosts in cluster. Disabling this option disconnects VM until the
host device is online.
resetIDracAndDeleteJobs Clears all the iDRAC jobs present in the Job Queue followed
by iDRAC reset before updating firmware on the host.
If you do not mention any value while running API, OMIVV
considers the settings configured on the
Settings > Firmware Update Settings on the User
Interface.
enterMaintenanceModetimeout Enter the Maintenance Mode timeout value between 60–1440
minutes. If the wait time goes beyond the specified time, the
update jobs fail and enter maintenance task will be canceled
94 Request body