[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Release

Model for releases with their description and product version

Properties

array of ProductVersion

bom Required

Release bill of materials

string

description Required

Release description with all major features.

string

releaseDate Required

Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format

string

minCompatibleVcfVersion Required

Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components

string

version Required

Version of the release

string

product Required

Name of the product e.g. “VCF”

boolean

isApplicable Optional

[Deprecated] Whether bundle is applicable or not.

array of PatchBundle

patchBundles Optional

List of patch bundles in this release

string

eol Optional

Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format

array of SkuBomDetails

sku Optional

Release sku specific patch and bill of materials

array of ReleaseUpdate

updates Optional

Collection of release updates

string

notApplicableReason Optional

[Deprecated] Incompatibility reason for not applicable.

JSON Example

Show optional properties

{
	"bom": [
		{
			"name": "string",
			"publicName": "string",
			"version": "string"
		}
	],
	"description": "string",
	"minCompatibleVcfVersion": "string",
	"product": "string",
	"releaseDate": "string",
	"version": "string"
}

{
	"bom": [
		{
			"additionalMetadata": "string",
			"name": "string",
			"publicName": "string",
			"releaseURL": {
				"authority": "string",
				"content": {},
				"defaultPort": 0,
				"file": "string",
				"host": "string",
				"path": "string",
				"port": 0,
				"protocol": "string",
				"query": "string",
				"ref": "string",
				"userInfo": "string"
			},
			"version": "string"
		}
	],
	"description": "string",
	"eol": "string",
	"isApplicable": false,
	"minCompatibleVcfVersion": "string",
	"notApplicableReason": "string",
	"patchBundles": [
		{
			"bundleElements": [
				"string"
			],
			"bundleId": "string",
			"bundleType": "string",
			"cumulativeFromVcfVersion": "string"
		}
	],
	"product": "string",
	"releaseDate": "string",
	"sku": [
		{
			"bom": [
				{
					"additionalMetadata": "string",
					"name": "string",
					"publicName": "string",
					"releaseURL": {
						"authority": "string",
						"content": {},
						"defaultPort": 0,
						"file": "string",
						"host": "string",
						"path": "string",
						"port": 0,
						"protocol": "string",
						"query": "string",
						"ref": "string",
						"userInfo": "string"
					},
					"version": "string"
				}
			],
			"description": "string",
			"name": "string",
			"skuSpecificPatchBundles": [
				{
					"bundleType": "string",
					"bundleVersion": "string",
					"version": "string"
				}
			]
		}
	],
	"updates": [
		{
			"baseProductVersion": "string",
			"description": "string",
			"id": "string",
			"productName": "string",
			"releaseDate": "string",
			"releaseUpdateURL": {
				"authority": "string",
				"content": {},
				"defaultPort": 0,
				"file": "string",
				"host": "string",
				"path": "string",
				"port": 0,
				"protocol": "string",
				"query": "string",
				"ref": "string",
				"userInfo": "string"
			}
		}
	],
	"version": "string"
}

vcf-for-vxrail

Property Of

Manifest
PageOfRelease

Returned By

Get System Release

Release

Properties

JSON Example

Property Of

Returned By

Was this page helpful?