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 vCenter and hosts license details
Description: Gets license details using license ID.
Command or URL: /Services/LicenseService/Licenses/{id}
Method: GET
Authorization: Bearer authentication
vCenter privileges required: None
Parameters:
Table 5. Parameters
Parameter Value Description Default value Parameter
type
Data type
id (required) License ID. Use the license ID received
from the Get list of vCenter and host
license on page 39 API.
N/A Path String
HTTP response code:
Table 6. HTTP response code
Code Description or response object
200 License Info
401 Authorization failure
404 Resource not found
429 Too many requests
500 Internal Server error
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
Example Response:
{
"id": "{License ID}",
"href": "https://{OMIVV IP}/Spectre/api/rest/v1/Services/LicenseService/Licenses/
{LicenseID}",
"objectType": "LicenseInfo",
"entitlementID": "{Entitlement ID}",
"licenseType": "{License Type}",
"maxHosts": {number of maximum hosts allowed},
"startDate": "{License start date}",
"expirationDate": "{License expiry date}",
"duration": {Duration of the license},
"licenseStatus": "{License status}"
}
For more information, see Response body on page 96.
Upload license to OMIVV
Description: Uploads new license in .XML file format to OMIVV. You can upload one license file at a time.
After you upload the standard license, the existing evaluation license becomes inactive.
Command or URL: /Services/LicenseService/Licenses
Method: POST
40
License management