Start-VEShellClient

Overrides default Virtualization Extensions Service connection settings.

Applies to versions: 8.0, 9.0, 9a

Syntax

Start-VEShellClient [-ServerName] <String> [[-ServerPort] <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet overrides the default behavior of cmdlets that support common connection parameters.

By default, if no connection parameters are passed to a cmdlet, the configuration task will be performed for the Virtualization Extensions Service on the localhost, with the default 8084 port number and credentials of the user who launched the VEShell console. The Start-VEShellClient cmdlet allows you to override the default server name and port that are used if no connection parameters are specified.

Note

The overridden connection settings are automatically reset to defaults every time you close the VEShell console.

Parameters

-ServerName <String>

Specifies the name of a machine (remote or local) where the Virtualization Extensions Service runs. If the parameter is not specified, the server name will not be overridden.

Acceptable formats for the input value are: server name (such as “localhost” or “.”), IP address (such as “172.15.19.6”) and FQDN (such as “localhost.veeam.local”).

Description

Aliases

 

Required?

False

Position?

1

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

-ServerPort <Int32>

Specifies the port that Virtualization Extensions Service uses to listen for incoming connections. If the parameter is not specified, the port number will not be overridden.

Description

Aliases

 

Required?

False

Position?

2

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see Microsoft Docs.

Output

The cmdlet does not return any output.

Example

The following command sets the default Virtualization Extensions server to "vesserver" and the default port number to 8085.

Start-VEShellClient -ServerName vesserver -ServerPort 8085