Set-VMwareServerProxySettings
Sets proxy connection settings for a registered VMware server.
Applies to versions: 8.0, 9.0, 9a
Syntax
Set-VMwareServerProxySettings [–Server] <String> -ProxyServer <String> -ProxyPort <Int32> -ProxyCredential <PSCredential> [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet sets or changes proxy connection settings (port number and access credentials) for a VMware server registered in configuration of the Virtualization Extensions Service.
Parameters
-Server <String>
Specifies the name of the VMware server for which proxy connection settings are set or changed.
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 |
-ProxyServer <String>
Specifies the name of the proxy server.
Acceptable formats for the input value are: server name (such as “proxy01”), IP address (such as “172.15.19.6”) and FQDN (such as “proxy01.veeam.local”).
Description | |
Aliases |
|
Required? | True |
Position? | Named |
Default Value |
|
Accept Pipeline Input? | False |
Accept Wildcard Characters? | False |
-ProxyPort <Int32>
Specifies the port number for communication with the proxy server.
Description | |
Aliases |
|
Required? | True |
Position? | Named |
Default Value |
|
Accept Pipeline Input? | False |
Accept Wildcard Characters? | False |
-ProxyCredential <PSCredential>
Specifies user name and password for connecting to the proxy server.
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").
- 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 -ServerName 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
The following command sets proxy settings for "prod-vcenter" VMware server.
Set-VMwareServerProxySettings -Server prod-vcenter –ProxyServer proxy01 -Port 2128 |
-OR-
Get-VMwareServer prod-vcenter | Set-VMwareServerProxySettings –ProxyServer proxy01 -Port 2128 |
Example 2
This example describes how to set proxy 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-VMwareServerProxySettings -Server prod-vcenter –ProxyServer proxy01 -Port 2128 -ProxyCredential $credentials |