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
Contents
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
Drift 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 99. Get firmware drift report (continued)

Field Type Description

managementIP String iDRAC IP

Service Tag String Service Tag of the host

model String Server Model Name

systemID String System ID

complianceStatus String Compliance Status.

You may get any of the following values for

compliant status:

VERSION_MISMATCH

NEW COMPONENT

COMPONENT MISSING/ATTRIBUTE_MISMATCH

NOT_APPLICABLE

nonCompliantType String Reason for non-compliance

noncompliantTypeDescription String Detailed description for non-compliance

componentID String Component ID

packageID String Package ID

bundleID String Bundle ID

instanceID String FQDD

componentName String Component Name

componentType String Component Type

componentTypeDisplay String Component Type Display. For example, firmware is

displayed as FRMW.

upgrade Boolean Component Upgrade required (True or False)

criticality String Importance of component update

rebootRequired Boolean Host reboot required (true or false)

deviceID String Device ID

subDeviceID String Sub device ID

subVendorID String Sub Vendor ID

vendorID String Vendor ID

driftedVersionInfo String Component version in host

baselineVersionInfo" String component version in repository

Get drift report for all clusters

Table 100. Get drift report for all clusters

Field Type Description

id String Cluster ID or cluster profile ID.

name String Cluster name or cluster profile name

Response body 105