Set-VMwareServerConnectionSettings

In this article

    Changes connection settings for the VMware server.

    Applies to versions: 8.0, 9.0

    Syntax

    Set-VMwareServerConnectionSettings [-Server] <String> [[-Port] <Int32>] -Credential <PSCredential> [-VESServer <Object>] [<CommonParameters>]

    Detailed Description

    This cmdlet changes connection settings for the VMware Server (port number and access credentials).

    Parameters

    -Server <String>

    Specifies the VMware server for which connection settings should be changed.

    Description

    Aliases

     

    Required?

    True

    Position?

    1

    Default Value

     

    Accept Pipeline Input?

    True (ByValue, ByPropertyName)

    Accept Wildcard Characters?

    False

    -Port <Int32>

    Specifies the new port number for communication with the VMware server. If the parameter is not specified, the port number is not changed.

    Description

    Aliases

     

    Required?

    False

    Position?

    2

    Default Value

     

    Accept Pipeline Input?

    False

    Accept Wildcard Characters?

    False

    -Credential <PSCredential>

    Specifies new user name and password for connecting to the VMware server. If the parameter is not specified, the credentials are not changed.

    The input parameter is a user name (such as "Domain01\User01").The password is entered in the interactive Windows PowerShell Credential Request prompt.

    Description

    Aliases

     

    Required?

    True

    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

    <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 does not return any output.

    Example 1

    This command changes connection settings for a VMware server “prod-vcenter”.

    Set-VMwareServerConnectionSettings -Server prod-vcenter -Port 447

    Example 2

    This example describes how to change connection settings for the VMware server “prod-vcenter”.

    $password = "mypassword" | ConvertTo-SecureString -asPlainText –Force

    $username = "domain\administrator"

    $credentials = New-Object System.Management.Automation.PSCredential($username,$password)

    Set-VMwareServerConnectionSettings -Server prod-vcenter -Port 443 -Credential $credentials