Remote Agent Commands
Remote Agent commands are mostly exposed via the Remote Agent context menu. Many of these commands are self-explanatory. Others are described below.
Note that some commands are hidden or disabled when not in admin-mode.
De-Authorize
Puts the Remote Agent back into the unauthorized state, where it can only connect to the Gateway (no data transfer or operations allowed). This is typically used if the remote agent host has failed or the Remote Agent is no longer needed. A Remote Agent must be De-Authorized before it can be deleted.
If a Remote Agent is no longer needed, use the Uninstall & WIPE ALL DATA command after de-authorizing. This command requires an Updater to still be connected.
Move to Gateway
Request the Remote Integrator to connect to a different Gateway in the cluster.
Move to External Gateway
Request the Remote Integrator to connect to a Gateway that is not in the current cluster. You should have exported the Remote Integrator from the current Gateway and imported it into the target Gateway cluster before performing this operation. The Remote Integrator will fail back to the current Gateway if any exceptions are thrown when attempting to connect.
This command shows the Move to Gateway dialog where you must specify the public endpoint of the external gateway.
Export Remote Integrator
Exports the Remote Integrator to a file which can then be imported into a different Gateway cluster. The export file contains channels, packages, routes, and other information. It may still require some manual fix up depending on how different your Gateway clusters are.
Use the Import button to read the exported Remote Integrator file.
Reset Connection Counters
Resets the connection counters to zero. Connection counters are displayed on the RI context tab, dashboard, and in metrics. These counters are used as an indicator of potential connection issues (ie, the connection count for this RI is much higher than other RIs).
Generate Bug Report
Generates a bug report for this Remote Integrator only. You can send the bug report and password to Conevity for troubleshooting and support. Only files which should not contain PHI are included in the report.
Move Data Folder
By default, the message database is stored in the %ProgramData%\Connexion.Integrator\Mongo folder. You can choose to move the data files to another drive\folder using this command.
This command shuts down the Remote Agent, copies the data files to the new directory (which is created automatically), and then re-starts the Remote Agent using the new data path. The old data files are not removed. You must manually remove these files via the File Browser UI.
If your message database is large, it may take quite a while to copy the files. The command may time out (and a timeout error displayed on the UI), however the command will continue to run on the Remote Agent.
Force Move Data Folder
This command is the same as the Move Data Folder command, except it will ignore any errors thrown when attempting to copy the database files from the current directory. If the ‘old’ database files cannot be copied, new (empty) database files will be created in the new folder.
Set Database Encryption
By default, database files are at-rest encrypted via EFS. This makes them inaccessible to any account other than the one hosting the Remote Agent service. Click YES to enable encryption, or NO to disable encryption.
To effect any encryption changes, the Remote Agent service must be restarted. Depending on the size of your message database, changing the encryption may take some time. The Remote Agent will not be available until the encryption routine completes.
Typically, you can confirm the encryption state of each file by viewing the associated icon. Encrypted files usually have a lock icon.
Flush Plugins (and Packages)
Deletes all cache files in the plugin (and package) directories and restarts the Remote Agent. All required files will be re-downloaded on demand.
Test Connectivity
Check connectivity between the Remote Integrator and a Gateway (either within the current cluster, or, an completely external Gateway).
Kill Process
Kill a process on the remote integrator host machine. You must know both the PID and name of the process to be killed. This information can be retrieved from the Monitor Performance dialog.
MongoDb Commands
Shut Down MongoDb: Attempts to shut down the MongoDb process, either via stopping the Remote Agent process, or, directly killing the Mongo process. This is an emergency command only.
Kill & Flush Data Files: Attempts to shut down the MongoDb process, and then deletes all message database files. This is an emergency command only.
Repair: Shuts down the Remote Agent and then runs a MongoDb repair command against the database. The repair can take some time for large databases, and the Remote Agent cannot restart until the repair completes. You must manually restart the RA process once the repair is complete.
Machine Commands
Restart Host Machine: Sends a command to restart the host machine.
Disable Hibernation: Attempts to disable hibernation, as this should not be enabled on Remote Integrator hosts.
Run Cipher Diagnostics
Runs a test to see which TLS protocols are available on the host machine.
Get Network Information
Displays information about the host network for diagnostic purposes.
Uninstall & WIPE ALL DATA
Uninstalls all Remote Integrator services and deletes all data. This is only available for an Unauthorized Remote Integrator which still has at least one Updater service connected.
Certificate Rotation Break Glass
By default, certificates used to secure communications between the Remote Integrator and the Gateway are periodically rotated. If there is an error during this rotation, and communication is interrupted, you can use this command to allow the new certificate being used by the Remote Integrator (after rotation).
Monitor Performance
This displays a task-manager-like dialog for the Remote Integrator host, with some host specifications. Rows highlighted in green are well-known Conevity processes, and those in orange are known to cause issues with the Remote Agent.
Generate Bug Report Archive
This generates a single archive file containing a bug report from every connected Remote Integrator. This can be used to periodically spot check for errors and overall cluster health.