Upgradables APIs
APIs for managing Upgradables
Table of Contents
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 API
None
1.2. Steps API
- 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: 427
{
"elements" : [ {
"bundleId" : "986acd5a-2dca-4ed6-ae3d-d30b79064659",
"bundleType" : "VXRAIL",
"resource" : {
"resourceId" : "562d4905-56fb-4bdd-adb1-c706786c7542",
"type" : "DOMAIN"
},
"softwareComponents" : [ {
"id" : "4e1a2933-64dd-4bad-8c78-15628c08af8d",
"type" : "VXRAIL",
"isUserInputRequired" : false
} ],
"status" : "AVAILABLE",
"errors" : null
} ]
}
1.3. Related APIs API
[_getupgradables] API [_startprecheck] API [_getprechecktask] API [_performupgrade] API
2. Get the Upgradables for a Domain
(Deprecated) This API provides the list of upgradables up to the target version for a given domain. If target version API for some domain is not selected upgradables for that domain will not be returned. 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. This API is used only for management domain, for all cases please use [_getupgradables] API.
2.1. Prerequisites API
- ID of a domain
2.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/upgradables/domains/562d4905-56fb-4bdd-adb1-c706786c7542' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/upgradables/domains/562d4905-56fb-4bdd-adb1-c706786c7542 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: 311
{
"elements" : [ {
"bundleId" : "3b6af93f-f53d-4716-9374-c35fec4bc5a2",
"bundleType" : "SDDC_MANAGER",
"resource" : {
"resourceId" : "562d4905-56fb-4bdd-adb1-c706786c7542",
"type" : "DOMAIN"
},
"softwareComponents" : [ ],
"status" : "AVAILABLE",
"errors" : null
} ]
}
2.3. Related APIs API
[_getupgradables] API
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 API
ID of a domain
Version of a Target Release
3.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/upgradables/domains/562d4905-56fb-4bdd-adb1-c706786c7542?targetVersion=4.1.0.0' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/upgradables/domains/562d4905-56fb-4bdd-adb1-c706786c7542?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: 311
{
"elements" : [ {
"bundleId" : "3b6af93f-f53d-4716-9374-c35fec4bc5a2",
"bundleType" : "SDDC_MANAGER",
"resource" : {
"resourceId" : "562d4905-56fb-4bdd-adb1-c706786c7542",
"type" : "DOMAIN"
},
"softwareComponents" : [ ],
"status" : "AVAILABLE",
"errors" : null
} ]
}
3.3. Related APIs API
[_getupgradables] API
Last updated 2024-08-27 16:13:54 -0700