vcenter cluster modules vm members: remove
Removes virtual machines from the module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
POST https://{server}/rest/vcenter/cluster/modules/vm/{module}/members?action=remove
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| module | string | Identifier of the module from which the specified virtual machines are removed. |
Request Body Structure:
{
"vms" : [
"obj-103",
"obj-103"
]
}
"vms" : [
"obj-103",
"obj-103"
]
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| vms | string[] | Set of identifiers of virtual machines that will be removed from the module. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"success" : true
}
}
"value" : {
"success" : true
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | status | Whether the removal of members from the module succeeded or failed. |
| value.success | boolean | This is true if the complete operation succeeded without any errors. Otherwise it is false and all or some operations have failed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the module is not known to this vCenter server. |