SCALANCE WLC711 CLI Reference Guide

Transcription

1 SCALANCE WLC711 CLI Reference Guide Release V C79000-G8976-C Published July 2015

2 Copyright SIEMENS AG All rights reserved. Warning Notice System This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger. If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage. Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems. Proper use of Siemens Products Note the following: Warning Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed. Trademarks All names identified by are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner. Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions. For information, contact: SIEMENS AG Industry Sector Postfach NÜRNBERG, GERMANY

3 Table of Contents Chapter 1: About This Guide...8 Who Should Use This Guide... 8 How to Use This Guide...8 Text Conventions...9 Chapter 2: Introduction to the CLI CLI Wizard...11 CLI Structure...13 Account Types...14 Chapter 3: Common Commands apply end exit...17 help logout no show Chapter 4: root Commands audit availability...25 backup no backup...28 copy host-attributes export...33 no export flash no flash healthpoll...36 import...36 key...37 loglevel ping radtest...39 radtest_mba...40 reset restart...41 restore...42 secureconnection...42 show...43 shutdown...75 tech_support traceroute...76 upgrade ac...77 upgrade apup...78 upgrade_backup_dest...79 SCALANCE WLC711 CLI Reference Guide 3

4 Table of Contents upgrade_image_src Chapter 5: ap Commands ap Context AP Common Commands Radio Commands DCS Commands Serial Commands Chapter 6: l2ports Commands esan jumbo-frames <named-lag-port> Chapter 7: ip Commands route ospf Chapter 8: login Commands apply auth auth-order move show Chapter 9: Radar Commands mitigator Context Common Scan Group/Profile Commands Chapter 10: mobility Commands backupmanagerip mrole mport mheartbeat slpreg agent secmode mdismethod mmanagerip Chapter 11: schedule_backup Commands destination dir freq password protocol server starttime type user Chapter 12: schedule_upgrade Commands schld_upgrd upgrade_backup SCALANCE WLC711 CLI Reference Guide 4

5 Table of Contents Chapter 13: snmp Commands contact context enable engine-id location port publish-ap rcommunity rwcommunity severity show trap-manager-v1v trap-manager-v user Chapter 14: syslog Commands audmsg facility stationevents svcmsg syslogip Chapter 15: time Commands clock date ntp ntpip tz Chapter 16: traffic_capture Commands file_name size interface delete list start stop show show interfaces Chapter 17: users Commands id pwd Chapter 18: VNS Commands (vnsmode) adminctr create das default-role delete nac SCALANCE WLC711 CLI Reference Guide 5

6 Table of Contents netflow-mirror radius rateprofile <named-vns> Common Filter Configuration Commands Chapter 19: wlans Commands clients create delete remote-ssid show <WLAN-service-name> Chapter 20: topology Commands create delete internal-vlanid multicast-support show <named-topology> topology-group Chapter 21: Location-Based-Service (lbs) Commands multicast port service server-ip show Related commands Chapter 22: web Commands guestportal-admin-timeout timeout showvns show Chapter 23: cos Commands create delete show <named-cos> Chapter 24: site Commands create delete show site <named-site> Chapter 25: RF Location Commands location-engine default-height auto-tracking SCALANCE WLC711 CLI Reference Guide 6

7 Table of Contents default-env-mode floor-plan on-demand publish show Chapter 26: Publish Commands push interval unit push-list SCALANCE WLC711 CLI Reference Guide 7

8 1 About This Guide Who Should Use This Guide How to Use This Guide Text Conventions The Command Line Interface (CLI) is used to configure the SCALANCE WLC711 and the SCALANCE W Controller Access Points. It is accessible directly on the controller's console port, or via Secure Shell (SSH) access on the ESA or Management ports. Who Should Use This Guide This guide is intended for system test, network administrators, and development engineers who understand all components of the SCALANCEWLC711. How to Use This Guide This guide contains the following chapters Introduction to the CLI on page 11 describes the overall context structure of the CLI. Common Commands on page 16 describes commands that appear within every context level of the CLI. root Commands on page 22 describes commands available from the root context of the Wireless Appliance. ap Commands on page 81 describes commands that manage the functions of Wireless APs on a system using the Wireless Appliance. l2ports Commands on page 158 describes commands to enable and disable L2 ports on the Wireless Controller. ip Commands on page 161 describes commands to configure routing information. login Commands on page 169 describes commands to configure the login authentication modes local authentication and RADIUS-based authentication. Radar Commands on page 175 describes configurable options for the detection of rogue Access Points, DoS attacks, and other potential network intrusion events. mobility Commands on page 198 describes commands to manage the exchange of client session information across a network. schedule_backup Commands on page 203 describes commands to schedule data backups. schedule_upgrade Commands on page 209 describes commands to configure scheduling an upgrade and back up of the controller s software. snmp Commands on page 212 describes commands to manage Simple Network Management Protocol (SNMP) settings for the Wireless Appliance. syslog Commands on page 220 syslog Commands, describes commands to configure System Log settings. SCALANCE WLC711 CLI Reference Guide 8

9 About This Guide Text Conventions time Commands on page 224 describes commands to set the system time for the Wireless Appliance, and configure network time protocol options. traffic_capture Commands on page 227 describes commands to manage the TCPDump. users Commands on page 232 describes commands used to manage user accounts on the network. VNS Commands (vnsmode) on page 234 VNS Commands (vnsmode), describes commands for the setup of virtual network services (VNS) for the network. wlans Commands on page 275 describes commands used to define and configure WLAN services for the network. role Commands describes commands used to define and configure policies for the Wireless Appliance. topology Commands on page 340 describes commands used to define and configure topology objects used by policy and VNS objects. Location-Based-Service (lbs) Commands on page 377 describes commands used to configure the Wireless APs for use with an AeroScout or Ekahau location-based service. web Commands on page 381 describes commands used to configure the web settings. cos Commands on page 384 describes commands for configuring Classes of Service that can be applied to policies. site Commands on page 392 describes commands for configuring sites that have their own local authentication server defined. RF Location Commands on page 409 describes commands used to enable and configure the Radio Frequency (RF) Location engine on a Wireless Appliance to determine location and perform tracking on wireless mobile users through Wireless APs. Publish Commands on page 415 describes commands used in the publish context. Related Documentation SCALANCE WLC711 documentation is available at: Keyboard Shortcuts There are several keyboard shortcuts available to assist in navigating within the contexts of the CLI. To display options within a context or to complete partial entries of commands at the prompt, use [CTRL] + I, [Tab], or the [?] key. To transpose mi--typed characters at the command prompt, use [CTRL] + T. To recall previous commands executed for the session, use the UP arrow. To cycle forward through previously executed commands, use the DOWN arrow. Text Conventions The following tables list text conventions that are used throughout this guide. SCALANCE WLC711 CLI Reference Guide 9

10 About This Guide Text Conventions Icon Notice Type Alerts you to... Notice Caution Warning Indicates that an unintended result or situation can occur if the relevant information is not taken into account. With a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken. Without a safety alert symbol, indicates that property damage can result if proper precautions are not taken. Indicates that death or severe personal injury may result if proper precautions are not taken. Danger Indicates that death or severe personal injury will result if proper precautions are not taken. Table 1: Text Conventions Convention Description Courier font Bold font Italic font Used for examples of information displayed on the screen. Courier font in italics indicates a user-supplied value, either required or optional. Indicates mandatory keywords, parameters or keyboard keys. Indicates complete document titles [ ] Square brackets indicate an optional value. { } Braces indicate required values. One or more values may be required. A vertical bar indicates a choice in values. [x y z] Square brackets with a vertical bar indicates a choice of a value. {x y z} Braces with a vertical bar indicate a choice of a required value. [x [x {y z}] A combination of square brackets with braces and vertical bars indicates a required choice of an optional value. The words enter and type [Key] names When you see the word enter in this guide, you must type something, and then press the Return or Enter key. Do not press the Return or Enter key when an instruction simply says type. Key names are written with brackets, such as [Return] or [Esc]. If you must press two or more keys simultaneously, the key names are linked with a plus sign (+). : Press [Ctrl]+[Alt]+[Del] SCALANCE WLC711 CLI Reference Guide 10

11 2 Introduction to the CLI CLI Wizard CLI Structure Account Types The commands of the CLI are structured in a hierarchical set of contexts. Each context contains commands which relate to a specific type of function. For example, the radio1 context is a set of commands available for configuring operational parameters on the Radio1 radio of an access point. To configure default Radio1 parameters for AP3710s, you must move down from the root context through the ap, default, ap37xx, radio1 contexts (ap:defaults:ap37xx:radio1) to reach, set, and apply those parameters. To configure Radio1 parameters for a specific access point for which you know the ID (serial number), move down from the root context through the ap, <serial>, and radio1 contexts (ap: :radio1). CLI Wizard The CLI wizard is designed to configure administrative settings on the controller. The CLI wizard begins automatically when a user with administrative access logs into the controller for the first time or when the system has been reset to the factory default. Instructions display when the wizard starts. Each screen in the wizard presents the default response in square brackets [ ]. You can exit the wizard by pressing [CTRL] + [C]. To complete the CLI wizard: 1 Press Enter to begin configuring the controller in the CLI wizard. The Change Admin Password screen appears. 2 Enter y to change the administrator password, otherwise enter n and press Enter. The Current Host Attribute Settings screen appears. 3 Enter y to change the host attributes, otherwise enter n and press Enter. You can change the following host attributes: Host Name - Management port's (Admin) hostname. Domain Name - Management port's (Admin) domain name. IP Address - Management port's (Admin) IP address. Netmask - Management port's (Admin) subnet mask. Gateway - Management port's (Admin) gateway. Primary DNS - Address of the Primary DNS. Secondary DNS - Address of the Secondary DNS. The Current Time Settings screen appears. SCALANCE WLC711 CLI Reference Guide 11

12 Introduction to the CLI CLI Wizard 4 Enter y to change the time settings, otherwise enter n and press Enter. Enter the appropriate continent code (the first letter of the country is in parentheses): Continent Code Africa (A-J) 0 Africa (K-W) 1 America (A-A) 2 America (B-D) 3 America (E-I) 4 America (J-M) 5 America (N-R) 6 America (S-Y) 7 Antarctica 8 Arctic 9 Asia (A-G) 10 Asia (H-O) 11 Asia (P-V) 12 Asia (Y-Y) 13 Atlantic 14 Australia 15 Europe (A-L) 16 Europe (M-U) 17 Europe (V-Z) 18 Indian (V-Z) 19 Pacific (A-N) 20 Pacific (P-W) 21 Select a city within the continent and country to configure the correct time zone for the controller. Enter the current date and time in the mm-dd-yyyy hh:mm format, where y = year, m = month, d = day, h = hour, m = minute. Enter the NTP server's IP address. You can designate up to three NTP servers. The Current SNMP Settings screen appears. 5 Enter the SNMP mode and press Enter. 0 = SNMP disabled. 1 = SNMPv1/v2c enabled. 2 = SNMPv3 enabled. Entering 1 or 2 requires additional SNMP configuration. The Current Data Plane Settings screen appears. SCALANCE WLC711 CLI Reference Guide 12

13 Introduction to the CLI CLI Structure 6 Enter y to change the port settings for a port on the controller, otherwise enter n and press Enter. Available port settings you can change include: The port's name. The port's IP address. The port's netmask. The port's VLAN ID. Whether or not the port's VLAN ID is tagged or untagged. Whether or not the port allows management traffic. The Controller Port Installation Configuration screen appears. 7 Change any of the settings you configured, or exit the wizard with or without saving by entering the corresponding number and pressing Enter. 1 - Return to the Change Admin Password screen from which you can change the administrator's password. 2 - Return to the Current Host Attribute Settings screen from which you can change the host attributes. 3 - Return to the Current Time Settings screen from which you can change the time zone, date, and time. 4 - Return to the Current SNMP Settings screen from which you can change the SNMP settings for the controller. 5 - Return to the Current Data Pkane Settings screen from which you can change the settings for individual ports on the controller. 6 - Save your changes and exit the wizard. 7 - Exit the wizard without saving your changes. The wizard is complete. For additional information about individual commands available in the CLI, refer to the following chapters in this reference guide. For additional information about configuration and setup information for both the wireless controller and APs, refer to the Wireless User Guide. Note Exiting the wizard without saving the changes results in the wizard being run the next time you access the controller. CLI Structure The following diagram shows the root context. Many of the commands move to a context (ap, topology) and some are commands that perform a system function (export, login). This kind of structure applies at every context level. SCALANCE WLC711 CLI Reference Guide 13

14 Introduction to the CLI Account Types Figure 1: CLI Root Structure Account Types Access to the CLI varies for two account types: "admin" and "user". The admin account provides administrator access to all the contexts and features in the CLI, while the user account provides no access to contexts and command availability is limited. The following example displays commands available in the root context for the admin account type. WLC.siemens.com# help Available commands are: ap availability copy external server. cos end exit export flash healthpoll host-attributes import file ip key l2ports lanset lbs login loglevel logout mitigator Modify Access Point settings Modify availability settings Transfer files between the controller and an Configure Controller cos settings Return to the base mode Return to the previous mode Export Controller data to a file Mount/Unmount flash drive Set healthpoll timeout Configure Controller host attributes settings Restore Controller data/configuration from Modify controller route Modify License Keys Configure Controller L2 Ports settings Set Ethernet link parameters Modify settings for AP location based service. Configure login settings. Set a log level Logout Modify Mitigator settings to assist in SCALANCE WLC711 CLI Reference Guide 14

15 Introduction to the CLI Account Types detection of rogue AP mobility no ping policy radtest Portal and EAP radtest_mba authorization reset restart schedule_backup schedule_upgrade secureconnection settings show shutdown site snmp syslog tech_support time topology traceroute traffic_capture upgrade software (APUP) upgrade_backup_dest upgrade_image_src upgrade is being users vnsmode Segment) settings web wlans Modify access controller mobility settings Clear the command setting Ping a host or gateway. Configure Controller policy settings Test Radius Server connectivity, Caotive authentication Test Radius Server connectivity and MAC-based Reset database configuration Restart a process Modify backup schedule. Scheduled upgrade Modify access controller secure connection Display settings Used to safely halt or reboot the controller Configure site settings Configure SNMP settings Change syslog settings Collect tech support data Configure network time for the Controller Configure Controller topology settings Traceroute a host or gateway. Traffic capture on interface Utility for upgrading AC software (AC), or AP Set ftp parameters for full disk clone backup Set location of upgrade image, if remote performed Change Controller user settings Modify Controller VNS(Virtual Network Modify web settings Configure WLAN Service settings SCALANCE WLC711 CLI Reference Guide 15

16 3 Common Commands apply end exit help logout no show The following commands are used universally throughout the CLI shell. apply Use the apply command, after a command or a series of commands have been executed, for the configuration of the Wireless Appliance to take affect. Unless otherwise noted, run the apply command for configuration changes to take effect. apply None s The following example disables the DNS server configuration. WLC.siemens.com.com:dns# no dns WLC.siemens.com:dns# apply end Use the end command to return to the base context. end None SCALANCE WLC711 CLI Reference Guide 16

17 Common Commands exit s The following example returns you to the base context from the ap:defaults context. WLC.siemens.com:ap:defaults# end WLC.siemens.com# exit Use the exit command to return to the previous context, or to exit the shell if you are in the base context. exit None s The following example exits a context and moves up one level to the previous context. WLC.siemens.com:policy:p1# exit WLC.siemens.com:policy# The following example exits the shell from the base context. WLC.siemens.com# exit help Use the help command to display available commands in a context, or obtain usage information for a specified command. help help command command Specifies the command for which you need usage information. s The following example displays the available commands in the ap:defaults context: WLC.siemens.com:ap:defaults# help Available commands are: 11n 4102 Modify 4102 ap defaults settings apply Commit AP default changes. assign Modify AP default VNS assignment settings SCALANCE WLC711 CLI Reference Guide 17

18 Common Commands help dualband end exit learnac logout no show std Modify dualband ap defaults settings Enable/disable learn on the AP. Clear the command setting Display settings Modify standard ap defaults settings The following example displays the usage information for the serial command: WLC.siemens.com:ap:# help serial Create a new AP entry Usage: serial <ap serial number> <name> <hardware type> <ap_role> [<description>] Usage: no serial <serial#> <hardware type> is one of: A2650e (Wireless AP2660 External) A2650i (Wireless AP2650 Internal) AP2605 (Wireless AP2605) AP2610 (Wireless AP2610 Internal) AP (Wireless AP Internal) AP2620 (Wireless AP2620 External) AP (Wireless AP External) AP2630 (Wireless AP2630 Internal) AP (Wireless AP Internal) AP2640 (Wireless AP2640 External) AP (Wireless AP External) AP (Wireless AP Internal) AP (Wireless AP Internal) AP (Wireless AP External) AP (Wireless AP External) AP3605 (Wireless AP3605 Internal) AP3610 (Wireless AP3610 Internal) AP (Wireless AP Internal) AP3620 (Wireless AP3620 External) AP (Wireless AP External) AP3630-NAM (Wireless AP3630-NAM Internal) AP3630-ROW (Wireless AP3630-ROW Internal) AP3630-ROW-1 (Wireless AP3630-ROW-1 Internal) AP3640-NAM (Wireless AP3640-NAM External) AP3640-ROW (Wireless AP3640-ROW External) AP3640-ROW-1 (Wireless AP3640-ROW-1 External) AP3660 (Wireless AP3660 External) AP (Wireless AP External) AP3705i (Wireless AP3705i Internal) AP3710e (Wireless AP3710e External) AP3710i (Wireless AP3710i Internal) AP3715e (Wireless AP3715e External) AP3715i (Wireless AP3715i Internal) AP3715i-1 (Wireless AP3715i-1 Internal) AP3765e (Wireless AP3765e External) AP3765i (Wireless AP3765i Internal) AP3767e (Wireless AP3767e External) AP3801i (Wireless AP3801i Internal) AP3805e (Wireless AP3805e External) AP3805i (Wireless AP3805i Internal) AP3825e (Wireless AP3825e External) SCALANCE WLC711 CLI Reference Guide 18

19 Common Commands logout AP3825i (Wireless AP3825i Internal) AP3865e (Wireless AP3865e External) AP3935e-JPN (Wireless AP3935e-JPN External) AP3935e-NAM (Wireless AP3935e-NAM External) AP3935e-ROW (Wireless AP3935e-ROW External) AP3935i-JPN (Wireless AP3935i-JPN Internal) AP3935i-NAM (Wireless AP3935i-NAM Internal) AP3935i-ROW (Wireless AP3935i-ROW Internal) AP3965e-JPN (Wireless AP3965e-JPN External) AP3965e-NAM (Wireless AP3965e-NAM External) AP3965e-ROW (Wireless AP3965e-ROW External) AP3965i-JPN (Wireless AP3965i-JPN Internal) AP3965i-NAM (Wireless AP3965i-NAM Internal) AP3965i-ROW (Wireless AP3965i-ROW Internal) AP4102 (Wireless AP4102) AP4102-EU (Wireless AP4102-EU) AP4102C (Wireless AP4102C) AP4102C-EU (Wireless AP4102C-EU) BP200e_3_P1 (Chantry BP200 R2.0.6 External P1) BP200e_3_P2 (Chantry BP200 R2.0.6 External P2) BP200e_4_P1 (Chantry BP200 R2.1 External P1) BP200e_4_P2 (Chantry BP200 R2.1 External P2) BP200i_3_P2 (Chantry BP200 R2.0.6 Internal P2) BP200i_4_P2 (Chantry BP200 R2.1 Internal P2) W786-2PROe (Scalance W786-2HPW-External) W786-2PROe-1 (Scalance W786-2HPW-External-1) W786-2PROe-2 (Scalance W786-2HPW-External-2) W786-2PROe_FO (Scalance W786-2HPW-External-FO) W786-2PROe_FO-1 (Scalance W786-2HPW-External-FO-1) W786-2PROe_FO-2 (Scalance W786-2HPW-External-FO-2) W786-2PROi (Scalance W786-2HPW-Internal) W786-2PROi-1 (Scalance W786-2HPW-Internal-1) W786-2PROi-2 (Scalance W786-2HPW-Internal-2) W786-2PROi_FO (Scalance W786-2HPW-Internal-FO) W786-2PROi_FO-1 (Scalance W786-2HPW-Internal-FO-1) W786-2PROi_FO-2 (Scalance W786-2HPW-Internal-FO-2) W786C-2-RJ45 (Scalance W786C-2-RJ45) W786C-2-SFP (Scalance W786C-2-SFP) W786C-2IA-RJ45 (Scalance W786C-2IA-RJ45) W788C-2-M12 (Scalance W788C-2-M12) W788C-2-RJ45 (Scalance W788C-2-RJ45) WB500 (Wireless WB500) logout Use the logout command to exit the shell immediately. logout None SCALANCE WLC711 CLI Reference Guide 19

20 Common Commands no s The following example exits the shell: WLC.siemens.com:topology:Admin:l3# logout no Use the no option to disable a function of a command. Use the command s syntax without the no form to enable it. The no option can also be used to delete settings or files when used with certain commands. Not all commands within the CLI include a no option. Syntax no None s The following example configures and displays a gateway IP address, then disables it with the no command and displays the change. WLC.siemens.com:topology:Admin:l3# gateway WLC.siemens.com:topology:Admin:l3# show gateway gateway WLC.siemens.com:topology:Admin:l3# no gateway WLC.siemens.com:topology:Admin:l3# show gateway no gateway show Use the show command to display the current configuration within a context. show None s The following example displays the DNS configuration. WLC.siemens.com:dns# show dns SCALANCE WLC711 CLI Reference Guide 20

21 Common Commands show dns dns SCALANCE WLC711 CLI Reference Guide 21

22 4 root Commands audit availability backup no backup copy host-attributes export no export flash no flash healthpoll import key loglevel ping radtest radtest_mba reset restart restore secureconnection show shutdown tech_support traceroute upgrade ac upgrade apup upgrade_backup_dest upgrade_image_src The root context of the CLI displays available commands relating to the Wireless Appliance s configuration, as well as available sub-contexts. All CLI commands cache changes. For this reason, sometimes when you make a change in a particular context, the change may not be visible immediately. If this happens, you must exit and re-enter the context in order to ensure that the database is synchronized with the latest change. SCALANCE WLC711 CLI Reference Guide 22

23 root Commands This chapter documents root context commands not associated with features documented in other chapters. See Table 2: Root Commands Documented in Feature Chapters on page 23 for a listing and description of root commands documented outside of this chapter. The following commands are available in the root context: availability on page 25 copy on page 28 host-attributes on page 31 export on page 33 no export on page 35 flash on page 35 no flash on page 36 healthpoll on page 36 import on page 36 key on page 37 lanset loglevel on page 38 ping on page 39 radtest on page 39 radtest_mba on page 40 reset on page 41 restart on page 41 secureconnection on page 42 show on page 43 shutdown on page 75 tech_support on page 75 traceroute on page 76 upgrade ac on page 77 upgrade apup on page 78 upgrade_backup_dest on page 79 upgrade_image_src on page 79 Table 2: Root Commands Documented in Feature Chapters Command ap cos exit Description The ap command moves you to the ap context of the CLI, providing access to commands required to manage the basic functions of the Wireless APs on the system. See ap Commands on page 81. The cos command moves you to the cos context, where you can configure Class of Service (CoS) settings to be applied to policies. See cos Commands on page 384. The exit command returns to the previous context or exits the shell if you are in the base context. See exit on page 17. SCALANCE WLC711 CLI Reference Guide 23

24 root Commands Table 2: Root Commands Documented in Feature Chapters (continued) Command ip l2ports login Description The ip command moves you to the ip context of the CLI, providing access to commands for the configuration of routing information. See ip Commands on page 161. The l2ports command moves you to the l2ports context of the CLI, providing access to commands for the enabling and disabling of ports. See l2ports Commands on page 158. The login command moves you to the login context of the CLI, providing access to commands for the configuration of the login authentication modes. See login Commands on page 169. logout The logout command exits the shell immediately. See logout on page 19. mitigator mobility policy schedule_backup schedule_upgrade site snmp syslog time topology The mitigator command moves you to the mitigator context of the CLI, providing commands that assist in the detection of network intrusion, including DoS attacks, rogue Access Points, and other forms of network intrusion. See Radar Commands on page 175. The mobility command moves you to the mobility context of the CLI, providing commands that configure the sharing and exchanging of client session information, which enables a wireless device to roam between Wireless APs on different SCALANCEWLC711 without service interruption. See mobility Commands on page 198. The policy command moves you to the policy context of the CLI, providing commands for the defining and configuring of policy for the SCALANCEWLC711. See role commands. The schedule_backup command moves you to the schedule_backup context of the CLI, providing commands for backup scheduling of software configurations, CDR, log, and audit. See schedule_backup Commands on page 203. The schedule_upgrade command moves you to the schedule_upgrade context of the CLI, providing commands for scheduling an upgrade and back up of the controller s software. See schedule_upgrade Commands on page 209. The site command moves you to the site context of the CLI, providing commands for configuration of sites that can perform autonomous local authentication. See site Commands on page 392. The snmp command moves you to the snmp context of the CLI, providing for the management of SNMP settings for the SCALANCEWLC711. See snmp Commands on page 212. The syslog command moves you to the syslog context of the CLI, providing for the configuration of system log settings on the SCALANCEWLC711. See syslog Commands on page 220. The time command moves you to the time context of the CLI, providing for synchronization network elements on the SCALANCEWLC711 to a universal clock using the SCALANCEWLC711 s own system time or the Network Time Protocol. See time Commands on page 224. The topology command moves you to the topology context of the CLI, providing for defining and configuration of topology objects used by policy and VNS objects. See topology Commands on page 340. SCALANCE WLC711 CLI Reference Guide 24

25 root Commands audit Table 2: Root Commands Documented in Feature Chapters (continued) Command Description traffic_capture users vnsmode web wlans The traffic_capture command moves you to the traffic_capture context of the CLI, providing for the management of the TCPDump. See traffic_capture Commands on page 227. The users command moves you to the users context of the CLI, providing for commands used to create and manage user accounts on the network. users Commands on page 232. The vnsmode command moves you to the vnsmode context of the CLI, providing for commands used to define and configure Virtual Network Services (VNS) for the network. See VNS Commands (vnsmode) on page 234. The web command moves you to the web context of the CLI, providing for commands to configure the web settings. See web Commands on page 381. The wlans command moves you to the wlans context of the CLI, providing for commands used to define and configure WLAN services for the network. See wlans Commands on page 275. audit The audit command is deprecated. availability Move to the availability context from the root context to access the following commands on the Wireless Appliance pair. The following commands are available in the availability context: pair on page 25 pairip on page 26 pairrole on page 26 fast_failover on page 27 link_timeout on page 27 sync-config on page 27 sync-mu on page 28 pair Use the pair command to set up two Wireless Appliances as a pair. Use the no form of the command to set up Wireless Appliances in stand-alone mode. pair A.B.C.D primary secondary SCALANCE WLC711 CLI Reference Guide 25

26 root Commands pairip A.B.C.D primary secondary Specifies the IP address of the peer Wireless Appliance in the availability pair. Specifies if the Wireless Appliance is the primary or secondary controller in the pair. s WLC.siemens.com:availability# pair primary pairip Use the pairip command to specify the backup of the Wireless Appliance's IP address. pairip A.B.C.D A.B.C.D Specifies the IP address of the peer Wireless Appliance in the availability pair. s The following example sets an IP address for the backup Wireless Appliance: WLC.siemens.com:availability# pairip pairrole Use the pairrole command to designate the Wireless Appliance as the primary connection point for availability Link Exchange or as the secondary point. When a Wireless Appliance is set as the secondary connection point, Wireless AP registration requests will be set to pending until the other Wireless Appliance is set up as the primary connection point. pairrole primary secondary primary secondary Assigns the primary connection point role. Assigns the secondary connection point role. s The following example sets the current Wireless Appliance to be the primary connection point: WLC.siemens.com:availability# pairrole primary SCALANCE WLC711 CLI Reference Guide 26

27 root Commands fast_failover fast_failover Use the fast_failover command to enable fast failover of the Wireless APs to the secondary controller in availability mode. Use the no form of the command to disable the fast failover feature. fast_failover no fast_failover None s WLC.siemens.com:availability# fast_failover link_timeout Use the link_timeout command to specify the time period in which the link failure between the Wireless APs and the primary controller in availability mode would be detected. link_timeout seconds seconds Specifies time period in seconds before link failure is detected. Valid values are 2 to 30 seconds. s The following example sets the time for link failure detection to 10 seconds: WLC.siemens.com:availability# link_timeout 10 sync-config Use the sync-config command to enable or disable synchronization of the configuration elements. sync-config enable disable enable disable Enable synchronization of the configuration elements. Disable synchronization of the configuration elements. The following example enables the synchronization of the configuration elements: WLC.siemens.com:availability# sync-config enable SCALANCE WLC711 CLI Reference Guide 27

28 root Commands sync-mu sync-mu Use the sync-mu command to enable or disable synchronization of the Guest Portal MU user accounts. sync-mu no sync-mu None. The following example enables the synchronization of the MU accounts: WLC.siemens.com:availability# sync-mu backup The backup command is deprecated. See export on page 33. no backup The no backup command is deprecated. See no export on page 35. copy Use the copy command to transfer files between the Wireless Appliance and an external server. Available filenames and platform information can be retrieved by invoking the respective show commands. For more information, see show on page 43. copy ap_certreq server user dir file copy apup server user dir file platform copy cdrs server user dir cdr_dir/file copy configuration to-local to-flash to-remote server user dir ftp password scp password from-local file #file from-flash file #file from-remote server user dir file ftp password scp password copy export server user dir file scp scp password copy floor-plan to-local from-local server user dir file ftp ftp_password scp scp password show copy import server user dir file scp scp password copy sensor tftp_server dir file AP26xx AP36xx copy tcpdump server user dir file #file copy tech_support server user dir file scp scp password copy upgrade server user dir file flash scp scp password SCALANCE WLC711 CLI Reference Guide 28

29 root Commands copy server user dir file platform cdr_dir/file #file scp scp password ftp password to-local to-flash to-remote from-local from-flash from-remote flash floor-plan show Specifies the IP address of the FTP or SCP server. The IP address can be either IPv4 A.B.C.D or IPv6 A:B:C:D:E:F:G:H format. Specifies the user name of an account on the FTP or SCP server. Specifies the name of a directory on the FTP or SCP server. Specifies the name of a file on the Wireless Appliance. Specifies the platform of the Wireless AP. Specifies the location of a file on the Wireless Appliance. The sequence in which the files are listed in the corresponding list. For more information, see list on page 229. Sets the file transfer protocol to SCP rather than the default setting of FTP. The scp password to use with scp for the ssh connection. The ftp password to use with ftp. Specifies the local drive as the location the configuration is copied to Specifies the flash drive as the location the configuration is copied to Specifies the configuration is copied to the specified device or server Specifies the configuration to be copied is located on the local drive Specifies the configuration to be copied is located on the flash drive Specifies the configuration to be copied is located on the specified remote device or server This option is available only when a flash device is plugged in Displays a list of all locally-stored floor plans s The following example copies the certificate request (.csr) file for a Wireless AP: WLC.siemens.com# copy ap_certreq jdoe /jdoe/orlandoap.csr The following command copies the Call Detail Records from the Wireless Appliance onto the specified server location: WLC.siemens.com.com# copy cdrs test mycdr wed/ dat Please input password: Attempting to upload file using ftp SUCCESS: Upload completed. The following command copies an upgrade image for the C25 platform from a server to the Wireless Appliance: WLC.siemens.com# copy apup test new/ap/ C25-0x.xx.xx.000x.img C25 Please input password: SCALANCE WLC711 CLI Reference Guide 29

30 root Commands copy Attempting to download file using ftp... SUCCESS: FTP Download completed. WLC.siemens.com# The following command copies the Wireless Appliance s upgrade image from a specific FTP server location onto the Wireless Appliance: WLC.siemens.com# copy upgrade test new/ac/rpm/ build AC-MV rue Please input password: Attempting to download file using ftp... SUCCESS: FTP Download completed. WLC.siemens.com# The following example copies the upgrade file to the flash device, mounted on the Wireless Appliance, from a specific FTP server: WLC.siemens.com# copy upgrade test new/ac/rpm/ build AC-MV rue flash Please input password: Attempting to download file using ftp... SUCCESS: FTP Download completed. WLC.siemens.com# In the following example, the CLI command states that the upgrade file will be downloaded from the SCP server to the flash card: WLC.siemens.com# copy upgrade test system/images AC- MV rue flash scp TestPassword In the following example, the CLI command states that the upgrade file will be downloaded from the SCP server to the Wireless Appliance local drive: WLC.siemens.com# copy upgrade test system/images AC- MV rue scp TestPassword The following example copies the TCPDump file to the FTP server: WLC.siemens.com# copy tcpdump mnj /TCPDump/April_2008 mgmt_traffic_capture.cap 1 The following example copies the fsh_1.zip configuration file located in the backup directory for user tester with password SECRET on the remote FTP server to the local drive: WLC.siemens.com# copy configuration to-local from-remote tester backup fsh_1.zip ftp SECRET The following example copies the my_conf.zip export file located on a flash drive to bak_dir directory of the remote SCP server for user tester with password SECRET: WLC.siemens.com# copy configuration to-remote tester bak_dir scp SECRET from-flash my_conf.zip SCALANCE WLC711 CLI Reference Guide 30

31 root Commands host-attributes The following example copies the local export file with index 2 to a flash drive: WLC.siemens.com# copy configuration to-flash from-local 2 The following example lists all locally-stored floor plans: WLC.siemens.com# copy floor-plan show Locally stored floor-plan files: 1. 1.fxml fxml fxml fxml 5. 12_export.fxml host-attributes Move to the host-attributes context from the root context to configure host attributes on the Wireless Appliance. The following commands are available in the host-attributes context: hostname on page 31 domain on page 31 dns on page 32 hostname Use the hostname command to configure a hostname for the controller. After you have run the hostname command, run the apply command to implement the changes. hostname name none name none Specifies the hostname of the controller. Removes the configured hostname. s The following example specifies that the host name of the controller should be 123. WLC.siemens.com:host-attributes# hostname 123 WLC.siemens.com:host-attributes# apply domain Use the domain command to configure the domain name for the controller. After you have run the domain command, run the apply command to implement the changes. SCALANCE WLC711 CLI Reference Guide 31

32 root Commands dns domain domain name none domain name none Specifies the domain name of the controller. Removes the configured domain name. s The following example specifies what the domain name of the controller: WLC.siemens.com:host-attributes# domain siemens.com WLC.siemens.com:host-attributes# apply dns Use the dns command at the host-attributes context to move into DNS server configuration context. The following commands are available in the host-attributes:dns context: dns on page 32 move on page 32 dns Use the dns command in the host-attributes:dns context to configure DNS servers for the controller. You can configure up to three DNS servers to resolve RADIUS server host names to their corresponding IP addresses. Use the no form of the command to remove a DNS server configuration. After you have run the dns command, run the apply command to implement the changes. dns 1-3 ip address no dns 1-3 ip address 1-3 Specifies the position of the DNS server in the DNS servers list. ip address Specifies the IP address of the DNS server. The IP address can be either IPv4 A.B.C.D or IPv6 A:B:C:D:E:F:G:H format. s The following example defines a DNS server, with a IP address, as the first DNS server: WLC.siemens.com:host-attributes:dns# dns move Use the move command in the dns context to reposition DNS servers in the DNS server list. After you have run the move command, run the apply command to implement the changes. SCALANCE WLC711 CLI Reference Guide 32

33 root Commands export move orig_index new_index orig_index new_index Specifies the current position of the DNS server that you want to reposition. Specifies the new position of the DNS server that you want to reposition. s The following example displays the current DNS server configuration: WLC.siemens.com:host-attributes:dns# show dns dns dns To move the DNS sever into the first position on the DNS servers list, use the following command: host-attributes:dns# move 3 1 The following displays the results of the previous move command: WLC.siemens.com:host-attributes:dns# show dns dns dns export Use the export command to export the controller s configuration, CDRs, logs and audit information, or all of them in a.zip file to either the local or flash drive. During the export process, the.zip file containing the controller's data is zipped. The exported file displays.zip extension. If you want to upload the controller s data to the FTP or SCP server, you must use the copy configuration command. For more information, see copy on page 28. export configuration cdrs all logs audit local flash configuration cdrs all logs audit local flash Exports the controller s configuration. Exports the controller s CDRs. Exports all of the following: controller s configuration, CDRs, logs, audit information. Exports the controller s logs. Exports the controller s audit information. Exports the specified data to the local drive. Exports the specified data to the flash drive. SCALANCE WLC711 CLI Reference Guide 33

34 root Commands export s The following command exports the controller s existing configuration in a.zip file: WLC.siemens.com# export configuration Filename (lab-91-f ): Comment: Please wait... CLI Export start: Mon Aug 16 11:05: CLI Export end: Mon Aug 16 11:05: Creating lab-91-f Backup/Export complete. The following example exports the controller s CDRs: WLC.siemens.com# export cdrs Filename (lab-91-f ): Comment: Please wait... Creating lab-91-f Backup/Export complete. The following example exports the controller s logs: WLC.siemens.com# export logs Filename (lab-91-f ): Comment: Please wait... Creating lab-91-f Backup/Export complete. The following example exports the controller s audit information: WLC.siemens.com# export audit Filename (lab-91-f ): Comment: Please wait... Creating lab-91-f Backup/Export complete. The following example exports all of the following: Configuration, CDRs, logs, audit information: WLC.siemens.com# export all Filename (lab-91-f ): Comment: Please wait... CLI Export start: Mon Aug 16 11:06: CLI Export end: Mon Aug 16 11:07: Creating lab-91-f Backup/Export complete. WLC.siemens.com# SCALANCE WLC711 CLI Reference Guide 34

35 root Commands no export no export Use the no export command to remove the specified export file from the local or flash drive. no export filename number filename number Specifies the file name of the export file to remove. If the export file is located on a flash drive, the string (flash) must be suffixed to the end of the specified file name. Specifies the index number of the export file on the list to remove. The following command removes the list index 2 file from the export list: WLC.siemens.com# no export 2 WLC.siemens.com# The following command removes the export_lab213_v4r1.7.10_namo_ent.zip export file from the export list: WLC.siemens.com# no export export_lab213_v4r1.7.10_namo_ent.zip WLC.siemens.com# flash Use the flash command to mount or dismount the flash device on the Wireless Appliance. flash mount unmount mount unmount Specifies to mount the flash device. Specifies to dismount the flash device. s The following example mounts the flash device on the Wireless Appliance: WLC.siemens.com# flash mount The following example dismounts the flash device from the Wireless Appliance: WLC.siemens.com# flash unmount SCALANCE WLC711 CLI Reference Guide 35

36 root Commands no flash no flash Use the no flash command to delete files on a flash device. The no flash command is under the root context. no flash file name The following example deletes the files from the flash device: WLC.siemens.com# no flash lab-91-f Successfully deleted file lab-91-f from flash healthpoll Use the healthpoll command to enable or disable the poll timer. healthpoll enable disable enable disable Enables the poll timer. Disables the poll timer. The following command enables the poll timer: WLC.siemens.com# healthpoll enable WLC.siemens.com# show healthpoll healthpoll enable import Use the import command to import the controller s configuration from a file that was earlier exported from a previous platform or an old software release. If you want to import the controller s data from a remote FTP or SCP server, you must use the copy configuration command. For more information, see copy on page 28. Use the no import command to remove the specified file from the local or flash drive. [no] import filename number SCALANCE WLC711 CLI Reference Guide 36

37 root Commands key filename number The name of the.zip or.cli file that contains the controller s configuration. If the export file is located on a flash drive, the string (flash) must be suffixed to the end of the specified file name. Specifies the index number of the import file. You can use the show import command to find the restore file s index number. s The following command imports the controller s configuration from a zipped.zip file that was exported from the previous platform or from the older software: WLC.siemens.com# import lab-213-g zip The following command removes the controller s import configuration, CDRS, logs, audit information file: WLC.siemens.com# no import lab-213-g zip key Move to the key: context to configure license key information for the Wireless Appliance. The key context has the following commands: activate on page 37 ecap on page 38 activate Use the activate command to apply a license key on the Wireless Appliance. The activate command is accessible from the key context of the CLI. activate activation-key activation-key Specifies the license key to be applied on the Wireless Appliance. The license key format is: AAAAAAA The following example applies a license key on the Wireless Appliance: WLC.siemens.com:key# activate ABCDEFG SCALANCE WLC711 CLI Reference Guide 37