Virtual Machine Snapshot Rename Snapshot
Rename this snapshot with either a new name or a new description or both.
At least one of these must be specified when calling the rename method.
Required privileges: VirtualMachine.State.RenameSnapshot
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 VirtualMachineSnapshot/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"name": "string",
"description": "string"
}
New name for the snapshot.
New description for the snapshot.
No Content
NotSupported: if the host product does not support snapshot rename.
InvalidName: if the specified snapshot name is not valid.
TaskInProgress: if the virtual machine is busy.
InvalidPowerState: if the operation cannot be performed in the current power state of the virtual machine.
InvalidState: if the operation cannot be performed in the current state of the virtual machine. For example, the virtual machine's configuration is not available.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}