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
Use cases
Topics:
• 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
Navigate vCenter heirachy
Prerequisites
Ensure that you have verified all the pre-requisites mentioned in the Prerequisites on page 9.
About this task
The vSphere Client lists all the registered vCenters, hosts, clusters, and datacenters in a hierarchical manner.
You can use OMIVV APIs to retrieve the required details of host, cluster, vCenter, and datacenter listed in the vSphere Client.
This topic describes how you can:
● Retrieve host ID using Service Tag
● Retrieve cluster ID using cluster name
● Retrieve vCenter ID using vCenter IP
● Retrive cluster ID for a given host ID
● Get list of registered vCenters
● Get host details
● Retrieve host ID using Host IP
● Retrieve host details using host ID
Steps
Start an OMIVV session using OMIVV user credentials. OMIVV credentials are required to authenticate a client of the RESTful
API.
For more information, see OMIVV authentication on page 11.
● Retrieve host ID using Service Tag
Sample code to retrieve the host ID using Service Tag:
```json
def get_host_id_by_service_tag(bearer_token,ip_address, vcenter_ip, serviec_tag,
vc_username, vc_domain, vc_password):
"""Authenticate with OMIVV and enumerate reports."""
try:
""" Get all registered vcenter """
registered_vcenter_list = get_registered_vcenter_list(ip_address, bearer_token)
if(registered_vcenter_list is None):
print("No vcenter is regsitered with this OMIVV")
return
else:
vcenter_id = None;
registered_vc_array = json.loads(registered_vcenter_list)
for vc in registered_vc_array:
4
Use cases 13