OpenManage Integration for VMware vCenter Version 5.2 User's Guide

Using OMIVV as a firmware add-on provider in vSphere Lifecycle Manager—vSphere Automation APIs

Scan firmware compliance

Before managing the clusters using vSphere Automation API, ensure that you have completed the following tasks using vSphere Lifecycle Manager User Interface:

Select the hardware support manager as DellEMC OMIVV.
Select a cluster profile that is applicable for the selected cluster and save the image.

Command: POST https://{VC IP/FQDN}/api/esx/settings/clusters/{cluster ID}/software?vmw-task=true&action=scan

{
    "spec" : {
      "message": "test commit"
    }
}

Description: Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

HTTP response codes: 200. For the list of all the response codes, see Response codes.

Example response:

{task ID}

Get compliance task status

Command: GET https://{VC IP/FQDN}/rest/cis/tasks/{task ID}

Description: Returns information about a task.

HTTP response codes: 200. For the list of all the response codes, see Response codes.

Example response: The following example contains only firmware non-compliance.

"result": 
[
{
 "value": 
[
{
"value": 
{
"hardware_modules": 
[
{
 "value": 
 {
 "current": 
 {
 "version": "25.5.6.0009"
 },
 "details": 
 {
 "component_class": "PCI_DEVICE",
 "description": "PERC H730 Mini"
 } "notifications": 
 {
  "info": 
 [
 {
 "id": "Different versions.",
 "time": "2020-02-04T10:47:54.422Z",
 "message": 
 {
 "args": [],
 "default_message": "Different versions.",
 "id": "Different versions."
  }
  }
 ]
 },
 "status": "NON_COMPLIANT",
 "target": {
 "version": "25.5.5.0005"
  }
  }
 "key": ""
  }
  ],
 "notifications": 
 {
 "info": 
 [
 {
 "id": "[vCenter:<vCenter IP/FQDN>][Cluster: <Cluster name>][Host: <host IP/FQDN>]              The host is non-compliant",
 "time": "2020-02-04T10:47:54.423Z",
 "message": 
 {
 "args": [],
 "default_message": “[vCenter:<vCenter IP/FQDN>][Cluster: <Cluster name>][Host: <host IP/FQDN>] The host is non-compliant",
 "id": "[vCenter:<vCenter IP/FQDN>][Cluster: <Cluster name>][Host: <host IP/FQDN>] The host is non-compliant"
 }
 }]
 },
"status": "NON_COMPLIANT",
"target": {
"pkg": "<cluster profile name>",
 "version": "0.0.0-0"
 }
 },
 "key": "com.dell.plugin.OpenManager_HWSupportManager"
 }
 ],

Run remediation pre-check

Command: POST https://{VC IP/FQDN}/api/esx/settings/clusters/{cluster ID}/software?vmw-task=true&action=check

Description: Runs checks on the cluster before applying the desired state across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired state.

HTTP response codes: 200. For the list of all the response codes, see Response codes.

Example response:

{task-id}

Get remediation pre-check task status

Command: GET https://{VC IP/FQDN}/rest/cis/tasks/{task ID}

Description: Returns information about a task.

HTTP response code: 200. For the list of all the response codes, see Response codes.

Example response:

{
 "value": 
{
"parent": "",
"cancelable": true,
"end_time": "2020-02-12T18:03:59.391Z",
"description": 
{
 "args": [],
 "default_message": "Task created by VMware vSphere Lifecycle Manager",
 "id": "com.vmware.vcIntegrity.lifecycle.Task.Description"
  },
 "target":
{
"id": "domain-c8",
 "type": "ClusterComputeResource"
 },
 "result": 
{
"start_time": "2020-02-12T17:52:09.264Z",
"commit": "",
"end_time": "2020-02-12T18:03:59.386Z",
 "entity_results": 
[
{
"host": "host-47",
"type": "HOST",
"check_statuses": [],
"status": "OK"
 }
 {
"host": "host-41",
"type": "HOST",
"check_statuses": [],
"status": "OK"
 },
 {
 "host": "host-22",
 "type": "HOST",
 "check_statuses": [],
 "status": "OK"
  },
{
  "host": "host-16",
  "type": "HOST",
  "check_statuses": [
{
  "check": 
 {
   "name": 
  {
  "args": [],
  "default_message": "Host Hardware support check.",
  "id": "com.vmware.vcIntegrity.lifecycle.ClusterHealthCheckTask.HwSupportCheck.Name"
   },
  "description": 
 {
  "args": [],
  "default_message": "Checks if the hardware update can be performed.",
  "id": "com.vmware.vcIntegrity.lifecycle.ClusterHealthCheckTask.HwSupportCheck.Description"
  },
  "check": "com.vmware.vcIntegrity.lifecycle.ClusterHealthCheckTask.HwSupportCheck"
  },
 "issues": [
 {
 "args": [],
 "default_message": "[vCenter: jpvc7dot0d5-2.sped.bdcsv.lab][Cluster: R6415_vSAN_AllFlash_ESXi7.0RC+][Host: 100.100.10.154][Update PreCheck Task] System Lockdown Mode is turned On for iDRAC IP, 172.20.5.5; hence Firmware update cannot continue.",
"id": "[vCenter: jpvc7dot0d5-2.sped.bdcsv.lab][Cluster: R6415_vSAN_AllFlash_ESXi7.0RC+][Host: 100.100.10.154][Update PreCheck Task] System Lockdown Mode is turned On for iDRAC IP, 172.20.5.5; hence Firmware update cannot continue."
 }
],
"status": "ERROR"
 }
 ],
"status": "ERROR"
 },
 {
 "host": "host-19",
 "type": "HOST",
 "check_statuses": [],
 "status": "OK"
 },
 {
"host": "host-13",
 "type": "HOST",
                
 "check_statuses": [],
 "status": "OK"
  },

Remediate cluster

Command: POST https://{{VC IP/FQDN}/}}/api/esx/settings/clusters/{cluster ID}/software?vmw-task=true&action=apply

{
 "accept_eula" : true
}

Description: Applies the desired state associated with the given cluster to hosts within the cluster.

HTTP response codes: 200. For the list of all the response codes, see Response codes.

Example response:

{task-id}

Welcome

Welcome to Dell

OpenManage Integration for VMware vCenter Version 5.2 User's Guide

Using OMIVV as a firmware add-on provider in vSphere Lifecycle Manager—vSphere Automation APIs

Scan firmware compliance

Get compliance task status

Run remediation pre-check

Get remediation pre-check task status

Remediate cluster

Rate this content