Add-VMwareServer

In this article

    Adds VMware server connection(s) to the Virtualization Extensions Service configuration.

    Applies to versions: 8.0, 9.0

    Syntax

    Add-VMwareServer [-ServerName] <String[]> [[-Port] <Int32>] [-MonitoringGroup <String>] -Credential <PSCredential> [-DisableMonitoring] [-Options <AddVMwareServerOptions>] [-VESServer <Object>] [<CommonParameters>]

    Detailed Description

    This cmdlet registers new VMware server(s) in the Virtualization Extensions Service configuration.

    By default, the cmdlet enables monitoring for the registered VMware server and its child vSphere clusters/hosts. You can use the -DisableMonitoring parameter to disable monitoring.

    Parameters

    -ServerName <String[]>  

    Specifies VMware server(s) that should be registered in the Virtualization Extensions Service configuration. You can register a single server (a vCenter Server or a standalone vSphere host), as well as a group of servers.

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

    Description

    Aliases

     

    Required?

    True

    Position?

    1

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -Port <Int32>

    Specifies the port used for communication with the VMware server.

    Note

    In case you are adding a group of servers, the port number will be set for all of them.

     

    Description

    Aliases

     

    Required?

    False

    Position?

    Named

    Default Value

    443

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -MonitoringGroup <String>

    Specifies the monitoring group to which all newly discovered jobs from the registered VMware server will be assigned. If the parameter is not specified, jobs will be assigned to the Default Monitoring Group.

    Note

    In case you are adding a group of servers, the monitoring group will be set for all of them.

     

    Description

    Aliases

     

    Required?

    False

    Position?

    Named

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -Credential <PSCredential>

    Specifies user name and password for connecting to the VMware server. The input parameter is a user name (such as "Domain01\User01").

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

    Note

    In case you are adding a group of servers, the credentials will be set for all of them.

     

    Description

    Aliases

     

    Required?

    True

    Position?

    Named

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -DisableMonitoring

    If the parameter is specified, VMware server(s) will be registered in the Virtualization Extensions Service configuration, but monitoring will be disabled.

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

    For more information, type “get-help about_VESServerParameter”.

    Description

    Aliases

     

    Required?

    False

    Position?

    Named

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -Options <AddVMwareServerOptions>

    Specifies options for registering a group of VMware servers in the Virtualization Extensions Service configuration.

    Possible values:

    • None — if specified credentials and/or port number do not match those necessary to connect to one or more VMware servers in the group, none of the servers will be added to the Virtualization Extensions Service configuration.
    • AddEvenIfError — if specified credentials and/or port number do not match those necessary to connect to one or more VMware servers in the group, only servers with correct credentials and port number will be added to the Virtualization Extensions Service configuration.
    • AddDelayed — if specified credentials and/or port number do not match those necessary to connect to one or more VMware servers in the group, you can still add the group to the Virtualization Extensions Service configuration. However, these servers will be considered to be "ESX hosts" and monitoring for them will be disabled.  

    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.

    Output

    The cmdlet does not return any output.

    Example 1

    This command registers a new VMware server “prod-vcenter”. The VMware server is added with the default port number (443), monitoring of the VMware server is enabled. VEShell prompts for access credentials.

    Add-VMwareServer –ServerName prod-vcenter

    Example 2

    This command registers a new VMware server “prod-vcenter”. The VMware server is added with port number 447, monitoring of the VMware server is disabled. VEShell prompts for access credentials.

    Add-VMwareServer prod-vcenter –Port 447 –DisableMonitoring

    Example 3

    This command registers a group of VMware servers: "prod-vcenter”, "dev-vcenter" and "marketing-vcenter". VMware servers are added with port number 447. VEShell prompts for access credentials. Servers will be added to the Virtualization Extensions Service, regardless of the credentials correctness.

    Add-VMwareServer prod-vcenter,dev-vcenter,marketing-vcenter –Port 447 –DisableMonitoring -Options AddDelayed