Amx NI-2100/3100/4100 User Manual

WebConsole & Programming GuideNetLinx Integrated ControllersLast Revised: 4/24/2007NI SeriesNetLinx Integrated ControllersNI-700/900NI-2000/3000/4

Overview2NI Series WebConsole & Programming GuideRelated DocumentsFor detailed descriptions of NI Controller hardware, including specifications, p

Terminal (Program Port/Telnet) Commands92NI Series WebConsole & Programming Guide6. Click OK to complete the communication parameters and open a n

Terminal (Program Port/Telnet) Commands93NI Series WebConsole & Programming GuideLogin: User1Password: *****Login not authorized. Please try again

Terminal (Program Port/Telnet) Commands94NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionDNS LIST <D:P:S>

Terminal (Program Port/Telnet) Commands95NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionIP STATUS Provides i

Terminal (Program Port/Telnet) Commands96NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionPASS [D:P:S or NAME]

Terminal (Program Port/Telnet) Commands97NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionREBOOT <D:P:S>

Terminal (Program Port/Telnet) Commands98NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSET DNS <D:P:S>

Terminal (Program Port/Telnet) Commands99NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSET HTTPS PORT Sets t

Terminal (Program Port/Telnet) Commands100NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSET LOG COUNT Sets t

Terminal (Program Port/Telnet) Commands101NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSET TELNET PORT Sets

Overview3NI Series WebConsole & Programming GuideUpdate the On-board Master and Controller Firmware  Before using your new NI unit, you must firs

Terminal (Program Port/Telnet) Commands102NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSET UDP BC RATE Sets

Terminal (Program Port/Telnet) Commands103NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSHOW DEVICE <D:P:

Terminal (Program Port/Telnet) Commands104NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSHOW MAX BUFFERS Dis

Terminal (Program Port/Telnet) Commands105NI Series WebConsole & Programming GuideTerminal Commands (Cont.)Command DescriptionSHOW ROUTE Displays

Terminal (Program Port/Telnet) Commands106NI Series WebConsole & Programming GuideESC Pass CodesThere are 'escape' codes in the pass mod

Terminal (Program Port/Telnet) Commands107NI Series WebConsole & Programming GuideAccessing the Security Configuration OptionsThe help security op

Terminal (Program Port/Telnet) Commands108NI Series WebConsole & Programming GuideSetup Security MenuThe Setup Security menu is described below:Se

Terminal (Program Port/Telnet) Commands109NI Series WebConsole & Programming GuideSecurity Options MenuSelect "Set system security" from

Terminal (Program Port/Telnet) Commands110NI Series WebConsole & Programming GuideEdit User MenuThe Edit User Menu is accessed whenever you enter

Terminal (Program Port/Telnet) Commands111NI Series WebConsole & Programming GuideAccess Rights MenuThe Access Rights Menu is accessed whenever yo

Overview4NI Series WebConsole & Programming Guide

Terminal (Program Port/Telnet) Commands112NI Series WebConsole & Programming GuideEdit Group Menu: Add Directory Association1.At the Edit Group pr

Terminal (Program Port/Telnet) Commands113NI Series WebConsole & Programming GuideDefault Security ConfigurationBy default, the NetLinx Master wil

Terminal (Program Port/Telnet) Commands114NI Series WebConsole & Programming GuideNotes on Specific Telnet/Terminal ClientsTelnet and terminal cli

Appendix A: IPSec Configuration File115NI Series WebConsole & Programming GuideAppendix A: IPSec Configuration FileIPSec Config fileThe IPSec Conf

Appendix A: IPSec Configuration File116NI Series WebConsole & Programming GuideInternet Key Exchange (IKE)ikeAddPeerAuth ikeAddPeerAuthNAME ikeAdd

Appendix A: IPSec Configuration File117NI Series WebConsole & Programming GuideikeAddPeerAuth (Cont.)EXAMPLES Using a pre-shared key for IPv4:ikeA

Appendix A: IPSec Configuration File118NI Series WebConsole & Programming GuideikeSetProp ikeSetProp NAME ikeSetProp – create a Phase 1 proposalSY

Appendix A: IPSec Configuration File119NI Series WebConsole & Programming GuideikeSetPropAttrib ikeSetPropAttribNAME ikeSetPropAttrib – set attrib

Appendix A: IPSec Configuration File120NI Series WebConsole & Programming GuideSecurity Policy Database (SPD)spdAddTransport spdAddTransport NAME

Appendix A: IPSec Configuration File121NI Series WebConsole & Programming GuideSpdAddTunnel SpdAddTunnelNAME spdAddTunnel– create a tunnel mode po

Initial Configuration and Firmware Upgrade5NI Series WebConsole & Programming GuideInitial Configuration and Firmware UpgradeThis section describe

Appendix A: IPSec Configuration File122NI Series WebConsole & Programming GuideSpdAddBypass SpdAddBypass NAME spdAddBypass– create a bypass policy

Appendix A: IPSec Configuration File123NI Series WebConsole & Programming GuideSpdAddDiscard SpdAddDiscardNAME spdAddDiscard – create a discard po

Appendix A: IPSec Configuration File124NI Series WebConsole & Programming GuideSpdSetProp SpdSetPropNAME spdSetProp– add Phase 2 transforms to a P

Appendix A: IPSec Configuration File125NI Series WebConsole & Programming GuideSpdSetProp (Cont.)esp_g1_transport=esp_3des_sha,esp_3des_md5,esp_3d

Appendix A: IPSec Configuration File126NI Series WebConsole & Programming GuideSpdSetProp (Cont.)esp_des_sha=ESP_DES,SHAesp_des_md5=ESP_DES,MD5esp

Appendix A: IPSec Configuration File127NI Series WebConsole & Programming GuideSpdSetProp (Cont.)esp_aes_ctr_192_sha=ESP_AES-CTR,KEY_LENGTH,192,SH

Appendix A: IPSec Configuration File128NI Series WebConsole & Programming GuideSpdSetPropAttrib SpdSetPropAttribNAME spdSetPropAttrib– set attribu

Appendix A: IPSec Configuration File129NI Series WebConsole & Programming GuidespdSetSA SpdSetPropAttrib (Cont.)EXAMPLES spdSetPropAttrib=ah_defau

Appendix A: IPSec Configuration File130NI Series WebConsole & Programming GuideManual Key Manager (MKM)mkmAddBypass mkmAddBypassNAME mkmAddBypass

Appendix A: IPSec Configuration File131NI Series WebConsole & Programming GuidemkmAddDiscard mkmAddDiscardNAME mkmAddDiscard – add a discard Secur

Initial Configuration and Firmware Upgrade6NI Series WebConsole & Programming GuideThis action causes the *Not Active* message (in red) to display

Appendix A: IPSec Configuration File132NI Series WebConsole & Programming GuidemkmAddTransport mkmAddTransport NAME mkmAddTransport – add a transp

Appendix A: IPSec Configuration File133NI Series WebConsole & Programming GuidemkmAddTunnel mkmAddTunnelNAME mkmAddTunnel – add a tunnel mode Secu

Appendix A: IPSec Configuration File134NI Series WebConsole & Programming GuidemkmSetInboundAH mkmSetInboundAHNAME mkmSetInboundAH – set the trans

Appendix A: IPSec Configuration File135NI Series WebConsole & Programming GuidemkmSetInboundESP mkmSetInboundESPNAME mkmSetInboundESP – set the tr

Appendix A: IPSec Configuration File136NI Series WebConsole & Programming GuidemkmSetOutboundAH mkmSetOutboundAHNAME mkmSetOutboundAH – set the tr

Appendix A: IPSec Configuration File137NI Series WebConsole & Programming GuidemkmSetOutboundESP mkmSetOutboundESPNAME mkmSetOutboundESP – set the

Appendix A: IPSec Configuration File138NI Series WebConsole & Programming GuideSample IPSec Configuration FileThe following is a sample IPSec conf

Appendix A: IPSec Configuration File139NI Series WebConsole & Programming GuideIPSec Web Configuration InterfaceOnce the IPSec Config file for a s

Appendix A: IPSec Configuration File140NI Series WebConsole & Programming Guide

Appendix B: Clock Manager NetLinx Programming API141NI Series WebConsole & Programming GuideAppendix B: Clock Manager NetLinx Programming APITypes

Initial Configuration and Firmware Upgrade7NI Series WebConsole & Programming Guide4. Note the obtained IP Address (read-only). This information i

Appendix B: Clock Manager NetLinx Programming API142NI Series WebConsole & Programming GuideLibrary CallsThe NetLinx.axi file that ships with NetL

Appendix B: Clock Manager NetLinx Programming API143NI Series WebConsole & Programming GuideNetLinx.axi - Library Calls (Cont.)CLKMGR_GET_START_DA

Appendix B: Clock Manager NetLinx Programming API144NI Series WebConsole & Programming GuideNetLinx.axi - Library Calls (Cont.)CLKMGR_GET_END_DAYL

Terminal (Program Port/Telnet) Commands145NI Series WebConsole & Programming Guide

4/07 ©2007 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without no

Initial Configuration and Firmware Upgrade8NI Series WebConsole & Programming GuideAssigning a Static IP to the NI Controller1. In NetLinx Studio,

Initial Configuration and Firmware Upgrade9NI Series WebConsole & Programming Guide12. Complete the communication process by continuing on to the

Initial Configuration and Firmware Upgrade10NI Series WebConsole & Programming Guide6. Click the Edit Settings button (on the Communications Setti

Initial Configuration and Firmware Upgrade11NI Series WebConsole & Programming GuideVerifying the Firmware Version On the MasterAll NI Controllers

AMX Limited Warranty and DisclaimerAll products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is obtained from

Initial Configuration and Firmware Upgrade12NI Series WebConsole & Programming GuideUpgrading the On-board Master Firmware via an IPThe on-board M

Initial Configuration and Firmware Upgrade13NI Series WebConsole & Programming Guide7. In NetLinx Studio, select Tools > Firmware Transfers >

Initial Configuration and Firmware Upgrade14NI Series WebConsole & Programming Guide12. After the last components fails to install, click Done.13.

Initial Configuration and Firmware Upgrade15NI Series WebConsole & Programming Guide5. If the NI Controller firmware being used is not current, do

Initial Configuration and Firmware Upgrade16NI Series WebConsole & Programming GuideDo not use the 2105-03_NI_X00 Kit file on anything other than

Initial Configuration and Firmware Upgrade17NI Series WebConsole & Programming GuideIf The Connection FailsIf the connection fails to establish, a

Initial Configuration and Firmware Upgrade18NI Series WebConsole & Programming Guide5. If the NXC card firmware being used is not current, downloa

Initial Configuration and Firmware Upgrade19NI Series WebConsole & Programming Guide16. Cycle power to the Master (unplug and reconnect power to t

Initial Configuration and Firmware Upgrade20NI Series WebConsole & Programming Guide

Onboard WebConsole User Interface21NI Series WebConsole & Programming GuideOnboard WebConsole User InterfaceWebConsole UI OverviewNetLinx Masters

Table of ContentsiNI Series WebConsole & Programming GuideTable of ContentsOverview ...

Onboard WebConsole User Interface22NI Series WebConsole & Programming GuideAccessing the WebConsoleFrom any PC that has access to the LAN that the

Onboard WebConsole User Interface23NI Series WebConsole & Programming GuideDevice Network Settings PagesClick on the blue Information (i) icon nex

Onboard WebConsole User Interface24NI Series WebConsole & Programming Guide

WebConsole - WebControl Options25NI Series WebConsole & Programming GuideWebConsole - WebControl OptionsManage WebControl ConnectionsThe WebContro

WebConsole - WebControl Options26NI Series WebConsole & Programming Guide

WebConsole - Security Options27NI Series WebConsole & Programming GuideWebConsole - Security OptionsSecurity OverviewThe Security System Details p

WebConsole - Security Options28NI Series WebConsole & Programming GuideDefault Security ConfigurationBy default, the NetLinx Master creates the fo

WebConsole - Security Options29NI Series WebConsole & Programming GuideSystem Security - System LevelSystem Level Security options provide authori

WebConsole - Security Options30NI Series WebConsole & Programming GuideSystem Security Access Options System Security Access OptionsOption D

WebConsole - Security Options31NI Series WebConsole & Programming GuideAccepting ChangesClick the Accept button to save changes on this page. Acce

iiNI Series WebConsole & Programming GuideTable of ContentsSystem Security Access Options ...

WebConsole - Security Options32NI Series WebConsole & Programming GuideConfiguring Settings1.Check the Enabled option to enable Security, and make

WebConsole - Security Options33NI Series WebConsole & Programming GuideSystem Security - Group LevelSelect the Group Level tab of the Security Pag

WebConsole - Security Options34NI Series WebConsole & Programming Guide6. Click the Accept button to save your changes to the target Master. If th

WebConsole - Security Options35NI Series WebConsole & Programming GuideGroup and User Security Access Options (Cont.)Option DescriptionTelnet Acce

WebConsole - Security Options36NI Series WebConsole & Programming GuideViewing Group Security Settings DetailsClick on any Group listed in the Gro

WebConsole - Security Options37NI Series WebConsole & Programming GuideAny properties possessed by groups (ex: access rights, update rights, direc

WebConsole - Security Options38NI Series WebConsole & Programming GuideSystem Security - User LevelSelect the User Level tab of the Security Page

WebConsole - Security Options39NI Series WebConsole & Programming GuideThe password must be a unique alpha-numeric character string (4 - 20 charac

WebConsole - Security Options40NI Series WebConsole & Programming GuideIf you are not logged into the Master, you receive a reminder message: &quo

WebConsole - System Options41NI Series WebConsole & Programming GuideWebConsole - System OptionsSystem OverviewThe Manage System page is accessed

Table of ContentsiiiNI Series WebConsole & Programming GuideExporting an SSL Certificate Request ...

WebConsole - System Options42NI Series WebConsole & Programming GuideManage System - System NumberThe options on this page display the current Sys

WebConsole - System Options43NI Series WebConsole & Programming GuideControlling or Emulating a System Device1.Select the device that you want to

WebConsole - System Options44NI Series WebConsole & Programming GuideSelect the On or Off buttons to Emulate Channel ON (CHON) and Channel OFF (CH

WebConsole - System Options45NI Series WebConsole & Programming Guide6. In the Command and String fields, enter any character strings that can be

WebConsole - System Options46NI Series WebConsole & Programming GuideManage System - Diagnostics OptionsClick the Diagnostics link (in the Manage

WebConsole - System Options47NI Series WebConsole & Programming Guideinformation on the selected device (including network configuration details).

WebConsole - System Options48NI Series WebConsole & Programming Guide3. The device that you just enabled diagnostics for appears in the Diagnostic

WebConsole - System Options49NI Series WebConsole & Programming Guide Repeat steps 1-3. Alternatively, you can click one of the Edit buttons to

WebConsole - System Options50NI Series WebConsole & Programming GuideDisabling all Diagnostic Options For a DeviceThere are two ways to disable al

WebConsole - System Options51NI Series WebConsole & Programming GuideManage System - Server OptionsClick the Server link (in the Manage System tab

ivNI Series WebConsole & Programming GuideTable of ContentsInput/Output Send_Commands ...

WebConsole - System Options52NI Series WebConsole & Programming GuideServer Port SettingsThe following table describes each of the Port Settings p

WebConsole - System Options53NI Series WebConsole & Programming GuideOnce any of the server port settings have been modified, press the Accept but

WebConsole - System Options54NI Series WebConsole & Programming Guide1. Click the Create SSL Certificate link (under SSL Certificate Options) to a

WebConsole - System Options55NI Series WebConsole & Programming GuideDisplaying SSL Server Certificate InformationClick the Create SSL Certificate

WebConsole - System Options56NI Series WebConsole & Programming Guide4. Click Create SSL Certificate to save the newly modified certificate inform

WebConsole - System Options57NI Series WebConsole & Programming GuideImporting an SSL CertificateClick the Import SSL Certificate link to import a

WebConsole - System Options58NI Series WebConsole & Programming GuideManage System - Clock Manager OptionsClick the Clock Manager link (in the Man

WebConsole - System Options59NI Series WebConsole & Programming Guide2. Click Accept to save these settings to the Master.Setting Daylight Savings

WebConsole - System Options60NI Series WebConsole & Programming Guide4. Use the Ends fields to specify when Daylight Savings should end. The Ends

WebConsole - System Options61NI Series WebConsole & Programming GuideRemoving an NIST Server From the List1.Click on the Remove (x) button to the

Table of ContentsvNI Series WebConsole & Programming GuidemkmAddTransport ...

WebConsole - System Options62NI Series WebConsole & Programming GuideExample: AMX Meeting Manager and i!-Voting applications are examples of produ

WebConsole - System Options63NI Series WebConsole & Programming GuideSystem - Manage NetLinxThe Manage NetLinx tab displays a list of NetLinx devi

WebConsole - System Options64NI Series WebConsole & Programming Guide Refresh List: Click this button to regenerate the device listing by looking

WebConsole - System Options65NI Series WebConsole & Programming GuideSystem - Manage DevicesThe Manage Devices tab (FIG. 46) contains links to sev

WebConsole - System Options66NI Series WebConsole & Programming Guide2. Press the Accept button to save your changes.Managing Device ModulesUse th

WebConsole - System Options67NI Series WebConsole & Programming GuideTo browse for a Module file and then upload it to the Master:1. Click the Bro

WebConsole - System Options68NI Series WebConsole & Programming GuideConfiguring Application-Defined DevicesElements such as DUET_DEV_TYPE_DISC_DE

WebConsole - System Options69NI Series WebConsole & Programming GuideThis code gives the Master a “heads-up” notification to look for those device

WebConsole - System Options70NI Series WebConsole & Programming GuideEach entry in the table has one of four buttons to the right of the Physical

WebConsole - System Options71NI Series WebConsole & Programming GuideManage Devices - User-Defined DevicesClick the User-Defined Devices link (in

viNI Series WebConsole & Programming GuideTable of Contents

WebConsole - System Options72NI Series WebConsole & Programming Guide2. Fill in the device information fields, as described in the following table

WebConsole - System Options73NI Series WebConsole & Programming Guide3. Once you are done creating the profile for the new device, click the Add P

WebConsole - System Options74NI Series WebConsole & Programming Guide Unless the Disable Module Search via the Internet option was selected in th

WebConsole - System Options75NI Series WebConsole & Programming GuideManage Devices - Manage Polled PortsClick the Polled Ports link (in the Manag

WebConsole - System Options76NI Series WebConsole & Programming GuideUse the drop-down menus to modify the Port settings.Click Reset to Default Se

Programming77NI Series WebConsole & Programming GuideProgrammingOverviewThis section describes the Send_Commands, Send_Strings, and Channel comman

Programming78NI Series WebConsole & Programming GuideMaster IP Local Port Send_CommandsThese commands are specific to the Master and not the Contr

Programming79NI Series WebConsole & Programming GuideLED Disable/Enable Send_CommandsThe following commands enable or disable the LEDs on the Inte

Programming80NI Series WebConsole & Programming GuideRS-232/422/485 Send_Commands RS-232/422/485 Send_CommandsCommand DescriptionB9MOFFSet the

Programming81NI Series WebConsole & Programming GuideRS-232/422/485 Send_Commands (Cont.)Command DescriptionGET BAUDGet the RS-232/422/485 port’s

Overview1NI Series WebConsole & Programming GuideOverviewNetLinx Integrated ControllersNetLinx Integrated Controllers (Masters) can be programmed

Programming82NI Series WebConsole & Programming GuideRS-232/422/485 Send_Commands (Cont.)Command DescriptionSET BAUDSet the RS-232/422/485 port&ap

Programming83NI Series WebConsole & Programming GuideRS-232/422/485 Send_String Escape Sequences This device also has some special SEND_STRING e

Programming84NI Series WebConsole & Programming GuideIR / Serial Ports Channels IR RX Port ChannelsIR/Serial Send_CommandsThe following IR and I

Programming85NI Series WebConsole & Programming GuideIR/Serial Send_Commands (Cont.)Command DescriptionCHSend IR pulses for the selected channel.A

Programming86NI Series WebConsole & Programming GuideIR/Serial Send_Commands (Cont.)Command DescriptionGET BAUDGet the IR port’s current DATA mode

Programming87NI Series WebConsole & Programming GuideIR/Serial Send_Commands (Cont.)Command DescriptionPONTurn On a device connected to an IR port

Programming88NI Series WebConsole & Programming GuideIR/Serial Send_Commands (Cont.)Command DescriptionSET BAUDSet the IR port's DATA mode co

Programming89NI Series WebConsole & Programming GuideIR/Serial Send_Commands (Cont.)Command DescriptionXCHTransmit the selected chan-nel IR codes

Programming90NI Series WebConsole & Programming GuideInput/Output Send_CommandsThe following Send_Commands program the I/O ports on the Integrated

Terminal (Program Port/Telnet) Commands91NI Series WebConsole & Programming GuideTerminal (Program Port/Telnet) CommandsOverviewThere are two type