Depot Settings APIs

APIs for managing Depot Settings

Table of Contents

• Get Depot Settings

• Update Depot Settings

1. Get Depot Settings

Online:

• Get Depot Settings API is used to retrieve the existing My VMware Account information.

Offline depot:

• Get Depot Settings API is used to retrieve the existing Offline Depot information.

1.1. Prerequisites

None

1.2. Steps

• Invoke the API.

Online:
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: 259

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : null,
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "dellEmcSupportAccount" : null,
  "offlineAccount" : null,
  "depotConfiguration" : null
}

Offline Depot:
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: 406

{
  "vmwareAccount" : {
    "username" : "offline-user",
    "password" : null,
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "dellEmcSupportAccount" : {
    "username" : "offline-user",
    "password" : null,
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "offlineAccount" : null,
  "depotConfiguration" : null
}

2. Update Depot Settings

Online:

• Update Depot Settings API is used to update SDDC Manager with the My VMware Account. This account is used for Downloading Upgrade/Install Bundles(Please refer to Update Bundle for Downloading).

Offline depot:

• Update Depot Settings API is used to update SDDC Manager with Offline Depot configuration. Customer can deploy a custom centralized repository used for Downloading Upgrade/Install Bundles(Please refer to Update Bundle for Downloading). (Please refer to the VMware Cloud Foundation documentation for more information)

• 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

Online:
The following data is required:

• Username of My VMware Account.

• Password of My VMware Account.

Tip : Refer to: DepotSettings and DepotAccount.

Offline depot:
The following data is required:

• Offline depot account

• Depot configuration

Tip : Refer to: DepotAccount and DepotConfiguration.

2.2. Steps

• Invoke the API.

Online:
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"
  }
}'

HTTP Request

PUT /v1/system/settings/depot HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 90
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 259

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : null,
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "dellEmcSupportAccount" : null,
  "offlineAccount" : null,
  "depotConfiguration" : null
}

Offline depot:
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 '{
  "offlineAccount" : {
    "username" : "offline-user",
    "password" : "offline-password"
  },
  "depotConfiguration" : {
    "isOfflineDepot" : true,
    "hostname" : "offline.depot.com",
    "port" : 8282
  }
}'

HTTP Request

PUT /v1/system/settings/depot HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 216
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "offlineAccount" : {
    "username" : "offline-user",
    "password" : "offline-password"
  },
  "depotConfiguration" : {
    "isOfflineDepot" : true,
    "hostname" : "offline.depot.com",
    "port" : 8282
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 349

{
  "vmwareAccount" : null,
  "dellEmcSupportAccount" : null,
  "offlineAccount" : {
    "username" : "offline-user",
    "password" : null,
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "depotConfiguration" : {
    "isOfflineDepot" : true,
    "hostname" : "offline.depot.com",
    "port" : 8282
  }
}

3. Delete Depot Settings

• Delete Depot Settings API is used to remove the depot configuration if such is present within VCF.

3.1. Prerequisites

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

• 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

Last updated 2024-02-29 05:35:20 -0800