Upgradables

Table of Contents

• Get the Upgradables

• Get the Upgradables for a Domain

• Get the Target VCF Release Upgradables for a Domain

1. Get the Upgradables

Get the Upgradables API provides the list of upgradables in the system. Each upgradable provides information about the bundle, resource and its associated software components that can be prechecked and upgraded. The upgradables can be of different types ex: AVAILABLE, PENDING, SCHEDULED etc.

1.1. Prerequisites

None

1.2. Steps

• Invoke the API.

cURL Request

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

HTTP Request

GET /v1/system/upgradables 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: 406

{
  "elements" : [ {
    "bundleId" : "6e19bca3-54cf-42e4-b944-b1ca540e7b8a",
    "bundleType" : "VXRAIL",
    "resource" : {
      "resourceId" : "511f9891-83ed-4461-9e88-852b70252995",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ {
      "id" : "9fe39cd1-848f-4192-b305-9c3f80d49bd1",
      "type" : "VXRAIL",
      "isUserInputRequired" : false
    } ],
    "status" : "AVAILABLE"
  } ]
}

2. Get the Upgradables for a Domain

This API provides the list of upgradables for a given domain. Each upgradable provides information about the bundle, resource and its associated software components that can be prechecked and upgraded. The upgradables can be of different types ex: AVAILABLE, PENDING, SCHEDULED etc.

2.1. Prerequisites

• ID of a domain

2.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/upgradables/domains/511f9891-83ed-4461-9e88-852b70252995' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/upgradables/domains/511f9891-83ed-4461-9e88-852b70252995 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: 290

{
  "elements" : [ {
    "bundleId" : "c47bced6-4cc9-4748-9e5a-8bd20a7d1da1",
    "bundleType" : "SDDC_MANAGER",
    "resource" : {
      "resourceId" : "511f9891-83ed-4461-9e88-852b70252995",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ ],
    "status" : "AVAILABLE"
  } ]
}

3. Get the Target VCF Release Upgradables for a Domain

This API provides the list of upgradables for a given domain and target VCF release. Each upgradable provides information about the bundle, resource and its associated software components that can be prechecked and upgraded. The upgradables can be of different types ex: AVAILABLE, PENDING, SCHEDULED etc.

3.1. Prerequisites

• ID of a domain

• Version of a Target Release

3.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/upgradables/domains/511f9891-83ed-4461-9e88-852b70252995?targetVersion=4.1.0.0' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/upgradables/domains/511f9891-83ed-4461-9e88-852b70252995?targetVersion=4.1.0.0 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: 290

{
  "elements" : [ {
    "bundleId" : "c47bced6-4cc9-4748-9e5a-8bd20a7d1da1",
    "bundleType" : "SDDC_MANAGER",
    "resource" : {
      "resourceId" : "511f9891-83ed-4461-9e88-852b70252995",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ ],
    "status" : "AVAILABLE"
  } ]
}

Last updated 2022-09-28 17:42:27 PDT

Operations