Invoke-Telnet Cmdlet

Parameters Output Objects Configuration Settings

The Invoke-Telnet cmdlet is used to remotely execute a command on a Telnet server.

Syntax

Invoke-Telnet [parameters]

Remarks

This cmdlet establishes a telnet connection to a server which starts up the user's default shell. Using the cmdlet is very simple. The destination is specified by Server and the remote shell's prompt is specified by ShellPrompt. In order to specify the authentication credentials, set the Credential parameter.

Command contains the command you wish to execute on the remote machine. The output of the command is returned in one or more TelnetResponse objects.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# execute a simple command

invoke-telnet $server -user $username -password $password -command "ls -la" -shellprompt "bash-2.05a$ " -eol "`r`n" | foreach-object{$_.Text}

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new Telnet connection, use the Connect-Telnet cmdlet. To close the connection, use the Disconnect-Telnet cmdlet.

Parameter List

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.


Connection	An already established connection.
LogFile	The location of a file to which debug information is written.
Command	The command to be sent to the server.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for user/password authentication.
EOL	The EOL used to parse the response.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
LoginPrompt	The format of the prompt for the user's login.
NoAuthentication	Disables authentication during connection.
Password	The password to use for authentication.
PasswordPrompt	The format of the prompt for the user's password.
Port	The port to be used.
Server	The address of the Server.
ShellPrompt	The shell prompt on the remote shell on which the telnet connection is established.
ShellPromptExpression	A regular expression to match the shell prompt returned by the server.
Timeout	The maximum time allowed for the operation.
User	The username to use for authentication.

Output Objects

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.


TelnetResponse	Object containing part or all of the response from server.

Configuration Settings

The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.


ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the cmdlet whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the cmdlet binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
UseBackgroundThread	Whether threads created by the cmdlet are background threads.
UseInternalSecurityAPI	Tells the cmdlet whether or not to use the system security libraries or an internal implementation.