Engine device object commands - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help

Brand
Metasys
Product name
Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active
Language
English

The following table lists the commands supported by the engine device object.

Table 1. Engine device object commands

Command name

Parameters

Description

Activate Changes Value Activates the pending attribute changes to network ports of the network engine. The command activates all pending changes to all network ports on the engine; individual ports cannot be activated separately. Also, this command is offered only when the staging area in the engine has files that are waiting for activation, which is indicated when the Changes Pending attribute of one or more integration objects is set to True. After you issue this command, the Changes Pending attributes of the integration objects in the engine are set to False. Command options: Update Changes Pending Attributes Except Network Number and Update All Changes Pending Attributes and Restart Device.
Note: This command is only available for network engines at Release 11.0 or later.
Apply Staged Files None Activates all staged files in the engine. The command is offered only when the staging area has files for the selected engine. If code is in staging, the engine switches over to the re-provisioned, inactive partition. After activation, the staging area is empty.
Note: This command is only available for network engines at Release 10.1 or later.
Archive None Archives the object instances to the nonvolatile memory.
Cancel Staged Files None Flushes all staged files in the engine. The command is offered only when the selected engine has staged files. After you issue this command to cancel the staged files, the Apply Staged Files command is no longer available until after you issue another staged download from SCT.
Note: This command is only available for network engines at Release 10.1 or later.
Change Audit Enabled Class Level Value Changes the Audit Enabled Class Level attribute. Integer range is 1-4.
Rediscover Text Strings None Requests the system to rediscover text strings for some binary and multistate BACnet integrated objects. In some cases, the Site Director can lose text strings when online configuration changes are made. When this occurs, the words Text not found appear in the Site Management Portal, Ready Access Portal, and Advanced Reporting. The following configuration changes (and other variations) can cause this:
  • If a child NxE contains user defined enumerations, and then its site director is re-imaged or downloaded without previously uploading.
  • If an NxE contains user defined enumerations, and then its Local Site Director is changed to any device other than itself.

To correct from these situations, issue the Rediscover Text Strings command to the NxE containing the objects that are displaying the errors.

Note: After you send this command to a site director, also send it to all child devices with custom text strings that include a BACnet Integration.
Reset Device None Initiates an orderly reset that saves recent changes to the engine archive database to Flash memory and restarts the engine operating system. When the engine requires a reset, the title bar of the object in the Display panel displays Reset Needed.

Route Samples

None

Forwards all trend samples from the engine to the ADS Repository, which is most often the Site Director. Issue this command before you upgrade an engine to ensure that the Site Director has all possible samples. Wait about 5 minutes for all samples to be forwarded.
Start Network Packet Capture Value This command starts scanning the network, and is only available when the appropriate signed resource file has been added to the Engine.
This command uses three arguments:
  • Network Interface: The user can either select Internal or External LAN Port.
  • Port Number: This is a user specified network port number used to filter the network traffic. An invalid user enter port number will create an empty .pcap file. When the Port Number field is left blank or set to 0, it will run in promiscuous mode and capture all the communications for the selected Network Interface.
  • Packet Count to Capture: This specifies the count of packets to be scanned. A user may enter a value from 1 to 25000.
Stop Network Packet Capture None This command stops the feature from scanning the network.
Update Flash Usage None Commands the engine to recalculate the Flash Usage value recorded under the Diagnostic tab of the network engine. This value is an estimated percent of flash memory currently in use.
Table 2. Bulk command support
Object Commands
Engine device object
  • Apply Staged Files
  • Cancel Staged Files
  • Archive
  • Reset Device
  • Change Audit Enabled Class Level
  • Update Flash Usage
  • Route Samples
  • Rediscover Text Strings
  • Start Network Packet Capture
  • Stop Network Packet Capture