Virtual Machine Snapshot Rename Snapshot

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

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/VirtualMachineSnapshot/{moId}/RenameSnapshot
COPY
Path Parameters
string
moId
Required

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}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
RenameSnapshotRequestType of type(s) application/json
Required 
"RenameSnapshotRequestType Object"
string
name
Optional

New name for the snapshot.

string
description
Optional

New description for the snapshot.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

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.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/VirtualMachineSnapshot/{moId}/RenameSnapshot
On This Page
Virtual Machine Snapshot Operations
POST
Virtual Machine Snapshot Export Snapshot
POST
Virtual Machine Snapshot Remove Snapshot Task
POST
Virtual Machine Snapshot Rename Snapshot
POST
Virtual Machine Snapshot Revert To Snapshot Task
POST
Virtual Machine Snapshot Set Custom Value
GET
Virtual Machine Snapshot Get Available Field
GET
Virtual Machine Snapshot Get Child Snapshot
GET
Virtual Machine Snapshot Get Config
GET
Virtual Machine Snapshot Get Value
GET
Virtual Machine Snapshot Get Vm