API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- 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
- Host management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
json_response = json.dumps(response.json(), indent=4, sort_keys=True)
return json_response;
else:
print("Get registered vCenter list failed")
def get_vcenter_tree_from_omivv(OMIVV_ip, vcenter_id, session_token):
url = "https://" + OMIVV_ip + "/Spectre/api/rest/v1/Services/ConsoleService/
Consoles/" + vcenter_id
head = {'Authorization': 'Bearer ' + session_token}
response = requests.get(url, verify=False, headers=head)
if (response.status_code == 200):
json_response = json.dumps(response.json(), indent=4, sort_keys=True)
return json_response
else:
print("Get registered vCenter list failed")
```
● Retrieve vCenter ID using vCenter IP
Sample code retrieve the vCenter ID using the vCenter IP:
```json
def get_vcenter_id(bearer_token, ip_address, vcenter_ip):
"""Authenticate with OMIVV and enumerate reports."""
try:
bearer_token = get_bearer_token(ip_address, user_name, password)
""" 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:
registered_vc_array = json.loads(registered_vcenter_list)
for vc in registered_vc_array:
if vcenter_ip.upper() == vc['ip'].upper():
print(vc['id'])
break
except:
print("get_vcenter_tree: Unexpected error:", sys.exc_info()[0])
def get_registered_vcenter_list(omivvIP,bearerToken):
"""Get all registered vcenter with this OMIVV"""
url ="https://" + omivvIP + "/Spectre/api/rest/v1/Services/ConsoleService/Consoles"
head = {'Authorization': 'Bearer ' + bearerToken}
response = requests.get(url, verify=False, headers=head)
if(response.status_code == 200):
json_response = json.dumps(response.json(), indent=4, sort_keys=True)
return json_response;
else:
print("Get registered vCenter list failed")
```
● Retrieve cluster ID for a given host ID
Sample code to retrive the cluster ID using host ID:
```json
def get_cluster_id_by_host_id(bearer_token, ip_address, vcenter_ip, host_id,
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:
16
Use cases