NxE Information and Configuration Tool Technical Bulletin Code No. LIT Software Release 7.0 Issued December 5, 2014

Transcription

1 Code No. LIT Software Release 7.0 Issued December 5, 2014 Refer to the QuickLIT website for the most up-to-date version of this document. Document Introduction...2 Features of the NCT...2 NCT Overview...2 Related Documentation...3 Component Overview...3 NCT and Connections Tab...3 Tools Tab...7 Performance Monitor...9 Device Snapshot...12 Trace Feature...14 Set Date and Time Button...15 FTP Sessions Between NCT and NxEs...15 Explorer Tab...16 Directories...18 Get All Debug Files...18 About, Etc. Tab...18 Detailed Procedures...20 Installing the NCT...20 Minimum Computer and Operating System Requirements...20 Installation Steps...20 Metasys Software Requirements for NxEs Connecting to the NCT...25 IT Considerations...25 Finding the IP Address of an NxE...26 Finding the IP Address of an NxE Using the NCT to Discover the Device...26 Finding the IP Address of an NxE Using the NCT to Capture the SNMP Broadcast...26 Using the Advanced Mode...26 Enabling Advanced Mode...27 Using FTP and Telnet Servers in the Advanced Mode...27 Transferring Files...29 Finding Crash Files...29 Finding Non-Crash Files on an NxE...31 Using Remote Desktop with the NCT...32 Using Remote Desktop with Windows 7 and Later Operating Systems...32 Monitoring Engine Messages...32 Synchronizing the Time between the NxE and Your Computer...33 Troubleshooting...34 Windows Security Alert...34 Determining Possible Reasons for an NCE25 NAE35 or NAE45 Shutdown...34 Remote Desktop to NxE55 May Not Enable Access to the Local Drive

2 Document Introduction This document describes how to install the Network Engine (NxE) Information and Configuration Tool (NCT) and use the NCT to discover, identify, monitor, collect configuration information, and troubleshoot NxEs on Metasys networks. It also describes how to transfer files between a computer running the NCT and NxEs. Unless otherwise specified, the term NxE in this document refers to all of the supported models. See Features of the NCT and NCT Overview for more information on the NxEs supported by this release. Features of the NCT The NCT includes the following features: The NCT is compatible with all redesigned NxE55xx-2 engines. The NCT is compatible with NxE55xx-1 engines that are updated with compatible disk images. Currently, compatible NxE55xx-1 disk images are available for Releases 4.1, 5.0, 5.1, 5.2, 6.0, 6.1, 6.5, and 7.0. The NCT is required if you want to access an NxE55 engine with Remote Desktop. To improve network security, the capability to access an NxE55 from any Windows computer on the building network with the Remote Desktop Connection application has been disabled. The NCT identifies the Metasys software release version and build number when a compatible NxE is discovered. The NCT can discover NxEs on your Metasys networks, so IP Tracker is no longer required to discover NxEs. The NCT can run on a computer at the same time as the NAE/NIE Update Tool. Multiple instances of the NCT can run at the same time on the same computer. Discovered NxEs can be sorted according to model number, MAC address, host name, IP address, or order discovered. Advanced users, such as field technicians, should use the NCT for device discovery. Note: At Release 7.0, the SCT can be used for device discovery. The NCT can collect device debug files. Advanced users, such as field technicians, should use the NCT to collect device debug files. Note: At Release 7.0, the SCT can be used to collect device debug files. NCT Overview The NxE Information and Configuration Tool (NCT) is a software tool that allows you to quickly discover Metasys Network Engines (NxEs) on Ethernet networks and display some basic information regarding the discovered NxEs such as model number, MAC address, IP address, host name, NxE operating system (OS) version, and Metasys software release version. The NCT can also connect to individual NxEs and allow you to retrieve, copy, and transfer NxE files; diagnose and troubleshoot NxE problems; and edit NxE parameters. After connecting to an NxE, you can also monitor Simple Network Management Protocol (SNMP) traps and start the NxE s Site Management Portal user interface. The NCT supports NAE35, NAE45, NCE25, NAE55, and NIE55 Series engines that are loaded with compatible Metasys software. See Metasys Software Requirements for NxEs Connecting to the NCT for more information. The NxE85 and NIE89 models cannot be discovered and are not supported by the NCT. Note: The hardware platforms, operating systems, and other features of the NAE35, NAE45, and NCE25 engines differ from the NAE55 and NIE55 engines; therefore, some of the NCT diagnostic information, features, and procedures differ depending on the NxE type. These differences are called out in this document where applicable. Note: Currently, a Release or later version disk image is required for an NxE55xx-1 engine to be discovered by, connect to, and communicate with the NCT. 2

3 Related Documentation Table 1: Related Documentation For Information on How to update a Network Automation Engine (NAE) or Network Control Engine (NCE) How to set up an NAE for network connectivity, how to access the NAE user interface via a web browser, and how to set the basic NAE parameters How to set up an NCE25 for network connectivity, how to access the NCE25 user interface via a web browser, and how to set the basic NCE25 parameters How to use the SCT for device discovery and device debugging See Document NAE/NIE Update Tool Help (LIT ) NAE Commissioning Guide (LIT ) NCE Technical Bulletin (LIT ) Metasys SCT Help (LIT ) Component Overview This section describes the NCT screens, tabs, features, functions, and the associated user actions for the NCT user interface. Note: The NCT can operate in Normal mode or Advanced mode. Typically, you should use the NCT in Normal mode. Use the Advanced mode with the guidance of your local Johnson Controls service/support representative. The NCT screens in this document are shown in the Advanced mode to display all available features. Items that appear only in Advanced Mode are highlighted in gray. See Using the Advanced Mode for more information. NCT and Connections Tab Use the Connections tab (Figure 1 and Figure 2) to connect to the NxE, determine which NxEs are online, and log connection errors. Figure 1 shows the NCT when the NCT is started, prior to discovery of NxE engines and prior to connecting to an NxE engine. When you start the NCT, the Connections tab appears as the default screen. Prior to connecting to an NxE, the NCT displays a red banner with Disconnected displayed on the banner. Also, only the Connections and About, Etc. tabs are available prior to connecting to an engine. The Connections tab presents different options depending on whether you are using the NCT in Normal mode or Advanced mode. The Advanced mode includes all of those options present in Normal mode, as well as options that are only available in Advanced mode. All options are shown in Table 2. 3

4 Figure 1: NCT and Connections Tab Prior to Discovery of NxEs and Connection to an NxE Figure 2 shows the NCT with NxE engines discovered and one of the discovered engines connected to the NCT. 4

5 Figure 2: NCT Showing Connections Tab in the Advanced Mode 1 1 Shaded callouts signify those features that are only available in Advanced Mode. Features are described in the following table. 5

6 Table 2: Connections Tab Features and User Actions Callout Number Item Name User Action, Item Function, and Item Description Connections Tab Tools Tab Explorer Tab About, Etc. Tab Connect Button Disconnect Button See the following information regarding user actions, item functions, and item descriptions on the Connections tab. Click Tools to display the Tools tab. See Tools Tab for more information. Click Explorer to display the Explorer tab. See Explorer Tab for more information. Click About, Etc. to display the About, Etc. tab. See About, Etc. Tab for more information. Click Connect to connect the NCT to the NxE entered in the Connect to: field. Click Disconnect to disconnect the NCT from the NxE to which the NCT is currently connected. Note: Clicking Disconnect does not exit the NCT application. 7 Quit Button Click Quit to exit the NCT application. Note: Clicking Quit immediately disconnects you from the NxE. Any unsaved data open in the Connections tab or other tabs is lost. 8 Discover Button Click Discover to find compatible NxEs within range. Note: The NCT can discover only those NxEs that are connected on the same subnet as the NCT. See Metasys Software Requirements for NxEs Connecting to the NCT for additional NxE software requirements Clear List Button Connect UI Button Click Clear List to clear all devices from the Discovered Devices list. Click Connect UI to start the Windows Internet Explorer web browser and connect to the Site Management Portal of the NxE listed in the Connect to: field. Note: The NCT does not have to be connected to a device to successfully connect via the web browser to the device s Site Management Portal Remote Display Button or Remote Desktop Button Click Remote Display or Remote Desktop to open a remote display or Remote Desktop window for the NxE entered in the Connect to field. Note: The button displays Remote Display when the NCT is connected to an NAE35, NAE45, or NCE25. The button displays Remote Desktop when connected to an NAE55 or NIE Connect Telnet Button Connect FTP Button Click Connect Telnet to connect to the Telnet server on the connected NxE. Note: The Connect Telnet button is available only when the NCT is connected to an NAE35, NAE45, or NCE25. When connected to an NxE55 engine, use Remote Desktop to transfer files. Click Connect FTP to connect to the FTP server on the connected NxE. See Connect FTP on the Connections Tab for more information. Note: The Connect FTP option is available only when the NCT is connected to an NxE55-1, NxE55-2, NAE35, NAE45, or NCE Clear Messages Button Mode Bar Connection Status Bar Click Clear Messages to clear all of the messages displayed in the Messages from Selected Device field. Displays the NCT s current mode of operation (Normal or Advanced). The default mode of operation is Normal Mode. Figure 2 shows an NCT in Advanced Mode. See Using the Advanced Mode for more information. Displays the NCT connection status. When the NCT is connected, the Connection Status bar displays the DNS name or IP address of the connected NxE (entered in the Connect to: field). 6

7 Table 2: Connections Tab Features and User Actions Callout Number Item Name User Action, Item Function, and Item Description Connection Activity Log Always On Top Check Box Messages from Selected Device Field Device Connected to NCT Discovered Devices Field Sort By Button Ascending or Descending Order Button Password Field Connect to: Field Records and displays activities performed, status messages, any connection errors you encounter, and connection remedy messages while working from any of the NCT tabs. The Connection Activity Log provides valuable diagnostic and remedy information regarding the activities performed from NCT. Select the Always On Top check box to force the NCT window to remain on top of the other open windows on your computer. Selecting the check box does not deactivate the other windows, but the NCT on top may hide important information displayed in other windows if the NCT window is not placed or sized well. Displays the history of events and messages from the NxEs selected in the Discovered Devices field. The messages are shown in chronological order with time stamps. Displays SNMP Trap messages. The device (in the Discovered Devices field) that is currently connected to the NCT is highlighted in dark blue. Click Disconnect to disconnect the currently connected device. Select another device and double-click the selection to connect to the selected device, or select another device and click Connect to connect to the selected device. This field lists the devices from which the tool has received a message. Devices send messages for various reasons, including startup and IP address change. The messages appear in the Messages from Selected Device field. Click Sort By to establish the sort criteria and create a sorted list of devices. You can sort by Order Found, Model Number, MAC Address, IP Address, or host name. After selecting a Sort By category, click the ascending/descending order (arrow) button to reverse the sort order of the listed devices. Enter the same login password you use to connect to the NxE s Site Management Portal. If the default password has changed, you must enter the new password to connect to the NxE. Type in the IP address (or domain name system (DNS)) of the NxE to which you want to connect. If you have a device in the Discovered Devices list, double-click the entry to connect to the device. The IP address is automatically entered in the Connect to field and the device as listed is highlighted. 1 Shaded rows signify features that are only available in Advanced Mode. Tools Tab Use the Tools tab (Figure 3) to gather different types of data from an NxE, to synchronize the date and time on the NxE with the date and time on your computer, and to start and stop the FTP and Telnet servers. The Tools tab presents different options depending on whether you are using the NCT in Normal mode or Advanced mode. The Advanced mode includes all of those options present in Normal mode, as well as options that are only available in Advanced mode. Both options are shown in Table 3. 7

8 Figure 3: NCT Showing Tools Tab in the Advanced Mode 1 1 Shaded callouts signify those features that are only available in Advanced Mode. Features are described in the following table. Table 3: Tools Tab Features and User Actions Callout Item Name User Action, Item Function, and Item Description 1 Get Device Snapshot Button Click Get Device Snapshot to display a dialog box populated with recent data messages and updates regarding several critical areas of the controller s memory. See Device Snapshot for more information. 2 Set Time and Date Button Click Set Time and Date to synchronize the time on the connected NxE with the time on your NCT computer. The command sent from the NCT to the NxE contains the time in Coordinated Universal Time (UTC) format. This feature allows the NCT to work across time zones and stay in sync. The correct time zones must be configured in the NxE Site Management Portal and the NCT computer. See Set Date and Time Button and Synchronizing the Time between the NxE and Your Computer for more information. Important: Be aware that you can cause devices to go offline if your computer time differs by more than 5 minutes from the time on the Site Director. 3 Save Registry Button Click Save Registry to save registry information to persistent storage. Important: Use the Save Registry button only with the assistance of your local Johnson Controls service/support representative Start FTP Server Stop FTP Server Button Click Start FTP Server to start the FTP server on NAE55-1, NAE55-2, NAE35, NAE45, and NCE25 engines. To use the NxE s FTP server, you need to have an FTP application or Windows Internet Explorer web browser running on your laptop or computer to transfer files between your computer and the NxE. See FTP Sessions Between NCT and NxEs and Using FTP and Telnet Servers in the Advanced Mode for more information. Click Stop FTP Server to exit the FTP server application. See FTP Sessions Between NCT and NxEs and Using FTP and Telnet Servers in the Advanced Mode for more information. 8

9 Table 3: Tools Tab Features and User Actions Callout Item Name User Action, Item Function, and Item Description 6 1 Start Telnet Server Button Click Start Telnet Server to start the Telnet server application on NAE35, NAE45, and NCE25 engines. See Using FTP and Telnet Servers in the Advanced Mode for more information. Note: The Start Telnet Server button is not available for NxE55s. NxE55s use Remote Desktop to transfer files. 7 1 Stop Telnet Server Button Click Stop Telnet Server to exit the Telnet server application. See Using FTP and Telnet Servers in the Advanced Mode for more information. Note: The Stop Telnet Server button is not available for NxE55s. NxE55s use Remote Desktop to transfer files. 8 Disable Device Manager Button Click Disable Device Manager to disable the Metasys Device Manager. Important: Disabling the Device Manager and saving the changes prevents the Metasys Site Management Portal from running after restarting. Important: Use the Disable Device Manager button only with the assistance of your local Johnson Controls service/support representative Enable Device Manager Button Get NAE Information Button Restart Device Button Click Enable Device Manager to enable the Metasys Device Manager. Important: Use the Enable Device Manager button only with the assistance of your local Johnson Controls service/support representative. Click Get NAE Information to display a message box with the Windows time, Metasys time zone, Metasys software version number, Microsoft OS version number, Java Runtime Environment (JRE) version number, and the NxE model number for the connected NxE engine. For NxE55 series engines, the basic input/output system (BIOS) firmware version number is also included. Click Restart Device to force a reset of the connected NxE. Important: Clicking Restart Device forces a restart of the NxE without performing an archive. Any changes you made since the last archive of the NxE are lost when you click this button. 12 Performance Monitor Button Click Performance Monitor to start the Performance Monitor. The Performance Monitor gathers device performance data from the connected NxE. The NxE s Windows OS supplies this data; it is not supplied by the Metasys system application. See Performance Monitor for more information. 1 Shaded rows signify features that are only available in Advanced Mode. Performance Monitor Start the Performance Monitor from the NCT Tools tab. See Tools Tab for more information. When you click Performance Monitor, the Performance Monitor screen appears (Figure 4). Important: When the NCT Performance Monitor is running, it places additional load on the NxE processor. If the NxE processor is close to being overloaded, this additional load may cause the NxE to reset. Note: The NCT must be connected to an NxE to start and run the Performance Monitor. 9

10 Figure 4: NAE35, NAE45, and NCE25 Performance Monitor (Top), and NAE55 and NIE55 Performance Monitor (Bottom) 1 1 Shaded callouts signify features which may vary based on the engine in use. 10

11 Table 4: Performance Monitor Features and User Actions Callout Item Name User Action, Item Function, and Item Description Processor Usage Indicator Total Memory Usage Indicator (NCE25, NAE35, NAE45 Engines Only) Memory Usage Indicator (NxE55 Engines Only) Indicates the percentage of processor time used. Lower values are better for computer performance. If the value climbs to 100% or remains higher than 50 to 75% for more than a few seconds, there is a large load on the NxE processor that you should address. Indicates the percentage of NxE usage. The percentage shown to the right of the indicator bar and the length of the bar represents the percentage of total RAM consumed by the OS, applications, and others. Calculate the actual total amount of RAM by combining the Object Store and the System Memory values shown on the right of the Object Store and System Memory bars. For example, using the top screen capture shown in Figure 4: Object Store: 7,144 KB of RAM System Memory: 107,200 KB of RAM Total Memory: 114,344 KB of RAM The percentage fluctuates with usage; however, check for problems if the value increases dramatically. For instance, if the value increases over 50% for no apparent reason and stays there, there may be a problem. Note: The Total Memory usage indicator is available only when NCT is connected to an NAE35, NAE45, or NCE25 engine. When the NCT is connected to an NxE55 engine, the Memory usage indicator is available. The Memory usage indicator displays the total NxE55 memory available and the amount of memory currently in use. 3 1 Object Store Usage Indicator (NCE25, NAE35, NAE45 Engines Only) Indicates the percentage of RAM that the Windows OS and Metasys system use for temporary storage. The percentage shown to the left of the meter is the portion of total memory reserved for the Object Store. The values shown to the right of the meter indicate how much of the object store is used, its total size, and the percentage used. The total is assigned by the operating system upon startup and remains fixed. The percentage used should not change dramatically after the database has been downloaded. If you see dramatic changes up or down, these file changes may indicate a problem, such as a virus or a hacking attempt. Note: The Object Store usage indicator is available only when the NCT is connected to an NAE35, NAE45, or NCE25 engine. When the NCT is connected to an NxE55 engine, this indicator is not available. 4 1 System Memory Usage Indicator Indicates the amount of RAM available to applications after the RAM file system has been allocated. (NCE25, NAE35, NAE45 Engines Only) Note: The System Memory usage indicator is available only when the NCT is connected to an NAE35, NAE45, or NCE25 engine. When the NCT is connected to an NxE55 engine, this indicator is not available. 5 Storage Usage Indicator Indicates the percent usage of the total storage space available on the flash memory. Storage in the NxE is not like storage in a personal computer. A standard computer has a hard disk drive while the NxE has a flash memory chip. The storage bar displays three values (to the right of the indicator bar): the total amount of storage space on the flash chip available to the NxE, the current amount of flash space used by the NxE (represented by the bar), and the percent usage of the total storage available. 11

12 Table 4: Performance Monitor Features and User Actions Callout Item Name User Action, Item Function, and Item Description 6 Receiving Data Indicator Indicates integrity of the NCT/NxE connection. When blinking, these circles with red dots represent a good connection between the NCT performance monitor and the NxE. If the circles are not blinking, the connection to the NxE may have been lost. If the connection is lost, the data in the performance monitor is no longer dynamic. Note: Updates to the performance monitor (including the receiving data indicators) may pause during certain operations of the tool, such as receiving a file using the Explorer tab Always On Top Check Box Log Update Interval Value Browse Button Select the Always On Top check box to force the Performance Monitor to remain on top of other applications on the desktop. This selection is recommended, as it is sometimes difficult to get back to this window in time to see transient results. Select the Log Update interval (in seconds) of the NxE performance data using the up and down arrow buttons. Click Browse to navigate to and select the filepath/folder for storing NxE performance data logs on the NCT computer. 10 Enable Logging Check Box Select the Enable Logging check box to capture NxE performance data in the selected log file. 1 Shaded callouts signify features which may vary based on the engine in use. Device Snapshot When you click Get Device Snapshot on the NCT Tools tab, you create a snapshot (Figure 5) of several critical areas of the controller s memory. The snapshot shows the readings for those memory areas at the moment that you clicked the button. Figure 5: Device Snapshot Window 12

13 The information in each of the window panes provides details from the memory of the connected NxE. The information in the panes is not dynamic. To refresh the information in a device snapshot, close the window and click Device Snapshot again; however, you can save any particular snapshot to a file by clicking Save Snapshot to File on the Device Snapshot screen. Figure 6 shows an example of a snapshot log file in a Notepad window. The Device Snapshot window includes the following information: Processes This pane lists the processes running at the time of the snapshot. Threads This pane lists the open threads at the time the snapshot was taken. A thread can be thought of as an application within a process. Threads consume the resources allocated by the process. 13

14 Modules This pane lists the modules (dynamic-link library (DLL) files) that are currently called for use by the Processes and Threads. A dynamic link library is a small program that is not resident in RAM memory until it is called by a process or thread. Modules consume additional resources when called; therefore, DLL modules are only called when required. Windows This pane lists the window shells called and currently open inside the controller. Use the data here to help determine whether the processes currently running are complete and correct. For example, a missing window might indicate an operating system problem. Figure 6: Snapshot Log File Trace Feature The trace feature in the Device Snapshot tool allows you to determine which: threads are associated with which process modules (DLL files) are associated with which process window is held open by which process Click any line in any pane and all of the connections are highlighted for you. In Figure 7, the selection in the Processes pane causes the associated threads, modules, and windows to be highlighted in their respective panes. 14

15 Figure 7: Device Snapshot Trace Feature Set Date and Time Button This feature allows you to synchronize the NxE s date and time to the date and time on the computer running NCT. The command sent from the NCT to the NxE contains the time in UTC format. This feature can synchronize NxE date and time across time zones when the correct time zones are configured on the NxE and the computer. Important: Take care in using this tool. You can cause devices to go offline if your computer time differs more than 5 minutes from the time on the Site Director. When date and time synchronization is successful, it is recorded in the Connection Activity log at the bottom of the NCT window. FTP Sessions Between NCT and NxEs You can transfer files between the NCT computer and NAE55-1, NAE55-2, NAE35, NAE45, and NCE25 engines by establishing an FTP session between the NCT and NxE. Using the NCT, you can initiate an FTP session using one of two different methods: clicking the Connect FTP button on the Connections tab, or clicking the Start FTP button on the Tool tab. Note: There is potential risk in copying files back into the NxE using the FTP utility; therefore, we recommend that you use this utility as a read-only tool. That is, copy files that aid in troubleshooting, but do not copy these files into other NxEs or write them back into the same NxE. Important: FTP allows anonymous authentication (user: anonymous, password: anything), so anyone on the network can connect to the device while the FTP server is enabled. The FTP server is automatically stopped when the last NCT connection to the device is closed. If an NxE s FTP server is started but not in use and you plan on keeping the NCT connected to the NxE, stop the NxE s FTP server. Note: The FTP connection does not use significant resources within the NxE except during an actual file transfer. 15

16 Connect FTP on the Connections Tab When your NCT computer is connected to an NAE55-1, NAE55-2, NAE35, NAE45, or NCE25 and the NCT is running in Advanced mode, you can click Connect FTP on the Connections tab to automatically start an FTP session using Internet Explorer. The FTP session stops when you disconnect the NxE from the NCT. You can also stop the File Transfer Protocol (FTP) session by clicking Stop FTP on the Tools tab. Using the Connect FTP button on the Connections tab is the recommended method for setting up an FTP session. See Using FTP and Telnet Servers in the Advanced Mode for more information. Start FTP on the Tools Tab With an NAE55-1, NAE55-2, NAE35, NAE45, or NCE25 connected, click Start FTP Server on the Tools tab to start the FTP server on the NxE. You need an FTP application on your NCT computer to transfer files between your computer and the NxE s FTP server. Internet Explorer has a built-in FTP application. When you click Start FTP Server on the Tool tab, the comment...request made appears in the Connection Activity Log (Figure 8) indicating that a thread is started on the NxE, which starts the NxE s FTP server. Note: If a high-priority thread is using the NxE s processor, starting the FTP server could cause the application and the NCT to become inactive; therefore,...request made does not necessarily mean that FTP service has started. If the NxE is running normally and is not overburdened, then most likely the service has started. If the NCT connects to FTP client on the NxE, the service has started. Figure 8: Connection Activity Log Start the FTP application on the computer connected to the NxE and execute the required tasks. In the Internet Explorer web browser, type ftp://xxx.xxx.xxx.xxx, where xxx.xxx.xxx.xxx is the IP address of the connected NxE. See Using FTP and Telnet Servers in the Advanced Mode for more information. Explorer Tab Use the Explorer tab (Figure 9) to quickly locate and retrieve copies of files from an NxE. The Explorer tab does not allow file deletion. 16

17 Figure 9: NCT Showing Explorer Tab in the Advanced Mode (Connected to an NAE35, NAE45, or NCE25) Table 5: NCT Explorer Tabs, Advanced Mode Features, and User Actions Callout Number Item Name User Action, Item Function, and/or Item Description Files Pane Get File Button Get All Debug Files Button When you highlight a directory in the Directories Pane, the Files pane displays the files located in the highlighted folder. You can retrieve a copy of any file by highlighting the file in the Files pane and clicking Get File. You can select only one file at a time. Click Get File to copy the files you select in the Files pane. For information on using this function, see Finding Non-Crash Files on an NxE. Click Get All Debug Files to retrieve and store several log files created by the OS and Metasys applications. These files help when troubleshooting NxE problems. For information on using this function, see Finding Crash Files. Important: The Get All Debug Files tool places additional load on the NxE processor. If the NxE processor is close to being overloaded, this additional load may cause the NxE to reset. 4 5 Directories Pane Refresh Device Contents Button Displays a navigation tree showing the directory structure of the NxE when you click Refresh Device Contents. The paths/directories can be expanded and contracted to browse through the NxE. The Directories feature is read-only and does not allow you to act on the directories that appear. Click Refresh Device Contents to command the NCT to read the directory structure of the connected NxE and display the directory content (as a navigation tree) in the Directories pane. Important: The Refresh Device Contents tool places additional load on the NxE processor. If the NxE processor is close to being overloaded, this additional load may cause the NxE to reset. 17

18 Directories When connected to NCE25, NAE35, and NAE45 engines, the Directories pane of the Explorer tab (Figure 9) shows the directories on the NxE; however, these directories are not necessarily in the same physical location. The Storage directory is mapped directly to the flash on a device. The Windows directory is a special, read-only section of memory; the contents of which are not included in the memory numbers shown on the performance monitor. In general, you should not need to access the Windows directory unless instructed by your local Johnson Controls service/support representative. The rest of the directories are part of the object store described in Performance Monitor. Because the contents of the object store are lost at restart, the NxE copies some items (for example, Events) to storage during its shutdown process. Note: The Windows directory is not displayed in the Directories pane when the NCT is connected to NxE55 engines. Get All Debug Files The Get All Debug Files function allows you to retrieve and store the debug files that the NCT generates. The NCT saves several types of debug files, including.log,.map,.txt, and others. Table 8 shows an example of the Device Manager log file (dmlog.txt) file from an NCE25, NAE35, or NAE45 engine. The debug files are saved in the same directory structure as they are stored on the NxE. The directory created by the Get All Debug Files process for an NAE35, NAE45, or NCE25 is shown in the square in Figure 21. For more information on using this feature, see Finding Crash Files. About, Etc. Tab This tab provides the user with additional details about the tool and a quick link to the NCT log file. The log file section of the tab is viewable only in the Advanced mode. Use the Advanced mode only with assistance from your local Johnson Controls service/support representative. Note: The Messages from Selected Device field on the Connections tab are more helpful to the general user than the Log File View button. We strongly recommend that you do not use the Empty button to empty the log file unless directed to do so by your local Johnson Controls service/support representative. 18

19 Figure 10: NCT Showing About, Etc. Tab in the Advanced Mode 1 1 Shaded callouts signify those features that are only available in Advanced Mode. Features are described in the following table. Table 6: NCT About, Etc. Tab, Advanced Mode Features and User Actions Callout Item Name User Action, Item Function, and/or Item Description NCT Information Pane Log File Section View Button Empty Button Provides some additional details about the NCT, including copyright, port usage, NCT version number, and a list of devices supported by NCT. Appears only in the Advanced mode and contains the View button and Empty button. Click View to open a new window that displays the entire NCT log file. Note: The Messages from Selected Device field on the Connections tab are more helpful to the general user than the Log File View button. Click Empty to erase the log file. This function permanently deletes all information in the log file. You cannot undo the Empty command. Important: Use the Empty button with caution. We strongly recommend that you do not click Empty unless directed to do so by your local Johnson Controls service/support representative. 5 Log all network data Check Box Select the Log all network data check box to include all communication data between the NCT and the connected NxE. 6 Command Timeout Box Select a value to establish the amount of time (in seconds) in which commands sent from the NCT wait before they return a lack of response error. For example, if you have trouble starting the performance monitor tool (which could be due to network delays), you could increase this value by 5-second increments until the lack of response error messages stop appearing. 1 Shaded rows signify features that are only available in Advanced Mode. 19

20 Detailed Procedures Installing the NCT Minimum Computer and Operating System Requirements Table 7 provides the minimum computer and OS software requirements for installing the NCT on a laptop, computer, or server. Table 7: System Requirements for Installing the NCT Recommended Computer/Server Platform 1 Intel Core 2 Duo E6700 or higher (Intel Core 2 Duo E4300 minimum) 20 GB free hard disk space available (600 MB minimum) DVD drive Recommended Memory 1 Supported Operating Systems Computer Platforms: 2 GB RAM (1 GB RAM minimum) Server Platforms: 4 GB RAM (2 GB RAM minimum) Windows 8.1 Pro and Windows 8.1 Enterprise Editions (64-bit) Requires.NET Framework Version 3.5. Windows 8 Pro and Windows 8 Enterprise Editions (64-bit) Requires.NET Framework Version 3.5. Windows 7 Professional, Enterprise, or Ultimate Editions with SP1 (64-bit) Requires.NET Framework Version Windows 7 Professional, Enterprise, or Ultimate Editions with SP1 (32-bit) Requires.NET Framework Version Windows Server 2012 R2 Standard and Enterprise Editions Requires.NET Framework Version 3.5. Windows Server 2012 Standard and Enterprise Editions Requires.NET Framework Version 3.5. Windows Server 2008 R2 Standard and Enterprise Editions with SP1 Requires.NET Framework Version Windows Server 2008 Standard and Enterprise Editions with SP2 (32-bit) Requires.NET Framework Version 3.5. Network Communication Ethernet network interface card 10/100/1,000 Mbps (a 100 or 1,000 Mbps network connection is recommended) 1 Our computer platform and memory recommendations are not meant to imply that older or slower machines are not usable. Refer to the Network and IT Guidance for the BAS Professional Technical Bulletin (LIT ) for more information regarding computer/server recommendations. Installation Steps Note: The laptop, computer, or server on which you intend to install the NCT must meet the minimum requirements described in Minimum Computer and Operating System Requirements. Also, you must remove any previous release of NCT before installing a new release of the NCT. To install the NCT: 20

21 1. Navigate to the NAE Configuration Tool folder on the product disk and double-click the setup.exe file. The Welcome screen appears (Figure 11). Figure 11: NCT Installation Wizard Start Screen Note: If the WinPcap utility is not already installed on your computer, a WinPcap installation prompt message appears. If WinPcap is already installed on your computer, the WinPcap installation prompt message does not appear. Go to Step 5 to continue installing the NCT. 2. Click Next in the WinPcap Installation Wizard welcome screen (Figure 12) to start the WinPcap installation. 21

22 Figure 12: WinPcap Setup Screen 3. Accept the default values and settings, and click Next in the installation wizard screens until the Completing the WinPcap Setup Wizard screen appears (Figure 13). 22

23 Figure 13: WinPCap Installation Wizard Finish Screen 4. Click Finish (Figure 13). The WinPcap installation wizard closes, and the NCT installation wizard welcome screen appears (Figure 14). 23

24 Figure 14: NCT Installation Wizard Start Screen 5. Click Next (Figure 14). Follow the instructions on the installation wizard screens to install the NCT. 6. Click Finish in the NCT InstallShield Wizard complete screen (Figure 15). 24

25 Figure 15: NCT Installation Wizard Complete Screen The new version is installed on your computer and ready for use with the supported NxE engines on your Metasys networks. Metasys Software Requirements for NxEs Connecting to the NCT All NCE25, NAE35, and NAE45 engines (except NAE45xx-0 engines) with Release 3.0 or later disk images can be discovered by, connect to, and communicate with the NCT. NxE55xx-0 engines cannot be discovered and are not supported by the NCT. NxE55xx-1 engines require downloading a new/compatible disk image. Currently, a Release or later version disk image is required for an NxE55xx-1 engine to be discovered by, connect to, and communicate with the NCT. Currently, NxE55xx-2 engines ship with the disk image for the latest release installed, which enables NxE55xx-2 engines to be discovered by, connect to, and communicate with that release of the NCT. Note: For an NxE55xx-1 or NxE55xx-2 engine before release 5.2 to respond to an NCT discovery request, the engine must be at a specific patch level for its release. These patch levels are , , and NxE55xx-0 engines cannot be discovered regardless of release. IT Considerations The NCT requires access to Transmission Control Protocol (TCP) port 9910 to communicate between the computer running NCT and the NxE. The NCT connects to any NxE across routers and over the Internet as long as any firewalls the device has to cross have TCP Port 9910 open; however, SNMP startup messages only work on the same physical network segments. The NCT can be run in an advanced mode, which has more features and function than the normal mode. See Component Overview and Using the Advanced Mode for more information. 25

26 Finding the IP Address of an NxE This section describes ways that you can use the NCT to find the IP address of an NxE. Finding the IP Address of an NxE Using the NCT to Discover the Device To find the IP address of an NxE by using the NCT to discover the device, click Discover and look for the NxE in the Discovered Devices list. Note: The NxEs must be connected to the same subnet as the NCT computer to be discovered by the NCT. NCE25, NAE35, and NAE45 engines must be at Release 3.0 or later to respond to the NCT discovery request. For an NxE55xx-1 or NxE55xx-2 engine before release 5.2 to respond to an NCT discovery request, the engine must be at a specific patch level for its release. These patch levels are , , and NxE55xx-0 engines cannot be discovered regardless of release. Finding the IP Address of an NxE Using the NCT to Capture the SNMP Broadcast The NCT captures SNMP broadcasts for any supported NxE, regardless of the disk image loaded on the engine. Important: This method of finding an IP address requires you to disconnect power from the NxE, wait until all LEDs are off, and then reapply power. NxE shutdown may adversely affect the current conditions of your Metasys system and the controlled equipment. Please verify with your customer that NxE shutdown is acceptable prior to shutting down the NxE. Note: A message appears in the Recently Started Devices list if an NxE is assigned a new IP address after it sends the initial startup serial port message. The delay in IP address assignment occurs when an NxE is configured for Dynamic Host Configuration Protocol (DHCP), and the DHCP server is not responding or is responding slowly. If you attempt to use a serial port monitor to find the IP address of the NxE at this time, the monitor reads As soon as the NxE is assigned an IP address, a message appears in the Recently Started Devices list with the correct address listed, and Step 2 and Step 3 are not required. To determine the IP address of an NxE using the NCT to capture the SNMP broadcast: 1. Start the NCT on a computer connected to the LAN. 2. Disconnect power from the NxE and wait for all NxE LEDs to go off. 3. Reconnect power to the NxE. In approximately 1 to 2 minutes for NCE25, NAE35, or NAE45 engines, or 2 or 6 minutes for NxE55 engines, the Recently Started Devices list shows information from the NxE you started. This list includes the date and time started, the NxE name, the IP address, the OS version, and the MAC address. Note: If no messages appear in the Recently Started Devices pane, the local network may be blocking broadcast messages. In this case, connect your NCT computer on the same side of the router as the NxE and perform this procedure again. 4. When the NxE is in the RUN mode (RUN LED on), the SNMP broadcasts are captured for any supported NxE engine (including NxEs without compatible disk images.) Note: For NCE25, NAE35, and NAE45 engines prior to Release 3.0, and for NxE55xx-1 engines without a compatible disk image, the IP address is broadcast via SNMP when the RUN light is on steady during startup. Using the Advanced Mode The Advanced mode of NCT enables use of the FTP servers on NAE55-1, NAE55-2, NAE35, NAE45, and NCE25 engines only and Telnet servers on NAE35, NAE45, and NCE25 engines only. The Advanced mode is enabled by adding the /advanced switch to the NICTool.exe Target properties. The Advanced mode is a powerful option that allows you to update files on the device; however, users should avoid indiscriminate use of the Advanced mode features. Only use the Advanced mode as directed in Johnson Controls documentation or under the direction of your local Johnson Controls service/support representative. For information on enabling Advanced mode, see Enabling Advanced Mode. 26

27 Enabling Advanced Mode To enable the Advanced mode on the NCT: 1. On the Start menu, go to Programs > Johnson Controls > Metasys and hover over NAE Information and Configuration Tool to highlight the option. 2. With the NAE Information and Configuration Tool option highlighted, right-click and select Properties. The NAE Information and Configuration Tool Properties dialog box appears (Figure 16). Figure 16: NCT Properties Dialog Box 3. Select the Shortcut tab and enter a space followed by /advanced at the end of the string in the Target field (Figure 16). 4. Click OK. The properties are updated and properties box closes. The next time you start the NCT, it runs in the Advanced mode. Using FTP and Telnet Servers in the Advanced Mode Use these procedures to transfer files between your NCT computer and NAE35, NAE45, and NCE25 engines. FTP also works with the NAE55-1 and NAE55-2. Note: The NCT enables you to start/set up an FTP or Telnet session with the connected NxE on NAE35, NAE45, or NCE25 engines using the Connect FTP and Connect Telnet buttons on the Connections tab when the NCT is in Advanced mode. See Tools Tab for more information. We recommend starting an FTP or Telnet session from the Connections tab. To set up FTP and Telnet servers on the Connection tab: 1. Start the NCT in Advanced mode and click Discover on the Connections tab. 2. Double-click the desired NxE from the Discovered Devices list or enter the IP address of the desired NxE in the Connect to field (Figure 17) and click Connect. 27

28 Figure 17: NCT Connected to an NxE 3. Click Connect FTP. The FTP directory appears. If you are connecting to an NAE55-1 or NAE55-2, a login window may appear. Enter the credentials for the MetasysSysAgent user, then click OK. If you are unable to login using FTP, use Remote Desktop instead. 4. If you are using the Internet Explorer 8, 9, 10, or 11 web browser, click Page, then click Open FTP Site in Windows Explorer (Figure 18). A Windows Explorer user window appears. Figure 18: Displaying Files and Folders with Windows Explorer Internet Explorer 8 Browser 5. Use the Windows Explorer window to copy and paste files between your computer and the NxE. Consult with your local Johnson Controls service/support representative regarding the files to transfer. 6. When you are finished with the FTP session, go to the Tools tab and click Stop FTP Server. 7. To start a Telnet session, click Connect Telnet on the Connections tab window (Figure 17). A Telnet windows appears (Figure 19). 28

29 Note: You can also start the Telnet server by clicking Start Telnet Server on the Tools tab (Figure 3). Figure 19: Telnet Window 8. Perform your commands at the \> prompt. Consult with your local Johnson Controls service/support representative regarding the Telnet commands. 9. When you are finished with the Telnet connection, go to the Tools tab and click Stop Telnet Server. The Telnet window closes in the background. Transferring Files The NCT allows users to copy files from their local machine to engines. For information on copying files or transferring files, see Using FTP and Telnet Servers in the Advanced Mode and FTP Sessions Between NCT and NxEs. Finding Crash Files To find crash files on an NAE45 or NAE55: 1. Start the NCT. 2. On the Connections tab, select a device, then click Connect to connect to an NxE. 3. On the Explorer tab, click Get All Debug Files, select a destination for the files, then click OK. This transfers the crash and map files associated with the selected device. If you want to store your files in a new folder, click Make New Folder (Figure 20). 29

30 Figure 20: Select Destination for Debug Files Screen Note: The debug files are saved in the same directory structure as they are stored on the NxE. Figure 21 shows the directory created by the Get All Debug Files process for an NAE35, NAE45, or NCE25. Figure 21: Sample Debug File Directory When the transfer is complete (refer to the Connection Activity pane for successful completion results), use Windows Explorer to browse to and open the files you saved. 30

31 Note: The dmlog.txt file is located in the subfolder \storage\dmlog.txt. 4. Right-click the file and open with Notepad. The file should be similar to the example in Table 8. Table 8: Example of a dmlog.txt File 10/07/ :20:47 N40 Device Manager Service started ******************* 10/07/ :24:35 Line power is off, waiting before committing to shutdown 10/07/ :24:39 Line power off 10/07/ :25:02 App did not self-terminate 10/07/ :25:04 Requesting Windows to shutdown, reason = 4 10/07/ :29:39 N40 Device Manager Service started ******************* 10/07/ :34:44 Line power is off, waiting before committing to shutdown 10/07/ :34:48 Line power off 10/07/ :35:12 App did not self-terminate 10/07/ :35:14 Requesting Windows to shutdown, reason = 4 10/07/ :38:04 N40 Device Manager Service started ******************* Note: In this example, the shutdowns appear to be due to external circumstances, such as loss of power to the NxE. If the device is shut down by pressing the NCT s Restart Device button, the device shuts down immediately and no log of shutdown messages is recorded in dmlog.txt. Finding Non-Crash Files on an NxE Although the NCT is typically only used to find crash files for troubleshooting, you can use it to find other types of files as well. To find non-debug files on an NxE using the NCT, use the following instructions. For information on finding crash files, see Finding Crash Files. 1. Start the NCT. 2. On the Connections tab, select a device, then click Connect to connect to an NxE. 3. Select the Explorer tab. 4. If you are not sure where the file you are looking for is located, click Refresh Device Contents. The NxE Device directory appears in the Directories pane of the Explorer tab. (Figure 22). 31