Get System Release
Returns release for the lowest deployed VCF version for a domain on the environment.If Management domain is ahead of WLD domain, VCF BOM version for the WLDdomain will be returned. Domain VCF release calculations consider SDDC-M, BOM stack components(life cycle managed by LCM eg: Vcenter, Esx, Nsx) to compute Management domain VCF version, BOM stack components(life cycle managed by LCM) to compute VI domain VCF version respectively. Eg: Management domain component stack versions: [SDDC-M: 5.2.1.0, VC: 8.0U3, NSX:4.2.1.3, ESX: 8.0U3]. VCF version computed will be 5.2.1.0. VI domain component stack versions: [VC: 9.0.0.0, NSX: 9.0.0.0, ESX: 9.0.0.0]. VCF version computed is 9.0.0.0 for VI domain.
OK
{
"product": "string",
"version": "string",
"minCompatibleVcfVersion": "string",
"description": "string",
"releaseDate": "string",
"bom": [
{
"name": "string",
"version": "string",
"changeId": "string",
"publicName": "string",
"releaseURL": "string",
"additionalMetadata": "string",
"automatedInstall": false,
"lifecycleManagedBy": "string"
}
],
"isApplicable": false,
"notApplicableReason": "string",
"sku": [
{
"name": "string",
"description": "string",
"skuSpecificPatchBundles": [
{
"bundleType": "string",
"bundleVersion": "string",
"version": "string"
}
],
"bom": [
{
"name": "string",
"version": "string",
"changeId": "string",
"publicName": "string",
"releaseURL": "string",
"additionalMetadata": "string",
"automatedInstall": false,
"lifecycleManagedBy": "string"
}
]
}
],
"updates": [
{
"id": "string",
"productName": "string",
"baseProductVersion": "string",
"description": "string",
"releaseUpdateURL": "string",
"releaseDate": "string"
}
],
"patchBundles": [
{
"bundleId": "string",
"bundleType": "string",
"bundleElements": [
"string"
],
"cumulativeFromVcfVersion": "string"
}
],
"eol": "string",
"upgradeOrder": "string",
"minInstallerVersion": "string"
}Name of the product e.g. "VCF"
Version of the release
Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components
Release description with all major features.
Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format
Release bill of materials
[Deprecated] Whether bundle is applicable or not.
[Deprecated] Incompatibility reason for not applicable.
Release sku specific patch and bill of materials
Collection of release updates
List of patch bundles in this release
Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format
Custom upgrade order. Comma separated list of components in upgrade order. Supported components types: NSX_T_MANAGER, VCENTER, ESX_HOST.
Minimum installer version, e.g. 9.0.0.0
Release Not Found
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal Server Error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/releases/system