Esx Settings Inventory assignEntities$Task
Assign a sofware specification from the repository to the entities. If the input for this API is vcenter, datacenter or folder, the software specification will be assigned to all the clusters and SAH under those entities. If the input of this API is list of entities(cluster or SAH), the software specification will be assigned to only those entities.
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.lifecycleSettings.Write. - The resource
HostSystemreferenced by the property Esx Settings Inventory EntitySpec.hosts requiresVcIntegrity.lifecycleSettings.Write. - The resource
ClusterComputeResourcereferenced by the property Esx Settings Inventory EntitySpec.clusters requiresVcIntegrity.lifecycleSettings.Write. - The resource
Datacenterreferenced by the property Esx Settings Inventory EntitySpec.datacenters requiresVcIntegrity.lifecycleSettings.Write. - The resource
Folderreferenced by the property Esx Settings Inventory EntitySpec.folders requiresVcIntegrity.lifecycleSettings.Write.
Describe the software specification and the inventory objects on which the specificed operation will be performed.
Show optional properties
{
"software_spec_id": "string",
"entities": {}
}{
"software_spec_id": "string",
"entities": {
"type": "string",
"hosts": [
"string"
],
"clusters": [
"string"
],
"folders": [
"string"
],
"datacenters": [
"string"
]
},
"orchestrator": {
"owner": "string",
"owner_data": "string"
}
}The software spec in the repository that will be assigned to the list of entities.
This property was added in vSphere API 9.0.0.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec.
Specification of entities on which the specified operation should be invoked.
This property was added in vSphere API 9.0.0.0.
Orchestrator specification of the desired state created during assign operation on the entities. It is used to ensure the authorized owner can make modification of desired state.
This property was added in vSphere API 9.0.0.0.
If missing or null, no orchestrator detail is provided during the assign operation.
Note:
It is used by vLCM orchestrators like SDDC Manager to manage the desired state. For a non-orchestrator user i.e. a VC user, it must be unset.
Setting it prevents other users from modifying the committed desired state.
Assignment result of all the entities.
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 does not have the necessary privileges.
"Vapi Std Errors Unauthorized Object"If there is no software specification associated with softwareSpecId in the repository.
"Vapi Std Errors NotFound Object"If there is an 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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"entities":"{}","software_spec_id:"string"}' https://{api_host}/api/esx/settings/inventory?action=assign-entities&vmw-task=true