Use online depots to add new content over time to the management scope of Depot Manager. Depot Manager periodically updates the software depots metadata stored on the

vCenter Server

instance. In case, new software updates are uploaded to the online depots, the Depot Manager makes sure that the metadata stored on the

vCenter Server

database is updated accordingly.

To add an online depot to the Depot Manager, you must first create the online depot specification by using the

Online.CreateSpec

data structure

. To specify the URI to the

vendor-index.xml

file of the online depot,

use the

location

property of the

Online.CreateSpec

data structure

. Optionally, you can add a description and enable the depot. By default, when you add an online depot to the Depot Manager, the depot is enabled and its metadata is synchronized following the defined schedule. If you want to synchronize the added online depot immediately,

use the

POST https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots?action=sync&vmw-task=true

request

. When you complete the depot specification,

use the

POST https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots/online

request and submit the

Online.CreateSpec

JSON object to add the depot

.

You can edit the depot description and deactivate the depot by

using the

PATCH https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots/online/

<depot_id>

request and submitting the depot ID as path parameter and an

Online.UpdateSpec

JSON object in the request body

.

You can remove an online depot from the list of currently configured depots by using the

DELETE https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots/online/

<depot_id>

?vmw-task=true

request and submitting the depot ID as a pat parameter

. This operation does not remove the already downloaded metadata and payloads from the deleted depot. You cannot delete the default VMware online depot, you can only deactivate it.

To retrieve a list of currently configured online depots,

use the

GET https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots/online

request

. You can also retrieve information about a currently configured online depot by using the

GET https://

<vcenter_ip_address_or_fqdn>

/api/esx/settings/depots/online/

<depot_id>

request and submitting the depot ID as path parameter

.