REST API - get

vcenter lcm discovery associated products: get

Returns the detailed information of a product associated with vCenter Server.

Request:

HTTP request

GET https://{server}/api/vcenter/lcm/discovery/associated-products/{product}

Path Parameters

Name Type Description
Required
product string An identifier of the product to be modified.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "deployments"[
        "string",
        "string"
    ],
    "auto"true,
    "installed_product""obj-103",
    "name""string",
    "version""string",
    "target_version""string"
}

Headers:

None

Type:

Name Type Description
bold = required
- product Product details.
-.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.

-.target_version string Future version of the product after upgrade.

Optional. target_version may not be applicable.

-.deployments 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.

Optional.

-.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.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the user can not be authenticated.
404 not_found If there is no record associated with product in the system.
500 error If there is some unknown internal error. The accompanying error message will give more details about the failure.