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

Get details of cluster profiles

Table 88. Get details of cluster profiles

Field Type Description

id String Cluster ID or cluster profile ID or

repository profile ID or system profile ID

or drift detection job ID

profileName String Cluster profile name or repository profile

name or system profile name

description String Description of cluster profile or

repository profile or system profile

name String Cluster name

repoType String Repository profile type (Driver or

Firmware)

status String Drift detection job status

Get list of repository profiles

Table 89. Get list of repository profiles

Field Type Description

id String vCenter ID

profileName String Repository profile name

Get repository profile details

Table 90. Get repository profile details

Field Type Description

id String Repository profile ID

name String Repository profile name

description String Repository profile description.

globalDefault Boolean Dell EMC default catalog repository

profile (True). Factory-created firmware

repository profile.

repoType String Repository Type (Firmware or Driver)

protocolType String Protocol Type (NFS, CIFS). For

NFS, credential is not required.For

CIFS credentials are required. domain

parameter is not mandatory.

uri String Catalog location

synchronzeRepository Boolean Synchronize with currently repository

location (Enabled or Disabled)

username String share username

domain String domain name

password String share password

Response body 99