Developer Documentation
Get Discovery Associated Products
Released in v7.0.0Returns the detailed information of a product associated with vCenter Server.
Request
URLURL
https://{api_host}/api/vcenter/lcm/discovery/associated-products/{product}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | An identifier of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product. |
Response
Response
Response BodyResponse Body
200 OK returns
DiscoveryProduct
of type application/json
Product details.
{
"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. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : If there is no record associated with product in the system. | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. |
