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
    Allan association of all properties (default)
  • RemoteRunProcess allows the following options:
  • AuthenticationAutomaticauthentication parameters for the connection
    RemoteAuthorizationCachingFalsewhether to use remote authorization caching

Examples

open allclose all

Basic Examples  (1)

Evaluate the hostname command on a remote machine:

In[1]:=
Click for copyable input
Out[1]=

Use a specific username to run the uptime command:

In[2]:=
Click for copyable input
Out[2]=

Retrieve a specified property from a command:

In[3]:=
Click for copyable input
Out[3]=

Provide input to a command:

In[4]:=
Click for copyable input
Out[4]=

Create a persistent session with RemoteConnect:

In[5]:=
Click for copyable input
Out[5]=

Once the session is created, it can be used without having to reconnect:

In[6]:=
Click for copyable input
Out[6]=

Close the session:

In[7]:=
Click for copyable input

Scope  (1)

Options  (2)

See Also

RemoteRun  RunProcess  Run  RemoteConnect

Introduced in 2018
(11.3)