ToggleTunnel and ChangeModel Technical Bulletin
Code No. LIT-12011531
Software Release 8.0
September 2016
Refer to the QuickLIT website for the most up-to-date version of this document.
Document Introduction.............................................................................................................2
Summary of Changes................................................................................................................2
Related Documentation.............................................................................................................2
ToggleTunnel and ChangeModel Overview.............................................................................2
ToggleTunnel.......................................................................................................................................3
ChangeModel.......................................................................................................................................4
Detailed Procedures..................................................................................................................5
Setting up and Using ToggleTunnel for the First Use.....................................................................5
Using ToggleTunnel for Each Subsequent Use...............................................................................6
Using ChangeModel............................................................................................................................6
Troubleshooting.........................................................................................................................7
ToggleTunnel and ChangeModel Technical Bulletin
1
Document Introduction
This document includes instructions for using the ToggleTunnel and ChangeModel utilities. This entire document
applies to Network Automation Engine (NAE) 55s/Network Integration Engine (NIE) 55s, and the ChangeModel
information applies to NAE85s/NIE85s.
Note: The NIE59 and NIE89xx models do not support ToggleTunnel or ChangeModel. If you try to run these utilities
on either of these two engine models, the message Existing model <MS-NIEx9xx> is unknown or
cannot be changed appears in the command prompt window, with the appropriate model number shown.
Summary of Changes
The following information is new or revised:
• Added the MS-NAE55xx-3 model to the footnotes in Table 2 and Table 3.
• Removed references to old Metasys system releases.
Related Documentation
Table 1: NAE/NIE Update Tool Related Documentation
For Information On
See Document
Performing the Complete Upgrade Process
Metasys® Server Installation and Upgrade Instructions Wizard
1
(LIT-12012162)
Commissioning an NAE/NIE, Using Remote Desktop NAE Commissioning Guide (LIT-1201519)
to Copy Files or Run Programs
Commissioning an NAE85/NIE85
NxE85 Commissioning Guide (LIT-12011044)
Updating an NAE/NIE to a New Release
NAE/NIE Update Tool Help (LIT-12011524)
Installing and Wiring an NAE55/NIE55
NAE55/NIE55 Installation Instructions (Part No. 24-10051-43)
1
Use the wizard to generate instructions specific to your system.
ToggleTunnel and ChangeModel Overview
ToggleTunnel and ChangeModel are executable files that change the networking capabilities of specific engines.
Important: Depending on the engine model, using either of these executable files may delete your archive. See
the conversion tables in theToggleTunnel and ChangeModel sections for details.
These tools allow you to change the functionality of your engine, but they do not allow you to update the engine to
a different release. Network engines with internal modem capability retain that capability after you use ToggleTunnel
or ChangeModel.
Use ToggleTunnel and ChangeModel on a new network engine before you log in to the engine for the first time.
These utilities do not perform a proper shutdown of the engine, which may cause a password synchronization
problem that disables your ability to log in to the engine again. If this condition occurs, you need to re-image the
engine. Alternatively, if you log in to the engine before you use ToggleTunnel or ChangeModel, issue a Reset Device
command from the Site Management Portal UI. This step performs a proper shutdown and preserves all password
changes.
Before using these utilities, plan for alternative ways to perform the duties currently performed by the engine you
are toggling or changing. After using these utilities, the engine may not be compatible with the network where it was
originally installed. For example, if you convert an N2 tunneling engine into an NIE55, you should first make sure
the duties performed by the tunneling NAE are absorbed by another N2 supervisory device.
ToggleTunnel and ChangeModel Technical Bulletin
2
ToggleTunnel
ToggleTunnel is a utility that you must purchase separately from the NAE55/NIE55 using Product Code Number
MS-MULTENGSW-6. ToggleTunnel changes a non-tunneling NAE55/NIE55 into an NAE55 with N2 tunneling
capability, and changes an NAE55 with N2 tunneling capability into a non-tunneling NAE55/NIE55.
See Table 2 for details on model conversion with ToggleTunnel.
When using Table 2, be sure to read the Model Number attribute and not the model number on the engine.
ToggleTunnel is not required for a system upgrade. For example, an updated NAE5512 remains an NAE5512 after
an update, without the use of ToggleTunnel.
Important: Depending on the model conversion, this executable file deletes your archive and replaces it with the
default archive for the engine to which you are changing. See Table 2 for details.
Important: Engines that are UL864 Listed for smoke control applications do not retain UL approval if they are
converted from their original state. Do not use ToggleTunnel with UL864 Listed engines.
Table 2: Model Conversion with ToggleTunnel
Before
After
Model Number Attribute
Functions Like This Model
Type of Engine
MS-NAE5501
MS-NAE5512
NAE5512
NAE with Tunneling
2
MS-NAE5512
NAE5512
NAE with Tunneling
1
Model Number Attribute
2
MS-NIE5501
MS-NAE5512
MS-NAE5501
NAE5510
NAE
MS-NAE5510-x
MS-NAE5512-x
NAE5512
NAE with Tunneling
MS-NAE5511-x
3
2
MS-NAE5513-x
NAE5513
NAE with Tunneling
3
MS-NAE5510-x
NAE5510
NAE
3
MS-NAE5511-x
NAE5511
NAE
4
MS-NAE5512-x
NAE5512
NAE with Tunneling
4
MS-NAE5513-x
NAE5513
NAE with Tunneling
5
MS-NAE5512-x-x
NAE5512
NAE with Tunneling
5
MS-NAE5513-x
NAE5513
NAE with Tunneling
2,5
MS-NAE5510-x
NAE5510
NAE
MS-NAE5511-x
NAE5511
NAE
2,5
MS-NAE5512-x
NAE5512
NAE with Tunneling
2,5
MS-NAE5513-x
NAE5513
NAE with Tunneling
MS-NAE5512-x
MS-NAE5513-x
MS-NAE5520-x
MS-NAE5521-x
MS-NIE5510-x
MS-NIE5511-x
MS-NIE5512-x
MS-NIE5513-x
2,5
MS-NIE5520-x
MS-NIE5521-x
1
2
3
4
5
The -x indicates the -1 , -2 , and -3 models.
This model number does not correspond to an orderable part number. Be sure to look at the Model Number attribute in the
engine when using this table.
This model number is discontinued and no longer an orderable part number. However, if you have an NAE5510 or an
NAE5511, you can use ToggleTunnel to toggle the device to act as an NAE5512 or NAE5513.
If an engine with a LONWORKS® trunk is converted into a tunneling NAE55, there is currently no way to restore the LONWORKS
compatible model number. An engine with NAE5512/NAE5513 in the Model Number attribute can be toggled only to an
engine with NAE5510/NAE5511 in the Model Number attribute. LONWORKS network communication is always possible on the
engine, no matter the contents in the Model Number attribute.
With this conversion, the archive is deleted and replaced with the factory-default archive for the engine to which you are
toggling.
ToggleTunnel and ChangeModel Technical Bulletin
3
ChangeModel
ChangeModel is a tool that converts an NAE55 to an NIE55, or converts an NIE85 to an NAE85, and vice versa.
Converting through ChangeModel preserves licensing.
See Table 3 for details on model conversion with ChangeModel.
When using Table 3, be sure to read the Model Number attribute and not the model number on the engine.
Important: The ChangeModel executable file deletes your archive and replaces it with the default archive for the
engine to which you are changing.
Important: Engines that are UL864 Listed for smoke control applications do not retain UL approval if they are
converted from their original state. Do not use ChangeModel with UL864 Listed engines.
Table 3: Model Conversion with ChangeModel
Before
After
1
Model Number Attribute
2
Model Number Attribute
2
MS-NAE5501
MS-NIE5501
Functions Like This Model
Type of Engine
NIE5510
NIE
MS-NIE5501
MS-NAE5501
NAE5510
NAE
MS-NAE5510-x
MS-NIE5510-x
NIE5510
NIE
MS-NAE5511-x
MS-NIE5511-x
2
2
NIE5511
NIE
2
NIE5510
NIE
2
MS-NAE5520-x
MS-NIE5520-x
MS-NAE5521-x
MS-NIE5521-x
NIE5511
NIE
MS-NAE8500
MS-NIE8500
NIE85
NIE
MS-NIE5510-x
MS-NAE5510-x
NAE5510
NAE
MS-NIE5511-x
MS-NAE5511-x
NAE5511
NAE
MS-NAE5520-x
NAE5520
NAE
MS-NAE5521-x
NAE5521
NAE
MS-NAE8500
NAE85
NAE
3
2
MS-NIE5520-x
2
NIE5521-x
3
MS-NIE8500
1
2
3
The -x indicates the -1 , -2 , and -3 models.
This model number does not correspond to an orderable part number. Be sure to look at the Model Number attribute in the
engine when using this table.
After using ChangeModel with an NxE85, rename the desktop shortcut icon to reflect the appropriate model. The icon name
does not update automatically.
ToggleTunnel and ChangeModel Technical Bulletin
4
Detailed Procedures
Setting up and Using ToggleTunnel for the First Use
Important: The NxE Information and Configuration Tool (NCT) is required to access an NAE55/NIE55 with remote
desktop. To improve network security, the capability to access an NAE55/NIE55 from any
Microsoft® Windows® computer on the building network with the Remote Desktop Connection application
has been disabled. The NCT enables the Remote Desktop services when Remote Desktop is selected
and disables the services when the NxE55xx is disconnected.
Important: Use ToggleTunnel or ChangeModel on a new network engine before you log in to the engine for the
first time. These utilities do not perform a proper shutdown of the engine, which may cause a password
synchronization problem that disables your ability to log in to the engine again. If this condition occurs,
you need to re-image the engine.
Note: The procedure in this section applies to the first time you copy and use ToggleTunnel. See Using ToggleTunnel
for Each Subsequent Use if you have already toggled the tunneling functionality at least once before.
To set up and use ToggleTunnel for the first use:
1.
2.
3.
4.
5.
Purchase the Johnson Controls® ToggleTunnel utility via your usual channels (Product Code Number
MS-MULTENGSW-6).
Insert the product disk into a computer with the NCT installed and network access to the NAE55/NIE55.
Using Windows® Internet Explorer®, browse to the following location: Images > TTU.
Copy ToggleTunnel.exe to a location on your computer.
Disconnect the field network connections from the NAE55/NIE55.
6.
Note: Make sure all critical functions performed by this NAE55/NIE55 are transferred to other devices before
disconnecting the NAE55/NIE55 from the field networks.
Start the NCT, connect to the NAE/NIE55, then click Remote Desktop to access the command prompt.
Note: Refer to the Enabling the Serial Printer DDA section in the NAE Commissioning Guide (LIT-1201519)
for in-depth instructions on using Remote Desktop with NCT to access the NAE55/NIE55.
7. At the command prompt, type explorer and press Enter. The NAE Windows Explorer window appears.
8. In the Remote Desktop Windows Explorer window, copy ToggleTunnel.exe from your computer to the
NAE55/NIE55 directory C:\WINDOWS\system32.
9. In the Remote Desktop Windows Explorer window, browse to the location on your computer where you pasted
ToggleTunnel.exe.
10. In the Remote Desktop Windows Explorer window, double-click the ToggleTunnel.exe file you pasted in the
NAE55/NIE55 in Step 9.
ToggleTunnel runs on the NAE55/NIE55. The file executes in a few seconds, and messages similar to those
in Figure 2 appear quickly in the Remote Desktop command prompt window before it closes.
Note: The window often disappears too quickly to read the text, and it may be hidden behind other windows.
Depending on the model conversion, the NAE55/NIE55 shuts down and the archive is deleted. See Table 3 for
information on model conversion and other details.
Figure 1: Successful Toggle Message
ToggleTunnel and ChangeModel Technical Bulletin
5
11. If Remote Desktop does not close, close it.
12. Adjust the hardware and wiring as necessary. For example, if you converted an NIE55 to a tunneling NAE55,
carefully peel off the label to expose the Field Controller (FC) ports and end-of-line (EOL) switches, and wire
the engine for N2 communication. Refer to the NAE55/NIE55 Installation Instructions (Part No. 24-10051-43)
for details.
Using ToggleTunnel for Each Subsequent Use
Note: Follow the steps in this section if you have already toggled the tunneling functionality at least once before.
See Setting up and Using ToggleTunnel for the First Use if this is the first time you are using ToggleTunnel.
To use ToggleTunnel for each subsequent use:
1. Start the NCT, connect to the NAE/NIE55, then click Remote Desktop to access the engine.
2. In the command prompt window that appears in Remote Desktop, type toggletunnel after
C:\WINDOWS\system32> and press Enter.
ToggleTunnel runs. The file executes in a few seconds, and messages similar to those in Figure 2 appear quickly
in the command prompt window before it closes.
Note: The window often disappears too quickly to read the text, and it may be hidden behind other windows.
Depending on the model conversion, the engine shuts down and the archive is deleted. See Table 3 for information
on model conversion and other details.
Figure 2: Successful Toggle Message
3. If Remote Desktop does not close, close it.
4. Adjust the hardware and wiring as necessary. For example, if you converted an NIE55 to a tunneling NAE55,
carefully peel off the label to expose the FC ports and EOL switches, and wire the engine for N2 communication.
Refer to the NAE55/NIE55 Installation Instructions (Part No. 24-10051-43) for details.
Using ChangeModel
If your NAE85/NIE85 is using the web edition of the Windows Server® 2008, Windows Server 2008 R2, Windows
Server 2012, or Windows Server 2012 R2 operating system, ChangeModel requires that you open the command
prompt with the Run as Administrator option. This step is included below.
Important: Use ToggleTunnel or ChangeModel on a new network engine before you log in to the engine for the
first time. These utilities do not perform a proper shutdown of the engine, which may cause a password
synchronization problem that disables your ability to log in to the engine again. If this condition occurs,
you need to re-image the engine.
To use ChangeModel:
1. Make sure all critical functions performed by this engine are transferred to other devices.
2. Disconnect the field network connections from the engine.
3. Start NCT and use Remote Desktop in NCT to access the NAE55/NIE55 or to access the NAE85/NIE85 if you
do not have access to the computer itself. If you have local access to the NAE85/NIE85 computer, click the Start
menu on the NAE85/NIE85. Under the Accessories folder, right-click Command Prompt and select Run as
Administrator. Click Continue if prompted by the User Access Control dialog box.
4. In the command prompt window that appears, type changemodel after C:\WINDOWS\system32> and press
Enter.
ToggleTunnel and ChangeModel Technical Bulletin
6
Note: If the NxE8500 is installed on a 64-bit operating system, you must move it to the correct directory. At the
command prompt, type cd %windir%\syswow64, and press Enter. Then type changemodel and press
Enter.
ChangeModel runs. The file executes in a few seconds, and messages similar to those in the Successful Change
Message window (Figure 3) appear. The window often disappears too quickly to read the text, and it may be
hidden behind other windows.
Figure 3: Successful Change Message
The engine shuts down and the archive is deleted. See Table 3 for information on model conversion and other
details.
5. Adjust the hardware and wiring as necessary. For example, if you converted an NIE55 to an NAE55, carefully
peel off the label to expose the FC ports and EOL switches, and wire the engine for FC communication. Refer
to the NAE55/NIE55 Installation Instructions (Part No. 24-10051-43) for details.
Troubleshooting
Troubleshooting messages appear in the command prompt window. Use Table 4 to diagnose problems when using
ToggleTunnel or ChangeModel.
Table 4: Troubleshooting ToggleTunnel and ChangeModel
Problem
Condition
Error reading existing model, ToggleTunnel or ChangeModel cannot read which model you have. Wait a few minutes
and try the utility again. If the problem persists on a -0 model, use the NAE/NIE Update
or unable to read existing
Tool to reimage the engine. If the problem persists on a -x model, contact your usual
model.
support channels.
Error setting new model.
An error occurred when the ToggleTunnel or ChangeModel attempted to change the
model. Wait a few minutes and try the utility again.
Error accessing the Windows
directory.
You do not have Administrator access, which is necessary to access the Windows
directory with the Command Prompt.
To run the Command Prompt with Administrator access for Windows Server 2008 or
Windows Server 2008 R2, click the Start button, select All Programs > Accessories and
right-click Command Prompt. Select Run as administrator. When the Command Prompt
appears, try the utility again.
To run the Command Prompt with Administrator access for Windows Server 2012 or
Windows Server 2012 R2, right-click the lower portion of the Start screen and click All
Apps. On the Apps screen, right-click the Command Prompt tile and select the Run as
Administrator option on the bottom of the screen.
Existing model <MS-NIEx9xx>
is unknown or cannot be
changed.
You tried to run ToggleTunnel or ChangeModel on an NIE59 or NIE89 engine. These
NIE models do not support ToggleTunnel or ChangeModel.
Building Efficiency
507 E. Michigan Street, Milwaukee, WI 53202
Metasys® and Johnson Controls® are registered trademarks of Johnson Controls, Inc.
All other marks herein are the marks of their respective owners.© 2016 Johnson Controls, Inc.
Published in U.S.A.
ToggleTunnel and ChangeModel Technical Bulletin
www.johnsoncontrols.com
7