List Discovery Associated Products
Retrieves 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
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
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"
}
]
boolean
auto
Required
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.
string
installed_product
Required
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.
string
name
Required
A public official product name.
string
version
Required
Current product version.
array of
string
deployments
Optional
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.
string
target_version
Optional
Future version of the product after upgrade. Product.target-version may not be applicable.
Errors
500
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
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListLcmDiscoveryAssociatedProducts
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/lcm/discovery/associated-products
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
