D-Link DWL-x600AP User Manual

CLI Command Reference

Product Model: DWL-x600AP Unified Wired and Wireless Access System

November 2011

D-Link UWS CLI Command Reference

Reproduction in any manner whatsoever without the written permission of D-Link Computer Corporation is strictly forbidden.

Trademarks used in this text: D-Link and the D-Link logo are trademarks of D-Link Computer Corporation; Microsoft and Windows are registered trademarks of Microsoft Corporation.

Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or thei

roducts. D-Link Computer Corporation disclaims any proprietary interest in trademarks and trade names other than its own.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 2

D-Link UAP CLI Command Reference

Table of Contents

About This Document ..............................................................................................................................7

Audience...........................................................................................................................................7

Acronyms and Abbreviations............................................................................................................7

Document Conventions .................................................................................................................... 8

Additional Documentation ...............................................................................................................8

About DWS-4000 Software......................................................................................................................9

Scope ................................................................................................................................................ 9

Product Concept ................................................................................................................ ...............9

Technical Support ..................................................................................................................................10

Section 1: Accessing the DWL-x600AP CLI....................................................................... 11

Serial Port Connection to the AP ........................................................................................................... 11

Telnet Connection to the AP..................................................................................................................12

SSH Connection to the AP......................................................................................................................13

Section 2: Commands and Syntax................................................................................... 14

Using the get Command ........................................................................................................................14

Using the Set Command ........................................................................................................................15

Using the add Command .......................................................................................................................16

Using the remove Command .................................................................................................................16

Additional CLI Commands ......................................................................................................................16

Getting Help on Commands at the CLI...................................................................................................17

Tab Completion ..............................................................................................................................17

Keyboard Shortcuts................................................................................................................................ 19

Section 3: Interface Naming Conventions .......................................................................20

Section 4: Saving Configuration Changes ........................................................................ 21

Section 5: Access Point CLI Commands ........................................................................... 22

Basic Settings .........................................................................................................................................22

Status ..................................................................................................................................................... 24

Ethernet Settings ...................................................................................................................................25

Radio Settings ........................................................................................................................................26

Managed Access Point ...........................................................................................................................27

IEEE 802.1X Supplicant Authentication.................................................................................................. 28

Firmware and Configuration File Management..................................................................................... 29

Radio and VAP Scheduler.......................................................................................................................29

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 3

D-Link UAP CLI Command Reference

Rogue APs Traps and Email Alerts .........................................................................................................30

Section 6: CLI Classes and Properties Reference .............................................................32

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 4

D-Link UAP CLI Command Reference

List of Tables

Table 1: Typographical Conventions ..................................................................................................................8

Table 2: Additional CLI Commands...................................................................................................................16

Table 3: Keyboard Shortcuts ............................................................................................................................19

Table 4: Interface Naming Convention.............................................................................................................20

Table 5: Basic Settings Commands ...................................................................................................................23

Table 6: Status Commands............................................................................................................................... 24

Table 7: Ethernet Settings Commands .............................................................................................................25

Table 8: Radio Settings Commands ..................................................................................................................26

Table 9: Managed Access Point Commands.....................................................................................................27

Table 10: IEEE 802.1X Supplicant Commands .................................................................................................. 28

Table 11: System Management........................................................................................................................29

Table 12: Radio and VAP Scheduler .................................................................................................................29

Table 13: Rogue APs and Email Alerts ..............................................................................................................30

Table 14: CLI Class Instances ............................................................................................................................32

Table 15: D-Link Access Point CLI Classes and Properties ................................................................................32

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 5

D-Link UAP CLI Command Reference

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 6

D-Link UAP CLI Command Reference

About This Document

In addition to the Web-based user interface, the D-Link Access Point DWL-x600AP includes a command-line interface (CLI) for administering the access point. The CLI lets you view and modify status and configuration information. This reference manual documents the commands and describes how to access and use the interface.

Note: This document contains both standalone and stacking commands. The stacking commands are available on the DWS-4000 Series Unified Switch.

Audience

This document is intended for the following audiences:

• System administrators who are responsible for configuring and operating the DWL-x600AP.

• Software engineers who integrate DWS-4000 software into their hardware platform can also benefit from a description of the configuration options.

• Level 1 and/or Level 2 support providers.

This document assumes that the reader has an understanding of the DWS-4000 software base and has read the appropriate specification for the relevant networking device platform. It also assumes that the reader has a basic knowledge of Ethernet and networking concepts.

Refer to the release notes for the DWS-4000 application-level code. The release notes detail the platformspecific functionality of the Switching, Routing, SNMP, Configuration, Management, and other packages. The suite of features the DWS-4000 packages support is not available on all the platforms to which DWS-4000 software has been ported.

Acronyms and Abbreviations

In most cases, acronyms and abbreviations are defined on first use.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 7

D-Link UAP CLI Command Reference

About This Document

Document Conventions

This section describes the conventions this document uses.

Note: A note provides more information about a feature or technology.

Caution! A caution provides information about critical aspects of the configuration, combinations of

settings, events, or procedures that can adversely affect network connectivity, security, and so on.

This guide uses the typographical conventions described in Tab le 1 .

Table 1: Typographical Conventions

Symbol Description Example

Bold Click Apply to save your settings. Menu titles, page names, and

button names

Blue Text Hyperlinked text. See “About This Document” on

page 7.

courier font

italic courier font Variable value. You must replace the italicized

[] square brackets

Command or command-line text

text with an appropriate value, which might be a name or number.

Optional parameter. [value]

{} curly braces Required parameter values. You must select a

parameter from the list or range of choices.

| Vertical bar Separates the mutually exclusive choices. [{}] Braces within

square brackets

Optional parameter values. Indicates a choice within an optional element.

show network

value

{choice1 | choice2}

choice1 | choice2

[{choice1 | choice2}]

Additional Documentation

The following documentation provides additional information about D-Link DWS-4000 Series software:

•The D-Link DWS-4000 Series Administrator’s Guide describes the Web-based graphical user interface (GUI) for managing, monitoring, and configuring the switch. The Administrator’s Guide also contains step-bystep configuration examples for several features.

•The D-Link DWS-4000 Series W ired Configuration Guide contains a variety of configuration examples that show how to configure the wired features on the switch.

• Release notes for this DWS-4000 Series product detail the platform-specific functionality of the software packages, including issues and workarounds.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 8

D-Link UAP CLI Command Reference

About DWS-4000 Software

The DWS-4000 software has two purposes:

• Assist attached hardware in switching frames, based on Layer 2, 3, or 4 information contained in the frames.

• Provide a complete device management portfolio to the network administrator.

Scope

DWS-4000 software encompasses both hardware and software support. The software is partitioned to run in the following processors:

•CPU

This code runs the networking device management portfolio and controls the overall networking device hardware. It also assists in frame forwarding, as needed and specified. This code is designed to run on multiple platforms with minimal changes from platform to platform.

• Networking device processor

This code does the majority of the packet switching, usually at wire speed. This code is platform dependent, and substantial changes might exist across products.

Product Concept

Fast Ethernet and Gigabit Ethernet switching continues to evolve from high-end backbone applications to desktop switching applications. The price of the technology continues to decline, while performance and feature sets continue to improve. Devices that are capable of switching Layers 2, 3, and 4 are increasingly in demand. DWS-4000 software provides a flexible solution to these ever-increasing needs.

The exact functionality provided by each networking device on which the DWS-4000 software base runs varies depending upon the platform and requirements of the DWS-4000 software.

DWS-4000 software includes a set of comprehensive management functions for managing both DWS-4000 software and the network. You can manage the DWS-4000 software by using one of the following three methods:

• Command-Line Interface (CLI)

• Simple Network Management Protocol (SNMP)

• Web-based

Each of the DWS-4000 management methods enables you to configure, manage, and control the software locally or remotely using in-band or out-of-band mechanisms. Management is standards-based, with configuration parameters and a private MIB providing control for functions not completely specified in the MIBs.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 9

D-Link UAP CLI Command Reference

Technical Support

D-Link provides customer access to the latest user documentation and software updates for D-Link products through its support website (http://support.dlink.com

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 10

D-Link UAP CLI Command Reference

Accessing the DWL-x600AP CLI

Section 1: Accessing the DWL-x600AP CLI

You can use any of the following methods to access the CLI for the access point or wireless network:

• Serial Port Connection to the AP

• Telnet Connection to the AP

• SSH Connection to the AP

Serial Port Connection to the AP

You can create a direct physical connection into the access point by connecting a cable from a laptop or desktop PC to a serial port on the access point. Then, using terminal emulation software on your PC, you can access the AP system console.

To emulate the AP system console on a serial port connection, you will need to have terminal emulation software installed on your PC, such as HyperTerminal or TeraTerm.

Use the following steps to set up the serial port connection, configure the terminal emulation software, and access the CLI.

1. Using a null-modem cable, connect a VT100/ANSI terminal or a workstation to the console (serial) port.

– If you attached a PC, Apple, or UNIX workstation, start a terminal-emulation program, such as

HyperTerminal or TeraTerm.

2. Configure the terminal-emulation program to use the following settings:

• Baud rate: 115200 bps

•Data bits: 8

•Parity: none

• Stop bit: 1

• Flow control: none

Note: By default, the serial port baud rate is 115200. You can also configure the serial port to use a baud rate of 9600, 19200, 28400, or 57600 from the Web interface Basic Settings page or by using the

set serial baud-rate rate command.

3. Press the return key, and a login prompt should appear.

– The login name is admin, and the default password is admin.

– After a successful login, the screen shows the (Access Point Name)# prompt. You are now ready to

enter CLI commands at the command line prompt.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 11

D-Link UAP CLI Command Reference

Telnet Connection to the AP

If you already deployed the network and know the IP address of your access point, you can use a remote Telnet connection to the access point to view the system console over the network.

Using Telnet tends to be more convenient than a serial port connection because it gives you remote access the AP system console. The only disadvantage of using Telnet (versus the direct serial port connection) is that with Telnet you cannot access the system console until the AP is fully initialized. Therefore, you cannot view AP startup messages. However, once the AP is operational you can use a Telnet connection to view the AP system console and enter CLI commands in exactly the same way as you would with a serial port connection. To use Telnet, you need a Telnet client, such as PuTTY.

To use the Microsoft Windows command window for Telnet access to the AP, use the following instructions:

1. Open a command window on your PC.

For example, from the system tray on the desktop choose Start Run to bring up the Run dialog, type cmd in the Open property, then click OK.

2. At the command prompt, type the following:

telnet ip_address

–where ip_address is the address of the access point you want to monitor.

– (If your Domain Name Server is configured to map domain names to IP addresses via DHCP, you can

also telnet to the domain name of the AP.)

3. When the login prompt appears, enter the username and password.

– The login name is admin, and the default password is admin.

– After a successful login, the screen shows the (Access Point Name)# prompt. You are now ready to

enter CLI commands at the command line prompt.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 12

D-Link UAP CLI Command Reference

SSH Connection to the AP

If you already deployed your network and know the IP address of your access point, you can use a remote Secure Shell (SSH) connection to the access point to view the system console over the network.

Using an SSH connection to the access point is similar to Telnet in that it gives you remote access to the system console and CLI. SSH has the added advantage of being a secure connection with encrypted traffic.

To use an SSH connection, you need to have SSH software installed on your PC. The examples in this guide use PuTTY, which is available as a free Internet download.

1. Start your SSH application.

2. Enter the IP address of access point and click Open.

(If your Domain Name Server is configured to map domain names to IP addresses via DHCP, you can enter the domain name of the AP instead of an IP address.)

This brings up the SSH command window and establishes a connection to the access point. The login prompt is displayed.

3. When the login prompt appears, enter the username and password.

– The default login name is admin. If you did not change the default password, press Enter when you are

prompted for a password. The default password is blank.

– After a successful login, the screen shows the

CLI commands at the prompt.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 13

Access Point Name# prompt. You are now ready to enter

D-Link UAP CLI Command Reference

Commands and Syntax

Section 2: Commands and Syntax

Configuration information for the DWL-x600AP is represented as a set of classes and objects. The CLI for the DWL-x600AP provides the following commands for manipulating objects:

•get

•set

•add

•remove

Caution! Settings that you update using the CLI get, set, add, and remove commands are not saved to the startup configuration unless you explicitly save them using the description of configurations maintained on the AP and details on how to save your updates, see

“Saving Configuration Changes” on page 21.

The following sections describe the function of each command.

save-running command. For a

Using the get Command

The get command enables you to view the property values of existing instances of a class. Classes can be “named” or “unnamed.” The command syntax is:

get unnamed-class [property ... | detail] get named-class [instance | all [property ... | name | detail]]

The rest of the command line is optional. If provided, it is either a list of one or more properties, or the keyword

The following example uses the

There is only one log on the AP, so the command returns information on the log file.

The following example uses the

There are multiple log entries but they are not named in the command, so this command returns all log entries.

The following example uses the

detail.

get command on an unnamed class with a single instance:

get log

get command on an unnamed class with multiple instances:

get log-entry

get command on a named class with multiple instances:

get bss wlan0bssvap0

There are multiple BSSes and they are named in the command, so this command returns information on the

BSS named wlan0bssvap0.

D-Link Unified Wired and Wireless Access System

November 7, 2011 Page 14

+ 32 hidden pages