Field Agent Commands; Using Edge Manager - Supported Field Agent Commands - GE Mini Field Agent User Manual

6.1.2 Field Agent Commands

6.1.2.1

Using Edge Manager - Supported Field Agent Commands

EdgeManager can be used to send commands to one or more Field Agents. The list of available commands is extensible, but
the core list of commands supported on all A&C Field Agents and meanings are listed below. Additional information on
Commands, including how to add and delete Custom Commands, can be found by searching for "Commands Overview" in
https://docs.predix.io. Note that built-in commands not included in the list below may not be supported by A&C Field Agents. For
example, the commands "HTTP Tunnel: Enable" and "HTTP Tunnel: Disable" and all Application Container commands are not
supported.
Meaning
Command
Retrieves a list of available log files that can be downloaded from
Predix Machine: Get
the Field Agent to EdgeManager, which is then accessible in the
Available Logs
user's browser.
Downloads a specified log file from the Field Agent to
Predix Machine: Get
EdgeManager, which is then accessible in the user's browser. The
Log
specified log file defaults to the Predix Machine log file
(machine log)
Retrieves the list of network interfaces on the Field Agent and the
Predix Machine: Get
IP addresses for each interface.
IP Address
Restarts the OSGi™ bundles while leaving the rest of the Predix
Predix Machine:
Machine container running.
Refresh
Restarts the entire Predix Machine container including all bundles.
Predix Machine:
Restart
Updates the rate at which Predix Machine contacts the Predix Cloud
Predix Machine: Set
to report status and retrieve operations to run.
Polling Interval
Uploads the Predix Machine configuration directory from the Field
Predix Machine:
Agent to the EdgeManager Repository. The configuration can then
Upload Configurations
be downloaded from the EdgeManager Repository to a connected
computer.
Disables the Web Console, closing TCP port 8443 on the LAN
Technician Console:
Disable
Enables the Web Console, opening TCP port 8443 on the LAN
Technician Console:
Enable
Using the Device Manager in EdgeManager, commands can be sent to one Field Agent at a time or to several Field Agents or
groups of Field Agent at a time. Commands can also be scheduled to occur immediately for Online Field Agents, or scheduled
to occur at any future date and time for Online or Offline Field Agents. If a command is scheduled to occur immediately for an
Offline Field Agent, or at a date or time that the Field Agent becomes Offline, then the command will be executed the next time
the Field Agent connects and becomes Online. The specific instructions to send commands from Device Manager to Field
Agents can be found by searching for "Executing Commands" in https://docs.predix.io.
Each Field Agent maintains a history of each command run against it and the corresponding command status. This history can
be seen by navigating to the device page for the Field Agent and selecting the Commands tab. Command operation failures on
Online Field Agents can be diagnosed either by reading the error entry in the Log Service of the Field Agent's Predix Machine
Web Console or by reading the error entry in the Predix Machine log file retrieved using the "Predix Machine: Get Log"
command.
For public disclosure
Predix Predix
Machine 16.2 Machine 17.1
No Yes
Yes, Yes
without
parameters
No Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
Yes Yes
GFK-2993F 68