Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

VMware vSphere - New Snapshot

  • Article
  • 1 minutes to read

Operation Information

This operation will take a snapshot of 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
SnapshotName string Specifies the name of the new snapshot Yes No
Description string Specifies a description against the new snapshot No No
Memory boolean Specifies if the virtual machine's memory state is to be preserved with the snapshot Yes No
Quiesce boolean Specifies if VMware Tools is to attempt to quiesce the file system of the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If the virutal machine is powered off or VMware Tools are not available, the Quiesce parameter is ignored 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
snapshotId string The ID of the new snapshot No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document