Get-VMwareServer - Veeam MP VEShell Reference
Help Center
Choose product document...
Veeam Management Pack 8.0 Update 5 for System Center
Veeam MP VEShell Reference

Get-VMwareServer

Gets VMware servers registered in the Virtualization Extensions Service configuration.

Applies to versions: 6.0, 6.5, 7.0, 8.0

Syntax

Get-VMwareServer [[-Include] <String[]>] [-VESServer <Object>] [<CommonParameters>]

Detailed Description

This cmdlet retrieves the list of VMware servers registered in the Virtualization Extensions Service configuration. The cmdlet returns a collection of objects that represent VMware servers.

The cmdlet displays the following property values for the returned VMware servers:

Available: server connection state.

ServerName: server name.

MonitoringGroup: monitoring group in which the server is included.

VirtualizationPlatform: virtualization platform type (vCenter or ESX)

SummaryInformation: Number of clusters, hosts and VMs under this server.

Notes: notes or comments (specified when adding the server via the Web UI).

Parameters

-Include <String[]>

Specifies names of VMware server(s) that should be retrieved. If the parameter is not specified, the cmdlet will return all VMware servers.

Get-VMwareServer Note:

This parameter supports wildcards. Search is not case sensitive.

 

Description

Aliases

 

Required?

False

Position?

1

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

True

-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").

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  http://go.microsoft.com/fwlink/p/?LinkID=113216.

Notes

If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.

Output

The cmdlet returns a collection of Veeam.Psves.VMwareServer objects that represent registered VMware servers.

Example 1

This command retrieves a list of all VMware servers registered in the Virtualization Extensions Service configuration.

Get-VMwareServer

Example 2

This command retrieves the “prod-vcenter” VMware server details.

Get-VMwareServer –Include prod-vcenter

This cmdlet returns a VMware server object, if available.

Example 3

This command retrieves a list of all VMware servers whose name starts with “prod”.

Get-VMwareServer –Include prod*

References

To learn more about supporting wildcard characters in cmdlet parameters, see http://msdn.microsoft.com/en-us/library/windows/desktop/aa717088%28v=vs.85%29.aspx.

Veeam Large Logo

Veeam MP for VMware User Guides

Veeam MP for VMware Reference

Veeam MP for VMware Online Knowledge Base

Veeam MP for Microsoft Hyper-V User Guide

Veeam MP for Hyper-V Reference

MP for Veeam Backup & Replication User Guide

MP for Veeam Backup & Replication Reference

Veeam Capacity Planning for Hybrid Clouds User Guide

Veeam MP Report Knowledge

Veeam MP VEShell Reference

Veeam MP Resource Kit Guide