RemoteRunProcess
RemoteRunProcess["host","command"]
runs the specified system command on the remote host, returning information on the outcome.
RemoteRunProcess[IPAddress["address"],"command"]
runs the command on the machine with the specified IP address.
RemoteRunProcess[obj,"command"]
run the command on the remote host specified by the RemoteConnectionObject obj.
RemoteRunProcess["host",{"command",arg1,arg2,…}]
runs the specified command, with command-line arguments argi.
RemoteRunProcess["host", command,"prop"]
returns only the specified property.
RemoteRunProcess["host", command,prop,input]
feeds the specified initial input to the command.
Details and Options
- RemoteRunProcess returns an association with the process exit code, the standard output and the standard error.
- RemoteRunProcess["host",…] prompts for a username and password.
- RemoteRunProcess["user@host",…] prompts for a password only.
- RemoteRunProcess will use an ssh-agent for authentication if available.
- In RemoteRunProcess[command,prop,input], input is automatically converted to a string using ToString. The same is true for the argi in RemoteRunProcess[{command,arg1,…},…].
- Typical possible properties to return include:
-
"ExitCode" the exit code for the process "StandardOutput" data sent to standard output, as a string "StandardError" data sent to standard error, as a string All an association of all properties (default) - RemoteRunProcess allows the following options:
-
Authentication $SSHAuthentication authentication parameters for the connection RemoteAuthorizationCaching False whether to use remote authorization caching - In the form Authentication->assoc, the association assoc can contain these keys:
-
"Username" username to use for authentication "Password" password to use for authentication "SSHKey" SSH identity "SSHKeyPassword" passphrase string to use 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.
Examples
open all close allBasic Examples (1)
Evaluate the hostname command on a remote machine:
RemoteRunProcess["host.example.com", "hostname"]Use a specific username to run the uptime command:
RemoteRunProcess["username@host.example.com", "uptime"]Retrieve a specified property from a command:
RemoteRunProcess["host.example.com", "hostname", "StandardOutput"]RemoteRunProcess["host.example.com", "cat", All, "Hello World!"]Create a persistent session with RemoteConnect:
remote = RemoteConnect["host.example.com"]Once the session is created, it can be used without having to reconnect:
RemoteRunProcess[remote, "hostname"]DeleteObject[remote]Scope (1)
Obtain the exit code from a command:
RemoteRunProcess["username@host.example.com", {"sh", "-c", "'exit 113'"}, "ExitCode"]Start a process asynchronously. When it is done, read from the log:
RemoteRunProcess["username@host.example.com", "date > log.txt &"]RemoteRunProcess["user@host.example.com", "cat log.txt"]Options (4)
Authentication (3)
Run a remote process using username and password authentication:
RemoteRunProcess["host.example.com", "pwd", Authentication -> <|"Username" -> "user", "Password" -> "xxxxx"|>]Run a remote process using an identity file for authentication:
RemoteRunProcess["host.example.com", "pwd", Authentication -> <|"Username" -> "user", "SSHKey" -> File["/path/.ssh/id_rsa"]|>]Set a value for $SSHAuthentication:
$SSHAuthentication = <|"Username" -> "user", "Password" -> password|>Now processes can be run using the default authentication contained in $SSHAuthentication:
RemoteRunProcess["host.example.com", "date"]RemoteAuthorizationCaching (1)
Authorize future connections by placing the public key on the remote machine:
RemoteRunProcess["username@host.example.com", "date", RemoteAuthorizationCaching -> True]This user is now authorized to execute commands without authentication:
RemoteRunProcess["username@host.example.com", "date"]Text
Wolfram Research (2018), RemoteRunProcess, Wolfram Language function, https://reference.wolfram.com/language/ref/RemoteRunProcess.html.
CMS
Wolfram Language. 2018. "RemoteRunProcess." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/RemoteRunProcess.html.
APA
Wolfram Language. (2018). RemoteRunProcess. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/RemoteRunProcess.html