Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Remove Snapshot

  • Article
  • 1 minutes to read

Operation Information

This operation will remove a snapshot from a VMware vSphere Virtual Machine.

Extra Credentials

This operation requires an extra credential to be provided, stored in KeySafe, to the following specification:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

Name Type Description Required Sensitive
VMName string The name of the Virtual Machine to perform the action against Yes No
Port string Specifies the port on the server you want to use for the connection No No
Protocol string Specifies the internet protocol you want to use for the connection. It can be either http or https No No
NoTrustedCert boolean Specifies if the Connect-VIServer cmdlet will establish the connection without taking into account that the certificate is invalid Yes No
SnapshotID string Specifies the ID of the snapshot to remove. You can provide this OR SnapshotName No No
SnapshotName string Specifies the name of the snapshot to remove. You can provide this OR SnapshotID No No
RemoveChildren boolean Indicates that you want to remove the children of the specified snapshots as well Yes No

Output Parameters

Name Type Description Required Sensitive
outcome string Outcome of the operation. Can be OK, WARN or FAIL Yes No
errors string Any errors returned by the operation No No
warnings string Any warnings returned by the operation No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document