< Back

Start-SSHPortForward

Sat Jan 18, 2020 8:00 pm

NAME Start-SSHPortForward



SYNOPSIS

Start a configured port forward configured for a SSH Session





SYNTAX

Start-SSHPortForward [-SessionId] <Int32> [-BoundPort] <Int32> [-BoundHost] <String> [<CommonParameters>]



Start-SSHPortForward [-SSHSession] <SshSession> [-BoundPort] <Int32> [-BoundHost] <String> [<CommonParameters>]





DESCRIPTION

Stops a configured port forward configured for a SSH Session given the session and port number





PARAMETERS

-SSHSession <SshSession>



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-SessionId <Int32>



Required? true

Position? 1

Default value 0

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-BoundPort <Int32>



Required? true

Position? 3

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-BoundHost <String>



Required? true

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:\\>Stop a currently working port forward thru a SSH Session



C:\\Users\\Carlos> Get-SSHPortForward -Index 0





BoundHost : 192.168.1.158

BoundPort : 8081

Host : 10.10.10.1

Port : 80

IsStarted : False







C:\\Users\\Carlos> Start-SSHPortForward -Index 0 -BoundPort 8081





BoundHost : 192.168.1.158

BoundPort : 8081

Host : 10.10.10.1

Port : 80

IsStarted : True











RELATED LINKS