Virtual App Update Linked Children
Deprecated as of vSphere API 5.1.
Reconfigure the set of linked children.
A VirtualMachine and vApp can be added as a linked child as long as it is not a direct child of another vApp. In case it is a linked child, the existing link is removed and replaced with the new link specified in this call.
An InvalidArgument fault is thrown if a link target is a direct child of another vApp, or if the addition of the link will result in a vApp with a cycle. For example, a vApp cannot be linked to itself.
The removeSet must refer to managed entities that are currently linked children. Otherwise, an InvalidArgument exception is thrown.
For each entity being linked, the operation is subject to the following privilege checks:
- If the object being linked is a vApp, VApp.Move must be held on the vApp being linked and its former parent vApp (if any). The privilege VApp.AssignVApp must be held on this vApp.
- If the object being linked is a VirtualMachine, VApp.AssignVM is required on both the target vApp, the VirtualMachine, and its former parent vApp (if any).
Privilege checks for each entity in the removeSet are similar to the entities in the addChangeSet, except that there is no target vApp.
This operation is only transactional with respect to each individual link change. The changes are processed sequentially and committed one at a time. The addChangeSet is processed first, followed by the removeSet. If a failure is detected, then the method terminates with an exception.
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualApp/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"addChangeSet": [
{
"_typeName": "string",
"key": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"destroyWithParent": false
}
],
"removeSet": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
]
}
a set of LinkInfo objects that either add a new link or modify an exisiting link.
a set of entities that should no longer link to this vApp.
No Content
InvalidArgument: See above description.
ConcurrentAccess: If a concurrent modification happens while adding the link.
NotSupported: If the target of the link is not in the same datacenter.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}