Getting Started with VEShell

This section provides information that will help you get started with VEShell.

Installing Veeam Virtualization Extensions Shell

VEShell is a component installed as part of the Veeam Virtualization Extensions Service on any machine that meets the system requirements.

Before you install Veeam Virtualization Extensions Service, make sure that Microsoft Windows PowerShell 3.0 is installed on the target machine. If Microsoft Windows PowerShell 3.0 is not installed on your machine, download Microsoft Windows PowerShell 3.0.

Launching Veeam Virtualization Extensions Shell

To launch VEShell, select Veeam Virtualization Extensions Shell in the Start menu.

You can also import the VEShell into Windows PowerShell:

Launch Windows PowerShell command prompt.
Import the VEShell module by using the following command:

Import-Module Psves

Note

If the VEShell module installation fails with an error, this means that the Windows PowerShell script execution policy does not allow the module to be installed on your computer. In this case, change the execution policy to RemoteSigned. After the module is imported, you can set the execution policy back to Allsigned.

For more information on Windows PowerShell execution policies, see Microsoft Docs.

Connecting to Veeam Virtualization Extensions Service

When you execute a command, VEShell connects to the Veeam Virtualization Extensions Service and performs the necessary configuration or management operation. You can work with Veeam Virtualization Extensions Service running on the localhost (that is, on the same machine where VEShell is installed) or with Veeam Virtualization Extensions Service running on any remote machine.

Most VEShell cmdlets support an optional -VESServer parameter. This parameter provides information on where the Virtualization Extensions Service is running and what options (port number, credentials) must be used to connect to it. By default, if the -VESServer parameter is not passed to a cmdlet, VEShell will connect to the Virtualization Extensions Service running on the localhost, with the default port number (8084) and credentials of the user who launched the VEShell console.

You can override the default connection settings using the Start-VEShellClient cmdlet. This can be useful if you are working with the Virtualization Extensions Service that is listening to the non-default port, if the service is running on a remote machine and so on.

This command changes the default Virtualization Extensions Service location and the default port number:

Start-VEShellClient -ServerName vesserver -ServerPort 8086

After you change the default connection settings, all VEShell commands will be executed for the Virtualization Extensions Service that is running on the "vesserver" machine. To establish connection with this service, VEShell will use port number 8086.

To learn more about overriding default connection settings, see Start-VEShellClient.