Moxa - ProductsMoxa - SupportMoxa - ProductsMoxa - SupportMoxa - SupportMoxa - Support
User Manual for MOXA models including: NPort 5150, NPort 5100 Series, NPort 5200 Series, NPort 5150 CLI Configuration Tool, NPort 5150 CLI, Configuration Tool
15 gen 2024 — Moxa CLI Configuration Tool User Manual ... Firmware v3.9 and later versions. NPort 5150 ... Step 1: Download MCC Tool for Windows on URL: https://www.moxa.com/ ...
NPort 5100 Series - General Device Servers | MOXA
The software described in this manual is furnished under a license agreement and may be used only in accordance with the terms of that agreement.
File Info : application/pdf, 17 Pages, 1,020.48KB
DocumentDocumentMoxa CLI Configuration Tool User Manual Version 2.2, January 2024 www.moxa.com/products © 2024 Moxa Inc. All rights reserved. Moxa CLI Configuration Tool User Manual The software described in this manual is furnished under a license agreement and may be used only in accordance with the terms of that agreement. Copyright Notice © 2024 Moxa Inc. All rights reserved. Trademarks The MOXA logo is a registered trademark of Moxa Inc. All other trademarks or registered marks in this manual belong to their respective manufacturers. Disclaimer · Information in this document is subject to change without notice and does not represent a commitment on the part of Moxa. · Moxa provides this document as is, without warranty of any kind, either expressed or implied, including, but not limited to, its particular purpose. Moxa reserves the right to make improvements and/or changes to this manual, or to the products and/or the programs described in this manual, at any time. · Information provided in this manual is intended to be accurate and reliable. However, Moxa assumes no responsibility for its use, or for any infringements on the rights of third parties that may result from its use. · This product might include unintentional technical or typographical errors. Changes are periodically made to the information herein to correct such errors, and these changes are incorporated into new editions of the publication. Technical Support Contact Information www.moxa.com/support Table of Contents 1. Introduction .........................................................................................................................................4 System Requirements ............................................................................................................................4 Supported Platforms .......................................................................................................................4 Supported Models...........................................................................................................................4 Installing MCC_Tool on Windows .............................................................................................................5 Installing MCC_Tool on Linux ..................................................................................................................8 2. Getting Started ...................................................................................................................................10 Overview ............................................................................................................................................ 10 Supported Functions and Command Structure ................................................................................. 10 Device List .................................................................................................................................. 11 Support Product Series ................................................................................................................. 11 Function Support Table ................................................................................................................. 11 Usage Examples of Supported Functions ................................................................................................. 12 Report Firmware Versions.............................................................................................................. 12 Upgrade Firmware and Restart the Device ....................................................................................... 13 Export/Import Device's Configuration ............................................................................................. 13 Restart Specific Serial Ports or the Whole Devices ............................................................................ 15 Change User's Password on the Device ........................................................................................... 16 Show Support Model List ............................................................................................................... 17 Update Plugin .............................................................................................................................. 17 Error Code Explanation ................................................................................................................. 17 1. Introduction Moxa CLI Configuration Tool (MCC_Tool) is a command line tool that provides the following functions to manage field devices. · Report firmware versions · Upgrade firmware · Import/export configuration files · Password changes Management tasks can be performed according to a desired scale (1 for single device or 1 for multiple devices) and across different subnet networks. System Requirements Supported Platforms · Windows 7 and later versions. · Linux kernel 2.6 and later versions. Supported Models Product Series / Model NPort 5100A Series NPort 5110 NPort 5130 NPort 5150 NPort P5150A Series NPort 5200A Series NPort 5200 Series NPort 5400 Series NPort 5600 Series NPort 5600-DT Series NPort 5600-DTL Series (EOL) NPort S9450I Series NPort S9650I Series NPort IA5100A Models NPort IA5200A Models NPort IA5400A Models NPort IA5000 Series NPort 5000AI-M12 Series NPort 6100/6200 Series NPort 6400/6600 Series Supporting Firmware Firmware v1.4 and later versions Firmware v2.0.62 and later versions Firmware v3.9 and later versions Firmware v3.9 and later versions Firmware v1.4 and later versions Firmware v1.4 and later versions Firmware v2.12 and later versions Firmware v3.13 and later versions Firmware v3.9 and later versions Firmware v2.6 and later versions Firmware v1.5 and later versions Firmware v1.1 and later versions Firmware v1.1 and later versions Firmware v1.3 and later versions Firmware v1.3 and later versions Firmware v1.4 and later versions Firmware v1.7 and later versions Firmware v1.3 and later versions Firmware v1.13 and later versions Firmware v1.13 and later versions Moxa CLI Configuration Tool User Manual 4 Product Series / Model MGate 5134 Series MGate 5135/5435 Series MGate 5217 Series MGate MB3180/MB3280/MB3480 Series MGate MB3170/MB3270 Series MGate MB3660 Series MGate 5101-PBM-MN Series MGate 5103 Series MGate 5105-MB-EIP Series MGate 5109 Series MGate 5111 Series MGate 5114 Series MGate 5118 Series MGate 5102-PBM-PN Series MGate W5108/W5208 Series (EOL) Product Series / Model ioLogik E1200 Series ioThinx 4500 Series Supporting Firmware All versions All versions All versions Firmware v2.0 and later versions Firmware v3.0 and later versions Firmware v2.0 and later versions Firmware v2.1 and later versions Firmware v2.1 and later versions Firmware v4.2 and later versions Firmware v2.2 and later versions Firmware v1.2 and later versions Firmware v1.2 and later versions Firmware v2.1 and later versions Firmware v2.2 and later versions Firmware v2.3 and later versions Supporting Firmware Firmware v2.4 and later versions All versions Installing MCC_Tool on Windows Step 1: Step 2: Download MCC_Tool for Windows on URL: https://www.moxa.com/support/download.aspx?type=support&id=15923. Unzip the folder and execute the .exe file. The setup wizard will pop up to direct you to the next steps. Select destination location of where MCC_Tool should be installed. Moxa CLI Configuration Tool User Manual 5 Step 3: Select Start Menu Folder to create the program's shortcuts. Step 4: Select Additional Tasks if any and click Next. Moxa CLI Configuration Tool User Manual 6 Step 5: Confirm previous selection and prepare to install. Step 6: Complete setup and check Launch mcc_tool if you want to use MCC_Tool after exiting the setup wizard. Moxa CLI Configuration Tool User Manual 7 Step 7: Use h command to prompt help information. Installing MCC_Tool on Linux Step 1: Step 2: Download MCC_Tool for Linux on URL: https://www.moxa.com/support/download.aspx?type=support&id=15925 (Linux x86) and https://www.moxa.com/support/download.aspx?type=support&id=15924 (Linux x64). Versions for x86 and x64 OS are available. Access the location where you save the downloaded file and unzip it. For example: moxa@moxa-virtual-machine:~$ cd Desktop/ moxa@moxa-virtual-machine:~/Desktop$ tar -xvzf mcc_tool_x64_ver1.0_build_17111618.tar.gz mcc_tool_x64_ver1.0_build_17111618/ mcc_tool_x64_ver1.0_build_17111618/dsci_mcc.so mcc_tool_x64_ver1.0_build_17111618/mxio_mcc.so mcc_tool_x64_ver1.0_build_17111618/mcc_tool mcc_tool_x64_ver1.0_build_17111618/mgci_mcc.so moxa@moxa-virtual-machine:~/Desktop$ cd mcc_tool_x64_ver1.0_build_17111618/ Moxa CLI Configuration Tool User Manual 8 Step 3: Execute MCC_Tool in the unzipped folder and use h command to get all the available functions and option commands of the tool. moxa@moxa-virtualmachine:~/Desktop/mcc_tool_x64_ver1.0_build_17111618$ ./mcc_tool -h MCC_Tool ver1.0 Copyright: Moxa Inc. Usage: ./mcc_tool [function] [options] Function: -fw: Execute "Firmware related" action. -cfg: Execute "Configuration related" action. -pw: Execute "Password related" action. -re: Execute "Restart related" action. -ver: Show mcc library version. -help: Display version of MCC_Tool and help information. Options: -r: Report firmware version. -up: Upgrade firmware. -ex: Export the configuration file. -im: Import the configuration file. -ch: Change password. -de: Restart device. -sp: Restart port. -i: Device IP address. -il: IP address list containing 1 IP address per line. -d: Device list. -f: File to be imported or upgraded. -nd: The Device list with new password settings. -u: Device's user account for login. -p: Device's password for login. -npw: The new password for the specific user. -dk: Secret key for import/export configuration. -ps: Specific serial ports to be restarted. -o: Output file name. -l: Export result log file. -n: Keep network settings for configuration import. -nr: Don't reboot device after finishing executing command. -print: Print process message for upgrade firmware command. -t: STimeout(sec). ** NOTICE ** If devices can't be found, you can try again with root privilege. moxa@moxa-virtual-machine:~/Desktop/mcc_tool_x64_ver1.0_build_17111618$ Moxa CLI Configuration Tool User Manual 9 2. Getting Started This chapter covers what functions are supported by MCC_Tool and how users could use a combination of main and optional functions to manage Moxa's edge devices. Overview Supported Functions and Command Structure Users will be able to achieve the following tasks by executing a set of command lines. 1. Report firmware version through a device's IP address or a range of devices specified by IP addresses. 2. Upgrade firmware to a device through a device's IP address or a range of devices specified by IP addresses. 3. Export/Import device's configuration through an IP address and or a range of devices specified by IP addresses. 4. Restart command for: a. Restart a list of specific ports of multiple devices. b. Restart a device through a device's IP address or a range of devices specified by IP addresses. 5. Change password for an existing user of a device through the device's IP address or a range of devices specified by IP addresses. NOTE Due to model and firmware differences, the following functions may NOT work: 1. Restart multiple ports of a device 2. Change the password for an existing user (expect the user "admin") 3. Export configuration file with pre-shared key parameters You may refer to page 11 for Function Support Table to learn more details. The main functions are defined as below: Command -fw -cfg -pw -re Function Execute "Firmware related" action. Execute "Configuration related" action. Execute "Password related" action. Execute "Restart related" action. Main functions must be used in conjunction with optional commands in order to perform management tasks. Optional commands are listed in the table below: Command -r -up -ex -im -ch -de -sp -i -il Function Report firmware version. Upgrade firmware. Export the configuration file. Import the configuration file. Change password. Restart device. Restart port. Device IP address. IP address list containing 1 IP address per line. Moxa CLI Configuration Tool User Manual 10 Command -d -f -nd -u -p -npw -dk -ps -o -l -n -nr -print -t Function Device list. File to be imported or upgraded. The Device list with new password settings. Device's user account for login. Device's password for login. The new password for the specific user. Secret key for import/export configuration. Specific serial ports to be restarted. Output file name. Export result log file. Keep network settings for configuration import. Don't reboot device after finishing executing command. Print process message for upgrade firmware command Timeout(sec). Device List As mentioned in a previous section, MCC_Tool supports management tasks to a device or a range of devices. Managing multiple devices via MCC_Tool requires device list(s). MCC_Tool includes an example file of a device list, named DeviceList under Linux and DeviceList.txt under Windows. The format of the device list is: Model ServerName NPort6650; NPort6650_123; IP MAC 192.168.1.1; 00:90:e8:01:02:03; FwVer User PWD CfgFile Key FwFile Port 1.3; ; moxa; ; moxa; ; ; NOTE 1. To import configuration, please identify the CfgFile and Key column. 2. To export configuration, please input the pre-shared key under Key column (This function only works on NPort products). 3. To upgrade firmware, please input the firmware name under FwFile column. 4. To restart a specific port, please input the specific port under Port column (This function only works on the NPort device server products). Support Product Series Because of easy maintenance, MCC Tool separates the device support list by independent product line plugin, which includes the E1200_model, I4500_model, MGate model, and NPort_model since version 1.1. In the future, you may update the plugin to support new product models. Function Support Table Due to firmware differences, some functions are not available for certain models; user may refer to the table below for function support coverage. NPort 6000 Series Report firmware versions Upgrade firmware Export device's configuration Import device's configuration NPort IA5000A/5000A MGate 3000 Series Series ioLogik E1200 Series ioThinx 4500 Series · Does not support account management (-u) · Does not support account management (-u) · Does not support file decryption (-dk) · Does not support account management · Does not support account management (-u) (-u) · Does not support file decryption (-dk) · Does not support file · Does not allow device to reject to restart (-nr) decryption (-dk) Moxa CLI Configuration Tool User Manual 11 Restart specific serial port(s) Restart the devices NPort 6000 Series Set password NPort IA5000A/5000A Series · Does not support account management (-u) MGate 3000 Series ioLogik E1200 Series · Does not support this command ioThinx 4500 Series · Does not support account management (-u) · Does not support · account management (-u) · Does not support account management (-u) Does not allow device to reject to restart (-nr) Usage Examples of Supported Functions Report Firmware Versions Report firmware version of an individual device or a range of devices specified through an IP address list. Output is directed to the screen, unless an output file is specified. MCC_Tool fw r i [ip_address] o [output_file] MCC_Tool fw r il [IP_address_list] o [output_file] MCC_Tool fw r il [IP_address_list] o [output_file] t [timeout_value] Example of the IP address list file of Moxa devices: 192.168.1.1; 192.168.1.2; 192.168.1.3; Parameters Description: Command -fw -r -i -il -o -l -t Function Execute actions for firmware related Report firmware version Device's IP address (192.168.1.1) IP address list containing 1 IP address per line Output file name (can generate the Device List file) Export result log file Timeout (1~120 seconds) Default value: 10 seconds Example: Obtain firmware version of devices at IP.list and output to DeviceList file MCC_Tool fw r il IP.list o DeviceList The result log should include the items below: Model NPort6650; NPort6150; ServerName NPort6650_123; NPort6150_456; IP MAC 192.168.1.1; 00:90:e8:01:02:03; 192.168.1.2; 00:90:e8:04:05:06; FwVer User 1.3; ; 1.3; ; PWD moxa; moxa; CfgFile Key ; moxa; ; moxa; FwFile Port ; ; ; ; NOTE You may use this command to generate the Device List for other function usage. The output value under the PWD and Key columns are dummy values, where user will need to input the password and key information of the device when executing other function commands with the device list. Other columns highlighted will need to be assigned values when executing specific commands, such as import configuration file or firmware upgrade. Moxa CLI Configuration Tool User Manual 12 Upgrade Firmware and Restart the Device The password(s) must be specified by a command parameter or by the DeviceList file before upgrading the firmware and restarting a specific device (or multiple devices at the same time). After upgrading firmware, users should use search the command to check whether the device reboots successfully or not. MCC_Tool fw up i [ip_address] u [user] p [password] f [firmware_file] l [result_log] MCC_Tool fw up d [device_list] l [result_log] MCC_Tool fw up d [device_list] l [result_log] t [timeout_value] Parameters Description: Command -fw -up -i -u -p -d -f -l -t -print Function Remark Execute actions for firmware related Upgrade firmware version Device's IP address (192.168.1.1) Device's user account for login. Only the NPort 6000 *This option may only work with the Series supports this models that have user account management. command function. Device's password for login Device list Firmware file to be upgraded Export result log file Timeout (1~1200 seconds) Default value: 800 seconds Print upgrade process status message Example: Upgrade firmware using a device list and capture the results in an import log MCC_Tool fw u d DeviceList l result_log The result_log should include the items below: Model NPort6650; NPort6150; ServerName NPort6650_123; NPort6150_456; IP 192.168.1.1; 192.168.1.2; MAC 00:90:e8:01:02:03; 00:90:e8:04:05:06; FwFile NP6000_V1.3.rom; NP6000_V1.3.rom; ErrCode 0; 0; Export/Import Device's Configuration Export/Import the device configuration for a specific device or a range of devices through the device list file. The password must be specified by parameter or by the device list file. Device configurations are stored in individual files, using device type, IP address, and file create date as the filename. The result log is directly printed on the screen, or the user can specify a result_log file for it. MCC_Tool cfg ex i [ip_address] u [user] p [password] dk [key] l [result_log] MCC_Tool cfg ex d [device_list] l [result_log] MCC_Tool cfg ex d [device_list] l [result_log] t [timeout_value] MCC_Tool cfg im i [ip_address] u [user] p [password] dk [key] f [cfg_file] l [result_log] n nr MCC_Tool cfg im d [device_list] l [result_log] n nr MCC_Tool cfg im d [device_list] l [result_log] t [timeout_value] Parameters Description: Command -cfg -ex -im -i -d Function Execute actions for configuration related Export the configuration file Import the configuration file Device IP address (192.168.1.1) Device list Remark Moxa CLI Configuration Tool User Manual 13 Command -u -p -dk -f -n -nr -l -t Function Remark Device's user account for login Only the NPort 6000 *This option may only work with the models Series supports this that have user account management. command function. Device's password for login When Exporting configuration: The command decrypts the exported file with the pre-shared key. · If this parameter is not used, the exported file will be encrypted by the pre-shared key set on the firmware of the device. · If this parameter is used, the exported file will be decrypted to a clear-txt file for editing. When Importing configuration: If the configuration file that needs to be imported is encrypted, the command is needed with pre-shared key. · If the import configuration file is without -n, mcc tool will ignore -dk (won't return -11). Only the NPort 6000 Series supports this command function. · If the import configuration file is with n, mcc tool will use pre-shared key to decrypt the encrypted file. Therefore, if the key is wrong for decrypting the file, mcc tool will return -10. However, if the file is in plain text, and user inputs pre-shared key, it will ignore the key (won't return -10).* (by parameter -dk or the key column in the device list file) *This option may only work with the models that support encrypted configuration files. The configuration file to be imported Only for import configuration function Keep original network parameters (includes Only for import IP, subnet mask, gateway, and DNS) configuration function Only for import Do not reboot the device after importing the configuration function. MGate, ioLogik, and configuration file ioThinx devices do not support this command. Export result log file Timeout (1~120 seconds) Export function Default value: 30 seconds Import function Default value: 60 seconds Example: Export the configuration using a device list and export the results to a result log MCC_Tool cfg ex d DeviceList l result_log The result_log should include the following items: Model ServerName IP MAC FwVer ExportCfgFile Key ErrCode NPort6650; NPort6650_123; 192.168.1.1; 00:90:e8:01:02:03; 1.3; NP6650_192_168_1_1_20170622.ini; moxa; 0; NPort6150; NPort6150_456; 192.168.1.2; 00:90:e8:04:05:06; 1.3; NP6650_192_168_1_2_20170622.ini; moxa; 0; Example: Import the configuration to a device list (with restart the units) and export the results to a result log MCC_Tool cfg im d DeviceList l result_log Moxa CLI Configuration Tool User Manual 14 The result_log should include the items below: Model ServerName IP MAC FwVer CfgFile Key ErrCode NPort6650; NPort6650_123; 192.168.1.1; 00:90:e8:01:02:03; 1.3; NP6650_192_168_1_1_20170622.ini moxa; 0; NPort6150; NPort6150_456; 192.168.1.2; 00:90:e8:04:05:06; 1.3; NP6650_192_168_1_2_20170622.ini moxa; 0; Example: Import the configuration to a device list without restarting the units and export the results to a result log MCC_Tool cfg im d DeviceList nr l result_log Restart Specific Serial Ports or the Whole Devices Restart the specific port(s) or the device itself for an individual device or a range of devices specified by the device list file. The password must be specified by a parameter or by the device list file. Device configurations are stored in individual files, using device type, IP address, and file create date as the filename. The result log is directly printed on the screen, or users can specify a result_log file for it. MCC_Tool re sp ps [1-4,7] I [ip_address] u [user] p [password]l [result_log] MCC_Tool re sp d [device_list] l [result_log] MCC_Tool re sp d [device_list] l [result_log] t [timeout_value] MCC_Tool re de I [ip_address] u [user] p [password] l [result_log] MCC_Tool re de d [device_list] l [result_log] MCC_Tool re de d [device_list] l [result_log] t [timeout_value] Parameters Description: Command -re -sp -de -ps -i -u -p -d -l -t Function Remark Execute actions related to restart. Restart specific serial ports of the MGate and ioLogik devices device. This option may only work with do not support restart the models that support restart ports specific port functions. Restart Device Used for restarting specific ports that MGate and ioLogik devices assign which serial ports should be do not support restart restarted specific port functions. Device IP address (192.168.1.1) Device's user account for login Only the NPort 6000 Series *This option may only work with the supports this command models that have user account management function. Device's password for login Device list Export result log file Timeout (1~120 seconds) Restart device, the default value is 15 seconds Restart port, the default value is 10 seconds Example: Restart port using a device list and export the results to a result log MCC_Tool re sp d DeviceList l result_log The result_log should include items below: Model NPort6650; NPort6150; ServerName NPort6650_123; NPort6150_456; IP 192.168.1.1; 192.168.1.2; MAC 00:90:e8:01:02:03; 00:90:e8:04:05:06; FwVer 1.3; 1.3; Port 2-5, 8, 10; 1,2,3; ErrCode 0; 0; The serial ports 2-5, 8 and 10 of device 1 (NPort 6650) have been restarted. Moxa CLI Configuration Tool User Manual 15 Example: Restart device using a device list and export the results to a result log MCC_Tool re de d DeviceList l result_log The result_log should include the following items: Model NPort6650; NPort6150; ServerName NPort6650_123; NPort6150_456; IP 192.168.1.1; 192.168.1.2; MAC 00:90:e8:01:02:03; 00:90:e8:04:05:06; FwVer 1.3; 1.3; ErrCode 0; 0; Change User's Password on the Device Set the password of the target device specified by an IP address. The current password must be specified by a parameter or by the Device List file. MCC_Tool pw ch i [ip_address] u [user] p [old_password] npw [new_password] MCC_Tool pw ch d [device_list] nd [device_list_new_password] l [result_log] MCC_Tool pw ch d [device_list] nd [device_list_new_password] l [result_log] t [timeout_value] Parameters' Description: Command -pw -ch -npw -i -u -p -d -nd -l -nr -t Function Remark Execute actions for password related Change password The new password for the specific user Device's IP address (192.168.1.1) Device's user account for login Only the NPort 6000 *This option may only work with the Series supports this models that have user account management command function. Device's password for login (old password) Device list The user will need to The Device list with new password assign a new password in settings the Device List when using -nd command. Export result log file Don't reboot device after changing password. MGate and ioLogik devices do not support this command. Timeout (1~120 seconds) Default value: 60 seconds Example: Set new password as "5678" then restart the device to make it effective, and print the result on the screen MCC_Tool pw 5678 i 192.168.1.1 u admin p moxa Example: Set new password from a device list and then restart the device to make it effective, and export the results to a result log MCC_Tool pw DeviceList_New d DeviceList l result_log The result_log should include the items below: Model NPort6650; NPort6150; ServerName NPort6650_123; NPort6150_456; IP 192.168.1.1; 192.168.1.2; MAC 00:90:e8:01:02:03; 00:90:e8:04:05:06; FwVer 1.3; 1.3; User admin; admin; PWD 5678; moxa; ErrCode 0; 0; Moxa CLI Configuration Tool User Manual 16 Show Support Model List Show the supported models of the MCC Tool. MCC_Tool -ml Update Plugin Users may update the Plugin for the MCC Tool to support new models, which may not be included in the current version. The command is as follow below. This function is supported by MCC_Tool version 1.1 and later. MCC_Tool -install "path of the plugin" Error Code Explanation The MCC_Tool has the same error code for all the command options, please refer to below sheet for all the details: Return Value 0 -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 Other value Description Successful Device not found Password or username does not match Exceeds the length of the password Failed to open the file If the target file path exists, please make sure you have the privilege to the target path The action timed out Import failed Firmware upgrade failed Exceeds the length of the new password Fail to set restart port index Cipher key for decrypting the configuration file is mismatched Invalid parameter E.g., 1. Input parameters are not described above 2. The parameters do not work for some devices (e.g., -u for the MGate MB3000 Series, which does not support user account function, or -dk for the NPort 5000A Series, which does not support pre-shared key function) 3. Using device list file should not input -i, -u, -p, or -npw Unsupported command E.g., execute restart specific port command (MCC_Tool -re -sp) for the MGate MB3000 Series will get error code -12 A lack of information in the device list If a specific NPort only exists in the device_list_new_password but not in the device_list (original device list with old password), then an error will occur. A lack of information in the new password list If there is no new password in the device_list_new_password but the device exists in the original device list, then an error will occur. Not executable due to an error of other devices in the list The MCC_Tool does not support the firmware version of the device. Please upgrade the device to the supported firmware version (reference to the "Support Models" section) The device is still in the default state. Please create a password and then execute the import. Contact Moxa Moxa CLI Configuration Tool User Manual 17