background image

NPort S9000 Series   

Command Line Interface 

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 

© 2017 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 

Moxa Americas

   

Toll-free:  1-888-669-2872 
Tel:   

+1-714-528-6777 

Fax:  

+1-714-528-6778

 

 

Moxa China (Shanghai office)

   

Toll-free:  800-820-5036 
Tel:   

+86-21-5258-9955 

Fax:  

+86-21-5258-5505

 

Moxa Europe

   

Tel:   

+49-89-3 70 03 99-0 

Fax:  

+49-89-3 70 03 99-99

 

 

Moxa Asia-Pacific

   

Tel:   

+886-2-8919-1230 

Fax:  

+886-2-8919-1231

 

Moxa India

   

Tel:   

+91-80-4172-9088 

Fax:  

+91-80-4132-1045

 

 

 

 
 

 

Summary of Contents for NPort S9000 Series

Page 1: ...NPort S9000 Series Command Line Interface Edition 1 0 March 2017 www moxa com product 2017 Moxa Inc All rights reserved...

Page 2: ...nges 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 resp...

Page 3: ...ommunity 2 14 2 2 13 snmp server version 2 14 2 2 14 snmp server read write user 2 15 2 2 15 snmp server read only user 2 15 2 2 16 snmp server host 2 16 2 2 17 snmp server trap mode 2 16 2 2 18 inter...

Page 4: ...4 garp 2 40 2 2 75 ptp enable 2 41 2 2 76 ptp mode 2 41 2 2 77 ptp log sync interval 2 42 2 2 78 ptp log announce interval 2 42 2 2 79 ptp announce receipt timeout 2 42 2 2 80 ptp log min delay req in...

Page 5: ...tings configuring the settings etc Other commands for different tiers should be excuted in their relative folders Please find all the details in Chapter 2 which explains how to use the commands to con...

Page 6: ...guration levels When you first enter CLI mode type to view a quick help panel that shows the basic commands of the first configuration level Type any of the commands shown on the screen to access the...

Page 7: ...n any command level Partial command Provides a list of commands that begin with the character string no space between the command and the question mark Partial command Tab Completes a partial command...

Page 8: ...ax Description quit Exit command line interface Defaults N A Permission Admin group User group Usage Guidelines N A Examples NPort S9450I 2S SC HV quit 2 1 2 exit Use exit to exit the current configur...

Page 9: ...min group Usage Guidelines N A Examples NPort S9450I 2S SC HV reload NPort S9450I 2S SC HV reload factory default NPort S9450I 2S SC HV reload serial p1 p3 NPort S9450I 2S SC HV reload serial all 2 1...

Page 10: ...tp device firmware copy xmodem device firmware copy tftp running config copy running config event log startup config tftp tftp address Syntax Description copy Copy from one file to another tftp Remote...

Page 11: ...Commands ping destaddr Syntax Description ping Send echo messages destaddr Ping destination address or hostname Defaults N A Permission Admin group User group Usage Guidelines N A Examples NPort S945...

Page 12: ...1x local userdb radius show lldp entry show port monitor show email warning config show relay warning config status show garp timer show ptp settings status port mod_port show qos cos to queue dscp to...

Page 13: ...s interface Retrieve MAC address by interface ethernet Ethernet Port interface mod_port Port ID Ex 1 3 2 1 trunk Trunk interface trunk_id Trunk ID From 1 to 2 logging Display syslog information event...

Page 14: ...status network conn Display network connection information accounts Show current account informations Defaults N A Permission Admin group User group Usage Guidelines N A Examples NPort S9650I 16 2HV s...

Page 15: ...NPort S9450I 2S SC HV sslcertgen Generating it may take a few minutes generating ssl certificate done NPort S9450I 2S SC HV 2 1 13 sshkeygen Use the sshkeygen privileged command on the device server...

Page 16: ...sword minimum length characters 4 to 16 characters Defaults Password minimum length is 4 by default Permission Admin group Usage Guidelines N A Examples NPort S9450I 2S SC HV config password policy mi...

Page 17: ...y default Password complexity check special characters is disable by default Permission Admin group Usage Guidelines N A Examples NPort S9450I 2S SC HV config password policy complexity check digit NP...

Page 18: ...xamples NPort S9450I 2S SC HV config login lockout retry threshold 5 NPort S9450I 2S SC HV config no login lockout retry threshold 2 2 6 login lockout lockout time Use login lockout lockout time globa...

Page 19: ...N A Examples NPort S9650I 16 2HV config logging capacity over size action stop recording NPort S9650I 16 2HV config logging capacity over size action overwrite oldest 2 2 8 hostname To specify or mod...

Page 20: ...cation 2 2 10 snmp server description To set the system description string use the snmp server description global configuration command To remove the description string use the no form of this command...

Page 21: ...set up the community access string to permit access to the Simple Network Management Protocol SNMP use the snmp server community global configuration command Commands snmp server community community_s...

Page 22: ...racters Password max 16 characters Examples NPort S9650I 16 2HV config snmp server read write user admin auth md5 moxacli 2 2 15 snmp server read only user To configure a read write privileged user an...

Page 23: ...onfig no snmp server host 2 2 17 snmp server trap mode To enable all Simple Network Management Protocol SNMP notifications traps or informs available on your system use the snmp server trap mode globa...

Page 24: ...face protocols modbus Configure Modbus protocol settings dnp3 Configure DNP3 protocol settings Defaults N A Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config interface se...

Page 25: ...no form of this command to disable it Commands clock summer time start date month week day hour clock summer time end date month week day hour clock summer time offset offset hour Syntax Description...

Page 26: ...se the ntp refresh time global configuration command on the device server to configure the interval of each NTP query Use the no form of this command to return to the default Commands ntp refresh time...

Page 27: ...vice server to configure time source Commands time source local ntp irig b ptp Syntax Description time source Configure the time source of the device server local Time source from local ntp Time sourc...

Page 28: ...ied minutes Commands ip auto logout minutes Syntax Description ip Global IP configuration subcommands auto logout Auto logout timer minutes 1 to 1440 minutes Defaults Auto logout is 5 minutes by defau...

Page 29: ...r login message Welcome NPort S9650I 16 2HV config no ip http server login message 2 2 32 ip http server login failure message Use ip http server login failure message global configuration commands on...

Page 30: ...rvice Use the no form of this command to disable ssh service Commands ip ssh no ip ssh Syntax Description ip Global IP configuration subcommands ssh ssh service Defaults SSH service is enable Permissi...

Page 31: ...mms service no ip mms service Syntax Description ip Global IP configuration subcommands mms service Enable MMS service Defaults MMS enable Permission Admin group Usage Guidelines N A Examples NPort S9...

Page 32: ...s NPort S9650I 16 2HV config ip igmp snooping vlan 1 mrouter 1 1 NPort S9650I 16 2HV config no ip igmp snooping vlan 1 mrouter 1 1 2 2 40 ip igmp snooping querier vlan Use the ip igmp snooping querier...

Page 33: ...s The IGMP snooping function must be enabled first Examples NPort S9650I 16 2HV config ip igmp snooping query interval 100 2 2 42 ip igmp snooping enhanced Use the ip igmp snooping enhanced global con...

Page 34: ...ermission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config ip igmp static group 01 00 00 00 00 01 interface 1 2 3 NPort S9650I 16 2HV config no ip igmp static group 2 2 44 ip dhcp...

Page 35: ...ip dhcp relay option82 remote id type Use the ip dhcp relay option82 remote id type global configuration command to select the remote ID information of DHCP option82 messages Use ip dhcp relay option8...

Page 36: ...reate Configure VLAN parameters vlan id list VLAN IDs of the VLANs Defaults N A Permission Admin group Usage Guidelines You can only use this command mode for configuring normal range VLANs that is VL...

Page 37: ...cy configuration mode Defaults The feature is enabled by default Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config redundancy 2 2 52 redundancy mode Use the redundancy mo...

Page 38: ...ult setting Commands auth tacacs no auth tacacs Syntax Description auth Configure authentication mechanism tacacs TACACS authentication Defaults The default setting is disabled Permission Admin group...

Page 39: ...Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config auth tacacs server port 1234 2 2 57 auth tacacs shared key Use the auth tacacs shared key global configuration command o...

Page 40: ...Protocol mschap Microsoft Challenge handshake authentication protocol Defaults Default type is ASCII code authentication Permission Admin group Usage Guidelines To enable the TACACS authentication th...

Page 41: ...ansFreq no lldp timer Syntax Description lldp Configure LLDP parameters timer Transmission frequency of LLDP updates transFreq 5 to 32768 seconds Defaults Transmission frequency of LLDP updates is 30...

Page 42: ...1x radius server same dot1x radius 1stServer server ip server_ip dot1x radius 1stServer server port server_port dot1x radius 1stServer shared key server_key dot1x radius 2ndServer server ip server_ip...

Page 43: ...eceive by a source port Monitored port will be mirrored to the destination port Mirror port Examples NPort S9650I 16 2HV config monitor source interface 3 1 both NPort S9650I 16 2HV config no dot1x ra...

Page 44: ...Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config email warning mail address 1 test2 moxa com 2 2 68 email warning account Use email warning account to configure the account and the...

Page 45: ...form of this command to disable the specified warning event notifications Commands email warning event all cold start warm start power trans off power trans on config change auth fail topology change...

Page 46: ...ay Relay relayId Relay s ID 1 or 2 Defaults N A Permission Admin group Usage Guidelines relayId will only be used on the product that have multiple relays Examples NPort S9650I 16 2HV config relay war...

Page 47: ...r input 2 failure On Off turbo ring break Turbo Ring break Defaults All system events are disabled by default Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config relay warn...

Page 48: ...nfig if no ptp 2 2 76 ptp mode Use the ptp mode global configuration command on the device server to set the PTP operation mode Commands ptp mode e2e bc ptp mode p2p bc ptp mode e2e oc ptp mode p2p oc...

Page 49: ...og announce interval parameter Commands ptp log announce interval interval Syntax Description ptp Configure PTP log announce int erval Set the logarithm to the base 2 of the mean AnnounceInterval inte...

Page 50: ...onfiguration command on the device server to set the log min pdelay req interval parameter Commands ptp log min pdelay req interval interval Syntax Description ptp Configure PTP log min delay re q int...

Page 51: ...iority1 Use the ptp priority1 configuration command on the device server to set the priority1 parameter of the local clock Commands ptp priority1 priority Syntax Description ptp Configure PTP priority...

Page 52: ...to enable loop protection Commands loopprotection no loopprotection Syntax Description loopprotection Enable loop protection Defaults N A Permission Admin group Usage Guidelines N A Examples NPORT S9...

Page 53: ...qos mapping cos to queue 7 3 NPORT S9650I 16 2HV config qos mapping dscp to cos 23 7 2 2 90 account add To configure the user account name and its group to log in to this device Commands account add n...

Page 54: ...racters Examples Model config account edit name Tom group guests Model config account edit name Tom old_password 12345 new_password 13579 2 2 92 system log system To configure which events will be log...

Page 55: ...ure SysLog Server Settings Examples Model config system log network local Model config no system log network remote 2 2 94 system log config To configure which events will be logged locally and or rem...

Page 56: ...onfig system log opmode local Model config no system log opmode remote 2 2 96 reset button To configure the reset button auto disable after device bootup Commands reset button no reset button Syntax D...

Page 57: ...Ethernet Interface Commands From the CLI root use configure command to enter configure mode then input interface Ethernet command to enter the Ethernet interface folder 2 3 1 1 email warning event Us...

Page 58: ...o 100 duration 1 to 300 link All link events Defaults All interface events are disabled by default Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config interface ethernet 3...

Page 59: ...own To disable an interface use the shutdown interface configuration command To restart a disabled interface use the no form of this command Commands shutdown no shutdown Syntax Description shutdown S...

Page 60: ...Full Auto Speed Auto Defaults The default is Auto Permission Admin group Usage Guidelines N A Examples NPORT S9650I 16 2HV config interface ethernet 1 1 NPORT S9650I 16 2HV config if speed duplex 100M...

Page 61: ...ss vlan interface configuration command on the device server to configure a port as a static access or dynamic access port If the switchport mode is set to access the port operates as a member of the...

Page 62: ...Ns that is VLAN IDs 1 to 4094 Examples NPort S9650I 16 2HV config if switchport trunk fixed vlan add 1 3 5 7 2 3 1 12 switchport trunk fixed vlan remove Use the switchport trunk fixed vlan remove conf...

Page 63: ...1 to 4094 Examples NPort S9650I 16 2HV config if switchport trunk forbidden vlan add 1 3 5 7 2 3 1 14 switchport trunk forbidden vlan remove Use the switchport trunk forbidden vlan remove configurati...

Page 64: ...elines You can only use this command mode for configuring normal range VLANs that is VLAN IDs 1 to 4094 Examples NPort S9650I 16 2HV config if switchport trunk native vlan 2 2 3 1 16 switchport pvlan...

Page 65: ...n group Usage Guidelines You can only use this command mode for configuring normal range VLANs that is VLAN IDs 1 to 4094 Examples NPort S9650I 16 2HV config if switchport hybrid forbidden vlan add 1...

Page 66: ...You can only use this command mode for configuring normal range VLANs that is VLAN IDs 1 to 4094 Examples NPort S9650I 16 2HV config if switchport hybrid forbidden vlan remove 1 3 5 7 2 3 1 20 switch...

Page 67: ...d on the device server to enable port 802 1x authenticate Use the no form of this command to return to the default setting Commands dot1x auth no dot1x auth Syntax Description dot1x 802 1x setting aut...

Page 68: ...e CLI root directory use the configure command to enter configure mode and use the interface mgmt command to enter the VLAN configure folder In this folder user could set all LAN management settings 2...

Page 69: ...0I 16 2HV config interface mgmt NPORT S9650I 16 2HV config vlan ip default gateway 192 168 1 1 2 3 2 3 ip name server Use the ip name server VLAN configuration command on the device server to configur...

Page 70: ...vlan 1 2 3 2 5 access ip Use access ip in the configuration command as to restrict access to the serial to specified IP addresses Use the no form of this command to disable this feature or to remove t...

Page 71: ...event dcd changed dsr changed Syntax Description email warning Configure email warning event Port events dcd changed DCD changed dsr changed DSR changed Defaults All serial port events are disabled b...

Page 72: ...serif baud rate 9600 2 3 3 4 parity To configure the serial parity for specified serial port Commands parity none odd even mark space Syntax Description parity Configure parity for serial port Defaul...

Page 73: ...mmands flowcontrol none rtscts xonxoff Syntax Description flowctrl Configure flow control for serial port Defaults The default is rtscts Permission Admin group Usage Guidelines N A Examples NPort S965...

Page 74: ...S9650I 16 2HV config interface serial 1 NPort S9650I 16 2HV config serif port type 485 2w 2 3 3 10 opmode To configure the operation mode for specified serial port Commands opmode disable realcom rfc...

Page 75: ...ta or stop send this setting only work when max connection is not 1 allow driver ctrl Allow driver control determines how the port will proceed if driver control commands are received from multiple ho...

Page 76: ...ice server will wait for a response to keep alive packets before closing the TCP connection tcp port This is the TCP port number assignment for the serial port on the device server Defaults The defaul...

Page 77: ...ting only work when max connection is not 1 allow driver ctrl Allow driver control determines how the port will proceed if driver control commands are received from multiple hosts that are connected t...

Page 78: ...e are any remote sides happen connection problem the device should ignore these sides and keep send serial to Ethernet data or stop send dest ip1 1st destination IP address specifies an IP address all...

Page 79: ...s 4 blank Destination port 4 4001 Designated local port 1 5011 Designated local port 2 5012 Designated local port 3 5013 Designated local port 4 5014 Connection control Startup None Permission Admin g...

Page 80: ...ort to connect to dest ip4 begin 4th start ranges of IP addresses for the serial port to connect to dest ip4 end 4th end ranges of IP addresses for the serial port to connect to dest port1 1st destina...

Page 81: ...ation Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config interface serial 1 NPort S9650I 16 2HV config serif dnp3 mode master 2 3 3 17 dnp3 raw socket To configure the par...

Page 82: ...ve Inter frame dela y Set the inter frame delay of the serial port Only valid when connected dev is RTU slave Designated tcp p ort Set the designated TCP port of the serial port Only valid when connec...

Page 83: ...this value must be disable deli2 char To configure the delimiter 2 character this function could be set only when deli1 char was set process The delimiter proces determines how the data is handled wh...

Page 84: ...nt Port events dcd changed DCD changed dsr changed DSR changed Defaults All serial port events are disabled by default Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config i...

Page 85: ...To configure the send TCP exception of the Modbus Commands send tcp exception no send tcp exception Syntax Description send tcp excepti on Configure enable or disable send TCP exception for the Modbu...

Page 86: ...dbus NPort S9650I 16 2HV config modbus tcp response timeout 3000 2 3 4 5 sid map To display the slave id mapping table of the Modbus protocol Commands sid map Syntax Description sid map To configure t...

Page 87: ...ave id mapping of Modbus mode remote ip The desination is Modbus tcp IP address remote tcp port The remote TCP port sid start Set the mapping start slave id sid end Set the mapping end slave id Defaul...

Page 88: ...ssion Admin group Usage Guidelines Ip address IPv4 address Tcp port 1 65535 slave id start slave id end 1 255 Channel index 1 n Examples NPort S9650I 16 2HV config interface serial protocol modbus NPo...

Page 89: ...protocol modbus NPort S9650I 16 2HV config modbus sid map Slave ID Map Channel number Type Definition Modbus Address Range 1 Modbus Serial Port 1 00001 00005 2 Modbus Serial Port 2 00006 00010 3 Modb...

Page 90: ...age Guidelines tcp port 1 65535 Examples NPort S9650I 16 2HV config interface serial protocol dnp3 NPort S9650I 16 2HV config dnp3 listen port 20001 2 3 5 2 address table To configure the address tabl...

Page 91: ...nfigure the address table of DNP3 mode remote ip The destination is tcp remote tcp port Remote side TCP port addr start Set the start address addr end Set the end address Defaults N A Permission Admin...

Page 92: ...sion Admin group Usage Guidelines Ip adddress IPv4 address tcp port 1 65535 address 1 to 65519 Examples NPort S9650I 16 2HV config interface serial protocol dnp3 NPort S9650I 16 2HV config dnp3 addres...

Page 93: ...DNP3 channel id Defaults N A Permission Admin group Usage Guidelines N A Examples NPort S9650I 16 2HV config interface serial protocol dnp3 NPort S9650I 16 2HV config dnp3 address table Address table...

Reviews: