Update VM Snapshot operation

The Update VM Snapshot operation updates the name and description of the snapshot. With this operation, you need to specify either the name or description of the snapshot to be updated.

The following table describes the elements for this request.

Adapter request elements for the Update VM Snapshot operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Advanced_Vm	Yes
<operation-name>	Defines the name of operation: Update_VM_Snapshot	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Warning Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Warning Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the elements required to execute the operation	Yes
<virtual-machine>	Contains the name of the virtual machine on which this operation is to be executed	Yes
<name>	Contains the name of the snapshot to be updated The name need not be unique for the specified virtual machine. Valid value: String	Yes
<new-name>	Contains the new name for the snapshot Valid value: String	No
<description>	Contains the new description for the snapshot Valid value: String	No

The following codes sample shows a sample adapter request for the Update VM Snapshot operation.

Sample adapter request for Update VM Snapshot operation

<vmware-infrastructure-request>
   <operation-type>Advanced_Vm</operation-type>
   <operation-name>Update_VM_Snapshot</operation-name>
   <soap-url></soap-url>
   <transport></transport>
   <user-name></user-name>
   <password></password>
   <parameters>
       <virtual-machine>TestDev156</virtual-machine>
       <name>NewSnapshot</name>
       <new-name>UpdatedSnapshot</new-name>
       <description>updated description</description>
  </parameters>
</vmware-infrastructure-request>

The following codes sample shows the response for the sample Update VM Snapshot operation.

Sample adapter response for Update VM Snapshot operation

<vmware-infrastructure-response>
       <metadata>
       <status>success</status>
     </metadata>
     <RenameSnapshotResponse></RenameSnapshotResponse>
</vmware-infrastructure-response>

Update VM Snapshot operation

TrueSight Orchestration Content 20.19.02

On this page