Veeam Home | Support | Downloads
Veeam Management Pack 8.0 for System Center VEShell Reference

Veeam Management Pack Help Center  > VEShell Reference >  VEShell Cmdlets > New-VEConnection

New-VEConnection

Previous page Next page Print this Topic

Table of contents

Creates a new object that stores settings for connecting to the Virtualization Extensions Service (computer name, port and access credentials).

Applies to versions: 6.0, 6.5, 7.0, 8.0

Syntax

New-VEConnection [-ComputerName] <String> [[-Port] <Int32>] [[-Credential] <PSCredential>]
[<CommonParameters>]

Detailed Description

This cmdlet initializes a new Veeam.Psves.VesConnection object with the specified computer name, port and credentials.

After the cmdlet returns a connection object, no communication is established with the Virtualization Extensions Service (that is, the connection remains closed). To open the connection, you need to pass the returned connection object to the Connect-VE cmdlet as the -VESServer parameter.

Parameters

-ComputerName <String>

Specifies the name of a machine (remote or local) where the Virtualization Extensions Service runs.

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?

True

Position?

1

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

-Port <Int32>

Specifies the port that Virtualization Extensions Service uses to listen for incoming connections.

Description

Aliases

 

Required?

False

Position?

2

Default Value

8084

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

-Credential <PSCredential>

Specifies credentials of the account used to connect to the Virtualization Extensions Service. The input parameter is a user name (such as "Domain01\User01").

The password is entered in the interactive Windows PowerShell Credential Request prompt.

noteNote

The specified account must be a member of the Veeam Virtualization Extensions for VMware Users local group on the Virtualization Extensions Service machine.

Description

Aliases

 

Required?

False

Position?

3

Default Value

Credentials of the user who launched the VEShell console

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Output

The cmdlet returns the Veeam.Psves.VesConnection object that stores settings for connecting to the Virtualization Extensions Service. The State property of the object is set to “Close”.

The returned object can be passed to other cmdlets as the -ConnectionSession parameter.

Example 1

This example shows how to create and open a connection to the Virtualization Extensions Service.

The first command creates a connection for the Virtualization Extensions Service and stores it in the "$conn" variable.

The second command opens a connection to the Virtualization Extensions Service. The created connection object is passed to the Connect-VE cmdlet as the -ConnectionSession parameter.

$conn=New-VEConnection –ComputerName localhost –Port 8084

Connect-VE $conn

Example 2

The following command checks whether the Virtualization Extensions Service on the localhost is available.

New-VEConnection –ComputerName localhost | Connect-VE | Disconnect-VE

If the Virtualization Extensions Service is available, the cmdlet will return a connection object (with the “Close” state).

If the Virtualization Extensions Service is not available, the command will return an error. You can use the $Error variable to check the error message.

noteNote

You can use the returned connection object to connect to the Virtualization Extensions Service later, using the Connect-VE cmdlet.

Table of contents