WOLFRAM

Wolfram Language & System Documentation Center

$SSHAuthentication

specifies the default authentication options to use for SSH-related functions.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Scope  
Properties & Relations  
See Also
Related Guides
History
Cite this Page

$SSHAuthentication

$SSHAuthentication

specifies the default authentication options to use for SSH-related functions.

Details

  • The default setting for $SSHAuthentication is <||>.
  • $SSHAuthentication can be set to an association with the following keys:
  • "Username"username to use for authentication
    "Password"password to use for authentication
    "SSHKey"SSH identity
    "SSHKeyPassword"passphrase string used to decrypt "SSHKey"
  • An SSH identity can be given in the form "SSHKey"->File[ident], where ident is a file containing an SSH private key. It can also be given as "SSHKey"->"string", where string is an SSH private key.
  • "SSHKey" and "SSHKeyPassword" additionally accept a list of identities and passwords.
  • Authentication:>$SSHAuthentication is the default setting for functions such as RemoteFile, RemoteConnect, RemoteRun and RemoteRunProcess.

Examples

open all close all

Basic Examples  (3)

The default value contains no extra information:

Wolfram Language code: $SSHAuthentication

Set $SSHAuthentication to use a username and password:

Wolfram Language code: $SSHAuthentication = <|"Username" -> "user", "Password" -> "password"|>

Run a process on a remote host using the information set previously:

Wolfram Language code: RemoteRunProcess["host.example.com", "pwd"]

Set $SSHAuthentication to connect with an identity file:

Wolfram Language code: $SSHAuthentication = <|"Username" -> "user", "SSHKey" -> File["/path/.ssh/id_rsa"], "SSHKeyPassword" -> "example key password"|>

Connect to a remote host:

Wolfram Language code: remote = RemoteConnect["host.example.com"]

Close the connection:

Wolfram Language code: DeleteObject[remote]

Scope  (1)

Make sure $SSHAuthentication is clear:

Wolfram Language code: $SSHAuthentication = <||>

Without enough information to authenticate, a prompt will appear:

Wolfram Language code: RemoteConnect["host.example.com"]

Properties & Relations  (1)

The Authentication option of many of the remote functions defaults to $SSHAuthentication:

Wolfram Language code: Options[RemoteConnect]
Wolfram Research (2019), $SSHAuthentication, Wolfram Language function, https://reference.wolfram.com/language/ref/$SSHAuthentication.html.

Text

Wolfram Research (2019), $SSHAuthentication, Wolfram Language function, https://reference.wolfram.com/language/ref/$SSHAuthentication.html.

CMS

Wolfram Language. 2019. "$SSHAuthentication." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/$SSHAuthentication.html.

APA

Wolfram Language. (2019). $SSHAuthentication. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$SSHAuthentication.html

BibTeX

@misc{reference.wolfram_2026_$sshauthentication, author="Wolfram Research", title="{$SSHAuthentication}", year="2019", howpublished="\url{https://reference.wolfram.com/language/ref/$SSHAuthentication.html}", note=[Accessed: 12-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_$sshauthentication, organization={Wolfram Research}, title={$SSHAuthentication}, year={2019}, url={https://reference.wolfram.com/language/ref/$SSHAuthentication.html}, note=[Accessed: 12-June-2026]}