Set HPOVApplianceProxy - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Set-HPOVApplianceProxy

Configure appliance web proxy.

SYNTAX

Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int>[ [-Https] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Set-HPOVApplianceProxy [-Hostname] <String> [-Port] <Int> [-Username] <String> [-Password] <SecureString>[ [-Https] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

When configuring Remote Support, a Web Proxy may be required. This Cmdlet will assist in defining an HTTPS web proxy for Remote Support outbound connectivity. Proxy configuration does not support SOCKS.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases	Appliance
Required?	false
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	false
Accept wildcard characters?	False

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-Hostname <String>

The FQDN or IP Address of the HTTPS Proxy server.

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Https <SwitchParameter>

Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-HPOVApplianceTrustedCertificate Cmdlet.

Aliases	None
Required?	False
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Password <SecureString>

The proxy server account password.

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Port <Int>

The web proxy TCP port to connect to.

Aliases	None
Required?	true
Position?	named
Default value	0
Accept pipeline input?	false
Accept wildcard characters?	False

-Username <String>

The user name of your proxy server to authenticate with.

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Async task Resource object for monitoring.

Examples

-------------------------- EXAMPLE 1 --------------------------

Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080

Configure the appliance proxy server by providing the required Hostname and Port values.

-------------------------- EXAMPLE 2 --------------------------

Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080 -Username MyUserAccount -Password (ConvertTo-SecureString -String MyPassword -AsPlainText -Force)

Configure the appliance proxy server by providing the required Hostname and Port values, and using proxy authentication.

HPE OneView 4.00 Library