Esx Settings Repository Software Drafts Components update
Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSoftwareSpecification.Write
.
Identifier of the working copy document.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft
.
Update specification containing list of components to add and/or delete.
{
"components_to_set": {
"components_to_set": "string"
},
"components_to_delete": [
"string"
]
}
List of components to be updated. If the component already exists in the draft, the version is updated, else it is added. If a component is provided without version, then its version will be chosen based on constraints in the system.
This property was added in vSphere API 9.0.0.0.
If missing or null
, no components will be added or updated.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component
. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component
.
List of components to be removed.
This property was added in vSphere API 9.0.0.0.
If missing or null
, no components will be removed.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.component
. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.component
.
Success!
If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"
Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the caller is not authorized.
"Vapi Std Errors Unauthorized Object"
No draft associated with draft in the system.
"Vapi Std Errors NotFound Object"
If there is some unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"
Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null
for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object"
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'