API Guide

ManualsBrandsDell ManualsAnalyticsOpenManage Integration for VMware vCenter

100

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

Response body

This topic describes each parameter in the example response.

Start an OMIVV session

Table 78. Start an OMIVV session

Field Type Description

accessToken String Token ID

tokenType String Token type

expiresAt Integer and string Expiry date and time for token ID.

Get list of vCenter and host license

Table 79. Get list of vCenter and host license

Field Type Description

id String License ID

entitlementID String Entitlement ID

licenseType Integer and string License Type (Standard or Evaluation)

maxHosts String Number of maximum hosts allowed

startDate Integer and string The date when the license is uploaded to

OMIVV

expirationDate Integer and string License expiry date

duration String License duration

licenseStatus String License status

Get host and vCenter license details, upload vCenter license

Table 80. Get host and vCenter license details, upload vCenter license

Field Type Description

id String License ID

entitlementID String Entitlement ID

licenseType String License Type (Standard or Evaluation)

maxHosts String Number of maximum hosts allowed

startDate Integer and string The date when the license is uploaded to

OMIVV

expiryDate Integer and string License expiry date

duration String Duration of the license

96 Response body