ePMP CLI User Guide v3.4.1 PDF
ePMP CLI User Guide v3.4.1 PDF
ePMP CLI User Guide v3.4.1 PDF
User Manual
Firmware version 3.4.1
ePMP Command Line Interface User Manual
Table of Contents
1 Introduction ...................................................................................................................................... 3
1.1 Purpose................................................................................................................................ 3
1.2 Command Line Access ........................................................................................................ 3
1.3 Command usage syntax ...................................................................................................... 3
1.4 Basic information ................................................................................................................. 3
1.4.1 Context sensitive help .......................................................................................................... 3
1.4.2 Auto-completion ................................................................................................................... 3
1.4.3 Movement keys .................................................................................................................... 3
1.4.4 Deletion keys ....................................................................................................................... 4
1.4.5 Escape sequences .............................................................................................................. 4
2 Command Line Interface Overview ............................................................................................... 5
2.1 Reference list of commands ................................................................................................ 5
3 Configuration ................................................................................................................................... 8
3.1 Example 1: Changing device IP address in Bridge mode ................................................... 8
3.2 Example 2: Creating/Modifying MIR Profile ......................................................................... 8
4 Reference list of Configuration parameters ................................................................................. 9
Page 2 of 28
ePMP Command Line Interface User Manual
1 INTRODUCTION
1.1 Purpose
Access to command line is provided via SSH protocol version 2. To access CLI you can use the
following identity:
• ADMINISTRATOR (default username/password “admin”), who has full read and write permission.
For every command in this document you can find a usage syntax. In command usage syntax,
anything in a normal text font is required text. Anything in a boldface font is a flag or a subcommand.
Anything underlined is a user-specified argument such as a filename.
Any argument surrounded by brackets is considered to be optional. For example, [ filename ] would
indicate an optional filename argument.
Anything in angle brackets < > means the option is required.
To display the context sensitive help you can use the question mark sign on your keyboard - [?].
Help will provide you either a list of possible command completions with summaries, or the full
syntax of the current command. A subsequent repeat of this key, when a command has been
resolved, will display a detailed reference.
1.4.2 Auto-completion
The following keys both perform auto-completion for the current command line. If the
command prefix is not unique then the bell will ring and a subsequent repeat of the key will
display possible completions.
[enter] - Auto-completes, syntax-checks then executes a command. If there is a syntax error
then offending part of the command line will be highlighted and explained.
[space] - Auto-completes, or if the command is already resolved inserts a space.
Page 3 of 28
ePMP Command Line Interface User Manual
Page 4 of 28
ePMP Command Line Interface User Manual
Command Description
config apply Apply configuration
config set <table> <row> <parameter> Set <parameter> with <value> inside <table>,
<value> row <row>
config show Show running configuration
linktest <mac> [-t time] [-s size] Run link test for specific <mac> and time/packet
[-f force antenna] size.
The following options are available for
controlling the antenna usage during the link
test:
0 - Auto,
1 - Force Sector Antenna,
2 - Force Smart Antenna
Page 5 of 28
ePMP Command Line Interface User Manual
reboot Reboot
Page 6 of 28
ePMP Command Line Interface User Manual
Page 7 of 28
ePMP Command Line Interface User Manual
3 CONFIGURATION
In order to configure ePMP via command line interface there is a subset of “config” commands:
Command Description
config apply Apply configuration
config set <table> <row> <parameter> Set <parameter> with <value> inside
<value> <table>, row <row>
config show Show running configuration
In order to change device IP address in bridge mode the following commands should be used:
>config set networkBridgeIPAddr 192.168.0.100
>config save
>config apply
In order to create or modify existing first MIR profile the following commands should be used:
>config set wirelessMIRProfileTable 1 wirelessMIRProfileNumber 1
>config set wirelessMIRProfileTable 1 wirelessMIRProfileDescription 10Mbps
>config set wirelessMIRProfileTable 1 wirelessDLMIR 10000
>config set wirelessMIRProfileTable 1 wirelessULMIR 1000
>config save
>config apply
Page 8 of 28
ePMP Command Line Interface User Manual
Page 9 of 28
ePMP Command Line Interface User Manual
Page 10 of 28
ePMP Command Line Interface User Manual
Page 11 of 28
ePMP Command Line Interface User Manual
Page 12 of 28
ePMP Command Line Interface User Manual
Device Allocation:SM
mgmtVLAN
mgmtVLANEnable "Management VLANs State:
0 - Disable,
1 - Enable
Device Allocation:AP, SM"
mgmtVLANVID "Management VLAN ID
Device Allocation:AP, SM"
mgmtVLANVP "Management VLAN VP
Device Allocation:AP, SM"
dataVLAN
dataVLANEnable "Data VLANs State:
0 - Disable,
1 - Enable
Device Allocation:SM"
dataVLANVID "Data VLAN ID
Device Allocation:SM"
dataVLANVP "Data VLAN VP
Device Allocation:SM"
mcastVLAN
mcastVLANEnable "Multicast VLAN State:
0 - Disable,
1 - Enable
Device Allocation:SM"
mcastVLANVID "Multicast VLAN ID
Device Allocation:SM"
mcastVLANVP "Multicast VLAN VP
Device Allocation:SM"
networkBridge
networkBridgeIPAddressMode "Device Bridge IP Address Mode
1 - Static,
2 - DHCP
Device Allocation:AP, SM"
networkBridgeIPAddr "Device Bridge IP Address
Device Allocation:AP, SM"
networkBridgeNetmask "Device Bridge IP Subnet Mask
Device Allocation:AP, SM"
networkBridgeGatewayIP "Device Bridge Gateway IP Address
Device Allocation:AP, SM"
networkBridgeDNSIPAddr "Device Bridge DNS Server IP Address
Device Allocation:AP, SM"
networkBridgeMTU "Device Bridge MTU size
Device Allocation:AP, SM"
networkBridgeDNSIPAddrPrimary "Device Bridge DNS Server IP Address
Device Allocation:AP, SM
Primary Server IP"
networkBridgeDNSIPAddrSecondary "Device Bridge DNS Server IP Address
Device Allocation:AP, SM
Secondary Server IP"
networkMode "SM Network Mode:
Page 13 of 28
ePMP Command Line Interface User Manual
1 - NAT,
2 - Bridge,
3 - Router
Device Allocation:SM"
networkSTP "Spanning Tree Protocol:
0 - Disable STP (Default mode)
1 - Enable STP
Device Allocation:AP, SM"
networkPortSecurity "LAN Port Security switch:
0 - Disable
1 - Enable
Device Allocation:SM"
networkPortSecurityMax "Number of secure MAC addresses:
1-254 - Fixed Learned MAC limit
Device Allocation:SM"
networkPortSecurityAgingTime "Security MAC address aging time:
This prameter indicates on how long to store learned
MAC address in the cache in seconds,
0 - do not delete MAC address from the buffer,
Default - is 300 seconds.
Device Allocation:AP, SM"
mcastGroupLimit "Multicast Group Limit:
Default - is 3 Multicast Groups.
Device Allocation:SM"
snmp
snmpReadOnlyCommunity "SNMP read-only community name
Device Allocation:AP, SM"
snmpReadWriteCommunity "SNMP read-write community name
Device Allocation:AP, SM"
snmpSystemName "SNMP System Name
Device Allocation:AP, SM"
snmpSystemDescription "SNMP System Description
Device Allocation:AP, SM"
snmpTrapEnable "SNMP Trap Support Enable
0 - Disable,
1 - Enable
Device Allocation:AP, SM"
snmpTrapCommunity "SNMP Trap Community
Device Allocation:AP, SM"
snmpTrapTable "SNMP Trap Servers Table
Device Allocation:AP, SM"
snmpTrapEntry "SNMP Trap Table Entry
Device Allocation:AP, SM"
snmpTrapEntryIndex "SNMP Trap Server IP Table Index
Table Entry is cleared if Index is set to zero
Device Allocation:AP, SM"
snmpTrapEntryIP "SNMP Trap Server IP Address
Device Allocation:AP, SM"
snmpTrapEntryPort "SNMP Trap Server Port Number
Device Allocation:AP, SM"
snmpDomainAccessEnable "SNMP Access Domain Enable
Page 14 of 28
ePMP Command Line Interface User Manual
0 - Disable,
1 - Enable
Device Allocation:AP, SM"
snmpDomainAccessIP "SNMP Access Domain IP Address
Device Allocation:AP, SM"
snmpDomainAccessIPMask "SNMP Access Domain IP Mask
Device Allocation:AP, SM"
cambiumSystem
systemConfig
systemConfigTimezone "Time Zone
Device Allocation:AP, SM"
systemConfigDeviceName "SM Device Name
Device Allocation:AP, SM"
systemConfigETSILicense "ETSI Country Code.
Set the country code using license key on AP. Visit
Cambium Webserver
to get the license key. The country code set in
license key will
be used to set country code on AP if the key
validation pass. This
parameter is for AP only.
Device Allocation:AP"
systemDeviceLocLatitude "Device GPS Location Latitude.
Coordinates of device in (h ddd.ddddd) format.
Used to display location at Google Maps service.
Device Allocation:AP, SM"
systemDeviceLocLongitude "Device GPS Location Longitude.
Coordinates of device in (h ddd.ddddd) format.
Used to display location at Google Maps service.
Device Allocation:AP, SM"
systemDeviceLocHeight "Device GPS Location Longitude.
Altitude of device above/below mean sea level.
Device Allocation:AP, SM"
cambiumTelnetServerEnable Cambium Telnet Server:
0 - Disable,
1 - Enable
Device Allocation:AP, SM
networkMACTELNET Enable MAC-Telnet Service
0 - Disable,
1 - Enable
Device Allocation:AP,SM
networkMACTELNETProto MAC-Telnet Service Protocol
1 - MAC-Telnet
2 - MAC-SSH
Device Allocation:AP,SM
networkNATPMP Enable NAT-PMP on SM in NAT mode
0 - Disable,
1 - Enable
Device Allocation:SM
systemConfigFactoryResetKeepPwd Keep Passwords after Factory Default
0 - Disabled
Page 15 of 28
ePMP Command Line Interface User Manual
1 - Enabled
Device Allocation:AP, SM
systemConfigIPv6Support Systemwide IPv6 support.
Enables Systemwide IPv6 support:
0 - IPv6 Support Disabled,
1 - IPv6 Support Enabled,
Device Allocation:AP, SM
systemConfigMinAntGain Return Minimum allowed Antenna Gain.
Device Allocation:AP, SM
systemNtpServer
systemNtpServerIPMode "NTP Server IP Address receive mode
1 - Static,
2 - DHCP
Device Allocation:AP, SM"
systemNtpServerPrimaryIP "NTP Server 1 IP Address
Device Allocation:AP, SM"
systemNtpServerSecondaryIP "NTP Server 2 IP Address
Device Allocation:AP, SM"
cambiumWebServer
webService "Web Service
1 - HTTP,
2 - HTTPS
Device Allocation:AP, SM"
httpPort "HTTP Port
Device Allocation:AP, SM"
httpsPort "HTTPs Port"
wireless
wirelessDevice
wirelessDeviceCountryCode "Country Code.
If US Lock SKU, this is US and cannot be changed.
If not locked, for 9350, it will be None, for 9344, it
will be Follow AP CC.
When user change CC at SM, the SM Scan Frequency
Type will be FA
Device Allocation:AP"
wirelessType "Wireless type:
1 - tdd driver,
2 - 80211 (aquila) driver
Device Allocation:AP, SM"
wirelessDefaultCountryCode "Default Country Code."
wirelessAPForcedSector Enable/Disable Forcing of Sector/Smart Antenna for
all SMs.
0 - auto mode (default)
1 - force sector antenna
2 - force Smart antenna
Device Allocation:AP
wirelessSTAForcedSector Enable/Disable Forcing of Sector/Smart Antenna for
current SM.
0 - auto mode (default)
1 - force sector antenna
Page 16 of 28
ePMP Command Line Interface User Manual
Page 17 of 28
ePMP Command Line Interface User Manual
Device Allocation:AP"
wirelessInterfacePTPMACAddress "PTP MAC Address
Device Allocation:AP"
wirelessInterfaceSyncSource "1PPS Sync Source
1 - GPS,
2 - CMM,
3 - Internal Free Run
Device Allocation:AP"
wirelessInterfaceSyncHoldTime "GPS Sync Hold Time in seconds
Device Allocation:AP"
wirelessInterfaceScanFrequencyListTwenty "Scan Frequency List for 20 MHz
Device Allocation:SM"
wirelessInterfaceScanFrequencyListForty "Scan Frequency List for 40 MHz
Device Allocation:SM"
centerFrequency "Per freq band:5725 GHz for 5G SKU, 2412 for 2.4G
SKU
Device Allocation:AP"
dfsAlternative1CenterFrequency "Per freq band
Device Allocation:AP"
dfsAlternative2CenterFrequency "Per freq band
Device Allocation:AP"
wirelessMaximumCellSize "Maximum Cell Size in units
wirelessCellSizeUnit defines the unit type:
1 - Miles
2 - Kilometers
Device Allocation:AP"
wirelessCellSizeUnit "Maximum Cell Size units:
1 - Miles
2 - Kilometers
Device Allocation:AP"
wirelessMaximumSTA "Maximum Number of SM
Device Allocation:AP"
dfsAlternative1Bandwidth "Frequency Bandwidth
1 - 20Mhz,
2 - 40Mhz,
3 - 10Mhz,
4 - 5Mhz,
Device Allocation:AP"
dfsAlternative2Bandwidth "Frequency Bandwidth
1 - 20Mhz,
2 - 40Mhz,
3 - 10Mhz,
4 - 5Mhz,
Device Allocation:AP"
wirelessAcceptableAPRSSIThreshold "AP RSSI Threshold
Device Allocation:SM"
wirelessAcceptableAPCINRThreshold "AP CINR Threshold
Device Allocation:SM"
wirelessInterfaceUnblockUSfreqs "Block US 5.2 and 5.4 bands
5.2 and 5.4 bands are blocked until DFS certification
is acheived
Page 18 of 28
ePMP Command Line Interface User Manual
Page 19 of 28
ePMP Command Line Interface User Manual
Page 20 of 28
ePMP Command Line Interface User Manual
Device Allocation:AP, SM
apWiFiCompWDSTrBridge AP Wi-Fi WDS Transparent bridge mode
Compatibility mode for Ubiquiti WDS Transparent
bridge
and Mikrotik station WDS
0 - Disabled,
1 - Enabled
Device Allocation:AP
wirelessMACFilter Enable/Disable MAC list filter
0 - Disabled,
1 - Enabled
Device Allocation:AP
wirelessMACFilterPolicy Permit/Prevent policy for MAC list
1 - Prevent
2 - Permit
Device Allocation:AP
apWiFiDLCTSMode Force AP WiFi to enable Self CTS
0 - Disabled,
1 - Enabled
Device Allocation:AP
apWiFiRTSThreshold Wi-Fi interface RTS Threshold
Device Allocation:AP, SM
apWiFiULCTSRTSMode Force AP WiFi to add ERP IE to the Beacon
0 - Disabled,
1 - Enabled
Device Allocation:AP
wirelessAPWifiWLANmode AP Wi-Fi WLAN mode (short, 1000m operational
distance)
0 - Disabled,
1 - Enabled
Device Allocation:AP
wirelessPrefList
prefferedAPTable "Preffered AP Table
Device Allocation:SM"
prefferedAPEntry "Preffered SSID Table Entry
Device Allocation:SM"
prefferedListTableEntryIndex "Preferred AP Table Index
Table Entry is cleared if Index is set to zero
Device Allocation:SM"
prefferedListTableEntrySSID "Preferred AP SSID
Device Allocation:SM"
prefferedListTableEntryKEY "Preferred AP Shared Key
Device Allocation:SM"
prefferedListTableSecurityMethod "Authentication modes to connect to AP
Device Allocation:SM
Use bitmask to enable pereferred methods, 0 -
means enable method:
set 0-th bit to 0 - Open method (110b)
set 1-st bit to 0 - WPA2 method (101b)
set 2-nd bit to 0 - EAP-TTLS method (011b)
0x00 - All enabled"
Page 21 of 28
ePMP Command Line Interface User Manual
wirelessMIRList
wirelessMIRProfileTable "Maximum Information Rate (MIR) Limiting profile
Table
Device Allocation:AP"
wirelessMIRProfileEntry "Maximum Information Rate (MIR) Limiting profile
Table Entry
Device Allocation:AP"
wirelessMIRProfileIndex "Maximum Information Rate (MIR) Limiting profile
Number
Device Allocation:AP"
wirelessMIRProfileNumber "Number of MIR profile
Device Allocation:AP"
wirelessMIRProfileDescription "MIR profile description
Device Allocation:AP"
wirelessDLMIR "DL MIR in kilobits per second
Device Allocation:AP"
wirelessULMIR "UL MIR in kilobits per second
Device Allocation:AP"
wirelessRadius
wirelessRadiusTimeout "RADIUS server response timeout
Device Allocation:AP"
wirelessRadiusRetry "RADIUS server retry
Device Allocation:AP"
wirelessRadiusGUIUserAuth "GUI User Authentication Option
Device Allocation:AP"
wirelessRadiusCurrentGUIUserAuth "Current GUI User Authentication Option
Device Allocation:SM"
wirelessRadiusSeverInfo "RADIUS server info
Device Allocation:SM"
wirelessRadiusIdentityStr "Authentication Identity String
Device Allocation:SM"
wirelessRadiusIdentityRealm "Authentication Identity Realm
Device Allocation:SM"
wirelessRadiusUsername "Authentication Username
Device Allocation:SM"
wirelessRadiusPassword "Authentication Password
Device Allocation:SM"
wirelessRadiusServerList
wirelessRadiusServerTable "RADIUS servers table
Device Allocation:AP"
wirelessRadiusServerEntry "RADIUS servers table entry
Device Allocation:AP"
wirelessRadiusServerIndex "RADIUS servers limiting number
Device Allocation:AP"
wirelessRadiusServerIP "RADIUS server IP address
Device Allocation:AP"
wirelessRadiusServerPort "RADIUS server port
Device Allocation:AP"
wirelessRadiusServerSecret "RADIUS server port
Device Allocation:AP"
useMACAddressAsWirelessRadiusUsername For using an Ethernet MAC address instead of
Page 22 of 28
ePMP Command Line Interface User Manual
RADIUS username
0 - Off (default),
1 - using ':' as format,
2 - using '-' as format
Device Allocation:SM
wirelessRadiusCertificateList
wirelessRadiusCertificateListRow1
wirelessRadiusUseDefCertificate "RADIUS default certificate use
Device Allocation:SM"
wirelessRadiusDefCertificateView "RADIUS default certificate view
Device Allocation:AP"
wirelessRadiusCertificateListRow2
wirelessRadiusUser1CertificateName "First user RADIUS certificate name
Device Allocation:AP"
wirelessRadiusUser1CertificateView "First user RADIUS certificate view
Device Allocation:AP"
wirelessRadiusCertificateListRow3
wirelessRadiusUser2CertificateName "Second user RADIUS certificate name
Device Allocation:AP"
wirelessRadiusUser2CertificateView "Second user RADIUS certificate view
Device Allocation:AP"
wirelessRadiusCertificateSet
wirelessRadiusDefaultCertificate "Default RADIUS certificate
Device Allocation:SM"
wirelessRadiusUser1Certificate "Default RADIUS certificate
Device Allocation:SM"
wirelessRadiusUser2Certificate "Default RADIUS certificate
Device Allocation:SM"
wirelessRadiusUseDefaultCertificate "RADIUS default certificate use
Device Allocation:SM"
wirelessRadiusExtraCertificateSet
wirelessRadiusPMP320Certificate "PMP320 RADIUS certificate
Device Allocation:SM"
wirelessRadiusUsePMP320Certificate "RADIUS PMP320 certificate use
Device Allocation:SM"
wirelessRadiusPMP450Certificate "PMP450 RADIUS certificate
Device Allocation:SM"
wirelessRadiusUsePMP450Certificate "RADIUS PMP450 certificate use
Device Allocation:SM"
l2Firewall
l2FirewallEnable "L2 ACL Status Flag:
0 - Disable,
1 - Enable.
Device Allocation:AP, SM"
l2FirewallTable "Table for L2 ACL
Device Allocation:AP, SM"
l2FirewallEntry "L2 ACL Table Entry
Device Allocation:AP, SM"
l2FirewallEntryIndex "L2 Firewall Table Index
Table Entry is cleared if Index is set to zero
Page 23 of 28
ePMP Command Line Interface User Manual
Page 24 of 28
ePMP Command Line Interface User Manual
Page 25 of 28
ePMP Command Line Interface User Manual
Page 26 of 28
ePMP Command Line Interface User Manual
Page 27 of 28
ePMP Command Line Interface User Manual
Device Allocation:SM"
mappingVLANEntry "Mapping VLAN Table Rule Entry
Device Allocation:SM"
mappingVLANTableEntryIndex "Mapping VLAN Table Entry Index
Table Entry is cleared if Index is set to zero
Device Allocation:SM"
mappingVLANTableEntryCVLAN "Mapping VLAN Table C-VLAN ID,
Defines VLAN ID to be mapped from CPE side.
Device Allocation:SM"
mappingVLANTableEntrySVLAN "Mapping VLAN Table S-VLAN ID,
Defines VLAN ID to be mapped from Service
provider.
Device Allocation:SM"
cnMaestro / CNS
cambiumDeviceAgentCNSURL cnMaestro URL:
This specifies the URL for accessing the cnMaestro
Cloud Manager
cambiumDeviceAgentEnable Remote Management:
0 - Disable
1 - Enable
Cambium provides cloud management of Cambium
devices called cnMaestro.
This allows a user to manage all of their various
Cambium devices via the web from any location in
the world.
This field enables this cnMaestro Cloud
Management.
Page 28 of 28