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.

This document describes the set of APIs that can be used to automate the catalog-based host and cluster level firmware

updates and firmware drift management.

OMIVV sample API scripts are available at https://github.com/dell/omivv.

Topics:

• Supported APIs

• Prerequisites

• Base URI

• Request headers

• Sequence of API for firmware update

Supported APIs

● Start an OMIVV session

● Get vCenter details

● Set vCenter context

● Get datacenters, clusters, and hosts details

● Get cluster and cluster health details

● Get cluster profile details

● Get repository profile details

● Get firmware repository inventory details

● Create host and cluster level firmware inventory report

● Create host and cluster level firmware update job

● Get host firmware update job details

● Get firmware drift report

● End an OMIVV session

Prerequisites

Before using the OMIVV APIs:

● Create all the profiles (Host Credential Profile, Cluster Profile, System Profile, Repository Profile) in OMIVV User Interface

(UI) and use the profiles as required.

● The hosts must be management-complaint. For more information, see the Management Compliance topic in User's Guide.

Base URI

The base URI for any OMIVV RESTful API request must be in the following format:

https://{OMIVV Address}/Spectre/api/rest/v1/Services/

OMIVV Address: IPv4 address or Fully Qualified Domain Name (FQDN).

Overview 5