Transport configuration options

Descriptions of the target options for SSH, WinRM, or NETCONF transports.

Option	Transport method	Definition
Target port	SSH, WinRM, or NETCONF	The connection port. For SSH, the default is `22`. For WinRM, the default is `5986`, unless `ssl: false`, then the default is `5985`. For NETCONF, the default is 830.
Global timeout in seconds	NETCONF	Global timeout in seconds. Defaults to 10. Serves as default for all other timeouts.
Connection time-out in seconds	SSH, WinRM, or NETCONF	The length of time you want Puppet Enterprise (PE) to wait for a response when attempting to establish a connection. For NETCONF, how long Bolt should wait when establishing connections. Defaults to 10.
Disconnect timeout in seconds	NETCONF	How long Bolt should wait before forcing a disconnect. Defaults to 5.
Command timeout in seconds	NETCONF	How long to wait for a NETCONF command to complete.
Hello timeout in seconds	NETCONF	How long to wait for NETCONF hello exchange.
Idle timeout in seconds idle-timeout	NETCONF	How long before an idle connection times out.
Keepalive interval in seconds	NETCONF	Interval for sending keepalive messages.
Auto-reconnect	NETCONF	Whether to automatically reconnect on connection loss. Defaults to true.
Reconnection attempts	NETCONF	Number of reconnection attempts.
Reconnection delay in seconds	NETCONF	Delay between reconnection attempts.
Host key check	NETCONF	Whether to perform host key validation when connecting over SSH. Defaults to true.
Temporary directory	SSH and WinRM	The directory to use when uploading temporary files to the target node.
Run as another user	SSH	After login, this is the user profile to use for running commands.
Sudo password	SSH	The password to use when switching user profiles via `run-as`.
Process request as tty	SSH	Use this if you need to enable text terminal allocation.
Acceptable file extension	WinRM	A list of allowed file extensions for scripts or tasks. Scripts with the specified file extensions rely on the target node's file type associations to run. For example, if Python is installed on the target node, a `.py` script from PE uses `python.exe` to run (unless the file type association was changed on the target node). The extensions `.ps1`, `.rb`, and `.pp` are always allowed and run via hard-coded executables.