WebConsole & Programming Guide NetLinx Integrated Controllers (Firmware version 3.
AMX Limited Warranty and Disclaimer This Limited Warranty and Disclaimer extends only to products purchased directly from AMX or an AMX Authorized Partner which include AMX Dealers, Distributors, VIP’s or other AMX authorized entity.
Table of Contents Table of Contents Overview ............................................................................................................1 NetLinx Integrated Controllers ................................................................................. 1 DVX-2100HD Enova Total Environment Controller................................................... 2 About This Document ............................................................................................... 2 Related Documents.......
Table of Contents Default Security Configuration ...................................................................................... 26 Login Rules .................................................................................................................... 26 User Name and Password Rules .................................................................................... 26 Allowed Special Characters ...........................................................................................
Table of Contents Manage System - Server Options ........................................................................... 49 Port Settings ................................................................................................................. 49 Server Port Settings ...................................................................................................... 49 SSL Certificate Options .................................................................................................
Table of Contents Manage Devices - URL List...................................................................................... 72 Adding a URL To The Master’s List Of Devices ............................................................. 72 Manage Devices - Device Number .......................................................................... 73 Manage Devices - Control/Emulate ........................................................................ 74 Manage Devices - Log.............................
Table of Contents IR/Serial SEND_COMMANDs .................................................................................. 87 CAROFF ..................................................................................................................................87 CARON ...................................................................................................................................87 CH ....................................................................................................
Table of Contents HELP SECURITY ...................................................................................................................... 98 ICSPMON ENABLED|DISABLED [PORT] ................................................................................. 98 IP STATUS .............................................................................................................................. 99 IPSEC ON|OFF|STATUS ................................................................................
Table of Contents SHOW REMOTE ....................................................................................................................113 SHOW ROUTE ......................................................................................................................114 SHOW START LOG ...............................................................................................114 SHOW SYSTEM ..........................................................................................
Table of Contents SpdSetProp ................................................................................................................ 130 SpdSetPropAttrib ....................................................................................................... 133 spdSetSA .................................................................................................................... 134 Manual Key Manager (MKM) ................................................................................
Overview Overview NetLinx Integrated Controllers NetLinx Integrated Controllers (Masters) can be programmed to control RS-232/422/485, Relay, IR/Serial, and Input/Output devices using the NetLinx Studio application (version 2.4 or higher).
Overview The Web Console is described in this document (starting with the Onboard WebConsole User Interface section on page 21). These NI Controllers are Duet-compatible and can be upgraded via firmware. Duet is a dual-interpreter firmware platform from AMX which combines the proven reliability and power of NetLinx with the extensive capabilities of the Java® MicroEdition (JavaME) platform.
Overview Related Documents For detailed descriptions of NI Controller hardware, including specifications, port assignments, installation procedures, connection and wiring information, refer to the Hardware Reference Guide for your Master: Related Documents Title • DVX-2100HD Enova Total Environment Controller - Operation/Reference Guide • NXI-700/900 NetLinx Integrated Controllers - Hardware Reference Guide • NXI-x000 NetLinx Integrated Controllers - Hardware Reference Guide (NI-2000, NI-3000, NI-4000) • N
Overview Using Zero Configuration NetLinx Controllers with firmware versions of v3.41 or higher support using "zero-configuration" client software to quickly install multiple devices on the network. Bonjour (Zero-Configuration) Client You can use a zero-configuration client to determine the IP address of the Controllers. There are many zeroconfiguration clients available. However, for the purposes of this document, we will refer to Bonjour for Windows. It is free and widely available for download.
Initial Configuration and Firmware Upgrade Initial Configuration and Firmware Upgrade Overview This section describes using the NetLinx Studio software application to perform the initial configuration of the Master, as well as upgrading the firmware for various Master components. NetLinx Studio is used to setup a System number, obtain/assign the IP/URL for the connected NI Controller, and transfer firmware Kit files to the Master. NetLinx Studio is available to download (free of charge) from www.amx.
Initial Configuration and Firmware Upgrade Configuring the NI Controller for LAN Communication Before continuing, complete the COM port steps above. 1. Use an LAN cable to connect the Controller to the LAN to which the PC running NetLinx Studio is connected. The NI-x100 Controllers feature an Auto MDI/MDI-X LAN port. This provides the option of using either a standard (straight through), or a crossover LAN cable to communicate with a PC - both cable types will work. 2.
Initial Configuration and Firmware Upgrade 4. Click the Start Identify Mode button. This action activates Identify Mode on the named System. "Identify Mode" means that the system is put on hold while it waits for an event from any NetLinx device in the named system (for example, pushing the ID button on a NetLinx device). The device that generates the first event is the device that gets identified. The Device Addressing dialog displays the "Waiting...Press Cancel to Quit...
Initial Configuration and Firmware Upgrade Obtaining the NI Controller’s IP Address (using DHCP) Verify there is an active LAN connection on the NI Controller’s LAN port before beginning these procedures. 1. In NetLinx Studio, select Diagnostics > Network Addresses from the Main menu to access the Network Addresses dialog (FIG. 7). System Address reflects the value set in the Device Addressing tab Used to obtain a Dynamic (DHCP) IP Address FIG.
Initial Configuration and Firmware Upgrade 10. Click Reboot (from the Tools > Reboot the Master Controller dialog) and wait for the System Master to reboot and retain the newly obtained DHCP Address. The STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation. Wait until the STATUS LED is the only LED to blink. 11. Press Done once until the Master Reboot Status field reads *Reboot of System Complete*.
Initial Configuration and Firmware Upgrade 9. Click the Reboot Master button and select Yes to close the Network Addresses dialog. 10. Click Reboot (from the Tools > Reboot the Master Controller dialog) and wait for the System Master to reboot and retain the newly obtained DHCP Address. The STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation. Wait until the STATUS LED is the only LED to blink. 11.
Initial Configuration and Firmware Upgrade FIG. 10 NetLinx Studio - Communication Settings dialog a. Select NetLinx Master (under Platform Selection) to indicate you are working with a NetLinx Master. b. Select TCP/IP (under Transport Connection Option) to indicate you are connecting to the Master via an IP Address. 4.
Initial Configuration and Firmware Upgrade FIG. 12 NetLinx Studio - Communication Settings dialog a. Click on the new IP Address entry in the List of Addresses window b. Click Select to use the selected IP Address as the current IP Address. 6. Click OK to save your newly entered information and close the Communication Settings dialog. 7. In the Master Communication Settings dialog, click OK to begin the communication process to your Master (and close the dialog).
Initial Configuration and Firmware Upgrade Verifying the Firmware Version On the Master All NI Controllers contain both an on-board NI Master and an Integrated Controller. If you are using an NI4000 or NI-4100 with installed NXC cards, these will also show up within the Online Tree tab.
Initial Configuration and Firmware Upgrade Upgrading the On-board Master Firmware via an IP The on-board Master firmware Kit file is not the same as the Integrated Controller Kit file.
Initial Configuration and Firmware Upgrade Selected Master firmware file Description field for selected Kit file Firmware download status Device and System Number must match the Device and System values listed in the Workspace window FIG. 14 Send to NetLinx Device dialog (showing on-board NI_Master firmware update via IP) The Kit file for the NI-2100/3100/4100 Masters begins with 2105_04_NI-X100_Master. The Kit file for the NI-700/900 Masters begins with 2105-03_NI-X000_Master.
Initial Configuration and Firmware Upgrade The OUTPUT and INPUT LEDs alternately blink to indicate the on-board Master is incorporating the new firmware. Allow the Master 20 - 30 seconds to reboot and fully restart. 17. Right-click the System number and select Refresh System. This establishes a new connection to the System and populates the list with the current devices (and their firmware versions) on your system. Upgrading the NI Controller Firmware Via IP 1.
Initial Configuration and Firmware Upgrade Selected on-board Integrated Controller firmware file Firmware download status Device and System Number must match the Device and System values listed in the Workspace window FIG. 16 Send to NetLinx Device dialog (showing on-board Integrated Controller firmware update via IP) The Kit file for the Integrated Controller on the NI-2100/3100/4100 begins with 2105_04_NI_X100.
Initial Configuration and Firmware Upgrade Upgrading NXC Card Firmware Via IP This section applies to the NI-4000 and NI-4100 0nly. Before beginning with this section, verify that both the on-board Master and on-board Integrated Controller have been updated with the latest firmware and that the NetLinx cards are securely inserted into the NI-4100. 1. Follow the procedures outlined within the Communicating Via an IP Address section on page 10 to connect to the target NI device via the web. 2.
Initial Configuration and Firmware Upgrade Selected Control Card Firmware file Description field for selected Kit file Firmware download status System Number and Device Number must match the System and Device values listed in the Workspace window FIG. 18 Select Control Card firmware file for download page (via IP) 9. Select the Control Card’s Kit file from the Files section (FIG. 18) (in our above example we chose to update the NXC-VOL4 card). 10.
Initial Configuration and Firmware Upgrade Resetting the Factory Default System and Device Values 1. In NetLinx Studio, access the Device Addressing dialog (FIG. 4 on page 6) by either one of these two methods: Right-click on any system device listed in the Workspace and select Device Addressing. Select Diagnostics > Device Addressing from the Main menu. 2. Click the Set Device/System to Factory Default button.
Onboard WebConsole User Interface Onboard WebConsole User Interface WebConsole UI Overview NetLinx Masters have a built-in WebConsole that allows you to make various configuration settings via a web browser on any PC that has access to the Master. The webconsole consists of a series of web pages that are collectively called the "Master Configuration Manager" (FIG. 19).
Onboard WebConsole User Interface Accessing the WebConsole From any PC that has access to the LAN that the target Master resides on: 1. Open a web browser and type the IP Address of the target Master in the Address Bar. 2. Press Enter to access WebConsole for that Master. The initial view is the Web Control page (FIG. 19). Device Tree Click the Show Device Tree checkbox to show/hide the online device tree, which indicates all devices currently connected to this Master.
Onboard WebConsole User Interface Device Network Settings Pages Click on the blue Information (i) icon next to any device listed in the Device Tree to access the Network Settings page for the selected device (FIG. 22). FIG. 22 Example Network Settings page Use the options on this page to view/edit the device’s network settings. Refer to the Manage Devices - Network Settings section on page 71 for details.
Onboard WebConsole User Interface ZeroConfig Networking Use these radio buttons to enable/disable the new Zero-Configuration (zeroconf) client in the Master. By default, zeroconf is enabled (On option selected). With zeroconf enabled, the Master's web interface will be registered via zeroconf and can be viewed through a zeroconf browser plug-in such as Bonjour for IE.
WebConsole - Security Options WebConsole - Security Options Security Overview The Security System Details page is accessed by clicking on the Security button. This page allows you to view configure and modify the Master’s security settings at three levels: System Level - changes made at this level affect the system globally. See the System Security - System Level on page 27 for details. Group Level - changes made at this level affect specific User Groups.
WebConsole - Security Options Default Security Configuration By default, the NetLinx Master creates the following accounts, access rights, directory associations, and security options: Default Security Configuration Account 1 Account 2 Group 1 Username: administrator Username: NetLinx Password: password Password: password Group: administrator Group: none Group: administrator Rights: All Rights: FTP Access Rights: All Directory Association: /* Directory Association: none Directory Association
WebConsole - Security Options System Security - System Level System Level Security options provide authorized users the ability to alter the current security options of the entire system assigned to the Master. The options provided on this tab depend on the firmware version currently loaded on the Master: If your Master is currently running a firmware version that pre-dates v4.x.
WebConsole - Security Options Access Options Check the Enabled option on the left side of this page to make the Access options available for selection. The Access options are described in the following table: (System Security) Access Options Option Description Enabled: This option enables the Access options described below.
WebConsole - Security Options Accepting Changes Click the Accept button to save changes on this page. Accepting changes is instantaneous and does not require a reboot. System Level Security - IPSec Security Settings The "IPSec Security Settings" link is not provided in firmware versions 4.x.x or higher. Click the IPSec Security Settings link to access the IPSec Security Details page (FIG. 26). The options in this page allow you configure IPSec-specific security options on the Master at the System level.
WebConsole - Security Options Uploading an Configuration File 1. Click the Browse button (next to the Upload Configuration File text box) to locate and select a NetLinx compatible configuration file from your PC (or LAN). The configuration file name can use any suffix, but it will be re-suffixed to *.cfg by the Master. 2. Click the Submit button to transfer the selected configuration file to the Master. Refer to Appendix A: IPSec Configuration File on page 125 for additional details.
WebConsole - Security Options The options in this page allow authorized users to assign and alter group properties such as creating, modifying, or deleting a group’s rights, and also allows for the definition of the files/directories accessible by a particular group. Adding a New Group 1. Select the Group Level tab (in the Security section) to open the Group Security Details page. 2. Click the Add New Group button (see FIG. 27) to access the Add a group and modify settings page (FIG. 28). FIG.
WebConsole - Security Options Group and User Security Access Options (Cont.) Option Description Telnet/SSH/SFTP If selected, a valid username and password is required for Telnet Access. Telnet access Access: allows communication over either the Telnet and/or SSH Ports, and Secure FTP access. Note: SSH version 2 (only) is supported. To establish a secure Telnet connection, an administrator can decide to disable the Telnet Port and then enable the SSH Port.
WebConsole - Security Options Click the Edit button to edit the Security Access options for the selected user group. Click Delete to delete the selected User Group from the Master. Modifying the Properties of an Existing Group 1. Select the Group Level tab (in the Security section) to open the Group Security Details page. 2. Click the Edit button to open the Group Security Details page for the selected group (FIG. 30). FIG. 30 Group Security Details Page (Edit Group Security Details) 3.
WebConsole - Security Options System Security - User Level Select the User Level tab of the Security Page to access the User Security Details page (FIG. 31). The options on this page allow authorized users to add/delete User accounts and configure User’s Access rights. Click to add a new User FIG. 31 User Security Settings Page A User represents a single client of the Master, while a Group represents a collection of Users.
WebConsole - Security Options FIG. 32 User Security Settings Page (Add/Modify User page) 3. In the User Name field, enter a unique name for the new group. The name must be a unique alpha-numeric character string (4 - 20 characters), and is case sensitive. The words "administrator" and "NetLinx" cannot be used since they already exist by default. 4. In the Group drop-down list, choose from a list of pre-configured Groups and associate these rights to the 5. 6. 7. new user.
WebConsole - Security Options Viewing and Editing User Security Settings Click on any User listed in the User Security Details page to view and edit security settings for the selected User (FIG. 33): Click to edit Access settings for this User Click to delete this User FIG. 33 User Level Security Settings Page (Viewing User Security Settings Details) Click the Edit button to edit the Security Access options for the selected User. Click Delete to delete the selected User from the Master.
WebConsole - Web Control Options WebConsole - Web Control Options Manage Web Control Connections The Web Control page is accessed by clicking on the Web Control button (FIG. 34). This page allows you to view all touch panels running the G4Web Control application. Each G4Web Control-equipped touch panel connected to this Master is indicated by a link. Click on any of the links to open a new G4Web Control window, displaying the selected panel, using the native resolution of the target panel.
WebConsole - Web Control Options 38 NetLinx Integrated Controllers- WebConsole & Programming Guide (FMv3)
WebConsole - System Options WebConsole - System Options System Overview The Manage System page is accessed by clicking on the System button. This page allows you to view and configure various aspects of the NetLinx System, separated by four tabs: Manage System - Options in this tab allow you to view/change the Master’s System Number, Control/Emulate system devices, perform Diagnostics, configure Server settings and set the time/ date via the Clock Manager.
WebConsole - System Options Using Multiple NetLinx Masters When using more than one Master, each unit must be assigned to a separate System value. A Master’s System value can be changed but it’s device Address must always be set to zero (00000). The Device Addressing dialog will not allow you to alter the NetLinx Master address value. Example: Using an NI-2000 and NI-4100: The NI-2000 could be assigned to System 1 (with an Address of 00000).
WebConsole - System Options Manage System - Control/Emulate Options Click the Control/Emulate link (in the Manage System tab) to access the Control/Emulate Options page (FIG. 36). The options on this page allow you to Control or Emulate a device connected to this Master. Device Control/Emulation is accomplished by manipulating a target device’s channels, levels, and sending both send commands and strings to the device.
WebConsole - System Options Click on Control/Emulate from within the device’s Network Settings page to Control/Emulate that device FIG. 37 Select Control/Emulate from within a selected Device’s Network Settings page 2. Select either the Control or Emulate option. 3. In the Channel Code section, enter a valid Channel number to emulate Channel messages (i.e., Push/ 4. 5. 42 Release, CHON, and CHOFF) for the specified . The Channel number range is 1 - 65535.
WebConsole - System Options Level Data Type Minimum Value Maximum Value CHAR 0 255 INTEGER 0 65535 SINTEGER -32768 32767 LONG 0 429497295 SLONG -2147483648 2147483647 FLOAT -3.402823466e+38 3.402823466e+38 6. In the Command and String fields, enter any character strings that can be sent as either a String or Command, and press Send to transmit to the Master.
WebConsole - System Options Manage System - Diagnostics Options Click the Diagnostics link (in the Manage System tab) to access the Diagnostics Options page (FIG. 38). The options on this page allow authorized users to enable and monitor various diagnostic messages coming from and going to System Devices. Diagnostic Options table FIG. 38 Diagnostics Options Page (with diagnostic messages enabled) The System Number, Device Number, and Port Number value fields are read-only (disabled).
WebConsole - System Options Click on Diagnostics from within the device’s Network Settings page to enable/modify diagnostics for that device FIG. 39 Select Diagnostics from within a selected Device’s Network Settings page The currently selected device is also indicated in the Device field at the top of the page. 2. By default, all diagnostics are disabled (see FIG. 39). To enable diagnostic messages from this device, click on one of the Edit buttons along the bottom of the Diagnostics Options table.
WebConsole - System Options Click to delete this device from the Diagnostics page (disables all diagnostics on this device) Click to apply changes Click to close the Edit Options window (without disabling diagnostics) Click to select from Presets (saved sets of enabled Diagnostic messages) Click to Store and Recall Presets To set Diagnostic Options for a different System Device, enter the device’s System, Device and Port information in these fields (and press Update to add the specified device/diagnostics
WebConsole - System Options The default setting is 5 seconds. 4. To add more devices to the Diagnostics Options page: Repeat steps 1-3. Alternatively, you can click one of the Edit buttons to open the Edit Options window, and specify a System Number, Device and Port for a known System Device. Select the Diagnostics messages that you want to enable for this device and click Update.
WebConsole - System Options Diagnostic Options (Cont.) Diagnostic Option Description Channel Changes (Cont.) • Feedback Generates a message when there is a feedback channel change in the target device. Device Options • Level Changes From Generates a message when there is a level channel change from the target device. • Level Changes To Generates a message when there is a level channel change to the target device. • Strings To Generates a message when there is a string sent to the target device.
WebConsole - System Options Manage System - Server Options Click the Server link (in the Manage System tab) to access the Server Options page (FIG. 43). The options on this page allow you to: Change the port numbers (used by the Master for various Web services) Configure the SSL settings used on the Master Manage existing and pending license keys, manage the active NetLinx system communication parameters Configure/modify the SSL certificates on the target Master FIG.
WebConsole - System Options Server Port Settings (Cont.) Feature Description ICSP: The port value used for ICSP data communication among the different AMX software and hardware products. This type of communication is used by the various AMX product for communication amongst themselves. Some examples would be: NetLinx Studio communicating with a Master (for firmware or file information updates) and TPDesign4 communicating with a touch panel (for panel page and firmware updates).
WebConsole - System Options If the Device Tree contents do not refresh within a few minutes, press the browser’s Refresh button and reconnect to the Master. SSL Certificate Options There are three SSL Certificate options, presented as links along the bottom of this page: SSL Certificate Options Create SSL Certificate: Opens the Create SSL Certificate window where you can create a selfgenerated SSL certificate.
WebConsole - System Options SSL Certificate Entries The following table describes the SSL Certificate entries presented in the Create SSL Certificate window (FIG. 44): SSL Certificate Entries Entry Description Bit Length: Provides a drop-down selection with three public key lengths (512, 1024, 2048). • A longer key length results in more secure certificates. • Longer key lengths result in increased certificate processing times.
WebConsole - System Options Creating a Request for an SSL Certificate 1. Click the Create SSL Certificate link in the Server Options page to open the Create SSL Certificate window. 2. Fill out the fields, according to the descriptions in the SSL Certificate Entries section on page 52. 3. Click the down arrow next to the Action field, and choose Create Request from the drop-down list. 4.
WebConsole - System Options 5. Copy (Ctrl + C) the text to the clipboard. 6. Paste (Ctrl + V) this text into the Submit Request field on the CA’s Retrieve Certificate web page. 7. Choose to view the certificate response in raw DER format. Note the Authorization Code and Reference Number (for use in the e-mail submission of the request). 8. Submit the request. 9. Paste the copied text into your e-mail document and send it to the CA with its accompanying certificate application.
WebConsole - System Options Manage System - Clock Manager Options Click the Clock Manager link (in the Manage System tab) to access the Clock Manager Options page (FIG. 47). The options on this page allow you to enable/disable using a network time source and provide access to Daylight Saving configuration and which NIST servers to use as a reference. Date and Time are only available if Stand Alone is selected as the Time Synch option. FIG.
WebConsole - System Options Setting Daylight Savings Rules 1. In the Daylight Savings tab (FIG. 48), enable Daylight Savings mode by clicking the On button. FIG. 48 Clock Manager Options - Daylight Savings tab 2. Use the Offset drop-down menus to adjust the amount of time (hours and minutes) to offset Daylight Savings. By default, the offset is set to 1 hour. Although most places that support Daylight Savings usually adjust the local time by one hour this doesn't cover all locations.
WebConsole - System Options Selecting a Custom NIST Server FIG. 49 Clock Manager Options - NIST Servers tab 1. In the NIST Servers tab (FIG. 49), use the radio buttons to select one of the NIST Servers in the list. 2. Click Accept to save these settings to the Master. Adding a Custom NIST Server To the List 1. Click on the radio button next to the last (blank) entry in the NIST Server Manager list. 2. In the URL field, enter the URL of the NIST Server.
WebConsole - System Options Clock Manager NetLinx Programming API Refer to Appendix C: Clock Manager NetLinx Programming API section on page 145 for a listing and description of the Types/Constants and Library Calls that are included in the NetLinx.AXI to support Clock Manager functions. System - Manage License The Manage License tab displays current as well as pending license keys (FIG. 50). FIG.
WebConsole - System Options 4. Press the Accept button to save the information. If there are no errors with the information on this page, a “Key successfully added for Product ID XXXX” is displayed at the top of the page. Removing a License 1. Click the Remove (x) icon to the left of the license that you want to remove. 2. The system will prompt you to verify this action before the license is removed from the Master. Click OK to proceed. 3. Press the Accept button to save the information.
WebConsole - System Options NetLinx Device Details Column Description System: Displays the System value being used by the listed NetLinx Master. Device: Displays the assigned device value of the listed unit. This Device entry applies to both the Master and those NDP-capable devices currently connected to that Master. Device Type: Displays a description of the target Master or connected device, and its current firmware version. Example: NI Master v3.01.323.
WebConsole - System Options System - Manage Devices The Manage Devices tab (FIG. 53) contains links to several different device-related pages, as described in the following subsections. FIG. 53 System - Manage Devices (Details for Additional Devices) Manage Devices - Device Options Click the Device Options link (in the Manage Devices tab) to access the Details for Additional Devices page (FIG. 53). The options on this page display various details specific to additional (non-NetLinx) System Devices.
WebConsole - System Options Binding Options (Cont.) Option Description Enable Auto-Shutdown: Auto-Shutdown forces the termination of modules that have lost communication with their respective physical device. This capability is needed for plug-and-play support. By default, Auto-Shutdown is enabled. If automatic termination of modules when they have lost communication is not desired, this selection should be disabled.
WebConsole - System Options Manage Devices - Bindings Click the Bindings link (in the Manage Devices tab) to access the Manage Device Bindings page (FIG. 54). Use the options on this page to configure application-defined Duet virtual devices with discovered physical devices. FIG.
WebConsole - System Options (***********************************************************) (* THE EVENTS GO BELOW *) (***********************************************************) DEFINE_EVENT DATA_EVENT [dvRECEIVER1] { // Duet Virtual device data events go here } Sample code can be found within the DEFINE_START section, as shown in FIG. 55: FIG.
WebConsole - System Options Application Devices and Association Status There are two types of application devices: Static Bound application devices and Dynamic application devices: Static Bound application devices specify both a Duet virtual device and its associated Device SDK class type, as well as a NetLinx physical device port to which the application device is always associated (i.e. statically bound).
WebConsole - System Options Viewing Physical Device Properties Hold the mouse cursor over the Physical Device - Device entry in the table to display detailed device properties for that device, in a pop-up window (FIG. 56). Hold the mouse cursor over the Device D:P:S assignment to open the Device Properties pop-up FIG.
WebConsole - System Options Adding a User-Defined Device 1. Click the Add Device button (in the User-Defined Devices page) to access the Add User Defined Device page (FIG. 58): FIG. 58 User-Defined Devices - Add User Defined Device 2. Fill in the device information fields, as described in the following table: User-Defined Device Information Fields Address: Enter the address of the physical device in the Address field.
WebConsole - System Options SDK-Class Types Amplifier HVAC SlideProjector AudioConferencer IODevice Switcher AudioMixer Keypad Text Keypad AudioProcessor Light TV AudioTape Monitor UPS AudioTunerDevice Motor Utility Camera MultiWindow VCR Digital Media Decoder PoolSpa VideoConferencer Digital Media Encoder PreAmpSurroundSoundProcessor VideoProcessor Digital Media Server RelayDevice VideoProjector Digital Satellite System Receiver VideoWall Digital Video Recorder Security S
WebConsole - System Options If Module Search via Internet is NOT enabled, the search does NOT query the AMX online 2. 3. database nor will it pull any manufacturer specified URLs that do not match the IP Address of the physical device itself. Modules that are retrieved from either the Internet or from the manufacturer's device are then placed into the /unbound directory and automatically overwrite any existing module of the same name.
WebConsole - System Options Manage Devices - Manage Polled Ports Click the Polled Ports link (in the Manage Devices tab) to access the Manage Polled Ports page (FIG. 61). The options on this page allow you to view/modify settings for all polled ports in the System. Click to open the Edit Port Settings page FIG. 61 System - Manage Devices (Manage Polled Ports) Polled Ports must be specified in the Master’s code in order for this page to be populated.
WebConsole - System Options Manage Devices - Network Settings With the NetLinx Controller selected in the Device drop-down menu, click the Network Settings link (in the Manage Devices tab) to access the Network Settings page (FIG. 63). Use the options on this page to view/edit the Controller’s network settings. FIG.
WebConsole - System Options ZeroConfig Networking Use these radio buttons to enable/disable the Zero-Configuration (ZeroConfig) client in the Master. By default, ZeroConfig Networking is enabled (On option selected). With ZeroConfig enabled, the Master's web interface will be registered via ZeroConfig and can be viewed through a ZeroConfig browser plug-in such as Bonjour for IE. NDP Beacon Use these radio buttons to enable/disable the NetLinx Discovery Protocol (NDP) beacons client in the Master.
WebConsole - System Options Fill in the fields and click Accept to save the changes and add this information to the URL List. Manage Devices - Device Number With the NetLinx Controller selected in the Device drop-down menu, click the Device Number link (in the Manage Devices tab) to access the Change Device Number page (FIG. 66). The options on this page allow you to change the device number on the NetLinx Master Controller. FIG.
WebConsole - System Options Manage Devices - Control/Emulate With the NetLinx Controller selected in the Device drop-down menu, click the Control/Emulate link (in the Manage Devices tab) to access the Control/Emulate Options page (FIG. 67). Push button only displayed if Emulate is selected FIG. 67 Manage System (Control/Emulate Options) This page can also be accessed via the Manage System options, as described in the Manage System - Control/ Emulate Options section on page 41.
WebConsole - System Options Manage Devices - Log With the NetLinx Controller selected in the Device drop-down menu, click the Log link (in the Manage Devices tab) to access the Message Log For Device page (FIG. 68). This page displays message logs for the NetLinx Master Controller. FIG.
WebConsole - System Options Manage Devices - Diagnostics With the NetLinx Controller selected in the Device drop-down menu, click the Diagnostics link (in the Manage Devices tab) to access the Diagnostics Options page (FIG. 69). Diagnostic Options table FIG. 69 Diagnostics Options Page (with diagnostic messages enabled) This page can also be accessed via the Manage System options, as described in the Manage System Diagnostics Options section on page 44.
WebConsole - System Options NetLinx Integrated Controllers- WebConsole & Programming Guide (FMv3) 77
WebConsole - System Options 78 NetLinx Integrated Controllers- WebConsole & Programming Guide (FMv3)
NetLinx Programming NetLinx Programming Overview This section describes the Send_Commands, Send_Strings, and Channel commands you can use to program the Integrated Controller. The examples in this section require a declaration in the DEFINE_DEVICE section of your program to work correctly. Refer to the NetLinx Programming Language instruction manual for specifics about declarations and DEFINE_DEVICE information.
NetLinx Programming Master SEND_COMMANDs (Cont.) Command Description G4WC The internal G4WC Send command (to Master 0:1:0) has been revised to add G4Web Control devices to Web control list displayed in the browser. Add G4Web Control devices to Web control list displayed by the Web server in a browser.
NetLinx Programming Master IP Local Port SEND_COMMANDs These commands are specific to the Master and not the Controller. These commands are sent to the DPS 0:1:0 (the Master). A device must first be defined in the NetLinx programming language with values for the Device: Port: System. In these programming examples, = Device. The term = Device:Port:System. Master IP Local Port SEND_COMMANDs Command Description This is only available for Type 2 and Type 3 Local Ports.
NetLinx Programming LED Disable/Enable SEND_COMMANDs The following sections only apply to the integrated controller component of the NIs. The following commands enable or disable the LEDs on the Integrated Controller. In the examples: = Port 1 of the device. Sending to port 1 of the NI-700 affects all ports. LED SEND_COMMANDs Command Description LED-DIS Regardless of whether or not the port is active, the LED will not be lit. Issue this command to port 1 to disable all the LEDs on the Controller.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description B9MON Enables 9-bit in 232/422/455 mode. This command works in conjunction with the 'B9MOFF' command. Override and set the current communication settings and parameters on the RS-232 serial port to 9 data bits with one stop bit. Syntax: SEND_COMMAND ,"'B9MON'" Example: SEND_COMMAND RS232_1,"'B9MON'" Resets the RS-232 port's communication parameters to nine data bits, one stop bit, and locks-in the baud rate.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description HSOFF Syntax: Disable hardware handshaking (default). Example: SEND_COMMAND ,"'HSOFF'" SEND_COMMAND RS232_1,"'HSOFF'" Disables hardware handshaking on the RS232_1 device. HSON Enable RTS (ready-to-send) and CTS (clear-to-send) hardware handshaking. Syntax: SEND_COMMAND ,"'HSON'" Example: SEND_COMMAND RS232_1,"'HSON'" Enables hardware handshaking on the RS232_1 device.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description TSET BAUD TSET BAUD works the same as SET BAUD, except that the changes are not permanent, and the previous values will be restored if the power is cycled on the device. Temporarily set the RS-232/ 422/485 port's communication parameters for a device.
NetLinx Programming RS-232/422/485 SEND_STRING Escape Sequences This device also has some special SEND_STRING escape sequences: If any of the 3 character combinations below are found anywhere within a SEND_STRING program instruction, they will be treated as a command and not the literal characters. In these examples: = device. RS-232/422/485 SEND_STRING Escape Sequences Command Description 27,17,
NetLinx Programming IR / Serial Ports Channels IR / Serial Ports Channels CHANNELS: Description 00001 - 00229 IR commands. 00229 - 00253 May be used for system call feedback. 00254 Power Fail. (Used w/ 'PON' and 'POF' commands). 00255 Power status. (Shadows I/O Link channel status). 00256 - 65000 IR commands. 65000 - 65534 Future use. The NI series of NetLinx Masters support Serial control via the IR/RX port when using firmware version 300 or greater.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description CH All channels below 100 are transmitted as two digits. If the IR code for ENTER (function #21) is loaded, an Enter will follow the number. If the channel is greater than or equal to (>=) 100, then IR function 127 or 20 (whichever exists) is generated for the one hundred digit. Uses 'CTON' and 'CTOF' times for pulse times. Send IR pulses for the selected channel.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description GET BAUD The port sends the parameters to the device that requested the information. Only valid if the port is in Data Mode (see SET MODE command). Get the IR port’s current DATA mode communication parameters.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description PON If at any time the IR sensor input reads that the device is OFF (such as if one turned it off manually at the front panel), IR function 27 (if available) or IR function 9 is automatically generated in an attempt to turn the device back ON. If three attempts fail, the IR port will continue executing commands in the buffer and trying to turn the device On.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description SET BAUD Only valid if the port is in Data Mode (see SET MODE command). Set the IR port's DATA mode communication parameters. Syntax: SEND_COMMAND ,"'SET BAUD ,,,'" Variables: baud = baud rates are: 19200, 9600, 4800, 2400, and 1200. parity = N (none), O (odd), E (even), M (mark), S (space). data = 7 or 8 data bits. stop = 1 and 2 stop bits.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description XCH Syntax: Transmit the selected channel IR codes in the format/pattern set by the 'XCHM' send command. Variable: SEND_COMMAND ,"'XCH '" channel = 0 - 9999. Example: For detailed usage examples, refer to the 'XCHM' command. Note: This command supports 4-digit channels. XCHM Syntax: Changes the IR output pattern for the 'XCH' send command.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) XCHM (Cont.) Mode 5 Example: SEND_COMMAND IR_1,"'XCH 3'" Transmits the IR code as 0-0-0-3-enter. SEND_COMMAND IR_1,"'XCH 34'" Transmits the IR code as 0-0-3-4-enter. SEND_COMMAND IR_1,"'XCH 343'" Transmits the IR code as 0-3-4-3-enter. SEND_COMMAND IR_1,"'XCH 1343'" Transmits the IR code as 1-3-4-3-enter. Mode 6 Example: SEND_COMMAND IR_1,"'XCH 3'" Transmits the IR code as 0-0-0-3.
NetLinx Programming I/O SEND_COMMANDs (Cont.) Command Description GET INPUT An active state can be high (logic high) or low (logic low or contact closure). Channel changes, Pushes, and Releases generate reports based on their active state. The port responds with either 'HIGH' or 'LOW'. Get the active state for the selected channels. Syntax: SEND_COMMAND ,"'GET INPUT '" Variable: channel = Input channel 1 - 8. Example: SEND_COMMAND IO,"'GET INPUT 1'" Gets the I/O port's active state.
Terminal (Program Port/Telnet) Commands Terminal (Program Port/Telnet) Commands Overview There are two types of terminal communications available on NetLinx Integrated Controllers: Program Port - The "Program" port is a RS232 port located on the rear panel of the Master that allows terminal communication with the Master. This type of terminal communication requires that you are physically connected to the Master to access the configuration options and commands supported.
Terminal (Program Port/Telnet) Commands It is very important to execute the 'logout' command prior to disconnecting from a Master. Simply removing the RS-232 connector from the Program Port maintains your logged-in status until you either return to logout via a new session or reboot the target Master.
Terminal (Program Port/Telnet) Commands To restrict access to the Master via terminal connection, enable Configuration Security on the Master via the CONFIGURATION SECURITY option in the Security Options menu - see the Security Options Menu section on page 118 for details). With Configuration Security enabled, a valid user with Configuration Security access will have to login before being able to execute Telnet commands. If security is not enabled, these commands are available to all.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description DNS LIST Displays the DNS configuration of a specific device including: • Domain suffix· • Configured DNS IP Information Example: >DNS LIST [0:1:0] Domain suffix:amx.com The following DNS IPs are configured Entry 1-192.168.20.5 Entry 2-12.18.110.8 Entry 3-12.18.110.7 ECHO ON|OFF Enables/Disables echo (display) of typed characters. GET DEVICE HOLDOFF Displays the state of the Master’s device holdoff setting.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description IP STATUS Provides information about the current NetLinx IP Connections. Example: >IP STATUS NetLinx IP Connections No active IP connections IPSEC ON|OFF|STATUS Enables/Disables IPSec security or displays current setting. MEM Displays the largest free block of the Master’s memory. Example: >MEM The largest free block of memory is 11442776 bytes. MSG ON|OFF Enables/Disables extended diagnostic messages.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description PASS [D:P:S or NAME] Sets up a pass through mode to a device. In pass through mode, any string received by the device is displayed on the screen, and anything typed is sent as a string to the device. The device can be on any system that the Master you are connected to is able to reach.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description REBOOT Reboots the Master or specified device. Example: >REBOOT [0:1:0] Rebooting... RENEW DHCP Renews/Releases the current DHCP lease for the Master. Note: The Master must be rebooted to acquire a new DHCP lease. Example: >RENEW DHCP RESETADMINPASSWORD This command resets the administrator password back to "password". Note: This command is only available to Program Port terminal sessions.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET DATE Prompts you to enter the new date for the Master. When the date is set on the Master, the new date will be reflected on all devices in the system that have clocks (i.e. touch panels). By the same token, if you set the date on any system device, the new date will be reflected on the system’s Master, and on all connected devices.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET ETHERNET MODE This command sets the current LAN configuration. • = "auto" or where = 10 | 100 and = full | half Examples: Set Ethernet mode auto Set Ethernet mode 100 full Set Ethernet mode 10 half When new mode is set, unit will respond with: Ethernet mode set. Change takes effect after reboot. Note: See the GET ETHERNET MODE section on page 98.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET ICSP TCP TIMEOUT Sets the timeout period for ICSP and i!-Web Control TCP connections. Note: The new timeout value is immediately (no reboot required). Example: >SET ICSP TCP TIMEOUT This will set the timeout for TCP connections for both ICSP and i!-Web Control.When no communication has been detected for the specified number of seconds, the socket connection is closed.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET QUEUE SIZE Provides the capability to modify maximum message queue sizes for various threads. Example: set queue size This will set the maximum message queue sizes for several threads. Use caution when adjusting these values. Set Queue Size Menu: 1. Interpreter (factory default=2000, currently=600) 2. Notification Manager (factory default=2000, currently=200) 3.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SECURITY PROFILE (Cont.) Secure: • Unsecured interface ports are disabled including HTTP, Telnet and FTP. Only HTTPS and SSH and terminal user ports are available. • All user access requires a username/password login including HTTPS, SSH and terminal. • NetLinx/ICSP security is enabled requiring all NetLinx devices connecting with the Master to provide username/password authentication and encryption.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SECURITY PROFILE (Cont.) DoD: DoD security profile has all of the security specifications of "secure" profile along with the following additional features: • The default Web login banner text consists of the following: "This is a Department of Defense (DOD) computer system provided only for authorized U.S. Government use. This system may be monitored for all lawful purposes.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SSH PORT Sets the Master’s IP port listened to for SSH connections. Note: The Master must be rebooted to enable new settings.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET TIME Sets the current time. When the time is set on the Master, the new time will be reflected on all devices in the system that have clocks (i.e. touch panels). By the same token, if you set the time on any system device, the new time will be reflected on the system’s Master, and on all connected devices. Note: This will not update clocks on devices connected to another Master (in Master-to-Master systems).
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW AUDIT LOG Displays the User Account Access Audit Log.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW COMBINE Displays a list of devices, levels, and channels that are currently combined. Example: > SHOW COMBINE Combines -------Combined Device([33096:1:1],[96:1:1]) Combined Level([33096:1:1,1],[128:1:1,1],[10128:1:1,1]) Combined Device([33128:1:1],[128:1:1],[10128:1:1]) SHOW DEVICE Displays a list of devices present on the bus, with their device attributes.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW LOG Displays the log of messages stored in the Master's memory. The Master logs all internal messages and keeps the most recent messages. The log contains:· • Entries starting with first specified or most recent • Date, Day, and Time message was logged • Which object originated the message • The text of the message: SHOW LOG [start] [end] SHOW LOG ALL - specifies message to begin the display.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW MAX BUFFERS Displays a list of various message queues and the maximum number of message buffers that were ever present on the queue.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW ROUTE Displays information about how this NetLinx Master is connected to other NetLinx Masters (routing information). Example: >SHOW ROUTE Route Data: System Route Metric PhyAddress --------------------------------> 50 50 0 AxLink SHOW START LOG Displays the startup log (see START LOG below). specifies the message to begin the display. 'ALL' will display all startup log messages.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description TIME Displays the current time on the Master. Example: >TIME 13:42:04 URL LIST Displays the list of URL addresses programmed in the Master (or another system if specified). Example: >URL LIST The following URLs exist in the URL connection list ->Entry 0-192.168.13.65:1319 IP=192.168.13.65 State=Connected Entry 1-192.168.13.200:1319 IP=192.168.13.
Terminal (Program Port/Telnet) Commands Accessing the Security Configuration Options Security configuration options are only available to Program Port connections (see the Overview section on page 95). Refer to the SET SECURITY PROFILE section on page 105 for information on setting Security Profiles. 1. In the Terminal session, type help security to view the available security commands.
Terminal (Program Port/Telnet) Commands Setup Security Menu The Setup Security menu is described below: Setup Security Menu Command Description 1) Set system security options for NetLinx Master This selection will bring up the Security Options Menu that allows you to change the security options for the NetLinx Master. See the Security Options Menu section on page 118 for descriptions of each menu item. These are "global" options that enable rights given to users and groups.
Terminal (Program Port/Telnet) Commands Setup Security Menu (Cont.) Command Description 13) Make changes permanent by saving to flash When changes are made to the security settings of the Master, they are initially only changed in RAM and are not automatically saved permanently into flash. This selection saved the current security settings into flash.
Terminal (Program Port/Telnet) Commands Edit User Menu The Edit User Menu is accessed whenever you enter the Add user, or Edit user selections from the Setup Security menu. The Edit User Menu options are described in the following table: Edit User Menu Command Description 1) Change User Password This selection prompts you to enter the new password (twice) for the user. Once the new password is entered, the user must use the new password from that point forward.
Terminal (Program Port/Telnet) Commands Access Rights Menu The Access Rights Menu is accessed whenever you select Change Access Rights (option 6) from the Edit User menu, or Change Access Rights from the Edit Group menu. The options in this menu is described below: Access Rights Menu Command Description Enables/disables Terminal (RS232 Program port) Access. The account has sufficient access rights to login to a Terminal session if this option is enabled.
Terminal (Program Port/Telnet) Commands Here are some examples of valid entries: Path Notes / Enables access to the user directory and all files and subdirectories in the user directory. /* Enables access to the user directory and all files and subdirectories in the user directory. /user1 If user1 is a file in the user directory, only the file is granted access. If user1 is a subdirectory of the user directory, all files in the user1 and its sub-directories are granted access.
Terminal (Program Port/Telnet) Commands Refer to the SET SECURITY PROFILE section on page 105 for information on setting Security Profiles. Telnet Diagnostics Commands The following Telnet Diagnostics Commands provide visibility to remote Masters, in order to determine the current state of operations, and are provided as diagnostic/troubleshooting tools. While these commands are available for any user to execute, their output is interpretable primarily by an AMX Technical Support Engineer.
Terminal (Program Port/Telnet) Commands The following codes are known to be altered, but others may be affected depending on the computer's setup. Characters 15, 21, 22, and any characters above 127. This affects both Windows Telnet and Terminal programs. Linux Telnet Client The Linux Telnet client has three anomalies that are known at this time: A null (\00) character is sent after a carriage return. If an ALT 255 is entered, two 255 characters are sent (per the Telnet RAFT).
Terminal (Program Port/Telnet) Commands 124 NetLinx Integrated Controllers- WebConsole & Programming Guide (FMv3)
Appendix A: IPSec Configuration File Appendix A: IPSec Configuration File IPSec Config file The IPSec Configuration file contains user specified IPSec rule definitions to be applied to the running IPSec database. The IPSec Configuration file is read at boot-up and the individual lines are applied to the IPSec database. Configuration lines are applied to the database in the order that they appear in the configuration file. Each line of the configuration file represents an individual rule.
Appendix A: IPSec Configuration File ikeAddPeerAuth (Cont.) Rule Value (Cont.) • localKeyPassword - The password for the local peer's key. Specify NOPASS if there is no password. Note that the maximum password length is MAX_PRIVATE_KEY_PASSWORD_LENGTH. • localCertificate - The filename where the local peer's certificate is stored. • peerCertificate - The filename where the remote peer's certificate is locally stored.
Appendix A: IPSec Configuration File ikeSetProp (Cont.) Pre-defined proposal names (Cont.
Appendix A: IPSec Configuration File spdAddTransport (Cont.) Rule Value (Cont.): - sourceAddressSelector is an address in the format: ipAddress1[-ipAddress2 |/ipMaskPrefix]. - directionality is IN (for inbound) or OUT (for outbound). If IN, this policy applies to traffic coming into the current host. If OUT, it applies to traffic going out of the current host. A mirrored policy is automatically created for the opposite traffic flow.
Appendix A: IPSec Configuration File SpdAddBypass SpdAddBypass NAME SYNOPSIS spdAddBypass– create a bypass policy in the SPD spdAddBypass=pConfStr DESCRIPTION This rule creates a bypass policy in the SPD. Rule Value: pConfStr A stringValue specifier formatted as follows: protocolSelector[/destinationPort/sourcePort],destinationAddressSelector, sourceAddressSelector,directionality,mirroring where - protocolSelector is a decValue IANA protocol number or ANY (6 for TCP or 17 for UDP).
Appendix A: IPSec Configuration File SpdAddDiscard (Cont.) EXAMPLES IPv4: spdAddDiscard=17/17185/0,0.0.0.0/0,0.0.0.
Appendix A: IPSec Configuration File SpdSetProp (Cont.) Pre-defined proposal names (Cont.
Appendix A: IPSec Configuration File SpdSetProp (Cont.) Pre-defined Phase II transform names (Cont.
Appendix A: IPSec Configuration File SpdSetPropAttrib SpdSetPropAttrib NAME SYNOPSIS spdSetPropAttrib– set attributes of an IKE Phase 2 proposal spdSetPropAttrib=pConfStr DESCRIPTION This rule sets or modifies the attributes of an existing IKE Phase 2 proposal. Rule Value: Rule Value = pConfStr A stringValue specifier formatted as follows: proposalName,attributeType,attributeValue[,attributeType,attributeValue...] - proposalName is the name of an existing Phase 2 proposal.
Appendix A: IPSec Configuration File spdSetSA spdSetSA NAME SYNOPSIS spdSetSA – create an SA proposal in the SPD– create an SA proposal in the SPD spdSetSA=pConfStr DESCRIPTION This rule creates an SA proposal in the SPD. An SA proposal is a list of proposals. IKE sends the list to the peer during negotiation. Rule Value Rule Value = pConfStr A stringValue specifier formatted as follows: saName,proposalName,proposalNumber[,proposalName,proposalNumber...] where - saName is unique Phase 2 SA name.
Appendix A: IPSec Configuration File Manual Key Manager (MKM) mkmAddBypass mkmAddBypass NAME SYNOPSIS mkmAddBypass – add a bypass Security Association mkmAddBypass=cptr_mkm_sa DESCRIPTION This rule adds a bypass Security Association (SA). After adding an SA, mkmCommit must be called to commit the SA to the Security Association Database (SADB).
Appendix A: IPSec Configuration File mkmAddDiscard mkmAddDiscard NAME SYNOPSIS mkmAddDiscard – add a discard Security Association mkmAddDiscard=cptr_mkm_sa DESCRIPTION This rule adds a discard Security Association (SA). After adding an SA, mkmCommit must be called to commit the SA to the Security Association Database (SADB).
Appendix A: IPSec Configuration File mkmAddTransport mkmAddTransport NAME SYNOPSIS mkmAddTransport – add a transport mode Security Association mkmAddTransport=cptr_mkm_sa DESCRIPTION This rule adds a transport mode Security Association (SA). After adding an SA and setting the associated transform ID and keys, mkmCommit must be called to commit the SA to the Security Association Database (SADB).
Appendix A: IPSec Configuration File mkmAddTunnel mkmAddTunnel NAME SYNOPSIS mkmAddTunnel – add a tunnel mode Security Association mkmAddTunnel=cptr_mkm_sa DESCRIPTION This rule adds a tunnel mode Security Association (SA). After adding an SA and setting the associated transform ID and keys, mkmCommit must be called to commit the SA to the Security Association Database (SADB).
Appendix A: IPSec Configuration File mkmSetInboundAH mkmSetInboundAH NAME SYNOPSIS mkmSetInboundAH – set the transform ID and key for an inbound AH SA mkmSetInboundAH=cptr_value_string DESCRIPTION This rule sets the transform ID and key for an inbound AH SA. Rule Value: Rule Value = cptr_value_string A string formatted as follows: saNumber,spi,ahTransformID,key where - saNumber is a unique unsigned integer specified by the user. - spi is the decValue for the security parameter index, an unsigned long.
Appendix A: IPSec Configuration File mkmSetInboundESP mkmSetInboundESP NAME SYNOPSIS mkmSetInboundESP – set the transform ID and key for an inbound ESP SA mkmSetInboundESP=configuration_string DESCRIPTION This rule sets the transform ID and key for an inbound Encapsulating Security Payload (ESP) Security Association (SA). Rule Value: Rule Value = configuration_string A string formatted as follows: saNumber,spi,espTransformID,attributeType,attributeValue [,attributeType,attributeValue]...
Appendix A: IPSec Configuration File mkmSetOutboundAH mkmSetOutboundAH NAME SYNOPSIS mkmSetOutboundAH – set the transform ID and key for an outbound AH SA mkmSetOutboundAH=cptr_value_string DESCRIPTION This rule sets the transform ID and key for an outbound AH SA. Rule Value: Rule Value = cptr_value_string A string formatted as follows: saNumber,spi,ahTransformID,key where - saNumber is a unique unsigned integer specified by the user.
Appendix A: IPSec Configuration File mkmSetOutboundESP mkmSetOutboundESP NAME SYNOPSIS mkmSetOutboundESP – set the transform ID and key for an outbound ESP SA mkmSetOutboundESP=configuration_string DESCRIPTION This rule sets the transform ID and key for an outbound Encapsulating Security Payload (ESP) Security Association (SA). Rule Value: Rule Value = configuration_string A string formatted as follows: saNumber,spi,espTransformID,attributeType,attributeValue [,attributeType,attributeValue]...
Appendix A: IPSec Configuration File Sample IPSec Configuration File The following is a sample IPSec configuration file: ikeAddPeerAuth=192.168.220.57,%LOCAL_ADDR%,mm_g2,RSA,new.key.pem,AMXCA, new.cert.pem ikeAddPeerAuth=192.168.220.37,%LOCAL_ADDR%,mm_g2,PSK,password spdAddTransport=ANY,192.168.220.57,%LOCAL_ADDR%,OUT,PACKET,IKE,qm_sa_g2_transport spdAddTransport=ANY,192.168.220.37,%LOCAL_ADDR%,OUT,PACKET,IKE,qm_sa_g2_transport # add bypass for IKE TCP port (500) spdAddBypass=17/500/500,192.168.220.
Appendix A: IPSec Configuration File The “Certificates”, “CA Certificates” and “CRL Certificates” sub-pages provide the ability to upload certificates, certificate authority certificates and certificate revocation list certificates respectively onto the Master. Simply browse to the location of the certificate data on the PC, select the file and select “Submit”. The selected file will be uploaded to the appropriate directory on the Master.
Appendix B: Clock Manager NetLinx Programming API Appendix B: Clock Manager NetLinx Programming API Types/Constants The NetLinx.axi file that ships with NetLinx Studio includes the following types/constants: (*-----------------------------------------------------------------------------*) (* Added v1.
Appendix B: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_SET_DAYLIGHTSAVINGS_OFFSET (CONSTANT CLKMGR_TIMEOFFSET_STRUCT T) Sets the Daylight Savings Offset to the specified value. CLKMGR_GET_ACTIVE_TIMESERVER (CLKMGR_TIMESERVER_STRUCT T) Populates the TIMESERVER structure with the currently active time server's data. The function returns a negative SLONG value if it encounters an error.
Appendix B: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_SET_START_DAYLIGHTSAVINGS_RULE (CONSTANT CHAR RECORD[]) Sets the START Daylight Savings rule to the specified string which must be in either the Fixed-Date format or the Occurence-Of-Day format. The function returns a negative SLONG value if it encounters an error. The Fixed-Date rules have the form: "fixed:DAY,MONTH,HH:MM:SS" with all fields as numeric except for the word "fixed".
Appendix B: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_SET_END_DAYLIGHTSAVINGS_RULE (CONSTANT CHAR RECORD[]) Sets the END Daylight Savings rule to the specified string which MUST be in either the Fixed-Date format or the Occurence-Of-Day format. The function returns a negative SLONG value if it encounters an error. The Fixed-Date rules have the form: "fixed:DAY,MONTH,HH:MM:SS" with all fields as numeric except for the word "fixed".
Appendix D: Clock Manager NetLinx Programming API NetLinx Integrated Controllers- WebConsole & Programming Guide 149
In the ever-changing AV industry, continual education is key to success. AMX University is dedicated to ensuring that you have the opportunity to gather the information and experience you need to deliver strong AMX solutions. Plus, AMX courses also help you earn CEDIA, NSCA, InfoComm, and AMX continuing education units (CEUs).
