Get Snapshot Information
Gets the snapshots associated with a virtual machine or snapshot.
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
VM Name | String | Yes | Specifies the name of the virtual machine whose snapshots are to be retrieved. |
Snapshot ID | String | No | Unique GUID identifier for the snapshot. |
Output Parameters
Name | Type | Description |
---|---|---|
Snapshot Type | Sting | Type of snapshot. |
VM ID | String | GUID of the VM. |
Virtual Machine Name | String | Name of the VM. |
State | String | Current state of the VM. |
ID | String | ID of the snapshot. |
Name | String | Name of the snapshot. |
Notes | String | Snapshot notes. |
Path | String | File path of the snapshot. |
Creation Time | Date | Snapshot creation time. |
Size of System Files | Number | Size of the files. |
Parent Snapshot ID | String | Parent snapshot GUID (if applicable). |
Parent Snapshot Name | String | Parent snapshot name (if applicable). |
Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
Name | Type | Required | Example |
---|---|---|---|
VM Name | String | Yes | Guest001 |
Snapshot ID | String | Yes | GUID |