API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- Contents
- Overview
- Get started
- Security
- Use cases
- Session management
- License management
- Console management
- Repository profile management
- Cluster profile management
- Firmware repository inventory management
- Firmware inventory management
- Firmware update management
- System profile management
- Drift management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
Chapter 1: Overview...................................................................................................................... 6
Access OMIVV API documentation on Dell Technologies API marketplace..........................................................6
What is new in this release................................................................................................................................................6
Chapter 2: Get started.................................................................................................................. 9
Prerequisites......................................................................................................................................................................... 9
Base URI................................................................................................................................................................................ 9
Request headers.................................................................................................................................................................. 9
Rate limit................................................................................................................................................................................9
Chapter 3: Security...................................................................................................................... 11
OMIVV authentication....................................................................................................................................................... 11
Bearer Token..................................................................................................................................................................11
vCenter authorization....................................................................................................................................................... 12
Validate session token.................................................................................................................................................12
Validate vCenter user credentials ........................................................................................................................... 12
Chapter 4: Use cases................................................................................................................... 13
Navigate vCenter heirachy.............................................................................................................................................. 13
Retrieve firmware repository data................................................................................................................................ 24
Update firmware using catalogs.................................................................................................................................... 27
Retrieve OMIVV license information............................................................................................................................ 29
Compute server drift from baseline...............................................................................................................................31
Monitor component health in OMIVV.......................................................................................................................... 35
Chapter 5: Session management..................................................................................................37
Start an OMIVV session...................................................................................................................................................37
End an OMIVV session..................................................................................................................................................... 38
Chapter 6: License management..................................................................................................39
Get list of vCenter and host license ............................................................................................................................39
Get vCenter and hosts license details......................................................................................................................... 40
Upload license to OMIVV................................................................................................................................................ 40
Chapter 7: Console management................................................................................................. 42
Get list of registered vCenters...................................................................................................................................... 42
Get list of all hosts in vCenter........................................................................................................................................43
Get host details..................................................................................................................................................................43
Get vCenter tree view of data center..........................................................................................................................44
Set vCenter context.........................................................................................................................................................45
Get cluster details............................................................................................................................................................. 46
Get cluster health..............................................................................................................................................................47
Chapter 8: Repository profile management................................................................................. 49
Contents
Contents 3