Connect-TelnetCmdlet
Parameters Output Objects Config Settings
The Connect-Telnet cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-Telnet [parameters]
Remarks
This cmdlet allows you to create a persistent connection object to be used with related cmdlets.When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object.
To disconnect call Disconnect-Telnet.
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| 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.
| TelnetConnection | The connection object. |
Config Settings
The following is a list of config 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 component 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. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| 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 component 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. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| 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. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
LogFile Parameter (Connect-Telnet Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-Telnet -LogFile string
Remarks
When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.Default Value
null
Command Parameter (Connect-Telnet Cmdlet)
The command to be sent to the server.
Syntax
Connect-Telnet -Command string
Remarks
Default Value
""
Parameter Position
2
This is a required parameter.
Config Parameter (Connect-Telnet Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-Telnet -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-Telnet Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-Telnet -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
EOL Parameter (Connect-Telnet Cmdlet)
The EOL used to parse the response.
Syntax
Connect-Telnet -EOL string
Remarks
Default Value
"\r"
FirewallHost Parameter (Connect-Telnet Cmdlet)
Name or IP address of firewall.
Syntax
Connect-Telnet -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-Telnet Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-Telnet -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-Telnet Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-Telnet -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-Telnet Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-Telnet -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-Telnet Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-Telnet -FirewallUser string
Remarks
Default Value
""
LocalIP Parameter (Connect-Telnet Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-Telnet -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-Telnet Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-Telnet -LogFile string
Remarks
Default Value
""
LoginPrompt Parameter (Connect-Telnet Cmdlet)
The format of the prompt for the user's login.
Syntax
Connect-Telnet -LoginPrompt string
Remarks
Default Value
"Login:"
Parameter Position
4
NoAuthentication Parameter (Connect-Telnet Cmdlet)
Disables authentication during connection.
Syntax
Connect-Telnet -NoAuthentication SwitchParameter
Remarks
Default Value
false
Password Parameter (Connect-Telnet Cmdlet)
The password to use for authentication.
Syntax
Connect-Telnet -Password string
Remarks
Default Value
""
PasswordPrompt Parameter (Connect-Telnet Cmdlet)
The format of the prompt for the user's password.
Syntax
Connect-Telnet -PasswordPrompt string
Remarks
Default Value
"Password:"
Parameter Position
5
Port Parameter (Connect-Telnet Cmdlet)
The port to be used.
Syntax
Connect-Telnet -Port int
Remarks
Default Value
23
Server Parameter (Connect-Telnet Cmdlet)
The address of the Server.
Syntax
Connect-Telnet -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
ShellPrompt Parameter (Connect-Telnet Cmdlet)
The shell prompt on the remote shell on which the telnet connection is established.
Syntax
Connect-Telnet -ShellPrompt string
Remarks
Default Value
""
Parameter Position
3
Parameter Alias
Prompt
ShellPromptExpression Parameter (Connect-Telnet Cmdlet)
A regular expression to match the shell prompt returned by the server.
Syntax
Connect-Telnet -ShellPromptExpression string
Remarks
Default Value
""
Timeout Parameter (Connect-Telnet Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-Telnet -Timeout int
Remarks
Default Value
10
User Parameter (Connect-Telnet Cmdlet)
The username to use for authentication.
Syntax
Connect-Telnet -User string
Remarks
Default Value
""
TelnetConnection Output Object (Connect-Telnet Cmdlet)
The connection object.
Syntax
Object TelnetConnection {string[] Config;
PSCredential Credential;
string EOL;
string FirewallHost;
string FirewallPassword;
int FirewallPort;
string FirewallType;
string FirewallUser;
string LocalIP;
string LogFile;
string LoginPrompt;
SwitchParameter NoAuthentication;
string Password;
string PasswordPrompt;
int Port;
string Server;
string ShellPrompt;
string ShellPromptExpression;
int Timeout;
string User;
}