WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

$SSHAuthentication
✖
$SSHAuthentication

[Experimental]

✖

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 allclose all

Basic Examples  (3)Summary of the most common use cases

The default value contains no extra information:

In[1]:=1
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-jujykm
Out[1]=1

Set $SSHAuthentication to use a username and password:

In[1]:=1
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-buy0l4
Out[1]=1

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

In[2]:=2
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-0cpw
Out[2]=2

Set $SSHAuthentication to connect with an identity file:

In[1]:=1
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-en1emx

Connect to a remote host:

In[2]:=2
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-onm91
Out[2]=2

Close the connection:

In[3]:=3
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-g744qa

Scope  (1)Survey of the scope of standard use cases

Make sure $SSHAuthentication is clear:

In[1]:=1
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-dqnvqm

Without enough information to authenticate, a prompt will appear:

In[2]:=2
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-d79m51
In[3]:=3
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-ln0xup

Properties & Relations  (1)Properties of the function, and connections to other functions

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

In[1]:=1
✖
https://wolfram.com/xid/0bzsyi9pap7gay8ci-bhag7z
Out[1]=1
Wolfram Research (2019), $SSHAuthentication, Wolfram Language function, https://reference.wolfram.com/language/ref/$SSHAuthentication.html.
✖
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.

✖
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.

✖
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

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

BibTeX

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

✖
@misc{reference.wolfram_2025_$sshauthentication, author="Wolfram Research", title="{$SSHAuthentication}", year="2019", howpublished="\url{https://reference.wolfram.com/language/ref/$SSHAuthentication.html}", note=[Accessed: 30-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_$sshauthentication, organization={Wolfram Research}, title={$SSHAuthentication}, year={2019}, url={https://reference.wolfram.com/language/ref/$SSHAuthentication.html}, note=[Accessed: 30-April-2025 ]}

✖
@online{reference.wolfram_2025_$sshauthentication, organization={Wolfram Research}, title={$SSHAuthentication}, year={2019}, url={https://reference.wolfram.com/language/ref/$SSHAuthentication.html}, note=[Accessed: 30-April-2025 ]}