Manifests APIs | VMware Cloud Foundation for VxRail API

Manifests APIs

APIs for managing LCM Manifests

Table of Contents

Get latest supported LCM manifest
Save/Upload supported LCM manifest with updated sequence number to LCM.

1. Get latest supported LCM manifest

Get manifest API is used to get the latest supported LCM manifest

1.1. Prerequisites API

None

1.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/manifests' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/manifests HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1991

{
  "version" : 1,
  "sequenceNumber" : 2,
  "creationTime" : "2024-08-27T21:11:54.370Z",
  "publishedDate" : "2024-08-27T21:11:54.370Z",
  "releases" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T00:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "9896652a-b2e9-4515-a6e0-a4c9e4064857",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "8367a951-6210-4fb4-851f-e7ef1699176c",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "3291b8a2-6f3d-4822-944d-670d928d004f",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "83271d54-85d1-4e92-a25a-5ceacefa6afe",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "b6ea1412-e11c-4711-b5ff-914cb3ac5150",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ],
  "recalledBundles" : [ ],
  "sddcManagerReleases" : [ ]
}

1.3. Related APIs API

[_savemanifest] API [_getreleases] API

2. Save/Upload supported LCM manifest with updated sequence number to LCM.

Save/Load manifest API is used to save/upload supported LCM manifest with updated sequence number to LCM.

2.1. Prerequisites API

The following data is required:

Manifest Version
Sequence Number
Creation time of the manifest file
Collection of Releases till date

Tip : Refer to: Manifest.

2.2. Steps API

Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/manifests' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "version" : 1,
  "sequenceNumber" : 2,
  "creationTime" : "2024-08-27T21:11:48.828Z",
  "publishedDate" : "2024-08-27T21:11:48.829Z",
  "releases" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T00:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "bb547444-3ca1-49dd-ac3a-b5f69c8fef6e",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "812de96e-d8e4-4607-9c60-257c184a7f0b",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "b68c1220-6ddf-4d32-b69b-751a15458885",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "f7cf3e84-ec1a-415d-a9c2-7c613c63830d",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "e6adc6e1-11c6-411d-980d-9b4128795643",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ],
  "recalledBundles" : [ ],
  "sddcManagerReleases" : [ ]
}'

HTTP Request

POST /v1/manifests HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 1991
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "version" : 1,
  "sequenceNumber" : 2,
  "creationTime" : "2024-08-27T21:11:48.828Z",
  "publishedDate" : "2024-08-27T21:11:48.829Z",
  "releases" : [ {
    "product" : "vcf",
    "version" : "4.1.0",
    "description" : "VMware Cloud Foundation 4.1.0 Release",
    "releaseDate" : "2020-10-06T00:00:00.000Z",
    "bom" : [ {
      "name" : "DOMAIN_MANAGER",
      "version" : "4.1.0",
      "publicName" : "SDDC Manager"
    }, {
      "name" : "VCENTER",
      "version" : "7.0.1-16860138",
      "publicName" : "vCenter Server Appliance"
    }, {
      "name" : "HOST",
      "version" : "7.0.1-16850804",
      "publicName" : "VMware ESXi"
    }, {
      "name" : "NSX_T_MANAGER",
      "version" : "3.0.2-16887200",
      "publicName" : "NSX-T Data Center"
    }, {
      "name" : "VROPS",
      "version" : "8.1.1-16522874",
      "publicName" : "VMware vRealize Operations Manager"
    } ],
    "sku" : [ ],
    "updates" : [ ],
    "patchBundles" : [ {
      "bundleId" : "bb547444-3ca1-49dd-ac3a-b5f69c8fef6e",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "812de96e-d8e4-4607-9c60-257c184a7f0b",
      "bundleType" : "EVORACK",
      "bundleElements" : [ "SDDC_MANAGER_VCF" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "b68c1220-6ddf-4d32-b69b-751a15458885",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "VCENTER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "f7cf3e84-ec1a-415d-a9c2-7c613c63830d",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "ESX_HOST" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    }, {
      "bundleId" : "e6adc6e1-11c6-411d-980d-9b4128795643",
      "bundleType" : "VMWARE_SOFTWARE",
      "bundleElements" : [ "NSX_MANAGER" ],
      "cumulativeFromVcfVersion" : "3.7.0"
    } ]
  } ],
  "recalledBundles" : [ ],
  "sddcManagerReleases" : [ ]
}

HTTP Response

HTTP/1.1 202 Accepted

2.3. Related APIs API

[_getmanifest] API [_getreleases] API
Last updated 2024-08-27 16:13:54 -0700

Operations