API Guide

ManualsBrandsDell ManualsAnalyticsOpenManage Integration for VMware vCenter

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

Get list of repository profiles..........................................................................................................................................49

Get repository profile details..........................................................................................................................................50

Create a new repository profile...................................................................................................................................... 51

Modify or edit repository profile....................................................................................................................................52

Chapter 9: Cluster profile management....................................................................................... 54

Get list of cluster profiles................................................................................................................................................54

Get details of cluster profiles......................................................................................................................................... 54

Chapter 10: Firmware repository inventory management............................................................. 57

Get firmware repository inventory details...................................................................................................................57

Chapter 11: Firmware inventory management.............................................................................. 59

Create host level firmware inventory report.............................................................................................................. 59

Create cluster level firmware inventory report..........................................................................................................60

Chapter 12: Firmware update management.................................................................................. 63

Create host level firmware update jobs.......................................................................................................................63

Create cluster level firmware update jobs.................................................................................................................. 64

Get list of firmware update jobs (Host and Cluster)................................................................................................65

Get firmware update job details (Host or Cluster)................................................................................................... 66

Delete firmware update job.............................................................................................................................................67

Cancel firmware update job............................................................................................................................................68

Chapter 13: System profile management..................................................................................... 70

Get list of system profiles............................................................................................................................................... 70

Get system profile details................................................................................................................................................70

Chapter 14: Host management..................................................................................................... 72

Get all drift detection job.................................................................................................................................................72

Get specified drift detection job....................................................................................................................................73

Get drift report for all clusters....................................................................................................................................... 74

Get drift report for specific cluster.............................................................................................................................. 75

Get firmware drift report ............................................................................................................................................... 76

Get driver drift report...................................................................................................................................................... 78

Get configuration drift report ....................................................................................................................................... 79

Gets host details on specified drift detection jobs.................................................................................................... 81

Chapter 15: Get subsystem health report (OMIVV Host Health)...................................................82

Chapter 16: Host management.....................................................................................................84

Get the host overview..................................................................................................................................................... 84

Get host firmware inventory.......................................................................................................................................... 85

Get host warranty.............................................................................................................................................................86

Get alarms and events..................................................................................................................................................... 87

Set alarms and events......................................................................................................................................................88

Get host power supply information.............................................................................................................................. 88

Get host memory information........................................................................................................................................ 89

Get host processors information...................................................................................................................................90

Contents