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
Get started
Topics:
• Prerequisites
•
Base URI
• Request headers
• Rate limit
Prerequisites
Ensure that:
● User profile used to access API has administrator privileges
● vCenter profile has required Dell privileges. For more information, see the Required privileges for non-administrator
users topic in User's Guide.
● Host Credential Profile, Cluster Profile, and System Profile are created in OMIVV User Interface (UI) and use the profiles
as required. For more information, see the Create Host Credential Profile, Create Cluster Profile, and Create System
Profile topics in User's Guide.
● The hosts are management-complaint. For more information, see the Management Compliance topic in User's Guide.
Base URI
The base URI for any OMIVV RESTful API request must be in the following format:
https://{OMIVV Address}/Spectre/api/rest/v1/Services/
OMIVV Address: IPv4 address or Fully Qualified Domain Name (FQDN).
NOTE: All the URIs and query parameters are case-sensitive.
Request headers
The request header represents headers in the client HTTPS request that are used to communicate client preferences to the
service end-point. The bearer token is the request header.
Rate limit
At a given time, only three unique client IPs can be active and can create total ten sessions.
OMIVV supports 100 requests per minute. If there are multiple sessions, make sure that each session has maximum 10 API
requests per minute in parallel. However, if there is a single session, parallel API requests can go up to 100 per minute.
If there are more than ten sessions, Request limit per minute exceeded message is sent to the API Client.
Each OMIVV session is correspond to one vCenter. Ensure that you sequence the communication if you have more than ten
vCenters registered in OMIVV because you can start only 10 sessions at a time.
The total number of failure login attempts that is allowed is six (count includes failed login attempts in administration console or
REST API or use of invalid token for REST API access). After six failed login attempts, the account gets locked.
The account lockout duration is one minute.
You cannot start a new session when the account is locked. But, current active session remains active.
2
Get started 9