Set Depots UMDs
DescriptionSets or overwrites information about the UMDS software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
Request
URLURL
https://{api_host}/api/esx/settings/depots/umds
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
SettingsDepotsUmdsSetSpec of mimetype application/json
Required
Specification to set the UMDS depot.
{
"location": "string"
}
string
location
Required
Location of the depot. It should be the location to the index.xml for the depot.
string
description
Optional
Description of the depot. If unset, the description will be empty.
boolean
enabled
Optional
Flag indicating whether or not this depot should be enabled. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If unset, the depot will be enabled.
Authentication
This operation uses the following authentication methods.
Code Samples
Code Samples
PowerCLI Client SDK Example
$SettingsDepotsUmdsSetSpec = Initialize-SettingsDepotsUmdsSetSpec -Location "MyLocation"
Invoke-SetDepotsUmds -SettingsDepotsUmdsSetSpec $SettingsDepotsUmdsSetSpec
PowerCLI Client SDK All Parameters Example
$SettingsDepotsUmdsSetSpec = Initialize-SettingsDepotsUmdsSetSpec -Description "MyDescription" -Enabled $false -Location "MyLocation"
Invoke-SetDepotsUmds -SettingsDepotsUmdsSetSpec $SettingsDepotsUmdsSetSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","enabled":false,"location":"string"}' https://{api_host}/api/esx/settings/depots/umds
Errors
500
com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 7.0.0
On This Page
Depots UMDs Operations
patch
delete
get
put
delete
