1.4 Input syntax for commands starting with the word "no"............................................................................11
Chapter 2: How to use the commands.................................................................13
2.1 Operation via console.................................................................................................................................13
2.2 Operation via configuration (config) files..................................................................................................14
4.4 Show unit information................................................................................................................................34
4.4.1 Show version information...........................................................................................................34
4.4.2 Show inventory information........................................................................................................35
4.4.3 Show operating information........................................................................................................35
4.4.4 Show currently-executing processes...........................................................................................36
4.4.5 Show technical support information............................................................................................36
4.5 Time management......................................................................................................................................37
4.5.1 Set clock manually......................................................................................................................37
4.5.2 Set time zone...............................................................................................................................37
4.5.3 Show current time........................................................................................................................38
4.5.4 Set NTP server.............................................................................................................................38
4.5.5 Synchronize time from NTP server (one-shot update)................................................................39
4.5.6 Synchronize time from NTP server (update interval).................................................................39
4.5.7 Show NTP server time synchronization settings.........................................................................40
Chapter 5: IPv4/IPv6 common setting................................................................55
5.1 DNS client..................................................................................................................................................55
10.1.15 Show SFP module status.........................................................................................................95
10.2 Link aggregation.......................................................................................................................................96
10.2.1 Set static logical interface..........................................................................................................96
10.2.2 Show static logical interface status............................................................................................97
10.2.3 Set LACP logical interface........................................................................................................97
10.2.4 Show LACP logical interface status..........................................................................................98
10.2.5 Set LACP system priority........................................................................................................100
10.2.6 Show LACP system priority....................................................................................................101
10.2.7 Set LACP timeout....................................................................................................................101
10.2.9 Show LACP frame counter.....................................................................................................102
10.2.10 Set load balance function rules..............................................................................................102
88
6 | Command Reference | TOC
10.3 Port authentication..................................................................................................................................106
13.2 QoS (Quality of Service)........................................................................................................................178
13.4.1 Set storm control......................................................................................................................217
13.4.2 Show storm control reception upper limit...............................................................................217
193
10 | Command Reference | Introduction
Preface
Introduction
•All copyrights to the software and this command reference are the property of Yamaha Corporation.
•Unauthorized reproduction of this document in part or in whole is prohibited.
The contents of this document are subject to change without notice.
•
•Yamaha disclaims all responsibility for any damages caused by loss of data or other problems resulting from the use of this
product.
The warranty is limited to this physical product itself. Please be aware of these points.
•Ethernet is a registered trademark of Fuji Xerox Corporation.
•Microsoft and Windows are registered trademarks of Microsoft Corporation USA in the United States and in other
countries.
•Dante is a registered trademark of Audinate Corporation.
•Other company names and product names appearing in this document are the registered trademarks or trademarks of their
respective owners.
Command Reference | How to read the command reference | 11
Chapter 1
How to read the command reference
1.1 Applicable products
This command reference applies to the Yamaha SWP1 series of L2 switches (SWP1-8, SWP1-8MMF, SWP1-16MMF).
Refer to the following website for the latest information on firmware.
https://www.yamaha.com/proaudio/
1.2 How to read the command reference
This command reference describes the commands that you enter from the console of the Yamaha L2 switch SWP1.
Each command is described by a combination of the following items.
Explains the command input syntax. Key input can use either
uppercase or lowercase characters.
Command names are shown in bold (Bold face).
[Syntax]
[Keywords]
[Parameters]
[Default setting]Indicates the factory-set state of the command.
[Input mode]Indicates the modes in which the command can be executed.
[Description]Explains the command.
[Notes]
[Examples]Provides specific examples of the command.
The parameter portion is shown in italic (Italic face).
Keywords are shown in normal characters.
Parameters that can be omitted are enclosed in square
brackets ( [ ] ).
Explains the type and significance of keywords that can be
specified for the command.
Explains the type and significance of parameters that can be
specified for the command.
Explains points that you should be aware of when using the
command.
1.3 Interface names
In the command input syntax, interface names are used to specify each interface of the switch.
The following interface names are handled by the SWP1.
Interface typePrefixDescriptionExamples
Used to specify a physical
LAN/SFP portge
VLAN interfacevlan
static logical interfacesa
LACP logical interfacepo
port. Specify ge followed by
the port number.
Used to specify a VLAN.
Specify vlan followed by
"bridge ID (fixed at 0)" + "."
+ "VLAN ID".
Used to specify link
aggregation that combines
multiple LAN/SFP port.
Specify sa or po followed by
"logical interface ID".
1.4 Input syntax for commands starting with the word "no"
To specify LAN port #1: ge1
To specify VLAN #1: vlan0.1
To specify static logical
interface #1: sa1
To specify LACP logical
interface #2: po2
12 | Command Reference |
Many commands also have a form in which the command input syntax starts with the word no. If you use a syntax that with
begins with the word no, the settings of that command are deleted and returned to the default value, unless explained otherwise.
How to read the command reference
Command Reference | How to use the commands | 13
Chapter 2
How to use the commands
The SWP1 lets you perform command operations in the following two ways.
Type of operationMethod of operationDescription
Issue commands one by one to
interactively make settings or perform
operations.
A file containing a set of necessary
commands (called a configuration or
"config" file) is used to specify multiple
settings, or to obtain multiple settings from
the SWP1, in a single operation.
Operation via console
Operation via a config file
This chapter explains how to use each method.
•Access from a console terminal
•Access from a TELNET client
File transfer via TFTP
•
•File transfer via GUI operation
2.1 Operation via console
2.1.1 Access from a console terminal
To make settings from a terminal connected to the CONSOLE port of the SWP1, use an RJ-45/DB-9 serial cable. If you are
using a computer as a console terminal (serial terminal), you'll need a terminal program to control the computer's serial (COM)
port. Set the communication settings of the console terminal as follows.
Setting itemValue
Baud rate9600bps
Data8-bit
Paritynone
Stop bit1-bit
Flow controlnone
For settings related to the console terminal, use the line console command to move to line mode.
2.1.2 Access from a TELNET client
You can use a TELNET client on a computer to connect to the TELNET server of the SWP1 and control it. In order to make
settings using TELNET, you must first set up a connection environment (IP network) and then make TELNET server settings.
The IP address settings of the SWP1 are as follows.
•The default IPv4 address setting is automatically specified by DHCP for VLAN #1 (vlan0.1).
To change the IPv4 address, use the ip address command.
•
The TELNET server settings of the SWP1 are as follows.
•With the default settings of the TELNET server function, it runs on the default port (TCP port 23) and allows access only
from VLAN #1 (vlan0.1).
•To change the reception port number, use the service telnet-server command.
•Access to the TELNET server can be controlled in VLAN units, and can be specified by the telnet-server interface
command.
A virtual communication port by which a TELNET client connects is called a "virtual terminal (VTY: Virtual TYpewriter)
port." The maximum number of simultaneous TELNET client connections depends on the number of VTY ports of the SWP1.
The VTY ports of the SWP1 are as follows.
•With the default VTY port settings, eight VTY ports (ID: 0--7) can be used.
•To check the number of VTY ports, use the show running-config | include line vty command.
•To change the number of VTY ports, use the line vty command. (maximum 8 (ID: 0--7))
To make VTY port settings, use the line vty command to specify the target VTY port, and then move to line mode. ID
management for virtual terminal ports is handled within the SWP1, but since login session and ID assignments depend on the
connection timing, you should normally make the same settings for all VTY ports.
| Command Reference | How to use the commands
14
2.1.3 Console terminal/VTY settings
The SWP1 lets you make the following settings for console terminals and VTY.
1. Timeout duration interpreted as no operation
2. Number of lines shown in one page of the terminal screen
Setting itemContent of setting
Timeout duration interpreted as no operation
Number of lines shown in one page of the terminal screen
Specifies the time after which the login session is forcibly
ended when there has been no key input from the terminal.
With the default setting, the session is forcibly disconnected
after ten minutes.
To make this setting, use the exec-timeout command of the
line mode; this takes effect from the next session.
Specifies the number of lines shown on one page of the
terminal screen.
This can be set as 0--512 lines/page, and the default setting is
24 lines/page.
When displaying in this state, 23 lines are displayed, then "--More---" is displayed and the system waits for key input.
There are two types of this setting, and they are applied to the
system starting with the upper type.
1) unprivileged EXEC mode terminal length command
2) global configuration mode service terminal-length
command
Setting 1) is a function that temporarily applies to the user
who is using the terminal, and is applied as soon as the
command is executed.
Setting 2) applies starting with the next session.
2.2 Operation via configuration (config) files
A file containing a set of needed commands is called a configuration (config) file.
The settings that have been made on the SWP1 can be read as a configuration file by a host on the LAN via TFTP. A
configuration file on the host can also be loaded into the SWP1 to specify its settings.
A configuration file contains all the settings for the entire unit; it is not possible to partially read or write only the settings for a
specific area. The configuration file is a text file consisting of ASCII + line-return (CRLF or LF).
The commands and parameters in a configuration file must be in the correct syntax. If the syntax or content are incorrect, that
content is ignored and is not applied to operation.
2.2.1 Access from a TFTP client
In order to transfer a configuration file via TFTP, you must first set up a connection environment (IP network) and then make
TFTP server settings.
The IP address settings of the SWP1 are as follows.
•
The default IPv4 address setting is automatically specified by DHCP for VLAN #1 (vlan0.1).
To change the IPv4 address, use the ip address command.
•
The TFTP server settings of the SWP1 are as follows.
•With the default settings of the TFTP server function, it is running on the default port (UDP port 69) and does not allow
access from anywhere.
•The reception port number cannot be changed.
•Access to the TFTP server can be controlled in VLAN units, and can be specified by the tftp-server interface command.
Specify the VLAN ID for which access is allowed.
2.2.2 Reading/writing a configuration file
Reading/writing a configuration file is performed by executing a TFTP command from the host on the LAN. The following
configuration files are read or written.
•
Config file
Command Reference | How to use the commands | 15
Applicable config fileDescriptionRemarks
running-configSetting values for current operation
startup-config for USER modeSaved setting values
The command syntax used depends on the OS of that host (TFTP client). Keep the following points in mind when executing
commands.
•IP address of the SWP1
Use "binary mode" as the transmission mode.
•
•Specify the following as the remote path of the configuration file read (GET) or write (PUT) destination.
•If an administrator password is set on the SWP1, you must specify the administrator password after the remote path in the
format "/PASSWORD".
•If you PUT (write) with "config" specified as the remote path, the changes are added or overwritten to the current operating
settings. Settings that you do not add or change will remain as the current operating settings. Since the setting values are not
saved, you must use the write command etc. if you want to save them.
If you want to start operation in USER mode with a completely new config file, specify "reconfig" as the remote path. After
•
updating startup-config, the unit restarts automatically, and begins operating with the new settings.
•The encrypted password (password 8 or enable password 8 command format) is not applied to the settings even if it is
PUT to running-config via TFTP.
startup-config for
USER mode
startup-config for
USER mode
✓✓-
-✓✓
Setting values when starting up with
DIP switch #1 ON
2.3 Login
When the SWP1 has finished starting up, a login screen is displayed. If a user password has been specified, enter that password.
When authentication is successful, the command prompt appears. Since no user password is specified with the default settings,
you will be able to log in without a password.
•Login screen
Password:
•Console screen following login
SWP1-16 Rev.2.01.01 (Mon Sep 14 11:28:38 2015)
Copyright (c) 2015 Yamaha Corporation. All Rights Reserved.
SWP1>
2.4 Command input mode
2.4.1 Command input mode basics
In order to change the settings of the SWP1 or to reference the status, you must move to the appropriate command input mode
and then execute the command. Command input mode is divided into hierarchical levels as shown below, and the commands
that can be entered in each mode are different. By noting the prompt, the user can see which mode they are currently in.
16 | Command Reference | How to use the commands
The basic commands related to moving between command input modes are described below. For commands that move from
global configuration mode to individual configuration mode, refer to "individual configuration mode."
•exit command
•logout command
•enable command
•disable command
•configure terminal command
•end command
2.4.2 individual configuration mode
individual configuration mode is the overall name for the mode in which you can make detailed settings for specific items such
as LAN/SFP port, VLAN interface, and QoS. To enter individual configuration mode, issue the command for transitioning to
the respective mode from global configuration mode.
On SWP1, individual configuration mode contains the following modes. Some of the modes within individual configuration
mode have a hierarchy. For example, policy map mode → policy map class mode.
The command prompt prefix indicates the host name. In the default state, the host name is the model name "SWP1". This
indication can be changed by using the hostname command to specify the host name. In cases where multiple SWP1 units are
used, management will be easier if separate names are assigned to each switch.
2.4.4 Executing commands of a different input mode
Because the commands that can be used on the SWP1 differ depending on the mode, you must transition to the mode in which a
command can be executed before you execute that command. The do command is provided as a way to avoid this requirement.
By using the do command you can execute priviledged EXEC mode commands from any configuration mode. This allows you
to reference the current configuration or save settings from any configuration mode without having to transition to priviledged
EXEC mode.
However, since the completion function cannot be used with do, you must enter the command that follows either in its full
spelling or in its abbreviated form.
•Entry in full spelling
SWP1(config)#do show running-config
•Entry in abbreviated form
SWP1(config)#do sh ru
2.5 Keyboard operations when using the console
2.5.1 Basic operations for console input
The SWP1 allows the following operations in the command line.
•Moving the cursor
Keyboard operationDescription and notes
→Move right one character
←Move left one character
Press Esc, then F
Press Esc, then B
Ctrl + AMove to the beginning of the line
Ctrl + EMove to the end of the line
•Deleting an input character
Move right one word (move to the character following the
end of the word at the cursor location)
Move left one word (move to the first character of the word
at the cursor location)
Keyboard operationDescription and notes
Backspace
Ctrl + H
Ctrl + D
Press Esc, then D
Ctrl + KDelete from the cursor position until the end of the line
Ctrl + UDelete all characters that are being entered
Delete the character at the left of the cursor
Delete the character at the cursor.
If this operation is performed when the command line is
empty, the result is the same as the exit command.
Delete from the cursor position until immediately before the
first space
18 | Command Reference | How to use the commands
•Other
Keyboard operationDescription and notes
Ctrl + T
Ctrl + C
Ctrl + Z
2.5.2 Command help
By entering '?' in the command line you can search for the available commands or parameters.
Exchange the character at the cursor position with the
preceding character.
If the cursor is at the end of the line, exchange the preceding
character with the character that precedes it.
In unprivileged EXEC mode and priviledged EXEC mode,
discard the command being entered and move to the next
line.
In individual configuration mode, discard the command line
being entered and move to priviledged EXEC mode.
Command processing that is currently being executed will
be stopped. (ex: ping command)
Move from individual configuration mode to priviledged
EXEC mode.
This is the same operation as the end command.
SWP1#show vlan ?
<1-4094> VLAN id
access-map Show VLAN Access Map
brief VLAN information for all bridges (static and dynamic)
filter Show VLAN Access Map Filter
private-vlan private-vlan information
SWP1#show vlan
2.5.3 Input command completion and keyword candidate list display
If you press the "Tab" key while entering a command in the console, the command name is completed. If you press the "Tab"
key after entering a keyword, a list of keyword candidates that can be entered next is shown. The same operation can also be
performed by pressing the "Ctrl + I" key.
•Command name completion
SWP1#con "press the <Tab>key"
↓
SWP1#configure
•Keyword candidate list display
SWP1(config)#vlan "press the <Tab> key"
access-map database filter
SWP1(config)#vlan
2.5.4 Entering command abbreviations
When you enter commands or parameters in abbreviated form, and the characters you entered can be recognized
unambiguously as a command or parameter, that command is executed.
Example of entering a command abbreviation (show running-config)
SWP1# sh run
2.5.5 Command history
By using the command history function, you can easily re-execute a command that you previously input, or partially modify a
previously input command and re-execute it. Command history is shown as a history that is common to all modes.
Operation is shown below.
Keyboard operationDescription and notes
↑
Ctrl + P
Move backward through command history
Command Reference | How to use the commands | 19
Keyboard operationDescription and notes
↓
Ctrl + N
Move forward through command history
2.6 Commands that start with the word "show"
2.6.1 Modifiers
Modifiers send the information produced by the show command through a filter, restricting the content that is shown in the
screen and making it easier for you to see the desired information.
The SWP1 provides the following three modifiers for the show command.
ModifiersDescription
include
grep
exclude
Modifiers can be used only one at a time. You cannot specify more than one modifier.
•(Example) Using
SWP1#show running-config | grep vlan0.1
interface vlan0.1
snmp-server community public ro interface vlan0.1
http-server interface vlan0.1
telnet-server interface vlan0.1
•(Example) Using
show running-config to view information that includes VLAN #1 (vlan0.1).
show spanning-tree to view information that includes Role.
Output only the lines that include the specified character
string
Output only the lines that do not include the specified
character string
SWP1# show spanning-tree | include Role
% ge1: Port Number 1 - Ifindex 1 - Port Id 8001 - Role Disabled - State
Discarding
% ge2: Port Number 2 - Ifindex 2 - Port Id 8002 - Role Disabled - State
Discarding
% ge3: Port Number 3 - Ifindex 3 - Port Id 8003 - Role Disabled - State
Discarding
% ge4: Port Number 4 - Ifindex 4 - Port Id 8004 - Role Disabled - State
Discarding
% ge5: Port Number 5 - Ifindex 5 - Port Id 8005 - Role Disabled - State
Discarding
% ge6: Port Number 6 - Ifindex 6 - Port Id 8006 - Role Disabled - State
Discarding
% ge7: Port Number 7 - Ifindex 7 - Port Id 8007 - Role Disabled - State
Discarding
% ge8: Port Number 8 - Ifindex 8 - Port Id 8008 - Role Disabled - State
Discarding
% ge9: Port Number 9 - Ifindex 9 - Port Id 8009 - Role Disabled - State
Discarding
% ge10: Port Number 10 - Ifindex 10 - Port Id 800a - Role Disabled - State
Discarding
% ge11: Port Number 11 - Ifindex 11 - Port Id 800b - Role Disabled - State
Discarding
% ge12: Port Number 12 - Ifindex 12 - Port Id 800c - Role Disabled - State
Discarding
% ge13: Port Number 13 - Ifindex 13 - Port Id 800d - Role Disabled - State
Discarding
% ge14: Port Number 14 - Ifindex 14 - Port Id 800e - Role Disabled - State
Discarding
% ge15: Port Number 15 - Ifindex 15 - Port Id 800f - Role Disabled - State
Discarding
% ge16: Port Number 16 - Ifindex 16 - Port Id 8010 - Role Disabled - State
Discarding
% ge17: Port Number 17 - Ifindex 17 - Port Id 8011 - Role Disabled - State
Forwarding
% ge18: Port Number 18 - Ifindex 18 - Port Id 8012 - Role Disabled - State
Discarding
20 | Command Reference | Configuration
Chapter 3
Configuration
3.1 Managing settings
The SWP1 uses the following configurations to manage its settings.
Types of configurationDescription
Running configuration (running-config)
Startup configuration (startup-config)
Backup configuration (backup-config)
Default configuration (default-config)
The start-up flow for the SWP1 system is as follows.
1. Reference DIP switch #1 and determine the CONFIG mode
•If DIP switch #1 is up (OFF), start up in DANTE mode
If DIP switch #1 is down (ON), start up in USER mode
•
2. Determine the startup configuration for each CONFIG mode
•For DANTE mode
•Use the default configuration that was selected according to the settings of DIP switches #2/#3
•For USER mode
•If a startup configuration for USER mode exists, use the corresponding data
•If a startup configuration for USER mode does not exist, use the default configuration that was selected according to
the settings of DIP switches #2/#3.
3. Load the startup configuration into RAM as the running configuration
•If a backup configuration exists in DANTE mode, overwrite the corresponding data onto the running configuration
If commands etc. are used to modify the settings while the SWP1 is running, the modified settings are immediately reflected in
the running configuration.
After modifying the running configuration, executing the write or copy command in USER mode will update the startup
configuration.
In DANTE mode, executing the backup-config command will update the backup configuration.
If you restart without saving the content that was specified or modified, the settings or modifications are lost. Please be aware of
this.
Setting values currently used for
operation. Managed in RAM.
In USER mode, setting values saved in
ROM.
In DANTE mode, the same setting
values as the default configuration.
Setting values for some functions saved
in DANTE mode. Managed in ROM.
Default setting values. Managed in
ROM.
Created based on the VLAN preset that
is selected by the settings of DIP
switches #2/#3 at start-up.
User operations that can be
performed
Note
Save to startup configuration (in USER
mode)
Save some functions to backup
configuration (in DANTE mode)
Note
Update by running configuration (in
USER mode)
Update by running configuration (in
DANTE mode)
No operations possible
3.2 Default setting values
On the SWP1, the VLAN preset specified by DIP switches #2/#3 will be the default setting values. The VLAN preset types for
DIP switch #2/#3 settings are as follows.
•DIP switch #2/#3 settings
Setting position
#2#3
Up (OFF)Up (OFF)
VLAN preset type
Normal
Command Reference | Configuration | 21
Setting position
#2#3
Down (ON)Up (OFF)
Up (OFF)Down (ON)B
Down (ON)Down (ON)C
The setting values that are common between models and presets are shown first, and then the setting values that are specific to
the presets of each model are shown.
•Settings common to all models and presets (system-wide)
If this is enabled, the password entered by the password command or the enable password command is saved in the
configuration in an encrypted form.
If this is executed with the "no" syntax, password encryption is disabled, and the password entered by the password command
or the enable password command is saved in the configuration as plaintext.
[Note]
If password encryption is changed from disabled to enabled, previously-entered passwords are converted from plaintext to an
encrypted form; however if it is changed from enabled to disabled, previously-encrypted passwords in a configuration file do
not return to plaintext.
SWP1(config)#no service password-encryption
SWP1(config)#
4.1.4 Allow login with special password
[Syntax]
service password-forget
no service password-forget
[Initial value]
service password-forget
[Input mode]
global configuration mode
30 | Command Reference | Maintenance and operation functions
[Description]
Enable login with special password.
If this is enabled, only when logging in from a serial console, it is possible to log in using "w,lXlma" (lowercase W, comma,
lowercase L, uppercase X, and lowercase L, M, and A) instead of the specified user password. If you login with the special
password, you will be in privileged EXEC mode.
If this is executed with the "no" syntax, login with the special password is disabled.
SWP1(config)#no service password-forget
SWP1(config)#
4.2 Configuration management
4.2.1 Save running configuration
[Syntax]
copy running-config startup-config
[Input mode]
priviledged EXEC mode
[Description]
Saves the current operating settings (running configuration) as the settings for startup (startup configuration).
[Note]
The save-destination startup configuration is determined by the unit's DIP switch #1 at the time that the unit is started.
The running configuration can also be saved by executing the write command.
This command can be used to save settings only when in USER mode. When in DANTE mode, the backup-config command
can be used to save some of the settings.
[Example]
Save the running configuration.
SWP1#copy running-config startup-config
Building configuration...
[OK]
SWP1#
Saves the current operating settings (running configuration) as the settings for startup (startup configuration).
[Note]
The save-destination startup configuration is determined by the unit's DIP switch #1 at the time that the unit is started.
The running configuration can also be saved by executing the copy running-config startup-config command.
This command can be used to save settings only when in USER mode. When in DANTE mode, the backup-config command
can be used to save some of the settings.
[Example]
Save the running configuration.
Loading...
+ 192 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.