API Guide

Overview
OpenManage Integration for VMware vCenter (OMIVV) provides RESTful APIs to enable automation. The support for RESTful
API is available from version 5.2.0. The APIs are compliant with OpenAPI Specification (OAS) 3.0.0.
This document is intended for a vCenter Administrator. It is assumed that the reader is familiar with REST APIs and
programmatic interaction with REST APIs. Any programming language can be used to create applications that interface with
these APIs. You can run the APIs using an API Client such as Curl or Postman.
OMIVV sample API scripts are available at https://github.com/dell/omivv.
Topics:
• Access OMIVV API documentation on Dell Technologies API marketplace
• What is new in this release
Access OMIVV API documentation on Dell
Technologies API marketplace
About this task
The API documentation for OMIVV 5.2 and later versions is now available on the Dell Technologies API Marketplace. To access
the OMIVV API documentation:
Steps
1. Go to https://api-marketplace.dell.com/.
2. Click Explore API and then click APIs.
3. Under Filter by Categories, select Infrastructure.
4. Under Filter By API Access, select Public.
5. Under Filter By API Type, select Catalog.
The OMIVV API is displayed.
6. Click View More.
What is new in this release
Table 1. List of new and enhanced APIs (continued)
Summary of new APIs APIs
● License management
○ GET to retrieve list of all licenses uploaded in OMIVV
and details by license ID
○ POST for uploading new licenses (in XML file format)
to OMIVV
● (GET)/Services/LicenseService/Licenses—
Gets list of all licenses uploaded in OMIVV
● (GET)/Services/LicenseService/Licenses/
{id}—Gets license details using license ID
● (POST)/Services/LicenseService/Licenses—
Uploads new license in XML file format to OMIVV
● Console management
○ GET for all the hosts in a given vCenter and the details
of a particular host
● (GET)/Services/ConsoleService/Consoles/
{id}/Hosts?serviceTags={service Tag1}&
serviceTags={serviceTag2}—Gets the list of all
the hosts registered in a vCenter for the given OMIVV IP.
1
6 Overview