Test-VMwareServerConnection
Tests VMware server connection.
Applies to versions: 8.0, 9.0, 9a
Syntax
Test-VMwareServerConnection [–Server] <String[]> [-Quiet] [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet tests connectivity for VMware servers registered in configuration of the Virtualization Extensions Service.
Parameters
-Server <String[]>
Specifies names of VMware servers for which connectivity should be tested.
Tip |
To get the list of connected VMware servers, use the Get-VMwareServer cmdlet. |
Description | |
Aliases |
|
Required? | True |
Position? | 1 |
Default Value |
|
Accept Pipeline Input? | True (ByValue, ByPropertyName) |
Accept Wildcard Characters? | False |
-Quiet
Specifies whether the connection verification progress should be displayed. If the parameter is specified, the cmdlet will not display the progress details.
Description | |
Aliases |
|
Required? | False |
Position? | Named |
Default Value |
|
Accept Pipeline Input? | False |
Accept Wildcard Characters? | False |
-VESServer
Specifies the Virtualization Extensions server. You can pass the following types of values:
- 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").
- Veeam.Psves.VesConnection object.
For more information, type “get-help about_VESServerParameter”.
Description | |
Aliases |
|
Required? | False |
Position? | Named |
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.
Notes
If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.
Input
The cmdlet accepts the following types of values for the -Server parameter:
- System.String (you can pass a VMware server name, the server name value is used exactly as it is typed)
- Veeam.Psves.VMwareServer (you can pass a VMware server object)
Output
The cmdlet returns a list of Veeam.Psves.TestConnectionTaskResult objects that store connectivity verification results.
- If the connection verification test is passed, the Passed property of the object will be set to “True”.
- If the connection verification test is not passed, the Passed property of the object will be set to “False” and the Status property of the object will contain the error message.
Example 1
This command tests connection for the “prod-vcenter” VMware server.
Test-VMwareServerConnection prod-vcenter |
-OR-
Get-VMwareServer prod-vcenter | Test-VMwareServerConnection |
Example 2
This command tests connection for all registered VMware servers.
Get-VMwareServer | Test-VMwareServerConnection |