List Discovery Associated Products
Released in v7.0.0Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.
Request
URLURL
https://{api_host}/api/vcenter/lcm/discovery/associated-products
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
array of
LcmDiscoveryProduct
of type application/json
List of all the registered products with vCenter.
{
"auto": false,
"deployments": [
"string"
],
"installed_product": "string",
"name": "string",
"target_version": "string",
"version": "string"
}| Property Name | Type | Description |
|---|---|---|
| auto | boolean |
Indicates if the product is auto-detected by the system or manually added. If it is set to true it means it is auto-detected. |
| installed_product | string |
Identifies a product and a version uniquely. The identifier consists of product internal name and version. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: PRODUCT. When operations return a value of this structure as a result, the field will be an identifier for the resource type: PRODUCT. |
| name | string |
A public official product name. |
| version | string |
Current product version. |
| deployments | array of string |
The list of hostname/IPs of the instances of the VMware products deployed in the environment. This field would be empty for manually added products. |
| target_version | string |
Future version of the product after upgrade. Product.target-version may not be applicable. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/lcm/discovery/associated-products
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. |
| default | Error | Not available |
