Depot Settings APIs
APIs for managing Depot Settings
Table of Contents
1. Get Depot Settings
Online:
- Get Depot Settings API is used to retrieve the existing My VMware and Dell EMC Support Accounts' information.
Offline:
- Get Depot Settings API returns account information.
1.1. Prerequisites API
None
1.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/depot' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/system/settings/depot 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: 400
{
"vmwareAccount" : {
"username" : "acmeuser",
"password" : null,
"status" : "DEPOT_CONNECTION_SUCCESSFUL",
"message" : "Depot Status: Success"
},
"dellEmcSupportAccount" : {
"username" : "vxrailUser",
"password" : null,
"status" : "DEPOT_CONNECTION_SUCCESSFUL",
"message" : "Depot Status: Success"
},
"offlineAccount" : null,
"depotConfiguration" : null
}
1.3. Related APIs API
[_getdepotsettings] API [_updatedepotsettings] API
2. Update Depot Settings
Online:
- Update Depot Settings API is used to update SDDC Manager with the My VMware and Dell EMC Support Account. This account is used for Downloading Upgrade/Install Bundles (Please refer to Update Bundle for Downloading).
Offline:
- Use the Bundle Transfer Utility tool (Please refer to the VMware Cloud Foundation documentation for more information) to manually download the bundles from the depot on your local computer and then copy them to SDDC Manager. Once the bundles are available in the SDDC Manager. Use the Upload a Bundle API to upload it to SDDC Manager.
2.1. Prerequisites API
The following data is required for updating My VMware Account information:
Username of My VMware Account.
Password of My VMware Account.
The following data is required for updating Dell EMC Support Account information:
Username of Dell EMC Support Account.
Password of Dell EMC Support Account.
Tip : Refer to: DepotSettings and DepotAccount.
2.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/depot' -i -X PUT \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"vmwareAccount" : {
"username" : "acmeuser",
"password" : "acmepassword"
},
"dellEmcSupportAccount" : {
"username" : "dellEmcUser",
"password" : "dellEmcPassword"
}
}'
HTTP Request
PUT /v1/system/settings/depot HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 192
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"vmwareAccount" : {
"username" : "acmeuser",
"password" : "acmepassword"
},
"dellEmcSupportAccount" : {
"username" : "dellEmcUser",
"password" : "dellEmcPassword"
}
}
HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 400
{
"vmwareAccount" : {
"username" : "acmeuser",
"password" : null,
"status" : "DEPOT_CONNECTION_SUCCESSFUL",
"message" : "Depot Status: Success"
},
"dellEmcSupportAccount" : {
"username" : "vxrailUser",
"password" : null,
"status" : "DEPOT_CONNECTION_SUCCESSFUL",
"message" : "Depot Status: Success"
},
"offlineAccount" : null,
"depotConfiguration" : null
}
2.3. Related APIs API
[_getdepotsettings] API [_updatedepotsettings] API
3. Delete Depot Settings
- Delete Depot Settings API is used to remove the depot configuration if such is present within VCF.
3.1. Prerequisites API
The following data is optional:
- Depot Type
Tip : If Depot Type is not provided all depot settings and users (both VCF_DEPOT and VXRAIL_DEPOT) will be deleted. If depot type is provided, then only delete/logout of that depot.
3.2. Steps API
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/system/settings/depot' -i -X DELETE \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
DELETE /v1/system/settings/depot HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 204 No Content
3.3. Related APIs API
[_deletedepotsettings] API [_getdepotsettings] API [_updatedepotsettings] API
Last updated 2024-08-27 16:13:54 -0700