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
Method: GET
Authorization: Bearer authentication
Parameters:
Table 24. Parameters
Parameter Value Description Default
value
Parameter
type
Data type
id (required) Cluster profile ID. Use the cluster profile
ID received from the Get list of cluster
profiles API. For more information, see
Get list of cluster profiles on page 54
N/A Path String
vCenter Privileges required: Dell.Inventory.Configure Inventory
HTTP response code:
Table 25. HTTP response code
Code Description or response object
200 OK
400 Operational Context not set
401 Authorization failure
403 VCenter permission denied
404 Resource not found
429 Too many requests
500 Internal Server error / timeout
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
Example Response:
{
"id": "{Cluster profie ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/PluginProfileService/
ClusterProfiles/{Cluster profile ID}",
"objectType": "ClusterProfile",
"data": {
"profileName": "{Cluster profile name}",
"description": "{Cluster profile description}",
"clusters": [
{
"id": "{Cluster ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/ConsoleService/
Clusters/{Cluster ID}",
"objectType": "ClusterMetadata",
"name": "{Cluster name}"
}
],
"repo": [
{
"id": "{Repostory profile ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/
PluginProfileService/RepositoryProfiles/{Repository profile ID}",
"objectType": "BaseProfileMetadata",
"profileName": "{Repository profile name}",
"repoType": "{Repository profile type (Firmware or Driver}",
"description": "{Profile description}"
}
],
"systemProfile": {
"id": "{System profileID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/PluginProfileService/
RepositoryProfiles/{System profile ID}",",
Cluster profile management
55