< Back

Set-HB-Proxy

Tue Jan 14, 2020 1:31 am

NAME Set-HB-Proxy



SYNOPSIS

Define proxy details to connect through





SYNTAX

Set-HB-Proxy [-ProxyAddress] <String> [[-ProxyCredentials] <PSCredential>] [<CommonParameters>]





DESCRIPTION

If you are using a proxy to connect to the internet, then this function allows you to define

the proxy address and authentication details (where applicable)





PARAMETERS

-ProxyAddress <String>

Mandatory - URI of the Proxy server to connect through



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProxyCredentials <PSCredential>

Either:

- String containing the username to authenticate against the proxy with (will prompt for password)

- A PSCredential object, such as one generated by the Get-Credential cmdlet.



By not providing this parameter, the module will use the credentials of the current Windows user



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



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



PS C:\\>Set-HB-Proxy "http://yourproxyaddress:80/"



The above will route the requests through your proxy, and will authenticate using the current user details



Set-HB-Proxy "http://yourproxyaddress:80/" "DOMAIN01\\User01"

The above will route the requests through your proxy, and will authenticate using "DOMAIN01\\User01" account











RELATED LINKS