API Guide

ManualsBrandsDell ManualsAnalyticsOpenManage Integration for VMware vCenter

101

102

103

104

105

106

107

108

109

110

Table Of Contents

OpenManage Integration for VMware vCenter Version 5.3 API Guide
Overview
- Access OMIVV API documentation on Dell Technologies API marketplace
- What is new in this release
Get started
- Prerequisites
- Base URI
- Request headers
- Rate limit
Security
- OMIVV authentication
  - Bearer Token
- vCenter authorization
  - Validate session token
  - Validate vCenter user credentials
Use cases
- Navigate vCenter heirachy
- Retrieve firmware repository data
- Update firmware using catalogs
- Retrieve OMIVV license information
- Compute server drift from baseline
- Monitor component health in OMIVV
Session management
- Start an OMIVV session
- End an OMIVV session
License management
- Get list of vCenter and host license
- Get vCenter and hosts license details
- Upload license to OMIVV
Console management
- Get list of registered vCenters
- Get list of all hosts in vCenter
- Get host details
- Get vCenter tree view of data center
- Set vCenter context
- Get cluster details
- Get cluster health
Repository profile management
- Get list of repository profiles
- Get repository profile details
- Create a new repository profile
- Modify or edit repository profile
Cluster profile management
- Get list of cluster profiles
- Get details of cluster profiles
Firmware repository inventory management
- Get firmware repository inventory details
Firmware inventory management
- Create host level firmware inventory report
- Create cluster level firmware inventory report
Firmware update management
- Create host level firmware update jobs
- Create cluster level firmware update jobs
- Get list of firmware update jobs (Host and Cluster)
- Get firmware update job details (Host or Cluster)
- Delete firmware update job
- Cancel firmware update job
System profile management
- Get list of system profiles
- Get system profile details
Host management
- Get all drift detection job
- Get specified drift detection job
- Get drift report for all clusters
- Get drift report for specific cluster
- Get firmware drift report
- Get driver drift report
- Get configuration drift report
- Gets host details on specified drift detection jobs
Get subsystem health report (OMIVV Host Health)
Host management
- Get the host overview
- Get host firmware inventory
- Get host warranty
- Get alarms and events
- Set alarms and events
- Get host power supply information
- Get host memory information
- Get host processors information
Request body
Response body
OMIVV-Specific error codes

Table 97. Get host or cluster firmware update job details

Field Type Description

If the wait time goes beyond the

specified time, the update jobs fail and

enter maintenance task will be canceled

or timed out. However, the components

may get updated automatically when the

host is restarted

enterMaintenanceModeOption String Enter maintenance mode option. This

option is applicable for vSAN host and

cluster.

Supported options are:

Ensure accessibility

Full Data migration

No data migration

Get list of system profiles and get system profile details

Table 98. Get list of system profiles and get system profile details

Field Type Description

id String system profile ID

name String system profile name

description String profile description

systemProfileType String system profile type (basic or advanced)

referenceESXiHostNameOrIP String Reference server hostname or hostIP

referenceManagementIP String iDRAC IP

referenceiDRACType String iDRAC license type

serviceTag String Service Tag of a host

serverModel String Server model name

dateCreated String Date and time when the profile is

created

dateModified String Date and time when the profile is

modified

lastModifiedBy String Details of the user who modified the

profile

Get firmware drift report

Table 99. Get firmware drift report

Field Type Description

id String Host ID

hostip String Host IP

hostname String Hostname

104 Response body