WebConsole & Programming Guide NI Series NetLinx Integrated Controllers NI-700/900 NI-2000/3000/4000 NI-2100/3100/4100 NXC-ME260/64 NetLinx Integrated Controllers Last Revised: 4/24/2007
AMX Limited Warranty and Disclaimer All products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is obtained from the AMX RMA Department. The RMA number must be clearly marked on the outside of each box. The RMA is valid for a 30-day period. After the 30-day period the RMA will be cancelled. Any shipments received not consistent with the RMA, or after the RMA is cancelled, will be refused. AMX is not responsible for products returned without a valid RMA number.
Table of Contents Table of Contents Overview ............................................................................................................1 NetLinx Integrated Controllers ................................................................................. 1 About This Document ............................................................................................... 1 Related Documents...................................................................................................
Table of Contents System Security Access Options .............................................................................. 30 Accepting Changes ....................................................................................................... 31 System Level Security - IPSec Security Settings ............................................................ 31 Configuring Settings .....................................................................................................
Table of Contents Exporting an SSL Certificate Request ........................................................................... 56 Importing an SSL Certificate ......................................................................................... 57 Manage System - Clock Manager Options .............................................................. 58 Setting the Mode for the Clock Manager ..................................................................... 58 Setting Daylight Savings Rules .......
Table of Contents Input/Output Send_Commands .............................................................................. 90 Terminal (Program Port/Telnet) Commands .....................................................91 Overview ................................................................................................................ 91 Establishing a Terminal Connection Via the Program Port...................................... 91 PC COM Port Communication Settings ..............................
Table of Contents mkmAddTransport ..................................................................................................... 132 mkmAddTunnel .......................................................................................................... 133 mkmSetInboundAH .................................................................................................... 134 mkmSetInboundESP ...................................................................................................
Table of Contents vi NI Series WebConsole & Programming Guide
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 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 NXI-700/900 NetLinx Integrated Controllers - Hardware Reference Guide NXI-x000 NetLinx Integrated Controllers - Hardware Reference Guide (NI-2000, NI-3000, NI-4000) NXI-x100 NetLinx Integrated Controllers - Hardware Reference Guide (NI-2100, NI-310
Overview Update the On-board Master and Controller Firmware Before using your new NI unit, you must first update your NetLinx Studio to the most recent release. Upgrade the on-board Master firmware through an IP Address via the Ethernet connector (Upgrading the On-board Master Firmware via an IP section on page 12) (IP recommended). Upgrade the Integrated Controller firmware through an IP Address via the Ethernet connector (Upgrading the NI Controller Firmware Via IP section on page 14) (IP recommended).
Overview 4 NI Series WebConsole & Programming Guide
Initial Configuration and Firmware Upgrade Initial Configuration and Firmware Upgrade 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.com.
Initial Configuration and Firmware Upgrade This action causes the *Not Active* message (in red) to display a Waiting...Press Cancel to Quit message (in green). This message indicates that Studio is waiting to detect the device value of the NI Controller associated with the ID button. 4. Press the NI Controller’s ID button to read the device value of the NI Controller, and assign it to the new value entered in step 2.
Initial Configuration and Firmware Upgrade 4. Note the obtained IP Address (read-only). This information is later entered into the Master Communication Settings dialog and used by NetLinx Studio v 2.x to communicate to the NI Controller via an IP. This address is reserved by the DHCP server and then given to the Master. If the IP Address field is empty, give the Master a few minutes to negotiate a DHCP Address with the DHCP Server, and try again.
Initial Configuration and Firmware Upgrade Assigning a Static IP to the NI Controller Verify there is an active Ethernet connection on the Ethernet port of the Master before beginning these procedures. 1. In NetLinx Studio, select Diagnostics > Network Addresses from the Main menu to access the Network Addresses dialog (FIG. 3). System Address reflects the value set in the Device Addressing tab Used to retain an IP Address FIG. 3 Network Addresses dialog (for a pre-obtained Static IP Address) 2.
Initial Configuration and Firmware Upgrade Verify that these IP values are also entered into the related fields within either the IP Settings section of the System Connection page (on the touch panel) or within the Address field on the web browser. 12. Complete the communication process by continuing on to the Communicating Via an IP section on page 9.
Initial Configuration and Firmware Upgrade 6. Click the Edit Settings button (on the Communications Settings dialog) to open the TCP/IP Settings dialog (FIG. 4). This dialog contains a series of previously entered IP Address/URLs and their associated names, all of which are stored within Studio and are user-editable. 7.
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 NI-4000 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 7. In NetLinx Studio, select Tools > Firmware Transfers > Send to NetLinx Device to open the Send to NetLinx Device dialog (FIG. 6). Verify the target’s System number matches the value listed within the active System folder in the OnLine Tree tab of the Workspace. The Device number is always 0 for the NI Master.
Initial Configuration and Firmware Upgrade Only upon the initial installation of a new Kit file to an on-board Master will there be a error message displayed indicating a failure of the last component to successfully download. This is part of the NI Master update procedure and requires that the firmware be reloaded after a reboot of the unit. This consecutive process installs the final component of the new Kit file. 12. After the last components fails to install, click Done. 13.
Initial Configuration and Firmware Upgrade On-board NI Master (NI-X000_Master) - Device 0 On-board Integrated Controller (NI-X000) NetLinx Studio version Unbound Dynamic Device FIG. 7 Sample NetLinx Workspace window (showing separate NI-Master and Controller) 5. If the NI Controller firmware being used is not current, download the latest Kit file by first logging in to www.amx.
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. 8 Send to NetLinx Device dialog (showing on-board Integrated Controller firmware update via IP) The Kit file for the Integrated Controller on the NI-2000/3000/4000 begins with 2105_NI_X000.
Initial Configuration and Firmware Upgrade If The Connection Fails If the connection fails to establish, a Connection Failed dialog appears. Try selecting a different IP Address if communication fails. Press the Retry button to reconnect using the same communication parameters. Press the Change button to alter your communication parameters and repeat steps 2 thru 11. Upgrading NXC Card Firmware Via IP This section applies to the NI-4000 and NI-4100 0nly.
Initial Configuration and Firmware Upgrade 5. If the NXC card firmware being used is not current, download the firmware file by first logging in to www.amx.com and then navigate to Tech Center > Firmware Files and from within the NetLinx section of the web page locate the NXC card entries. 6. Click on the desired Kit file link and after you’ve accepted the Licensing Agreement, verify you have downloaded the NetLinx NXC card firmware (Kit) file to a known location. 7.
Initial Configuration and Firmware Upgrade 16. Cycle power to the Master (unplug and reconnect power to the unit). This process of cycling power acts to reset the updated NetLinx Control Card and detect its new firmware update. It also serves to allow the Integrated Controller to detect and reflect the new firmware on the card to the NetLinx Studio display on the Workspace window. 17.
Initial Configuration and Firmware Upgrade 20 NI Series WebConsole & Programming Guide
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. 11).
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 nd 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 WebControl page (FIG. 11). 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. 14). FIG. 14 Example Network Settings page for a sample CV15 connected to the Master Use the options on this page to view/edit the device’s network settings. Refer to the System - Manage System section on page 41 for details.
Onboard WebConsole User Interface 24 NI Series WebConsole & Programming Guide
WebConsole - WebControl Options WebConsole - WebControl Options Manage WebControl Connections The WebControl page is accessed by clicking on the WebControl button (FIG. 15). This page allows you to view all touch panels running the G4WebControl application. Each G4WebControl-equipped touch panel connected to this Master is indicated by a link. Click on any of the links to open a new G4WebControl window, displaying the selected panel, using the native resolution of the target panel.
WebConsole - WebControl Options 26 NI Series WebConsole & Programming Guide
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 section on page 29 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 Username: administrator Account 2 Group 1 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. There are two System Level Security pages, accessible via the System Security Settings and Security Settings links in the System Level Tab: The. Security Settings option is only available on the NI-700/900 and NI-X100 series.
WebConsole - Security Options System Security Access Options System Security Access Options Option Description Enabled: This option enables the Access options this page. If the Master Security checkbox is not enabled, all subordinate options are greyed-out and not selectable, meaning that the Master is completely unsecured and can be altered by any user (regardless of their rights).
WebConsole - Security Options Telnet Access option Telnet 23 Telnet Port SSH Client 22 SSH Port 80 HTTP Port 443 HTTPS Port 1319 ICSP Port 21 FTP Port Web Browser Secure HTTP Access option Secure Browser or SSL AMX Software & Hardware ICSP Connectivity and Encryption option Secure Secure FTP NetLinx Master Username and Password are required when enabled FIG. 18 Port Communication Settings Accepting Changes Click the Accept button to save changes on this page.
WebConsole - Security Options The IPSec Security Settings option is only available on the NI-700/900 and NI-X100 series. Configuring Settings 1. Check the Enabled option to enable Security, and make the following CRL Checking options available (click the radio buttons to toggle on/off): No CRL Checking: No CRL (Certificate Revocation List) checking will be done. CRL Checking: Only the certificate in question will be checked against the CRL.
WebConsole - Security Options System Security - Group Level Select the Group Level tab of the Security Page to access the Group Security Details page (FIG. 20). FIG. 20 Group Security Details page 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. A Group represents a logical collection of individual users.
WebConsole - Security Options FIG. 21 Group Level Security Settings Page (Add a group and modify settings page) If you select a group directory, all lower groups in that tree will be selected. 6. Click the Accept button to save your changes to the target Master. If there are no errors within any of the page parameters, a “Group added successfully” is displayed at the top of the page. Security changes made from within the web browser are applied instantly, without the need to reboot.
WebConsole - Security Options Group and User Security Access Options (Cont.) Option Description Telnet Access: If selected, a valid username and password is required for Telnet Access. Telnet access allows communication over either the Telnet and/or SSH Ports. 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. Refer to the Manage System Server Options section on page 51.
WebConsole - Security Options Viewing Group Security Settings Details Click on any Group listed in the Group Security Details page to expand the view to show details for the selected user Group (FIG. 23): Click to add a new Group FIG. 23 Group Security Details Page 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.
WebConsole - Security Options FIG. 24 Group Security Details Page (Edit Group Security Details) The "administrator" group account cannot be modified or deleted. Any properties possessed by groups (ex: access rights, update rights, directory associations, etc.) are inherited by users assigned to that particular group. Unchecking a security option (which is available within the associated group) does not remove that right from the user.
WebConsole - Security Options System Security - User Level Select the User Level tab of the Security Page to access the User Security Details page (FIG. 25). 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. 25 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. 26 User Security Settings Page (Add/Modify User page) The password must be a unique alpha-numeric character string (4 - 20 characters), and is case sensitive. 6. Enable the security access rights you want to provide to the user. See the Group and User Security Access Options section on page 34 for details. 7.
WebConsole - Security Options Click to edit Access settings for this User Click to delete this User FIG. 27 User Level Security Settings Page (Viewing User Security Settings Details) If you are not logged into the Master, you receive a reminder message: "You must login before Security Settings can be changed". In this case, log into the Master and repeat the previous steps. 3. Reboot the Master via the Reboot button on the Manage System Page (select the System control button to access).
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 Manage System - System Number The options on this page display the current System Number assigned to the target Master (read-only), and allow you to change the system number (see FIG. 28). Changing the System Number On the Master 1. Enter the new numeric value into the New System Number field. 2. Click the Accept button to save this new value to the system on the target Master. The message; "System number changed to X. Master must be rebooted for the change to take effect.
WebConsole - System Options Push button only displayed if Emulate is selected FIG. 29 Manage System (Control/Emulate) The System Number, Device Number, and Port Number fields are read-only. Instead of specifying these values for a System Device, select a device via the Device Tree to populate these fields with that device’s information. Controlling or Emulating a System Device 1. Select the device that you want to Control or Emulate, via the Device Tree: a.
WebConsole - System Options Click on Control/Emulate from within the device’s Network Settings page to Control/Emulate that device FIG. 30 Select Control/Emulate from within a selected Device’s Network Settings page Select the On or Off buttons to Emulate Channel ON (CHON) and Channel OFF (CHOFF) messages for the specified . 4. Select the Push button to Emulate a push/release on the specified channel (not displayed if the Control option is selected).
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. 31). 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. 31 Diagnostics Options Page (with diagnostic messages enabled) The System Number, Device Number, and Port Number value fields are read-only (disabled).
WebConsole - System Options information on the selected device (including network configuration details). An example Network Settings page is shown in FIG. 32: c. Click on the Diagnostics link. This opens a Diagnostics Options page for the selected device (FIG. 32). Click on Diagnostics from within the device’s Network Settings page to enable/modify diagnostics for that device FIG.
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 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. The device will appear in the Diagnostics Options window, in the next available column (to the right of the last device added - see FIG. 35). FIG.
WebConsole - System Options Diagnostic Options (Cont.) Diagnostic option Description Channel Changes • Input Generates a message when there is an input channel change (i.e. Push/Release) in the target device. • Output Generates a message when there is an output channel change (i.e. CHON/CHOFF) in the target device. • Feedback Generates a message when there is a feedback channel change in 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. 36). 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 The following table describes each of the Port Settings presented on this page: Server Port Settings Feature Description Telnet: The port value used for Telnet communication to the target Master. Enabling this feature allows future communication with the Master via a separate Telnet application (such as HyperTerminal). • The default port value is 23.
WebConsole - System Options Server Port Settings (Cont.) Feature Description FTP: The default port value used for FTP communication. This port can be disabled/enabled but the value can not be changed. • The default port value is 21. Once any of the server port settings have been modified, press the Accept button to save these changes to the Master. Once these changes are saved, the following message appears: "Unit must be rebooted for the change to take effect".
WebConsole - System Options 1. Click the Create SSL Certificate link (under SSL Certificate Options) to access the Create SSL Certificate window (FIG. 37). FIG. 37 Create SSL Certificate window 2. Fill out the information in this window, according to the descriptions in the SSL Certificate Entries section below. 3. Click Create SSL Certificate to update the Master with the information entered on this page. This process can take several minutes.
WebConsole - System Options SSL Certificate Entries (Cont.) Entry Description Organization Name: Name of your business or organization. This is an alpha-numeric string (1 - 50 characters in length). Organization Unit: Name of the department using the certificate. This is an alpha-numeric string (1 - 50 characters in length). City/Location: Name of the city where the certificate is used. This is an alpha-numeric string (1 - 50 characters in length).
WebConsole - System Options 4. Click Create SSL Certificate to save the newly modified certificate information to the Master. Click Close to exit without making changes to the Master. Only use the Regenerate Certificate option when you have self-generated your own certificate. Do not regenerate an external CA-generated certificate. Exporting an SSL Certificate Request 1.
WebConsole - System Options Importing an SSL Certificate Click the Import SSL Certificate link to import a CA server certificate. Before importing an SSL Certificate you must: First, have a self-generated certificate installed onto your target Master. Second, enable the HTTPS/SSL feature from the Server Options page (FIG. 36), to establish a secure connection to the Master prior to importing the encrypted CA certificate. 1. Copy the returned certificate (signed by the CA) to your clipboard. 2.
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. 40). 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 2. Click Accept to save these settings to the Master. Setting Daylight Savings Rules 1. In the Daylight Savings tab (FIG. 41), enable Daylight Savings mode by clicking the On button. FIG. 41 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.
WebConsole - System Options 4. Use the Ends fields to specify when Daylight Savings should end. The Ends rules match the Start rules, and follow the same logic. Select Fixed or by Occurrence, and specify the End date/time information accordingly. 5. Click Accept to save these settings to the Master. Selecting a Custom NIST Server FIG. 42 Clock Manager Options - NIST Servers tab 1. In the NIST Servers tab (FIG. 42), use the radio buttons to select one of the NIST Servers in the list. 2.
WebConsole - System Options Removing an NIST Server From the List 1. Click on the Remove (x) button to the right of a user-added NIST Server in the NIST Server Manager list. 2. Click Accept to save these settings to the Master. The built-in entries cannot be removed. Clock Manager NetLinx Programming API Refer to Appendix B: Clock Manager NetLinx Programming API section on page 141 for a listing and description of the Types/Constants and Library Calls that are included in the NetLinx.
WebConsole - System Options FIG. 44 Manage License - Add a License page Example: AMX Meeting Manager and i!-Voting applications are examples of products that require both a Product serial number and a Master-specific key prior to usage. 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.
WebConsole - System Options System - Manage NetLinx The Manage NetLinx tab displays a list of NetLinx device connected to the Master, and indicates device status (FIG. 45). FIG. 45 System - Manage NetLinx tab The table on this page consists of five columns: 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.
WebConsole - System Options NetLinx Device Details (Cont.) Column Status: Description Indicates the Master or device state: • This Master: Indicates its the target Master currently being used and being browsed to. Its this Master’s web pages which are currently being viewed. • Orphan: Indicates that the device is currently not yet “bound” or assigned to communicate with a particular Master.
WebConsole - System Options System - Manage Devices The Manage Devices tab (FIG. 46) contains links to several different device-related pages, as described in the following subsections: FIG. 46 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. 46). 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 Bind (Cont.): For example, if the application only has one VCR defined and a VCR is detected in the system, auto-binding can then be accomplished. If there were two VCRs defined within the application, auto-binding could not be completed due to the lack of a clearly defined one-to-one correspondence.
WebConsole - System Options Any corresponding module within the /bound directory will not be deleted. Bound modules must be deleted via the Purge Bound Modules on Reset selection described within the Configure Device Bindings section. To browse for a Module file and then upload it to the Master: 1. Click the Browse button next to the Select a module to upload text field to browse for Duet Modules on your PC/Network. 2. Select the JAR file that you want to upload to the Master. 3.
WebConsole - System Options Configuring Application-Defined Devices Elements such as DUET_DEV_TYPE_DISC_DEVICE and DUET_DEV_POLLED are defined within the NetLinx.axi file. The NetLinx.axi file contains both the new API definitions, as well as the pre-defined constants that are used as some of the API arguments (ex: DUET_DEV_TYPE_DISC_DEVICE). Physical device names are typically prefixed with "dv" and Virtual device names are typically prefixed with "vdv".
WebConsole - System Options FIG. 48 Manage Device Bindings page - showing the NetLinx code relation This code gives the Master a “heads-up” notification to look for those devices meeting the criteria outlined within the code.
WebConsole - System Options Each entry in the table has one of four buttons to the right of the Physical Device D:P:S assignment: Static Bound application devices will either be blank, or display a Release button: Static Bound application devices that have not yet detected a physical device attached to their associated port have a blank button. Once a physical device is detected and its associated Duet module has been started, a Release button is then displayed.
WebConsole - System Options Hold the mouse cursor over the Device D:P:S assignment to open the Device Properties pop-up FIG. 49 Manage Device Bindings - Device Properties pop-up Manage Devices - User-Defined Devices Click the User-Defined Devices link (in the Manage Devices tab) to access the User-Defined Devices page (FIG. 50). This page provides a listing with all of the dynamic devices that have been discovered in the system, and allows you to add and delete User-Defined Devices. FIG.
WebConsole - System Options FIG. 51 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. This information can be either the NetLinx Master port value (D:P:S) or an IP Address (#.#.#.#). Category: Use the drop-down list to select the control method associated with the physical target device (IR, IP, Serial, Relay, Other).
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 Unless the Disable Module Search via the Internet option was selected in the Manage Devices page (see the Manage Devices - Device Options section on page 65), the search includes a query of the AMX online database as well as any manufacturer specified URLs that match the IP Address of the physical device for a compatible module.
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. 54). 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. 54 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 FIG. 55 Manage Polled Ports - Edit Port Settings Use the drop-down menus to modify the Port settings.
Programming 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. Master Send_Commands These commands are specific to the Master and not the Controller.
Programming Master Send_Commands (Cont.) Command Description ~IGNOREEXTERNALCLOCKCOMMANDS Syntax: Set the Master so that it cannot have it’s time set by another device which generates a ‘CLOCK’ command. SEND_COMMAND ,"'~IGNOREEXTERNALCLOCKCOMMANDS'" Example: SEND_COMMAND 0:1:0,"'~IGNOREEXTERNALCLOCKCOMMANDS'" 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).
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.
Programming RS-232/422/485 Send_Commands RS-232/422/485 Send_Commands Command Description B9MOFF Disables 9-bit in 232/422/455 mode. By default, this returns the communication settings on the serial port to the last programmed parameters. This command works in conjunction with the 'B9MON' command. Set the port's communication parameters for stop and data bits according to the software settings on the RS-232 port (default).
Programming RS-232/422/485 Send_Commands (Cont.) Command Description GET BAUD The port sends the parameters to the device that requested the information. Get the RS-232/422/485 port’s current communication parameters. The port responds with: ,,,, 485 Syntax: SEND_COMMAND ,"'GET BAUD'" Example: SEND_COMMAND RS232_1,"'GET BAUD'" System response example: Device 1,38400,N,8,1 485 DISABLED HSOFF Disable hardware handshaking (default).
Programming RS-232/422/485 Send_Commands (Cont.) Command Description SET BAUD Syntax: Set the RS-232/422/485 port's communication parameters. SEND_COMMAND ,"'SET BAUD ,,, [485 ]'" Variables: baud = baud rates are: 115200, 76800, 57600, 38400, 19200, 9600, 4800, 2400, 1200, 600, 300, 150. parity = N (none), O (odd), E (even), M (mark), S (space). data = 8 data bits. stop = 1 and 2 stop bits. 485 Disable = Disables RS-485 mode and enables RS-422.
Programming RS-232/422/485 Send_Commands (Cont.) Command Description XON Syntax: Enable software handshaking. SEND_COMMAND ,"'XON'" Example: SEND_COMMAND RS232_1,"'XON'" Enables software handshaking on the RS232_1 device.
Programming RS-232/422/485 Send_String Escape Sequences (Cont.) Command Description 27,20,1 Syntax: Set the RTS hardware handshake's output to low/inactive (< 3V). SEND_STRING ,"27,20,1" Example: SEND_STRING RS232_1,"27,20,1" Sets the RTS hardware handshake's output to low on the RS232_1 device. 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.
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.
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.
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.
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.
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. SEND_COMMAND ,"'XCH '" Variable: channel = 0 - 999. Example: For detailed usage examples, refer to the 'XCHM' command. XCHM Changes the IR output pattern for the 'XCH' send command. Syntax: SEND_COMMAND ,"'XCHM '" Variable: extended channel mode = 0 - 4.
Programming Input/Output Send_Commands The following Send_Commands program the I/O ports on the Integrated Controller. I/O ports: Port 4 (NI-700). Channels: 1 - 8 I/O channels. I/O Send Commands 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.
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 6. Click OK to complete the communication parameters and open a new Terminal window. 7. Type echo on to view the characters while entering commands. If that does not work, press key on your keyboard. 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 Login: User1 Password: ***** Login not authorized. Please try again. After a delay, another login prompt will be displayed to allow you to try again. If after 5 prompts, the login information is not entered correctly, the following message will be displayed and the connection closed: Login not allowed. Goodbye! If a connection is opened, but a valid a username / password combination is not entered (i.e.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command DNS LIST Description 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 IP STATUS Description 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 PASS [D:P:S or NAME] Description 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 REBOOT Description Reboots the Master or specified device. Example: >REBOOT [0:1:0] Rebooting... RELEASE DHCP Releases the current DHCP lease for the Master. Note: The Master must be rebooted to acquire a new DHCP lease. Example: >RELEASE 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 SET DNS Description Sets up the DNS configuration of a device. This command prompts you to enter a Domain Name, DNS IP #1, DNS IP #2, and DNS IP #3. Then, enter Y (yes) to approve/store the information in the Master. Entering N (no) cancels the operation. Note: The device must be rebooted to enable new settings.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SET HTTPS PORT Description Sets the Master’s IP port listened to for HTTPS connections. Note: The Master must be rebooted to enable new settings.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SET LOG COUNT Description Sets the number of entries allowed in the message log. Note: The Master must be rebooted to enable new settings. Example: >SET LOG COUNT Current log count = 1000 Enter new log count (between 50-10000): Once you enter a value and press the ENTER key, you get the following message: Setting log count to New log count set, reboot the Master for the change to take affect.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SET TELNET PORT Description Sets the Master’s IP port listened to for Telnet connections. Note: The Master must be rebooted to enable new settings.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SET UDP BC RATE Description Sets the UDP broadcast rate. A broadcast message is sent by the Master to allow devices to discover the Master. This command allows the broadcast frequency to be changed or eliminate the broadcast message. Example: >SET UPD BC RATE Current broadcast message rate is 5 seconds between messages.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SHOW DEVICE Description Displays a list of devices present on the bus, with their device attributes. Example: >SHOW DEVICE [0:1:0] Local devices for system #1 (This System) --------------------------------------------------------------------------Device (ID)Model (ID)Mfg FWID Version 00000 (00256)NXC-ME260/64M (00001)AMX Corp. 00336 v3.00.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SHOW MAX BUFFERS Description Displays a list of various message queues and the maximum number of message buffers that were ever present on the queue. Example: show max buffers Thread TX RX ----------- ---- ---Axlink 1 UDP 1 IPCon Mgr 0 (Total for TCP Connections TX=0) Con Manager Interpreter Device Mgr Diag Mgr Msg Dispatch Cfg Mgr Route Mgr Notify Mgr Total 8 17 8 1 0 0 0 0 ---- ---- ---2 34 GrandTotal 36 See SHOW BUFFERS.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SHOW ROUTE Description 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 SYSTEM Displays a list of all devices in all systems currently on-line. The systems lists are either directly connected to this Master (i.e.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command URL LIST Description 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.200 State=Issue Connect ESC Pass Codes There are 'escape' codes in the pass mode.
Terminal (Program Port/Telnet) Commands Accessing the Security Configuration Options The help security option is only available to Program Port connections (see the Overview section on page 91). 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 109 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 13) Make changes permanent by saving to flash Description 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 1) Terminal (RS232) Access (Enable/Disable) 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 Edit Group Menu: Add Directory Association 1. At the Edit Group prompt, type 1 to add a new directory association. A Directory Association is a path that defines the directories and/or files that a particular user or group can access via the HTTP (Web) Server on the NetLinx Master. This character string can range from 1 to 128 alpha-numeric characters. This string is case sensitive. This is the path to the file or directory you want to grant access.
Terminal (Program Port/Telnet) Commands Default Security Configuration By default, the NetLinx Master will create the following accounts, access rights, directory associations, and security options.
Terminal (Program Port/Telnet) Commands Notes on Specific Telnet/Terminal Clients Telnet and terminal clients will have different behaviors in some situations. This section states some of the known anomalies. WindowsTM Client Programs Anomalies occur when using a Windows client if you are not typing standard ASCII characters (i.e. using the keypad and the ALT key to enter decimal codes). Most programs will allow you to enter specific decimal codes by holding ALT and using keypad numbers.
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 Internet Key Exchange (IKE) ikeAddPeerAuth ikeAddPeerAuth NAME SYNOPSIS ikeAddPeerAuth – add a peer's authentication information ikeAddPeerAuth=configString DESCRIPTION This rule is used to specify IKE authentication information between the host and a peer. This rule may be called multiple times to define a set of peers with which the host will conduct IKE negotiations.
Appendix A: IPSec Configuration File ikeAddPeerAuth (Cont.) EXAMPLES Using a pre-shared key for IPv4: ikeAddPeerAuth=100.100.100.4,100.100.100.1,mm_grp2,NOPFS,PSK, thisisatest Using a pre-shared key for IPv6: ikeAddPeerAuth=3ffe:2::2,3ffe:1::2,mm_grp2,NOPFS,PSK,thisisatest Using certificates for IPv4: ikeAddPeerAuth=192.168.1.36,192.168.1.35,ph1_g1_1,NOPFS,RSA, local_key.key,mypassword,local_cert.crt,PEER_CERT,peer_cert.crt ikeAddPeerAuth=192.168.1.36,192.168.1.35,ph1_g1_1,NOPFS,RSA, local_key.
Appendix A: IPSec Configuration File ikeSetProp ikeSetProp NAME SYNOPSIS ikeSetProp – create a Phase 1 proposal ikeSetProp=configString DESCRIPTION This rule creates a Phase 1 proposal with previously defined Phase 1 transform names. Rule Value: configString A string formatted as follows: proposalName,transformName,[transformName][,transformName]... where - proposalName is a unique name for a Phase 1 proposal. - transformName is an existing Phase 1 transform name, defined via ikeSetXform.
Appendix A: IPSec Configuration File ikeSetPropAttrib ikeSetPropAttrib NAME SYNOPSIS ikeSetPropAttrib – set attributes of an IKE Phase 1 proposal ikeSetPropAttrib=configString DESCRIPTION This rule sets the attributes for a previously defined IKE Phase 1 proposal. Rule Value: configString A string formatted as follows: proposalName,attributeType,attributeValue,[attributeType,attributeV alue]... proposalName is the name of an existing Phase 1 proposal.
Appendix A: IPSec Configuration File Security Policy Database (SPD) spdAddTransport spdAddTransport NAME SYNOPSIS spdAddTransport – add a transport mode policy spdAddTransport=pConfStr DESCRIPTION This rule adds a transport mode policy.
Appendix A: IPSec Configuration File SpdAddTunnel SpdAddTunnel NAME SYNOPSIS spdAddTunnel– create a tunnel mode policy in the SPD spdAddTunnel=pConfStr DESCRIPTION This rule creates a tunnel mode policy in the SPD.
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 SpdAddDiscard NAME SYNOPSIS spdAddDiscard – create a discard policy in the SPD spdAddDiscard=pConfStr DESCRIPTION This rule creates a discard 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 SpdSetProp SpdSetProp NAME SYNOPSIS spdSetProp– add Phase 2 transforms to a Phase 2 proposal spdSetProp=pConfStr DESCRIPTION This rule adds one or more existing Phase 2 transforms to a Phase 2 proposal. Rule Value: pConfStr A stringValue specifier formatted as follows: proposalName,transformName[,transformName...] where - proposalName is a unique Phase 2 proposal name. - transformName is the name of an existing Phase 2 transform.
Appendix A: IPSec Configuration File SpdSetProp (Cont.
Appendix A: IPSec Configuration File SpdSetProp (Cont.
Appendix A: IPSec Configuration File SpdSetProp (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: 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 SpdSetPropAttrib (Cont.
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: 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: 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: 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 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: 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 IPSec Web Configuration Interface Once the IPSec Config file for a system has been created on a PC, the configuration of IPSec on a master is accomplished via its Web interface. The following is a screen shot of the IPSec Security Settings page and descriptions of each field (FIG. 56). All setting and file modifications require a system reboot to take effect. FIG. 56 IPSec Security Settings page The “Enabled” checkbox turns “on” and “off” the entire IPSec feature.
Appendix A: IPSec Configuration File 140 NI Series WebConsole & Programming Guide
Appendix B: Clock Manager NetLinx Programming API Appendix B: Clock Manager NetLinx Programming API Types/Constants The NetLinx.axi file that will ship with NetLinx Studio includes the following types/constants: (*-----------------------------------------------------------------------------------*) (* Added v1.
Appendix B: Clock Manager NetLinx Programming API Library Calls The NetLinx.axi file that ships with NetLinx Studio includes the following Clock Manager-specific library calls: NetLinx.axi - Library Calls CLKMGR_IS_NETWORK_SOURCED() Returns FALSE/0 or TRUE/1. The default setting is FALSE/0. CLKMGR_SET_CLK_SOURCE (CONSTANT INTEGER MODE) Can be set to CLKMGR_MODE_NETWORK or CLKMGR_MODE_STANDALONE. CLKMGR_IS_DAYLIGHTSAVINGS_ON() Returns FALSE/0 or TRUE/1. The default setting is FALSE/0.
Appendix B: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_GET_START_DAYLIGHTSAVINGS_RULE() Gets a string representation of when Daylight Savings is supposed to START. The Fixed-Date rules have the form: "fixed:DAY,MONTH,HH:MM:SS" with all fields as numeric except for the word "fixed". The Occurrence-Of-Day rules have the form: "occurence:OCCURENCE, DAY-OF-WEEK,MONTH,HH:MM:SS" with all fields as numeric except for the word "occurence".
Appendix B: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_GET_END_DAYLIGHTSAVINGS_RULE() Gets a string representation of when Daylight Savings is supposed to END. The Fixed-Date rules have the form: "fixed:DAY,MONTH,HH:MM:SS" with all fields as numeric except for the word "fixed". The Occurrence-Of-Day rules have the form: "occurence:OCCURENCE, DAY-OF-WEEK,MONTH,HH:MM:SS" with all fields as numeric except for the word "occurence".
Terminal (Program Port/Telnet) Commands NI Series WebConsole & Programming Guide 145
AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time. ©2007 4/07 It’s Your World - Take Control™ 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.
