Skip to content

Files

Latest commit

0f81439 · Jan 30, 2021

History

History
116 lines (90 loc) · 2.36 KB

New-SSHDynamicPortForward.md

File metadata and controls

116 lines (90 loc) · 2.36 KB
external help file Module Name online version schema
Posh-SSH-help.xml
Posh-SSH
2.0.0

New-SSHDynamicPortForward

SYNOPSIS

Establishes a Dynamic Port Forward thru a stablished SSH Session.

SYNTAX

Index (Default)

New-SSHDynamicPortForward [[-BoundHost] <String>] [-BoundPort] <Int32> [-SessionId] <Int32>
 [<CommonParameters>]

Session

New-SSHDynamicPortForward [[-BoundHost] <String>] [-BoundPort] <Int32> [-SSHSession] <SshSession>
 [<CommonParameters>]

DESCRIPTION

Dynamic port forwarding is a transparent mechanism available for applications, which support the SOCKS4 or SOCKS5 client protoco. In windows for best results the local address to bind to should be the IP of the network interface.

EXAMPLES

EXAMPLE 1

New-SSHDynamicPortForward -LocalAdress 192.168.28.131 -LocalPort 8081 -Index 0 -Verbose
VERBOSE: Finding session with Index 0
VERBOSE: 0
VERBOSE: Adding Forward Port Configuration to session 0
VERBOSE: Starting the Port Forward.
VERBOSE: Forwarding has been started.

PARAMETERS

-BoundHost

{{ Fill BoundHost Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Localhost
Accept pipeline input: False
Accept wildcard characters: False

-BoundPort

{{ Fill BoundPort Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-SSHSession

{{ Fill SSHSession Description }}

Type: SshSession
Parameter Sets: Session
Aliases: Session

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SessionId

{{ Fill SessionId Description }}

Type: Int32
Parameter Sets: Index
Aliases: Index

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS