Runtime command lines

You can launch the
FactoryTalkRemoteAccessRuntimeCli
 program by entering some comman lines in your command prompt.
NOTE: Command line parameters are only supported on the following systems:
Linux Ubuntu 22 and Windows
.
NOTE: Returned code legend:
  • Standard output
    : Output information following a comman line entry.
  • Exit status
    : The command entered in the
    FactoryTalkRemoteAccessRuntimeCli
     file was run successfully and is printed in the Logs.
Parameters
Description
--connect
Connect Runtime to the
FactoryTalk® Remote Access™
 servers when Runtime is already running but disconnected. Runtime connects automatically by default, unless you have not entered the
--disconnect
 command line.
--disconnect
Disconnect Runtime from the
FactoryTalk® Remote Access™
 servers. Connection to the remote assistance service is not possible.
--showChat
Open the assistance chat window.
--hideChat
Hide the assistance chat window.
--showKeyboard
Open the system keyboard.
--hideKeyboard
Close the system keyboard.
--openWebUI
Open Windows Runtime through a web page.
--remoteAccessServiceConnected
See the Runtime connection status.
Standard output:
  • 0
    : Runtime is not connected to the server
  • 1
    : Runtime is connected to the server
Exit status:
  • 0
    : The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
--remoteAccessSessionCount
See the quantity of remote supervisors that are connected to the Runtime from
FactoryTalk® Remote Access™
.
Standard output:
  • N
    : Number of supervisors connected to the Runtime from
    FactoryTalk® Remote Access™
Exit status:
  • 0
    :The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
--getanonymousID
View the ID and password required to register a Runtime device to a domain.
Exit status:
  • 0
    : The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
  • 2
    : Runtime is not connected to the
    FactoryTalk® Remote Access™
     servers
  • 3
    : The device is already registered to a domain.
--requestAssistance
Enable an assistance request. If
The user must provide contact details when assistance is requested
 is enabled, you must provide three additional parameters that correspond to the fields
<name>
,
<contact>
, and
<description>
.
Exit status:
  • 0
    : The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
  • 2
    : Runtime is not connected to the
    FactoryTalk® Remote Access™
     servers
  • 3
    : The assistance request cannot be opened.
--closeAssistance
Close an assistance request.
Exit status:
  • 0
    : The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
  • 2
    : Runtime is not connected to the
    FactoryTalk® Remote Access™
     servers
  • 3
    : The assistance request cannot be closed.
--getRequestAssistanceStatus
See an assistance request status.
Standard output:
  • 0
    : An assistance request has been sent.
  • 1
    : No assistance is currently requested.
Exit status:
  • 0
    : The command entry is successful
  • 1
    : The connection to the Runtime is unsuccessful
  • 2
    : Runtime is not connected to the
    FactoryTalk® Remote Access™
     servers
--canRequestAssistance
Check if an assistance request can be opened.
Standard output:
  1. 0
    : The Runtime cannot open a request for assistance
  2. 1
    : The Runtime can open a request for assistance
Exit status:
  1. 0
    : The command entry is successful
  2. 1
    : The connection to the Runtime is unsuccessful
  3. 2
    : Runtime is not connected to the
    FactoryTalk® Remote Access™
     servers
--exportConnectionLog
Export connection logs. Indicate the logs parameters
--fromDate
,
--toDate
 and
--outputDirectory
.
NOTE: If you select an invalid date range, the exported logs return zero results.
Exit status:
  1. 0
    : The command entry is successful
  2. 1
    : The connection to the Runtime is unsuccessful
  3. 2
    : The connection logs export is unsuccessful
--setRuntimePassword
 followed by the
<password>
 that you want to set up.
Configure a password to access Windows Runtime.
NOTE: See Ubuntu 22 Runtime installation and configuration for further information on how to configure a password.
Exit status:
  1. 0
    : The password setup is successful
  2. 1
    : You do not have the user rights to change the password
  3. 2
    : The password does not meet the security compliance standards
--unsetRuntimePassword
Remove a previously set password to access Windows Runtime
Exit status:
  1. 0
    : The password is successfully removed
  2. 1
    : You do not have the user rights to change the password
--quit
Disconnect Runtime when it is running.
--version
See the Runtime version.
-h, --help
See the list of the currently available commands.

Examples

The
path
 identifies the Runtime installation path. For example:
C:\Program Files (x86)\Rockwell Automation, Inc\FactoryTalk Remote Access\Runtime\
.
Parameters
Description
"<path>\FactoryTalkRemoteAccessRuntimeCli" --connect
Connect Runtime to the
FactoryTalk® Remote Access™
 servers when Runtime is already running but disconnected. Runtime connects automatically by default, unless you have not entered the
--disconnect
 command line.
"\FactoryTalkRemoteAccessRuntimeCli" --disconnect
Disconnect Runtime from the
FactoryTalk® Remote Access™
 servers. Connection to the remote assistance service is not possible.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --showChat
Open the assistance chat window.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --hideChat
Hide the assistance chat window and disconnect Runtime from the remote assistance service.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --showKeyboard
Open the system keyboard.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --hideKeyboard
Close the system keyboard.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --openWebUI
Open Windows Runtime through a web page.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --remoteAccessServiceConnected
See the Runtime connection status.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --remoteAccessSessionCount
See the quantity of remote supervisors that are connected to the Runtime from
FactoryTalk® Remote Access™
.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --getanonymousID
View the ID and password required to register a Runtime device to a domain. The following example shows how to query the Runtime through the
--getAnonymousID
 parameter by using .NET:
var process = new Process();
process.StartInfo.FileName = @"C:\Program Files (x86)\Rockwell Automation, Inc\FactoryTalk Remote Access\Runtime\FactoryTalkRemoteAccessRuntimeCli.exe";
process.StartInfo.Arguments = "--getAnonymousID";
process.StartInfo.CreateNoWindow = true;
process.StartInfo.RedirectStandardOutput = true;
process.StartInfo.UseShellExecute = false;
process.StartInfo.WindowStyle = ProcessWindowStyle.Hidden;
process.Start();
process.WaitForExit();
Console.WriteLine("AnonymousID, Password: " + process.StandardOutput.ReadToEnd());
Console.WriteLine("exit code: " + process.ExitCode);
Console.ReadLine();
"<path>\FactoryTalkRemoteAccessRuntimeCli" --requestAssistance
Enable an assistance request. If
The user must provide contact details when assistance is requested
 is enabled, you must provide three additional parameters that correspond to the fields
Name
,
Contact information
, and
Description
.
Example:
"<path>\FactoryTalkRemoteAccessRuntimeCli" --requestAssistance --name "John Doe" --contact "john.doe@email.com" --description "A brief description of the problem"
"<path>\FactoryTalkRemoteAccessRuntimeCli" --closeAssistance
Close an assistance request.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --getRequestAssistanceStatus
See an assistance request status.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --canRequestAssistance
Check if an assistance request can be opened.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --exportConnectionLog
Export connection logs. Indicate the logs parameters
--fromDate
,
--toDate
 and
--outputDirectory
.
Example:
"<path>\FactoryTalkRemoteAccessRuntimeCli" --exportConnectionLog --fromDate "2020-06-06" --toDate "2020-06-07" --outputDirectory "/tmp"
"<path>\FactoryTalkRemoteAccessRuntimeCli" --setRuntimePassword
Configure a password to access Windows Runtime. For example:
"<path>\FactoryTalkRemoteAccessRuntimeCli" --setRuntimePassword <password>
"<path>\FactoryTalkRemoteAccessRuntimeCli" --unsetRuntimePassword
Remove a previously set password to access Windows Runtime.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --quit
Disconnect Runtime when it is running.
"<path>\FactoryTalkRemoteAccessRuntimeCli" --version
See the Runtime version.
"<path>\FactoryTalkRemoteAccessRuntimeCli" -h, \FactoryTalkRemoteAccessRuntimeCli" --help
See the list of the currently available commands.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal