specifies the default authentication options to use for SSH-related functions.
- 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.
Examplesopen allclose all
Basic Examples (3)
The default value contains no extra information:
Set $SSHAuthentication to use a username and password:
Run a process on a remote host using the information set previously:
Set $SSHAuthentication to connect with an identity file:
Make sure $SSHAuthentication is clear:
Without enough information to authenticate, a prompt will appear:
Properties & Relations (1)
The Authentication option of many of the remote functions defaults to $SSHAuthentication:
Wolfram Research (2019), $SSHAuthentication, Wolfram Language function, 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.
Wolfram Language. (2019). $SSHAuthentication. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/$SSHAuthentication.html