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

Table 84. Get vCenter tree view of datacenter (continued)

Field Type Description

is configured properly using DNS.

Otherwise, hostname value displayed as

null or blank.

ip String vCenter IP

name String Datacenter name or cluster name

registeredWithVlcm Boolean vSphere Lifecycle Manager (vLCM)

registration status (true or false)

Get cluster details

Table 85. Get cluster details

Field Type Description

id String Cluster ID or host ID

name String Cluster name

cluster type String Cluster type (vSAN or vSphere)

hostip String Host IPv4

managementIP String iDRAC IP

hostname String vCenter host name

serviceTag String Service Tag of the server

model String Server model name

systemId String System ID

Get cluster health

Table 86. Get cluster health

Field Type Description

clusterId String Cluster ID

drsState String DRS state (Enabled or Disabled)

vsanObjectHealth String vSAN object health status (Healthy,

Unhealthy, or N/A)

Get list of cluster profiles

Table 87. Get list of cluster profiles

Field Type Description

id String Cluster profile ID

profileName String Cluster profile name

description String Cluster profile description

98 Response body