Installer/User Guide: For Technical Support
Installer/User Guide: For Technical Support
Installer/User Guide: For Technical Support
Installer/User Guide
Avocent Corporation
4991 Corporate Drive
Huntsville, Alabama 35805-6201 USA
Tel: +1 256 430 4000
Fax: +1 256 430 4031
Avocent Germany
Gottlieb-Daimler-Strae 2-4
D-33803 Steinhagen
Germany
Tel: +49 5204 9134 0
Fax: +49 5204 9134 99
Avocent Canada
20 Mural Street, Unit 5
Richmond Hill, Ontario
L4B 1K3 Canada
Tel: +1 877 992 9239
Fax: +1 877 524 2985
590-434-501E
USA Notification
Warning: Changes or modifications to this unit not expressly approved by the party responsible for compliance
could void the users authority to operate the equipment.
Note: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant
to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful
interference when the equipment is operated in a commercial environment. This equipment generates, uses and
can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may
cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to
cause harmful interference in which case the user will be required to correct the interference at his own expense.
Canadian Notification
This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus set out
in the Radio Interference Regulations of the Canadian Department of Communications.
Le prsent appareil numrique nmet pas de bruits radiolectriques dpassant les limites applicables aux
appareils numriques de la classe A prescrites dans le Rglement sur le brouillage radiolectrique dict par le
Ministre des Communications du Canada.
Japanese Approvals
European Union
Warning: This is a Class A product. In a domestic environment, this product may cause radio interference in
which case the user may be required to take adequate measures.
Taiwanese Notification
CCM
Installer/User Guide
Avocent, the Avocent logo, The Power of Being There, DSView and
AVWorks are registered trademarks of Avocent Corporation or its
affiliates. All other marks are the property of their respective owners.
2006 Avocent Corporation. All rights reserved. 590-434-501E
Instructions
This symbol is intended to alert the user to the presence of important operating and maintenance
(servicing) instructions in the literature accompanying the appliance.
iii
T A B L E O F C ON T E N T S
Table of Contents
List of Figures ................................................................................................................. ix
List of Tables ................................................................................................................... xi
Chapter 1: Product Overview.......................................................................................... 1
Features and Benefits ........................................................................................................................ 1
Safety Precautions ............................................................................................................................. 4
Rack mount safety considerations .............................................................................................. 4
Chapter 2: Installation and Configuration ..................................................................... 5
Hardware Overview........................................................................................................................... 5
CCM850 and 1650 appliance hardware .................................................................................... 5
CCM485x appliance hardware................................................................................................... 6
Installing the CCM Appliance ........................................................................................................... 7
Configuring the CCM Appliance ....................................................................................................... 8
Configuring the network address settings .................................................................................. 8
Initial CCM appliance login..................................................................................................... 10
Rebooting and Reinitializing the CCM Appliance........................................................................... 11
Rebooting.................................................................................................................................. 11
Reinitializing............................................................................................................................. 11
Configuring the Appliance for AV Operation or DS Operation ...................................................... 12
Chapter 3: Operations ................................................................................................... 13
Overview .......................................................................................................................................... 13
Configuring Global Settings ............................................................................................................ 13
Updating the Appliance Clock ......................................................................................................... 14
Configuring Port Settings ................................................................................................................ 15
Physical port settings................................................................................................................ 15
Port access................................................................................................................................ 17
Managing groups...................................................................................................................... 18
Virtual port settings .................................................................................................................. 19
Displaying port settings............................................................................................................ 20
Connecting to Serial Devices........................................................................................................... 21
Connecting to devices using Telnet .......................................................................................... 21
iv
Table of Contents
vi
Table of Contents
vii
viii
ix
List of Figures
Figure 2.1: CCM1650 Appliance Front Panel .................................................................................. 5
Figure 2.2: CCM1650 Appliance Back Panel ................................................................................... 6
Figure 2.3: CCM485x Appliance Front Panel .................................................................................. 6
Figure 2.4: CCM485x Appliance Back Panel ................................................................................... 7
Figure B.1: CAT 5 and CAT 6 Cable Adaptor Pin Assignments ................................................... 121
Figure B.2: Reversing Cable Adaptor Pin Assignments................................................................ 123
Figure B.3: 8-wire RJ-45 Reversing Cable ................................................................................... 124
xi
LIST OF TABLES
List of Tables
Table 2.1: CCM485x Appliance LAN LED Values............................................................................ 7
Table 3.1: Appliance Feature Reference ......................................................................................... 14
Table 3.2: Default Physical Port Settings ...................................................................................... 15
Table 3.3: Default Virtual Port Settings .......................................................................................... 19
Table 3.4: SSH Authentication Methods.......................................................................................... 25
Table 3.5: Access Rights .................................................................................................................. 33
Table 3.6: Port History Mode Commands....................................................................................... 41
Table 3.7: Substitution Strings in NFS Filename Specification ...................................................... 44
Table 4.1: Line Editing Operations for VT100 Compatible Devices .............................................. 51
Table 4.2: Line Editing Operations for ASCII TTY Devices ........................................................... 52
Table 4.3: Command Syntax Types in Example Command ............................................................. 52
Table 4.4: CCM Appliance Command Summary............................................................................. 55
Table 5.1: Connect Command Parameters...................................................................................... 61
Table 5.2: Group Command Summary ........................................................................................... 63
Table 5.3: Group Add Command Parameters ................................................................................. 63
Table 5.4: Group Delete Command Parameter............................................................................... 64
Table 5.5: Group Set Command Parameters................................................................................... 64
Table 5.6: Help Command Parameter............................................................................................. 65
Table 5.7: IPMI Command Parameter ............................................................................................ 66
Table 5.8: NFS Command Parameters............................................................................................ 66
Table 5.9: NTP Command Parameters............................................................................................ 67
Table 5.10: Port Command Summary ............................................................................................ 68
Table 5.11: Port Add Command Parameters .................................................................................. 69
Table 5.12: Port Alert Add Command Parameters ......................................................................... 71
Table 5.13: Port Alert Copy Command Parameters ....................................................................... 71
Table 5.14: Port Alert Delete Command Parameter ....................................................................... 72
xii
List of Tables
xiii
List of Tables
xiv
Table E.2: IPMI Shortcut and BMU Alert Command Parameters................................................ 140
Table E.3: BMU Help Command Parameter................................................................................. 140
Table E.4: IPMI Shortcut and BMU Identify Command Parameters............................................ 140
Table E.5: IPMI Shortcut and BMU Pet Command Parameters .................................................. 141
Table E.6: IPMI Shortcut and BMU Power Command Parameters ............................................. 142
Table E.7: IPMI Shortcut and BMU Sel Command Parameters ................................................... 143
Table E.8: IPMI Shortcut and BMU Sensor Command Parameters ............................................. 143
Table E.9: IPMI Shortcut and BMU Sol Command Parameters................................................... 144
Table E.10: IPMI Shortcut and BMU Sysinfo Command Parameters .......................................... 145
Table E.11: IPMI Shortcut and BMU User Command Parameters .............................................. 146
Table F.1: Ports Used by CCM Appliance .................................................................................... 147
CHAPTER
Product Overview
The CCM850 appliance has 8 serial ports. A single 10/100 Mbps Ethernet port provides network connectivity on each appliance. Two CCM850 appliances may be mounted in 1U of vertical space in a standard 19 inch rack.
The CCM1650 appliance has 16 serial ports. A single 10/100 Mbps Ethernet port provides network connectivity on each appliance. Two CCM1650 appliances may be mounted in 1U of
vertical space in a standard 19 inch rack.
The CCM485x appliance has 48 serial ports. A single 10/100/1000 Mbps Ethernet port provides network connectivity on each CCM appliance. One CCM485x appliance may be
mounted in 1U of vertical space in a standard 19 inch rack.
Each appliance has a console port that uses a Command Line Interface (CLI) for configuration,
management and optionally, connection to other ports.
In addition to the physical serial ports, you may configure and use up to 16 virtual serial ports on
each CCM appliance. Once a virtual port is established, it functions in a similar manner as a
physical port, except there is no need for physical cabling. A virtual port is accessed through the
Baseboard Management Controller (BMC) on a target device. The CCM appliance acts as an
Intelligent Platform Management Interface (IPMI) management console that allows users to
retrieve BMC-based status, statistics, logs and tracking information. If a target device experiences a
system failure, CCM appliance users may issue BMC Management Utility (BMU) commands to
virtual serial ports to determine the cause of the failure and reboot the device if necessary, even
when the devices operating system and keyboard are not available.
AV or DS operation
The CCM appliance supports two separate Flash application images: one for AV operation and one
for DS operation.
AV operation - CCM appliances are Flash loaded at the factory with an image that supports
standalone operation and the Avocent AVWorks cross-platform management application. The
AVWorks software is bundled with the CCM appliance and may be used to simplify installation,
configuration and subsequent session launching. When using this image, user authentication
requires user accounts to be maintained within the CCM appliance or within external authentication
servers which it can access.
DS operation - CCM appliances may be Flash loaded with an image that supports standalone
operation and the DSView 3 management software. When using this image, user authentication
includes user accounts maintained within the DSView 3 software server or within external
authentication servers which it can access. The CCM may be configured with other authentication
methods, if desired.
See Configuring the Appliance for AV Operation or DS Operation on page 12 for
more information.
NOTE: Hereafter, the phrase AV operation or DS operation will be used to identify features and commands that
are supported only when the CCM appliance is Flashed with an application image that supports that operation.
Whether the appliance is Flashed for AV or DS operation, you may perform most of the operations
that are described in this manual. This manual describes how to manage a CCM appliance by
entering commands using the CLI.
The AVWorks Installer/User Guide describes how to manage a CCM appliance using the
AVWorks software graphic interface.
The DSView Installer/User Guide describes how to manage a CCM appliance using the
DSView 3 software graphic interface.
NOTE: DSView 2 software is not supported on the CCM850, 1650 or 485x appliances. References to DSView
software and DS operation always refer to DSView 3 management software.
The AVWorks software offers a built-in enhanced Telnet client and an SSH client application
Third party Telnet clients and third party SSH clients may be used during standalone operation
When the CCM appliance is Flashed for AV operation, third party Telnet and third party SSH
clients may be configured and used from within the AVWorks software
When session sharing is enabled, the CCM appliance supports multiple concurrent sessions.
Preemption criteria is based upon configured user access levels (for AV operation) or configured
preemption levels (for DS operation).
Device access using virtual ports
Target devices with onboard BMCs may be configured through their Basic Input/Out System
(BIOS) to redirect serial console data from the local COM port to the serial interface on the BMC.
The BMC is further configurable for transferring this serial information to remote clients using the
Remote Management Control Protocol (RMCP). Transfer of RMCP messages between the BMC
and the RMCP client is called Serial over LAN (SoL). The CCM appliance contains an RMCP
client that supports a proprietary version of the IPMI 1.5 SoL protocol.
The CCM appliance serves as a gateway, allowing RMCP serial data to securely traverse nonsecure networks to remote clients over SSH sessions. Administrators may use its BMU interface to
monitor target device status, obtain information or reboot the device. See Using the BMU on
page 138.
The features that are available for physical ports, such as share mode, offline buffering of history
data and port alerts are also supported for virtual ports.
One SoL connection per BMC is allowed; up to four IPMI connections may be established to
each BMC.
User authentication and data security
The CCM user database supports up to 64 user accounts, which include usernames, passwords and/
or keys, plus specifications of access rights/levels to CCM appliance ports and commands. User
definitions may be changed at any time.
You may choose to have user access authenticated using the following methods.
Port history
Each CCM physical and virtual port has a buffer that holds the most recent 64K bytes of online and
offline serial data. A separate history command mode lets you navigate within a ports current
history file and conduct tailored searches.
You may also configure the appliance to write serial port data to a file on an NFS (Network File
System) server, thus preventing data loss due to overflow of the history buffer.
Safety Precautions
To avoid potential device problems, if the building has 3-phase AC power, ensure that a computer
and its monitor (if used) are on the same phase. For best results, they should be on the same circuit.
To avoid potentially fatal shock hazard and possible damage to equipment, please observe the
following precautions:
Do not use a 2-wire extension cord in any product configuration containing this appliance.
Test AC outlets at the computer and monitor (if used) for proper polarity and grounding.
Use only with grounded outlets at both the computer and monitor. When using a backup Uninterruptible Power Supply (UPS), power the computer, the monitor and the CCM appliance off
the supply.
Elevated Ambient Temperature: If installed in a closed rack assembly, the operation temperature of the rack environment may be greater than room ambient. Use care not to exceed the
rated maximum ambient temperature of the unit.
Reduced Airflow: Installation of the equipment in a rack should be such that the amount of airflow required for safe operation of the equipment is not compromised.
Mechanical Loading: Mounting of the equipment in the rack should be such that a hazardous
condition is not achieved due to uneven mechanical loading.
Circuit Overloading: Consideration should be given to the connection of the equipment to the
supply circuit and the effect that overloading of circuits might have on overcurrent protection
and supply wiring. Consider equipment nameplate ratings for maximum current.
Reliable Earthing: Reliable earthing of rack mounted equipment should be maintained. Pay
particular attention to supply connections other than direct connections to the branch circuit
(for example, use of power strips).
CHAPTER
Hardware Overview
This section describes the CCM appliance LEDs, buttons and connectors.
The lower left area of the front panel contains the following LEDs and buttons:
The POWER LED illuminates when the CCM appliance is connected to a power source.
The ONLINE LED illuminates steadily (not blinking) when the CCM appliance self-test and
initialization procedures complete successfully.
The LINK LED illuminates when the CCM appliance establishes a connection to the network.
The 100Mbps LED illuminates when the CCM appliance is connected to a 100 Mbps LAN.
The RESET button, when pressed, reboots the CCM appliance. See Rebooting on page 11.
The INIT button, when pressed and held, restores the CCM factory default values. See
Reinitializing on page 11.
RJ-45 port connectors for serial cabling (the CCM850 appliance has 8 port connectors, the
CCM1650 appliance has 16 port connectors). The port number is adjacent to each connector.
The front panel contains 48 serial port connectors. The lower left area of the front panel contains
the following LEDs, buttons and connectors.
The ONLINE LED illuminates steadily (not blinking) when the CCM self-test and initialization
procedures complete successfully.
The POWER LED illuminates when the CCM appliance is connected to a power source and the
power switch is on (|).
The RESET button reboots the CCM appliance when pressed. See Rebooting on page 11.
The INIT button restores the CCM factory defaults when pressed and held. See Reinitializing on
page 11.
A console device may be connected to the RJ-45 CONSOLE PORT.
A 10BaseT, 100BaseT or 1000BaseT interface cable may be connected to the LAN PORT.
Two LEDs adjacent to the LAN PORT (SPEED and LINK/TRAFFIC) indicate the link speed and
whether there is traffic on the link. Table 2.1 describes the possible values.
LINK/TRAFFIC LED
Description
Off
Off
No link
Off
On
Link at 10 Mbps
Green
On
Orange
On
Off
Flashing
Traffic at 10 Mbps
Green
Flashing
Orange
Flashing
A DB-9 DEBUG PORT connector. This port should be used only on the advice and with the
guidance of Technical Support.
Place the unit where you can connect cables between the serial devices and the CCM serial
ports, and where you can connect a LAN interface cable between the Ethernet hub or switch
and the CCM LAN connector.
2.
Connect devices to the CCM serial ports; see Device Cabling on page 119 for cable information.
Connect each serial device to its appropriate power source, following the devices documentation.
3.
Attach a LAN interface cable to the LAN connector on the CCM appliance. A CAT 5 cable is
required for 100BaseT operation. For CCM485x appliances, a CAT 6 cable is required for
1000BaseT operation.
4.
Insert the power cord into the back of the CCM appliance. Insert the other end of the power
cord into a grounded electrical receptor.
5.
Check that the POWER LED on the front of the unit is illuminated. If not, check the power
cable to ensure that it is inserted snugly into the back of the unit. The ONLINE LED will illuminate within two to three minutes to indicate that the self-test is complete. If the ONLINE
LED blinks, contact Technical Support for assistance.
6.
7.
Once the POWER, ONLINE and appropriate LEDs are illuminated, proceed with the configuration process (if you will be using BootP, remove power from the appliance).
Ensure that there is a BootP server on your network that is configured to correctly respond to a
BootP request from the CCM appliance. BootP servers require the Ethernet MAC address of
network devices. The Ethernet MAC address is printed on a label affixed to the appliance. See your
BootP servers system administrator guide for information about configuring the BootP server.
2.
After you have configured your networks BootP server with the CCM appliance Ethernet
MAC address, IP address, subnet mask and gateway, restore power to the CCM appliance and
wait for the ONLINE LED to illuminate. Once this occurs, the CCM appliance has completed
the BootP protocol, obtained its network address information and stored these in Flash.
3.
You may verify that the BootP process was successful with a ping command, which tests network connectivity. The ping command is entered as:
ping <ip_address>
For example, the following command tests the network connectivity of a CCM appliance with
the IP address 192.168.0.5.
ping 192.168.0.5
4.
If the CCM appliance completes the BootP successfully, you will see a display similar to
the following.
Pinging 192.168.0.5 with 32 bytes of data:
Reply from 192.168.0.5: bytes=32 time<10ms
Reply from 192.168.0.5: bytes=32 time<10ms
Reply from 192.168.0.5: bytes=32 time<10ms
Reply from 192.168.0.5: bytes=32 time<10ms
TTL=128
TTL=128
TTL=128
TTL=128
If the CCM appliance did not successfully obtain its IP address with the BootP protocol, you
will see a display similar to the following.
Pinging
Request
Request
Request
Request
In this case, check the address information provided to the BootP server to confirm it is correct.
Verify that the Ethernet LAN adaptor cable is correctly installed on the CCM appliance and the
Ethernet hub.
After the network address settings are configured successfully, launch a Telnet session to the
assigned IP address. Then, see Initial CCM appliance login on page 10.
To configure the CCM appliance using the serial CLI:
1.
Attach a compatible device to the console port. The compatible device types are: ASCII,
VT52, VT100, VT102, VT220 and VT320.
For cable and adaptor information, see Device Cabling on page 119. You may use any terminal
emulation program that is available on your system.
10
2.
9600
8
1
None
3.
Press the Return or Enter key until a prompt appears, requesting your username. If you do not
receive a prompt after pressing the key five times, check your cable and serial settings to be
sure that they are correct.
4.
At the Username prompt, type Admin. At the Password prompt, press Return.
Username: Admin
Password:
Authentication Complete
CCM configuration is required.
2.
Once authentication completes, the CCM appliance prompts for any missing configuration values that are required for operation.
If you already provided the IP address, subnet mask and gateway, you will not be prompted for
those values again.
If you have not already provided the network information, you will be prompted for them.
Enter the addresses using standard dot notation.
CCM configuration is required
Enter CCM IP address > 192.168.0.5
Enter CCM Subnet mask > 255.255.255.0
Enter CCM Gateway address > 0.0.0.0
3.
You are prompted for a new Admin password. Passwords are case sensitive and must contain
3-16 alphanumeric or hyphen characters. You must enter the new password twice to confirm
that you entered it correctly.
Enter CCM New Admin Password > *****
Confirm New Admin Password > *****
After you have provided the required configuration information, a confirmation message appears
while the CCM appliance stores the values in its configuration database.
11
You have now completed the initial login, and you may enter additional commands at the CLI
prompt (>). To configure other CCM appliance ports, see Configuring Port Settings on page 15.
Rebooting
During a reboot, any active Telnet sessions, including your own, are terminated. Any configuration
changes that require a reboot will become effective when the reboot completes.
To reboot the appliance in hardware:
1.
Locate the recessed RESET button on the front of the CCM appliance. An opened paper clip
may be used to depress the button.
2.
Insert the opened paper clip in the recess, then depress the button.
Reinitializing
Reinitializing the CCM appliance removes configured information. This may be useful when
reinstalling the unit at another location in your network.You may erase the configuration database,
which contains all nonvolatile data except the IP address, subnet mask and gateway. You may also
erase both the configuration database and the network address information.
To reinitialize the CCM appliance in hardware:
1.
Locate the recessed INIT button on the front of the CCM appliance. An opened paper clip may
be used to depress the button.
2.
Insert the end of the opened paper clip in the recess, then depress and hold the button. The
ONLINE LED will blink, indicating an initialization has been requested. You have approximately seven seconds to release the button before any action is taken.
After seven seconds, the ONLINE LED will blink more rapidly to confirm that the CCM
configuration database has been erased. Continuing to hold the INIT button for a few more seconds
will erase the IP address as well. The ONLINE LED will blink faster to confirm the deletion.
If any portion of Flash is erased, the CCM appliance reboots when the INIT button is released.
To reinitialize the CCM appliance with a command:
1.
Issue a Server Init command with the Config parameter if you wish to erase the configuration database but retain the network address information.
-orUse the All parameter if you wish to erase the configuration database and the network
address information.
12
2.
The appliance reboots after initializing the database and copying it to the configuration Flash.
Go to the Avocent web site, www.avocent.com/support, to locate and download the proper AV
operation application image.
2.
Issue a Server Security command to ensure that DS authentication is not enabled on the appliance and that no DSView 3 software server certificates are stored.
a.
Use the Auth parameter to specify any authentication methods you wish to use, other than
DS (that is, DS must not be included in the authentication method specification).
b.
Use the DSClear parameter to clear any stored DSView 3 software server certificates.
SERVER SECURITY AUTHENTICATION=<auth> DSCLEAR
3.
Issue a Server Flash command to update the appliance with the image that supports the
AVWorks software.
SERVER FLASH APP HOSTIP=<tftp_add> IMAGE=<host_file>
Alternatively, you may reinitialize the CCM appliance (using the INIT button on the front panel or
by issuing a Server Init command) to clear the database. This will clear any stored DSView 3
software server certificates. You may then issue the Server Security command to specify
authentication methods other than DS, followed by a Server Flash command to load the AV
operation application image.
13
CHAPTER
Operations
3
Overview
The CCM console management appliance and its ports are easily configured and managed to meet
your requirements for device connection, user authentication, access control, power status
monitoring, port history information display and Simple Network Management Protocol (SNMP)
compliance for use with third party network management products.
Enabling/disabling connections to devices from the console port - see Connecting to devices
from the console port on page 22
The modem initialization character - see Configuring and using dial-in connections on page 23
The CLI access character that will suspend a device session and place you in CLI command
mode (this value may be overridden at the port level) - see CLI Mode on page 30
Local port history file processing options during connection and when a session ends - see
Managing Port History on page 40
The session time-out value, which indicates the period of inactivity that must occur before a
session is ended (this value may be overridden at the port level) - see Session time-out on
page 31
14
To update the boot or application firmware on the appliance, use the Server Flash command,
described on page 83. If you wish to change the application firmware to a version that supports a
different operation (that is, from AV operation to DS operation or vice versa), see Configuring the
Appliance for AV Operation or DS Operation on page 12.
The appliance may be rebooted or reinitialized by pressing a button on the appliance or by issuing a
command; see Rebooting and Reinitializing the CCM Appliance on page 11.
Enabling/disabling features
Table 3.1: Appliance Feature Reference
For information about using this feature
PPP
Security lock-out
Session sharing
SNMP
SSH
Chapter 3: Operations
15
If you want the time to be updated periodically, specify an update interval of up to 99 hours. If you
specify a zero interval value (which is the default), the time will be updated only when the CCM
appliance reboots.
When you enable NTP, you are prompted to confirm or cancel the operation.
To disable NTP, issue an NTP command with the Disable parameter.
NTP DISABLE
See NTP Command on page 67 for more information.
To display NTP information:
Issue a Show NTP command.
See Show NTP command on page 98 for more information.
Value
Target device
Console
Name
Baud rate
9600
Parity
None
Stop bits
Flow control
None
Time-out
16
Value
Power
None
Chapter 3: Operations
17
Port access
The port access control method can be either by port or by group.
The port access method may affect the listing of available ports when using the Connect command.
For example, if a users access is by group, the list of available ports will only include valid groups
of which that user is a member.
Access by port
When access is by port, the user account may contain port access rights. For physical ports, this can
be specified with specific port numbers or PALL, which grants access to all ports. If the users
account contains access levels rather than rights, the ADMIN and APPLIANCEADMIN levels
include PALL access. For virtual ports, the PALL access right is required. For more information,
see Access levels and rights on page 33.
Access by group
Access control groups allow a user account to be granted access to a group of ports using a single
specification. Using port groups also simplifies access control when using external RADIUS or
LDAP servers or when moving a user database from one CCM appliance to another. Group based
access can be used on both physical and virtual ports.
Group settings are stored as a list of strings for each user and for each port. Each user has a list of
groups that they can access and each port has a list of groups to which it belongs. These are
separate lists.
When access is by group, the right to access a port is determined by whether that username is a
member of a group that has been granted access to the port. However, even when access is by
group, a user with PALL access rights can still access all ports.
For example, assume that physical ports 1, 2, 3 and 4 are assigned to a port group named LINUX.
Physical ports 5, 6, 7 and 8 are assigned to a port group named ROUTERS.
Users who must be able to access all Linux devices can be granted this right by being assigned to
the LINUX group of users (using a Group Add/Set command) or by having the LINUX group
specified in each of their user accounts (using a User Add/Set command). Those users will be able
to access the devices connected to ports 1, 2, 3 and 4.
Users who must be able to access Linux and router devices can be granted this right by being
assigned to both the LINUX and ROUTERS group of users or by having both the LINUX and the
ROUTERS groups specified in their user accounts. Those users will be able to access the devices
connected to ports 1 through 8.
Although unlikely, it is possible for a user to have access to an empty port group (a group to which
no ports belong). When all ports are removed from a group, the group no longer exists; however,
users on this CCM appliance will remain in that group. A warning message will be displayed if you
issue a User Add/Set command and use the Group parameter to specify a group that doesnt have
ports assigned to it.
Although also unlikely, it is possible for a port to belong to a group that no users can access.
18
Each port may belong to up to 8 groups. Multiple ports may belong to the same port group. Up to 8
port groups may then be specified in a user account.
Up to 8 port groups may be specified for a CCM850 appliance user, up to 16 port groups for a
CCM1650 appliance user and up to 48 port groups for a CCM485x appliance user.
Managing groups
The most convenient way to add, modify and delete groups is with the Group commands.
Alternatively, you may use the Group parameter in Port Add, Port Set, User Add and User Set
commands to add or change group membership; however, the Group commands provide an easier,
centralized method.
To specify the access control method:
Issue a Server Security command with the Access parameter.
SERVER SECURITY . . . ACCESS=BYPORT|BYGROUP
To add a group:
To add a group to one or more ports, issue a Group Add command with the Port parameter and a
comma-delimited list of port names/numbers.
GROUP <group> ADD PORT=<port>
To add a group to one or more users, issue a Group Add command with the User parameter and a
comma-delimited list of usernames.
GROUP <group> ADD USER=<user>
For more information, see Group Add command on page 63.
(Alternately, you may specify groups using the Group parameter in a Port Add, Port Set, User Add
or User Set command.)
To change a groups membership:
To change the membership of a group of ports, use the Group Set command with the Port
parameter and a comma-delimited list of port names/numbers to add, remove or replace.
GROUP <group> SET PORT=<port>
To change the membership of a group of users, use the Group Set command with the User
parameter and a comma-delimited list of usernames to add, remove or replace.
GROUP <group> SET USER=<user>
You may add, remove or replace membership with a Group Set command. For more information,
see Group Set command on page 64.
(Alternately, you may specify groups using the Group parameter in a Port Add, Port Set, User Add
or User Set command.)
To display group information:
To display one or more groups and their membership, issue a Show Group command
Chapter 3: Operations
19
Value
Username
Null
20
Value
Password
Null
Time-out
15 minutes
Chapter 3: Operations
21
You may request configuration and status information about a single physical or virtual port or all
physical and virtual ports. You may also request information about port names and port groups.
For more information, see Show Port command on page 99.
22
For example, the following Telnet command connects to the serial device attached to physical port
4 of the CCM appliance.
telnet 192.168.0.5 3004
If an authentication method other than None has been configured for the CCM appliance, you will
be prompted for a username and password. Once authentication completes, your connection is
confirmed. When you successfully connect to the serial device, you will see a display similar to
the following.
Username: Myname
Password: ******
Authentication Complete
Connected to Port: 7 9600,8,N,1,XON/XOFF
If the authentication method is configured as None, you may Telnet and connect to a serial device
without entering credentials; however, credentials are always required when connecting to the
CCM CLI.
NOTE: When using AVWorks software, the configuration of the credential caching feature may affect whether
you are prompted for a username and password. See the AVWorks Installer/User Guide for more information.
Data entered at the Telnet client is written to the serial device. Any data received by the CCM
appliance from the serial device is output to your Telnet client.
Issue a Server CLI command, using the Connect parameter to enable the use of the Connect
command from the console port. (This need only be done one time.)
SERVER CLI CONNECT=ON
2.
3.
To end a device session that was initiated with a Connect command, issue a Disconnect command.
Chapter 3: Operations
23
DISCONNECT
For more information, see Server CLI command on page 81, Connect Command on page 61 and
Disconnect Command on page 62.
Issue a Server CLI command, using the Modeminit parameter to specify the modem
initialization string.
SERVER CLI MODEMINIT=<string>
The string must be enclosed in quotes and must include at least the command settings ATV1
and S0=1, which cause the modem to issue verbose response strings and autoanswer the phone
on the first ring. For more information, see Server CLI command on page 81.
The modem initialization string is sent to the cabled modem when any of the following
conditions occur:
2.
Upon successful modem connection, press the Enter key until the login prompt appears.
Using PPP
The CCM appliance supports remote PPP access using an autoanswer modem that answers calls
and establishes the PPP protocol with a dial-in client. You may establish Telnet or SSH
connections over PPP.
PPP dial-in may be used to access a remote CCM appliance that does not warrant a WAN (Wide
Area Network) link to the Ethernet interface. The PPP dial-in may also be used to access a subnet
containing remote devices in the event of a WAN link failure. In this case, the PPP provides an
alternate path to one or more remote devices.
To use PPP, you must configure a modem in autoanswer mode on the console port; see Configuring
and using dial-in connections on page 23. Once the PPP connection is established, you must launch
24
an application that connects to the CCM appliance or to one of its ports. The PPP connection is
only a communications interface to the CCM appliance.
The CCM appliance implements a PPP server that uses CHAP (Challenge Authentication
Protocol). Passwords are not accepted in the clear on PPP connections.
To enable or disable a PPP server on the console port:
1.
To enable a PPP server on the console port, issue a Server PPP command with the Enable parameter.
SERVER PPP ENABLE LOCALIP=<local_ip> REMOTEIP=<rem_ip>
[MASK=<subnet>]
You must specify local and remote IP addresses to be used for the CCM appliance and client
ends of the PPP connection respectively. You are prompted to confirm or cancel the changes.
2.
To disable a PPP server, issue a Server PPP command with the Disable parameter.
SERVER PPP DISABLE
Using SSH
The CCM console management appliance supports version 2 of the SSH protocol (SSH2). The
CCM SSH server operates on the standard SSH port 22. The shell for this connection provides a
CLI prompt as if you had established a Telnet connection on port 23. The shell request for this
connection is for CLI access.
SSH connections to specific serial ports may be made on TCP ports that are numbered with values
100 greater than the standard 30xx Telnet ports for the CCM appliance. For example, if port 7 is
configured for Telnet access on port 3007, then port 3107 will be a direct SSH connection for port
7. When SSH is enabled, Telnet port 23 connections will be accepted from other clients if the
Server Security command includes the Encrypt=SSH,None parameter, which indicates that both
SSH and plain text connections will be allowed. Connecting to Telnet port 23 may also be tunneled
through a connection to SSH port 22.
SSH server keys
When SSH is enabled for the first time, all sessions are terminated and the CCM appliance
generates an SSH server key. The key generation process may take up to three minutes. The key is
computed at random and is stored in the CCM configuration database.
In most cases, the SSH server key should not be modified because most SSH clients will associate
the key with the IP address of the CCM appliance. During the first connection to a new SSH server,
the client will display the SSH servers key. You will be prompted to indicate if it should be stored
on the SSH client. After the first connection, most SSH clients will validate the key when
Chapter 3: Operations
25
connecting to the CCM appliance. This provides an extra layer of security because the SSH client
can verify the key sent by the server each time it connects.
When you disable SSH and later reenable it, you may either use the existing server key or compute
a new one. If you are reenabling the same server at the same IP address, it is recommended that you
use the existing key, as SSH clients may be using it for verification. If you are moving the CCM
appliance to another location and changing the IP address, you may wish to generate a new SSH
server key.
Authenticating an SSH user
SSH is enabled and disabled with the Server SSH command. When you enable SSH, you may
specify the authentication method(s) that will be used for SSH connections. The method may be a
password, an SSH key or both. A users password and SSH key are specified with a User Add or
User Set command. All SSH keys must be RSA keys. DSA keys are not supported.
Table 3.4 lists and describes the valid SSH authentication methods that may be specified with a
Server SSH command.
Table 3.4: SSH Authentication Methods
Method
Description
PW (default)
KEY
SSH connections will be authenticated with an SSH key. With this method, a users
definition must include valid SSH key information in order for that user to
authenticate an SSH session. Key authentication is always local; RADIUS and LDAP
are not supported. For more information, see SSH user keys on page 26.
PW|KEY or KEY|PW
PW&KEY or KEY&PW
SSH key authentication always uses the access rights from the local user database. Depending on
the server authentication method specified with the Server Security command, SSH password
authentication will use the access rights from the local user database or the values returned by the
26
RADIUS or LDAP server. When the CCM appliance is Flashed for DS operation, SSH password
authentication will use the access rights returned by the authentication service used by the DSView
3 software.
With either of the or methods (PW|KEY and KEY|PW), the user access rights are determined
from the method used to authenticate the user.
With either of the and methods (PW&KEY and KEY&PW), the user access rights are
determined from the first method specified. If PW&KEY is specified, the access rights from the
password authentication will be used. If KEY&PW is specified, the access rights from the key
authentication will be used.
For more information, see Using Authentication Methods on page 34.
SSH user keys
A users SSH key is specified in a User Add or User Set command. You may define a key even if
SSH is not currently enabled. The key may be specified in one of two ways:
When using the SSHKEY and FTPIP keyword pair to define the network location of a users
SSH key file, the SSHKEY parameter specifies the name of the uuencoded (Unix to Unix
encoded) public key file on an FTP server. The maximum file size that can be received is 4K
bytes. The FTPIP parameter specifies the FTP servers IP address.
When this method is specified, the CCM appliance initiates an FTP client request to the
specified IP address. The CCM appliance then prompts the user for an FTP username and
password for connection. When connected, the CCM appliance will GET the specified key file
and the FTP connection will be closed. The CCM appliance then stores the SSH key with the
username in the CCM user database.
When using the KEY keyword to specify the SSH key, the KEY parameter specifies the actual
uuencoded SSH key. This is for configurations that do not implement an FTP server. The CCM
appliance stores the specified key in the CCM user database.
The CCM appliance processes a uuencoded SSH2 public key file with the format described in the
IETF document draft-ietf-secshpublickeyfile-02. The key must follow all format requirements. The
UNIX ssh-keygen2 generates this file format. The CCM appliance also processes a uuencoded
SSH1 public key file. The UNIX ssh-keygen generates this file format.
To enable SSH session access to the CCM appliance:
1.
Issue a Show Server Security command to ensure that you are using an authentication method
other than None.
SHOW SERVER SECURITY
2.
Issue a Server SSH command with the Enable parameter. You may also specify an
authentication method.
SERVER SSH ENABLE AUTH=<auth>
If an authentication method is not specified, the previous authentication parameter will be
used. The default value is AUTH=PW.
Chapter 3: Operations
27
3.
If you are enabling SSH for the first time, you are advised that all other CCM appliance
sessions will be terminated. Enter Y to continue or N to cancel.
4.
If you are reenabling SSH, you are prompted to use the existing SSH server key or generate a
new key. Enter Y to use the existing key or N to generate a new key.
The maximum number of concurrent sessions allowed on a CCM appliance is based on the
following calculation:
(2 x Number of Physical Ports) + (2 x Number of Configured Virtual Ports)
A maximum of four concurrent sessions are allowed per port (physical or virtual).
For example, if you have 7 virtual ports configured on a CCM1650 appliance, the maximum
number of concurrent sessions on the appliance is 46 (2 x 16 physical ports = 32; 2 x 7 configured
virtual ports = 14; 32 + 14 = 46). However, at any given time, only four concurrent sessions will be
allowed on any single physical or virtual port.
One SoL connection per BMC is allowed. Up to four IPMI connections may be established to
each BMC.
You may:
Disable sharing. In this case, only one session per port may be active at a time.
28
Enable automatic session sharing. In this case, a user will automatically be connected to a port
even if it is in use (with restrictions noted in the following examples).
Enable session sharing with the query option. In this case, when a port is in use, the session
originator (the user who initiated the first session) must grant permission before other users are
able to join a session on that port.
Session sharing and the preemption of device sessions are also affected by a users configured
access level or preemption level (which is configured with the User Add/Set commands).
When the CCM appliance is Flashed for AV operation, the users configured access level is
used for session sharing and preemption. There are three access levels, with the following hierarchy (highest to lowest):
APPLIANCEADMIN > ADMIN > USER
See Access levels and rights on page 33 for more information.
When the CCM appliance is Flashed for DS operation, the users configured preemption level
is used for session sharing preemption. There are four preemption levels, with the following
hierarchy (highest to lowest):
4>3>2>1
For example, assume user A is currently accessing a device, and user B wishes to access the same
device. If user Bs access/preemption level is equal to or higher than user As access/preemption
level, then user B may be allowed to preempt user As device session.
Any user may also request exclusive access to a port if there is no other existing connection to that
port. This is done on the login screen by adding the E parameter after the username or by adding the
Exclusive parameter with the Connect command.
The following examples show the interaction between share mode and access/preemption levels.
Session sharing examples
These examples illustrate session sharing and preemption for one port and two users. Assume this
port is currently in use by the session originator (SO). Another user, the requesting user (RU),
wants to connect to the same port. For simplicity, also assume that if RU is allowed to connect, it
will not exceed the maximum allowable number of sessions per port or sessions per appliance.
Example 1 - SOs access/preemption level is higher than RUs access/preemption level
Chapter 3: Operations
29
RU will not be connected to the port. (In this case, it does not matter whether SO is connected
exclusively or non-exclusively.)
Example 2 - RUs access/preemption level is equal to or higher than SOs access/
preemption level
In a shared session, if the SO quits the session, the next user sharing the session will become the
SO. If the SO is logged out by another user, all sessions that are shared with the SO will be
terminated, as well as the SOs session.
To configure criteria to be used for session sharing and preemption:
Issue a User Add or User Set command.
If the CCM appliance is Flashed for AV operation, include the Access parameter, indicating
the desired access level or rights.
If the CCM appliance is Flashed for DS operation, include the Preempt parameter, indicating
the desired preemption level.
30
CLI Mode
While you are connected to an attached serial device, you may enter CLI mode and enter CCM
appliance commands.
To enter or exit CLI mode when connected to a serial device:
1.
To enter CLI mode, type the CLI access character, which is Ctrl-D by default. At the CLI
prompt (>), you may enter CCM commands.
2.
To exit CLI mode and return to the session with the attached device, issue a Resume command.
RESUME
Chapter 3: Operations
31
For more information, see Port Add command on page 69, Port Set command on page 75 and
Server CLI command on page 81.
To display CLI access character information:
Issue a Show Server CLI or a Show Port command.
SHOW SERVER CLI
SHOW PORT
For more information, see Show Server CLI command on page 105 and Show Port command on
page 99.
Session time-out
The CCM console management appliance monitors data traffic when you are connected to an
attached serial device. You may specify a time-out value with the Server CLI command. You may
also specify a time-out value for each port with the Port Set command (or Port Add for virtual
ports). The value indicates the number of idle minutes the CCM appliance will wait before
32
dropping a connection to that port. When a Port Set/Add time-out value is omitted or set to zero, the
port will use the value specified in the Server CLI command. To completely disable port time-outs,
the Server CLI time-out and the Port Set/Add time-out values must both be zero.
To display information about one user, issue a Show User command, specifying the username.
SHOW USER <username>
Chapter 3: Operations
2.
33
To display information about all users, issue a Show User command with the All parameter.
SHOW USER ALL
3.
To display information about group membership, issue a Show User command with the
Group parameter.
SHOW USER GROUP
The APPLIANCEADMIN level has the access rights PALL, USER, SCON, SMON, PCON
and BREAK
The ADMIN level has the access rights PALL, USER, SMON, PCON and BREAK
The USER access level has no port access rights by default (this level cannot be expressly
configured for a user account; it is assigned based on the criteria described in Access rights on
page 34)
Description
PCON
The Port Configuration access right allows the user to modify port settings. Grant PCON
access only to users who need to issue the Port Set command.
SCON
The Server Configuration access right allows the user to change the CCM configurations,
including setting the IP address and updating the program load in Flash. Grant SCON
access only to users who need to administer the CCM appliance.
SMON
The Server Monitor access right allows the user to view CCM appliance status and
monitor serial port activity. Grant SMON access only to users who need to assist other
users in accessing attached serial devices.
USER
The USER access right allows the user to modify the user database. Grant USER access
only to users who need to add users, change user specifications or delete users.
If local user authentication will be used, at least one user must have USER access rights;
otherwise, the user database cannot be changed.
Do not confuse this access right with the predefined USER access level.
BREAK
The BREAK access right allows the user to send a serial break sequence to the attached
serial device. On certain devices, this sequence has a special meaning. Grant BREAK
access only to users who need to use the Port Break command.
Pn, Px-y or
PALL
The Port access right gives a user access to one or more serial ports and the attached
serial devices. You may grant access to specific physical ports (Pn), a range of physical
ports (Px-y) or all physical and virtual serial ports (PALL).
34
The access levels and rights for each command are listed in Table 4.4 on page 55.
When the CCM appliance is Flashed for AV operation, session sharing preemption uses access
levels. See Session sharing and preemption on page 27 for more information.
When the CCM appliance is Flashed for DS operation, other access levels may control a users
permission to perform operations. See the DSView Installer/User Guide for more information
Access rights
You may fine-tune the predefined access levels in a user account by adding or subtracting granular
access rights with a User Set command.
When you create a user account, you may optionally specify individual access rights rather than a
predefined access level. In this case, an access level is assigned, based on the access
rights specification:
If the user account is created with a user rights specification that includes SCON, the
APPLIANCEADMIN access level is assigned.
If the user account is created with a user rights specification that includes USER (but not
SCON), the ADMIN access level is assigned.
If the user account is created with a user rights specification that does not include either SCON
or USER, the USER access level is assigned.
To configure a users access level/rights, issue a User Add command, using the Access parameter to specify a level or rights. (When you create a user account, you must also specify other
parameters; see Managing User Accounts on page 32 for more information.)
USER <username> ADD ACCESS=<access>
2.
To change a users access level/rights, issue a User Set command, using the Access parameter
to specify a level or rights.
USER <username> SET ACCESS=<access>
3.
To display the access level and rights for one or all users, issue a Show User command.
SHOW USER <username>|ALL
For more information, see User Add command on page 112, User Set command on page 114 and
Show User command on page 107.
Chapter 3: Operations
35
When the CCM appliance is Flashed for DS operation, local and DS authentication are enabled by
default. When the CCM appliance is Flashed for AV operation, local authentication is enabled
by default.
DS authentication
DS authentication uses either the internal DSView 3 software authentication service or an external
authentication service configured in the DSView 3 software. When you specify DS authentication,
you may also indicate the authentication mode.
Secure mode indicates that authentication will be locked to one DSView 3 software server
after a successful initial access, and the DSView 3 software server and appliance credentials
will be stored on the CCM appliance.
Trustall mode indicates that any DSView 3 software server may be used for authentication,
and the DSView 3 software server credentials will not be stored or validated on the
CCM appliance.
When the secure mode is used, you may clear the stored credentials used by the DSView 3 software
at any time. Reinitializing the CCM appliance also clears any stored credentials.
For more information, see the DSView Installer/User Guide.
Local authentication
Local authentication uses the CCM appliance internal user database to authenticate users. You may
optionally specify both local and another authentication method, in any order. In this case,
authentication will be attempted initially on the first method specified. If that fails, the second
method will be used for authentication, and so on. Local and downlocal authentication cannot both
be specified.
Downlocal authentication
Downlocal authentication uses the CCM appliance internal user database to authenticate users if
the configured external authentication services cannot be used due to lack of connection to the
external servers. Local and downlocal authentication cannot both be specified.
RADIUS authentication
RADIUS authentication uses an external third party RADIUS server containing a user database to
authenticate CCM appliance users. The CCM appliance, functioning as a RADIUS client, sends
usernames and passwords to the RADIUS server. If a username and password do not agree with
equivalent information on the RADIUS server, the CCM appliance is informed and the user is denied
CCM access. If the username and password are successfully validated on the RADIUS server, the
RADIUS server returns an attribute that indicates the access rights defined for that username.
To use RADIUS authentication, you must specify information about the primary RADIUS server
and optionally, a secondary RADIUS server to be used as a backup.
The RADIUS server definition values specified in CCM appliance commands must match
corresponding values configured on the RADIUS server. On the RADIUS server, you must include
CCM appliance-specific information: the list of valid users and their access rights/level for the
36
CCM appliance and any group assignments. Each user-rights attribute in the RADIUS servers
dictionary must be specified as a string containing the users access rights/level and any group
assignments for the CCM appliance, exactly matching the syntax used in the CCM User Add/User
Set command.
A user-rights attribute in the RADIUS servers dictionary may also contain a preemption value,
following the syntax used in the CCM User Add/User Set command. When this value appears in a
RADIUS attribute string, the authenticated user will have the specified preemption level. If the
attribute string does not contain the preempt keyword and value, the default Server CLI preemption
value will be used (see Console port session and connection authentication on page 36).
Consult your RADIUS administrators manual for information about specifying users and their
attributes. The exact process depends on the RADIUS server you are using.
When port group names are used, the CCM appliance will parse group names coming from a
RADIUS server, and allow access according to group content.
LDAP authentication
LDAP authentication uses an external third party LDAP server containing a user database to
authenticate CCM appliance users. The CCM appliance functions as an LDAP client.
To use LDAP authentication, you must specify information about the primary LDAP server and
optionally, a secondary LDAP server to be used as a backup. You must also supply search and
query information, and whether the LDAP server will be used just for authentication or for both
authentication and authorization. The LDAP configuration values specified in CCM appliance
commands must match corresponding values configured on the LDAP server(s).
Consult your LDAP administrators manual for information about specifying users, search and
query specifications. The exact process depends on the LDAP server you are using.
When port group names are used, the CCM appliance will parse group names coming from an
LDAP server, and allow access according to group content.
When using LDAP authentication on the CCM appliance, any port names containing spaces must
be changed to remove the spaces.
No authentication
When authentication is disabled, users are not authenticated. Telnet sessions to serial ports are
accepted immediately, and users are not prompted for a username or password. In this case, users
are granted access only to the port to which they are connected, including Break access.
Connections to the Telnet port (23), serial CLI and PPP are still authenticated using the local CCM
user database, even when authentication is expressly disabled. Generally, these communications
paths are used only by administrators, and authentication is enforced in order to establish
appropriate access rights.
Authentication may not be disabled when SSH session access is enabled.
Chapter 3: Operations
37
When the CCM appliance is Flashed for AV operation, console port session access is always
authenticated using the configured access level for the user in the CCM appliance local user
database (APPLIANCEADMIN, ADMIN, USER).
When the CCM appliance is Flashed for DS operation, user authentication at the console port may
be enabled or disabled. You may also configure a preemption level that will be used for a console
port user when user authentication is disabled on that port.
Enabling and disabling console port authentication
NOTE: Console port authentication may be enabled/disabled only when the CCM appliance is Flashed for
DS operation.
Console port authentication may be enabled/disabled with the Server CLI command, using the
Auth parameter.
When console port authentication is enabled for a CCM appliance that is Flashed for DS
operation, the user is authenticated using the methods specified with the Server Security
command (DS, LOCAL, LDAP, RADIUS and/or DOWNLOCAL).
However, if the configured methods include DS, LDAP or RADIUS, but not LOCAL or
DOWNLOCAL, and a negative response is not received from the DS, LDAP or RADIUS
authentication servers, local authentication will be used. This ensures that the console port
remains usable when remote authentication services cannot be contacted.
When local authentication is used, console port connections are authenticated against the local
CCM user database.
When console port authentication is disabled, a console port user is not authenticated. If that
console port user attempts to connect to another CCM port (assuming connection ability is
enabled), and that port is already in use, a server level preemption level is used. This level is
configured with the Server CLI command.
NOTE: PPP sessions are always authenticated using the method specified with the Server Security command.
In other words, enabling/disabling user authentication at the console port does not apply to PPP dialin connections.
For example, assume authentication has been disabled on the console port and that session sharing
is also disabled. A user starts a session on the console port (without having to log in with a
username and password), then attempts to connect to port 7, which is already in use by another
user. Since the console ports preemption level is not known (because no authentication occurred
during login), the configured server-level preemption value is used.
If that preemption level is lower than the current port 7 users preemption level, the connection
to port 7 will not be allowed.
If that preemption level is equal to or higher than the current port 7 users preemption level, the
serial CLI port user may choose to preempt the current port 7 users session.
38
Authentication summary
The CCM appliance allows concurrent use of multiple authentication methods (except local and
downlocal). This includes DS authentication, if the CCM appliance is Flashed for DS operation.
Examples when Flashed for AV operation
If you enable local and RADIUS authentication (in that order), authentication first uses the CCM
user database. If that fails, authentication goes to the defined RADIUS servers. If you enable
RADIUS and local authentication (in that order), authentication goes first to the defined RADIUS
servers. If that fails, the local CCM user database is used. Local is the default method.
Examples when Flashed for DS operation
If you enable local and DS authentication (which is the default), DSView 3 software clients will
always be authenticated using DSView 3 software internal or external authentication services.
Third party Telnet and SSH clients will be authenticated using the CCM local user database first,
and DSView 3 software second.
Similarly, if you enable DS and RADIUS authentication, DSView 3 software clients will always be
authenticated using the DSView 3 software internal or external authentication services. Third party
Telnet and SSH clients will be authenticated using the RADIUS servers.
As indicated above, the DSView 3 software internal or external authentication services will always
be used for the DSView 3 software clients. For third party Telnet and SSH clients, the order in
which you specify other authentication methods determines the order in which each method is used.
To specify the authentication method:
1.
2.
For LDAP authentication, issue Server LDAP Primary|Secondary, Server LDAP Auth, Server
LDAP Query and Server LDAP Search commands.
SERVER LDAP PRIMARY|SECONDARY [IP=<address>] [ACCESS=LDAP|LDAPS]
[PORT=<port>]
SERVER LDAP AUTH=AO|AA
SERVER LDAP QUERY [CSMODE=<csmode>] [TDMODE=<tdmode>]
[GROUP=<group>] [GMASK=<gmask>] [TMASK=<tmask>] [ACATTR=<acattr>]
Chapter 3: Operations
39
Issue a Server Security command, using the Authentication parameter to specify the
authentication method. Use the Encrypt parameter to enable plain text Telnet connections,
SSH connections or both.
SERVER SECURITY AUTHENTICATION=<auth> ENCRYPT=<conns>
When the CCM appliance is Flashed for AV operation, you may not specify DS authentication.
When the CCM appliance is Flashed for DS operation, DS authentication is automatically
appended to any other previously configured authentication methods.
You cannot specify both local and downlocal. If you specify downlocal, it should be the last
authentication method specified.
If you specify None, you cannot specify any other method. When SSH session access is
enabled, you must specify an authentication method other than None.
4.
Issue a Server CLI command, using the Auth parameter to indicate Enable or Disable. Use the
Preempt parameter with a value from 1-4 (lowest to highest) to configure a preemption value to be
used when console port authentication is disabled.
To clear stored DSView 3 software authentication credentials:
NOTE: This procedure is valid only when the CCM appliance is Flashed for DS operation.
Issue a Server Security command, using the DSClear parameter. This clears any stored credentials
used by the DSView 3 software.
To display authentication configuration information:
1.
2.
To display CCM RADIUS settings that were configured with the Server RADIUS command,
issue a Show Server RADIUS command.
SHOW SERVER RADIUS
40
3.
To display CCM LDAP settings that were configured with the Server LDAP commands, issue
a Show Server LDAP command.
SHOW SERVER LDAP
Server LDAP Auth command on page 85, Server LDAP Primary|Secondary command on
page 85, Server LDAP Query command on page 86 and Server LDAP Search command on
page 87
To enable security lock-out, issue a Server Security command, using the Lockout parameter
with a value between 1-999.
2.
To disable security lock-out, issue a Server Security command, using the Lockout=0 parameter.
Chapter 3: Operations
41
Description
Bottom
B sets the view location to the bottom of the file minus 23 history display lines, if available.
Clear
Help
Next
N increments the current history display line by the number of lines per page and outputs a
new history display page.
Prev
P decrements the current history display line by the number of lines per page and outputs a
new history display page.
Quit
Resume
R leaves port history mode and CLI mode and resumes the session with the attached serial device.
This single command is equivalent to sequentially using the Quit and Resume commands.
Search
S searches the port history buffer for a specified text string. Search strings with embedded
spaces must be enclosed in quotes.
By default, the search is case sensitive. To ignore case, enter -i before the string. To specify
direction, type -u to search up from the current line toward the top of the buffer or -d to search
down from the current line toward the bottom of the buffer. The search direction remains in
effect for subsequent searches until you change the search direction.
If the string is found, the current history display line is set to the line containing the string, and
the unit outputs a history display page. If the string is not found, an error message is displayed,
no other information is output and the current history display line is not changed.
Entering the Search command with no parameters searches again for the previous string in the
same direction as the previous search.
Top
T sets the current history display line to one and outputs a history display page.
42
The following command searches the history buffer for the string Process, ignoring case.
PORT HISTORY> s -i Process
For more information, see Server CLI command on page 81 and Port History command on page 73.
To access port history mode:
Issue a Port History command.
PORT HISTORY
The PORT HISTORY > prompt appears.
To control the port history buffer display when you connect:
Issue a Server CLI command, using the History parameter to specify the Hold or Auto option:
SERVER CLI HISTORY=HOLD|AUTO
If Hold is specified, the number of bytes in the history buffer is displayed, but none of the history data is output. In this case, you must access the CLI and use the Port History command to
view the ports history buffer content. This is the default mode.
If Auto is specified, the number of bytes in the history buffer is displayed and the entire content of the buffer is output to the Telnet session. In this mode, the history buffers content may
be reviewed in the Telnet clients scrolling window. You may also use the Port History command to view the ports history buffer content.
To control the port history buffer content when you end a session:
Issue a Server CLI command, using the History parameter to specify the Clear or Keep option:
SERVER CLI HISTORY=CLEAR|KEEP
If Clear is specified, the port history buffer is cleared and all data is discarded at the end of
a session.
If Keep is specified, the port history buffers content is retained at the end of a session.
Chapter 3: Operations
43
Linear - A file will be opened for writing at the end (appended); this is the default
By default, the TCP network protocol is used for communications between the CCM appliance and
the NFS server. You may use the Protocol parameter to specify the UDP or TCP protocol.
To enable/disable NFS on the CCM appliance:
1.
To enable NFS on the appliance, issue an NFS command with the Enable parameter.
NFS ENABLE [IP=<nfs_server>] [MOUNT=<mount>] [FTYPE=LINEAR|DAILY]
[PROTOCOL=TCP|UDP]
If this is the first time you are enabling NFS on the appliance, you must include the IP address
of the NFS server and a valid mount point. You may also specify the file type and protocol.
You may also use the NFS Enable command to change the current IP address, mount point, file
type or protocol.
44
When you enable NFS on one or all ports, you may specify a filename, which must be unique for
each port. If the daily file type was configured with the NFS Enable command, the filename must
also be unique for each day. You may use the substitution strings listed in Table 3.7 as part of the
filename specification, regardless of the file type.
Table 3.7: Substitution Strings in NFS Filename Specification
2-Character String
Substituted Value
%d
08
%D
Same as %m-%d-%y
01-08-04
%F
Same as %Y-%m-%d
(this is the ISO 8601 date format)
2004-01-08
%j
008
%m
Month (01-12)
01
%y
04
Chapter 3: Operations
45
Substituted Value
%Y
2004
%#
07
%n
Port name
Sales7
%%
If you do not specify a filename, the default is interpreted according to the configured file type:
If the file type is linear, the default is equivalent to P%#.hst for physical ports and P%n.hst for
virtual ports. The resulting filename for each physical port will include the port number; the
filename for each virtual port will include the port name.
If the file type is daily, the default is equivalent to P%#_%F.hst for physical ports and
P%n_%F.hst for virtual ports. The resulting daily filename for each port will include the port
number or name and the date.
Using the default filenames is the most convenient way to ensure that all filenames will be unique
for each port (and for each day, if the file type is daily).
However, if you choose to specify a filename rather than use the defaults, it must meet the
following criteria:
The filename must be different from the filename specified for any other port on the CCM
appliance. Using the port number substitution string (%#) or the port name substitution string
(%n) in the filename specification is one way to accomplish this.
If you are enabling NFS on all ports by including the All parameter, and you also include the
File parameter with a nondefault specification (that is, a specification other than File=), the
filename specification must explicitly include the %# port number or the %n port name
substitution string.
If the file type is daily, the filename specification must also include one or more of the date
substitution strings so that the resulting filename is different each day.
If you specify a nondefault filename, and later wish to use the default filename, you may change it
by issuing a Port NFS Enable command with a File= or File= parameter.
If you specify a nondefault filename, and later attempt to change the file type from linear to daily,
the request will be rejected if the filename specification does not include a date substitution string.
When writes will occur
When you enable NFS on a port, you may configure a buffer size and a time interval, which will be
used to determine when accumulated data is written to the NFS server file.
If you configure a buffer size of zero bytes and a time interval of zero seconds, data will be
written to the file as soon as the data is available (not to exceed one write per second).
46
If you configure a buffer size of zero bytes and a non-zero time interval, accumulated data will
be written to the file each time the specified interval elapses (unless 3584 or more bytes accumulate in the buffer before an interval elapses, in which case the data will be written then).
If you configure a non-zero buffer size and a time interval of zero seconds, data will be written
when the specified number of bytes has accumulated, regardless of elapsed time. (If you configure a size value larger than 3584, the data will be written whenever 3584 or more unwritten
bytes accumulate.)
To enable NFS on one or all ports, issue a Port NFS command with the Enable parameter.
PORT <port>|ALL NFS ENABLE [FILE=<file>] [SIZE=<bytes>] [TIME=<sec>]
You may specify a filename or use default values; see NFS filenames on page 44.You may also
configure size and time thresholds; see When writes will occur on page 45.
2.
To disable NFS on one or all ports, issue a Port NFS command with the Disable parameter.
PORT NFS DISABLE
Chapter 3: Operations
Defining, copying and deleting up to ten alert strings for each port
47
By default, SNMP is enabled but no traps are enabled and no trap destinations are defined.
To enable or disable SNMP processing:
1.
To enable SNMP processing, issue a Server SNMP command with the Enable parameter. This
is the default setting.
2.
To disable SNMP processing, issue a Server SNMP command with the Disable parameter.
To add an SNMP management entity address, issue a Server SNMP Manager command with
the Add parameter and the management entitys IP address. You may define up to four SNMP
management entity addresses, using separate commands.
SERVER SNMP MANAGER ADD <ip_address>
When you define at least one SNMP manager, SNMP requests are processed if they are from
one of the defined SNMP managers. If a request is not from one of the defined SNMP
managers, the SNMP request is discarded.
2.
To delete an SNMP management entity address, issue a Server SNMP Manager command with
the Delete parameter and the management entitys IP address.
SERVER SNMP MANAGER DELETE <ip_address>
If no management entities are defined, any SNMP manager may access the MIB. For more
information, see Server SNMP Manager command on page 94.
48
To enable SNMP traps, issue a Server SNMP Trap command with the Enable parameter.
SERVER SNMP TRAP ENABLE
The CCM appliance will display a numbered list of traps that are currently disabled with a
prompt requesting you to select trap(s) to enable. Indicate the traps to be enabled by entering a
traps list number, several numbers separated by commas, a range of numbers separated by a
dash or a combination of numbers with commas and dashes. To enable all traps, type ALL. To
cancel the command, press Enter.
- or To enable all SNMP traps, issue a Server SNMP Trap command with the Enable and All
parameters. In this case, the numbered list is not displayed.
SERVER SNMP TRAP ENABLE ALL
2.
To disable SNMP traps, issue a Server SNMP Trap command with the Disable parameter.
SERVER SNMP TRAP DISABLE
The CCM appliance will display a numbered list of traps that are currently enabled with a
prompt requesting you to select trap(s) to disable. Indicate the traps to be disabled by entering
a traps list number, several numbers separated by commas, a range of numbers separated by a
dash or a combination of numbers with commas and dashes. To disable all traps, type ALL. To
cancel the command, press Enter.
- or To disable all SNMP traps, issue a Server SNMP Trap command with the Disable and All
parameters. In this case, the numbered list is not displayed.
SERVER SNMP TRAP DISABLE ALL
For more information, see Server SNMP Trap command on page 94 and Supported Traps on
page 125.
To add or delete SNMP trap destination addresses:
1.
To add an SNMP trap destination address, issue a Server SNMP Trap Destination command
with the Add parameter and the destinations IP address. You may define up to four destination
addresses, using separate commands.
SERVER SNMP TRAP DESTINATION ADD <ip_address>
2.
To delete an SNMP trap destination address, issue a Server SNMP Trap Destination command
with the Delete parameter and the destinations IP address.
SERVER SNMP TRAP DESTINATION DELETE <ip_address>
For more information, see Server SNMP Trap Destination command on page 95.
To add, copy or delete port alert strings:
1.
To add a port alert string, issue a Port Alert Add command, specifying the port and a 3-32
character string. You may define up to ten strings for each port, using separate commands.
Chapter 3: Operations
49
The alert string will only generate a trap if the PortAlert trap is enabled with a Server SNMP
Trap command.
PORT <port> ALERT ADD <string>
2.
To delete a port alert string, issue a Port Alert Delete command, specifying a port.
PORT <port> ALERT DELETE
The CCM appliance displays a numbered list of alert strings that have been defined for the
specified port with a prompt requesting you to select alert string(s) to delete. Indicate the alert
strings to be deleted by entering an alert strings list number, several numbers separated by
commas, a range of numbers separated by a dash or a combination of numbers with commas
and dashes. To delete all alert strings, type ALL. To cancel the command, press Enter.
3.
To copy the defined alert strings from one port to another port, issue a Port Alert Copy command, specifying the ports to be copied to and from.
PORT <to_port> ALERT COPY <from_port>
At the confirmation prompt, press Y to confirm or N to cancel. When the copy operation
occurs, all previously defined strings on the port being copied to will be replaced.
For more information, see Port Alert Add command on page 70, Port Alert Copy command on
page 71 and Port Alert Delete command on page 71.
To display SNMP configuration information:
Issue a Show Server SNMP command.
SHOW SERVER SNMP
The display includes information specified with the Server SNMP, Server SNMP Community,
Server SNMP Manager, Server SNMP Trap and Server SNMP Trap Destination commands.
For more information, see Show Server SNMP command on page 107.
To display port alert string information:
Issue a Show Port Alert command, specifying a port.
SHOW PORT <port> ALERT
The display lists all the ports defined alert strings.
For more information, see Show Port command on page 99.
50
51
CHAPTER
Entering Commands
At the command prompt, type a command and then press Return or Enter. When the key is
pressed, the command line comprises all characters to the left of the cursor. The character at the
cursor and any characters to the right of the cursor are ignored. Table 4.1 lists the line editing
operations for VT100 compatible devices.
Table 4.1: Line Editing Operations for VT100 Compatible Devices
Operation
Action
Backspace
The character immediately before the cursor is erased and all text at and to the right of the
cursor moves one character to the left.
Left Arrow
If the cursor is not at the beginning of the line, the cursor moves one character to the left. If
the cursor is at the beginning of the line, no action is taken.
Right Arrow
If the cursor is not at the end of the line, the cursor moves one character to the right. If the
cursor is at the end of the line, no action is taken.
Up Arrow
The CLI maintains a buffer containing the last 16 typed command lines. If there is a
previous command line, it will be output as the current command line and may be edited. If
there is no previous command line in the command line buffer, the command line is set to
blanks and you may enter a new command.
Down Arrow
The next command in the CLI command line buffer is made available for edit. If there is no
next command line, the command line is set to blanks and you may enter a new command.
Delete
The character at the cursor position is deleted and all characters to the right of the cursor
position are moved left one character.
52
Table 4.2 lists the line editing operations for ASCII TTY devices. There is no command line buffer
available on an ASCII TTY device.
Table 4.2: Line Editing Operations for ASCII TTY Devices
Operation
Action
Backspace
Esc
Understanding Conventions
This section describes the parts of a CCM appliance command and the conventions used in this
document to describe a commands syntax.
Command syntax
A command may have four types of syntax: positional commands, positional parameters, keyword
parameters and keyword values. The following examples demonstrate the syntax types.
The following Set Port command changes the baud rate and flow control settings for port 2.
> PORT 2 SET BAUD=57600 FLOW=XONXOF
Table 4.3: Command Syntax Types in Example Command
Value
Syntax
PORT
Positional command.
Positional parameter that indicates the port number for the command.
SET
BAUD
57600
Keyword value indicating the baud rate value for the BAUD keyword parameter.
53
Syntax
FLOW
XONXOF
Keyword value.
Not every command will contain all syntax types. For example, the following command reboots the
CCM appliance.
>SERVER REBOOT
When you specify the terminal type with the Type parameter in the Server CLI command, you
must enter all characters.
When you specify an authentication method with the Auth parameter in the Server SSH
command, you must enter all characters.
When you specify control signal monitoring with the Power parameter in the Port Set
command, you must enter all characters.
When you specify the console port in commands such as Port Set and Show Port, you must
enter the capitalized abbreviation CON.
The IPMI command keyword may be abbreviated to IPM; however, when you issue any BMU
commands, or if you use any of the IPMI shortcut commands, none of the parameters may be
abbreviated. All BMU command keywords and parameters must be entered in their entirety.
See Using the BMU on page 138 for more information.
54
Case sensitivity
With the exception of usernames, passwords, port names and group names, commands are not case
sensitive; they may be entered in uppercase, lowercase or a combination. For example, all of the
following commands are correct.
>
>
>
>
NOTE: Usernames and passwords are case sensitive. These values are stored exactly as you enter them. For
example, the username Ann must be entered with an uppercase A and all other letters lowercase. The
username ANN will not be accepted as the username Ann. Usernames and passwords must contain 3-16
alphanumeric or hyphen characters.
Syntax errors
Any syntax errors are displayed, and where applicable, the error is underlined.
In the following example, the keyword parameter baud is misspelled. Even if more than three
characters are entered, they must all be correct.
> port 2 Set Baux=57600 flow=xon
---ERR 26 - SET keyword parameter invalid
In the following example, the keyword value 576 is not valid. Numeric keyword values must be
fully specified and may not be shortened to three characters.
> POR 2 SET BAUD=576 FLOW=XON
--ERR 27 - SET keyword value invalid
In the following example, there are spaces between BAUD, the equal sign and the value 57600.
Spaces are not permitted between keyword parameters and their values.
> POR 2 SET BAUD = 57600 FLOW=XON
-----------ERR 26 - SET keyword parameter invalid
Syntax conventions
This manual uses the following command syntax conventions:
Angle brackets < > surround user-supplied positional parameters and keyword parameter values.
In most cases, choices are separated by a vertical bar |. The description indicates if you may
specify more than one of the choices and how to separate multiple values. The exception is
the Server SSH command. In this case, the vertical bar is specified on the command line
when you wish to enable the password or key method (PW|KEY) or the key or password
method (KEY|PW).
55
Command Summary
Table 4.4 lists the CCM appliance commands, including a brief description plus the required access
rights and level. (For information about BMU commands, see page 138.)
Table 4.4: CCM Appliance Command Summary
Command
Connect
Disconnect
Help
IPMI
NFS
NTP
Port Add
Port Break
56
Port Delete
Port History
Port Logout
Port NFS
Port Refresh
Port Set
Specifies how carriage returns and linefeeds are treated in incoming or outgoing
serial data.
Access right: SCON or PCON
Access level: ADMIN or APPLIANCEADMIN
Quit
Resume
Server CLI
Specifies the console port type, CLI access character, modem initialization string,
port history mode operations and port time-out value.
For DS operation only: Also enables/disables device connection from the console
port and authentication of console port sessions.
Access right: SCON
Access level: APPLIANCEADMIN
Server Flash
Server Init
Server LDAP
Primary|Secondary
Server Ping
Server PPP
Server RADIUS
Server Reboot
Server Security
Specifies the user authentication method, access method, security lock-out setting
and connection methods.
For DS operation only: Clears stored DSView 3 software credentials
Access right: SCON
Access level: APPLIANCEADMIN
Server Set
Server Share
57
58
Server SNMP
Server SNMP
Community
Server SSH
Enables/disables SSH session access to the CCM appliance and specifies the SSH
authentication method.
Access right: SCON
Access level: APPLIANCEADMIN
Show Group
Show NFS
Show NTP
Show Port
Show Server
Show User
SPC
SPC Socket
User Add
User Delete
Deletes a user.
Access right: USER
Access level: ADMIN or APPLIANCEADMIN
User Logout
59
60
User Set
User Unlock
61
CHAPTER
Connect Command
The Connect command establishes a connection from the console port of the CCM appliance to a
device attached to a serial port on that CCM appliance. To use this command, you must have
previously issued a Server CLI command with the Connect=On parameter. For more information,
see Connecting to Serial Devices on page 21.
Your ability to connect to another port is also affected by session sharing and port access method.
For more information, see Session sharing and preemption on page 27 and Port access on page 17.
When the connect completes successfully, the message Connected to port x: will be displayed,
followed by the values for port_number,baud,bits_per_character,parity,stop_bits,flow_control.
Access right: port-specific
Access level: ADMIN, APPLIANCEADMIN or users with access to port
Syntax
Description
<port>
Port number (physical ports only) or name. You may specify an asterisk (*) as a
wildcard character, with or without other characters.
If the port specification is omitted, a menu will be displayed, listing all physical and
virtual ports that are available for serial connection (this excludes SPC ports, ports to
which you are already connected and ports you do not have permission to access).
If a port specification contains a wildcard, a menu will be displayed, listing all
physical and virtual ports that match the specification.
The menu will include your username plus the port access - if access is by port, Pall
will be displayed; if access is by group, the group names will be displayed. The
available ports will then be listed with their names, number (physical ports only) and
group (for group access only).
At the prompt, enter a port name or number. You may press Enter to cancel
the command.
EXCLUSIVE
Requests exclusive access to the port. This will initially be accommodated only if the
port is not currently in use.
62
Example
The following command establishes a connection from the CCM appliance console port to port 6.
>connect 6
The following command displays a subset of available ports - those beginning with the letter A and
to which the user has access.
>con A*
Port #
-----2
Group
----group1
groupVP
Disconnect Command
The Disconnect command terminates a session with a serial device that was previously initiated
with a Connect command.
Access right: port-specific
Access level: ADMIN, APPLIANCEADMIN or others with access to port
63
Syntax
DISCONNECT
Group Commands
The Group command has several forms, as listed in Table 5.2.
Table 5.2: Group Command Summary
Command
Description
Group Add
Group Delete
Group Set
Description
<group>
Group name (1-8 characters). Group names are case sensitive and must be unique.
If the name contains spaces, enclose the name in double quotes.
PORT=<port>
Port name or number. Separate multiple ports with commas. If an invalid port name/
number is specified, the entire command will fail.
USER=<user>
Example
The following command adds a group named mine, containing port numbers 1 and 3, and the ports
named PORT-2 and ACME.
group mine add port=1,3,PORT-2,ACME
64
Description
<group>
Group name. Group names are case sensitive. If the name contains spaces, enclose
the name in double quotes.
Description
<group>
Group name (1-8 characters). Group names are case sensitive. If the name contains
spaces, enclose the name in double quotes.
PORT=<port>
USER=<user>
65
Help Command
The Help command displays information about CCM appliance commands. For displays that span
more than one screen, -More- will appear on the last line of all screens but the last one. You may:
Press the Spacebar to see the next screen.
-orEnter Ctrl-J, Ctrl-M or press Enter to see the next line.
-orEnter q to quit.
Access right: none needed
Access level: none needed
Syntax
HELP [<command_name>]
Table 5.6: Help Command Parameter
Parameter
Description
<command_name>
Command name.
Default: Displays list of all commands
Examples
The following command displays information about the Show Server CLI command.
>help sho ser cli
The following command displays a list of all commands that begin with Server.
>help server
IPMI Command
The IPMI command accesses the BMU.
If no SoL connection is established, or if no virtual port name is specified with the command, you
will be prompted for server login information, including the IP address, username and password. If
you issue the IPMI command with a valid virtual port name and the configured login credentials are
correct, an IPMI session will be established to the specified BMC.
If you are serially connected to a valid virtual port, typing IPMI at the command prompt will
establish an IPMI session to that port. Typing IPMI <port_name> will establish an IPMI session to
the specified port.
After you have accessed the BMU, you may issue BMU commands. See Using the BMU on
page 138 for more information.
66
NOTE: You may also use IPMI shortcut commands that access the BMU, issue a BMU command and then
return to the CCM appliance CLI. See Using the BMU on page 138 for details.
IPMI [<port_name>]
Table 5.7: IPMI Command Parameter
Parameter
Description
<port_name>
NFS Command
The NFS command enables or disables use of the NFS feature on the CCM appliance, and specifies
the location of the NFS server, its mount point, the type of files that will be created and the protocol
to be used. For more information, see NFS history files on page 43.
Access right: SCON
Access level: APPLIANCEADMIN
Syntax
Description
ENABLE
IP=<nfs_server>
IP address of the NFS server, in IP dot notation. The NFS server must support
NFSv3 (RFC1813). This parameter is required if NFS is being enabled for the
first time.
MOUNT=<mount>
Mount point (subdirectory location) on the NFS server. This parameter is required if
NFS is being enabled for the first time. The NFS server must be configured to allow
the CCM appliance to access this file system location.
Linear indicates a file will be opened on the NFS server for writing at the end
(appended). Daily indicates a new file will be created on the NFS server
every midnight.
FTYPE=LINEAR|DAILY
For either file type, if the file being opened does not already exist, it will be created. If
the file already exists, it will be opened for writing at the end (appended).
Default = Linear
67
Description
Specifies the network protocol to be used between the CCM appliance and the
PROTOCOL=TCP|UDP NFS server.
Default = TCP
DISABLE
Examples
The following command enables the use of the NFS on the CCM appliance. The NFS server is
located at IP address 192.168.52.50, and files will be created under the subdirectory c/ccm_history
every midnight.
>nfs enable ip=192.168.52.50 mount=c/ccm_history ftype=daily
The following command disables using the NFS feature on the CCM appliance. If NFS is later
enabled again without additional parameters, the previously configured values will be used.
>nfs disable
NTP Command
The NTP command enables or disables use of the Network Time Protocol on the CCM appliance,
and specifies the location of the NTP server that will supply the time to the CCM appliance. For
more information, see Updating the Appliance Clock on page 14.
When you enable NTP, you are prompted to confirm or cancel the operation.
Access right: SCON
Access level: APPLIANCEADMIN
Syntax
Description
ENABLE
IP=<prim_add>
,<sec_addr>
IP address of the first NTP server to contact to obtain the time and optionally, the IP
address of the second NTP server. At least a primary address is required if NTP is
being enabled for the first time.
If a second server is specified, it will be contacted to obtain either the time (if the time
was not obtained from the first server) or the second servers status (if the time was
successfully obtained from the first server).
68
Description
UPDATE=<hours>
Interval for sending a time request to the NTP server and then updating the clock.
Valid values are 0-99 hours. A zero value indicates that the time should be requested
and the clock updated when the CCM appliance reboots.
Regardless of this parameters value, the clock is updated immediately when the
NTP Enable command is issued.
Default = 0 (update immediately and then only upon reboot)
DISABLE
Example
The following command enables use of NTP on the CCM appliance. The time requests will first be
made to the NTP server at IP address 192.168.50.200. The secondary NTP server at
192.168.50.220 will then be contacted to obtain either the time (if it was not provided by the
primary server) or the secondary servers status. The time will be updated immediately and then
every two hours.
>ntp enable ip=192.168.50.200,192.168.50.220 upd=2
Port Commands
The Port command has several forms, as listed in Table 5.10.
Table 5.10: Port Command Summary
Command
Description
Port Add
Port Break
Port Delete
Port History
Port Logout
Port NFS
Port Refresh
Port Set
69
Description
Specifies how carriage returns and linefeeds are treated in incoming or outgoing
serial data.
Description
<port_name>
1-32 character port name. The name cannot be Alert, All, Break, History,
Logout, Names, NFS or Set (in any case or any shortened form), CON or null
(). The name must be unique; two ports cannot have the same name. Port
names are case sensitive. The name cannot begin with a number or a space,
nor can it contain a double quote (), a comma (,) or an asterisk (*). If the name
contains spaces, enclose the name in double quotes.
If you are using LDAP authentication on the CCM appliance, the port name
cannot contain spaces.
SOCKET=<socket>
TCP port that must be entered on the Telnet client to connect to this serial
port. The new value becomes effective in subsequent sessions.
The valid range is 3000-5999 and 6064-65000 (6000-6063 should not
be used).
When SSH is enabled, the CCM appliance automatically adds 100 to the
specified value. When both plain text Telnet and SSH connections are
enabled, the +100 value will not appear in displays.
IP=<address>
IP address of the BMC, in standard dot notation. This value cannot be all
zeros, or a local loopback, broadcast or multicast (224.0.0.0239.255.255.255) address.
USERNAME=<username>
70
Description
PASSWORD=<password>
TIMEOUT=<time-out>
Number of idle minutes, in the range 1-90, that the CCM appliance will wait
before dropping a connection to the port. If the value is zero or omitted, the
port will use the time-out value specified in the Server CLI command. (To
completely disable port time-outs, the time-out values in the Port Add/Set and
Server CLI commands must both be zero.)
The new value does not affect an active session; it takes effect in
subsequent sessions.
Default = 0 (use value from Server CLI command)
CHAR=^<cli_char>
GROUP = <group>
Example
The following command adds a virtual port named VP1. The IP address of the BMC is
192.168.70.15 and socket 5001 is assigned.
>port VP1 add socket=5001 ip=192.168.70.15 username=user1
password=pword1
71
Description
<port>
<string>
3-32 character string. If the string contains embedded spaces, it must be enclosed
in quotes.
Description
<to_port>
<from_port>
Example
The following command copies the alert strings defined on physical port 1 to physical port 17,
replacing any previously defined alert strings on port 17.
>port 17 alert copy 1
72
Description
<port>
Example
The following command deletes defined alert strings from physical port 26.
>PORT 26 ALERT DELETE
Alert-strings assigned to port 26:
1) The first alert string
2) The second alert string
3) The third alert string
4) The fourth alert string
Select Alert-string(s) to delete>
PORT BREAK
Description
<port_name>
Port name.
ALL
73
PORT HISTORY
When you are in port history mode, you may issue the commands listed in Table 3.6 on page 41.
Examples
In history mode, the following command searches the history buffer in the downward direction for
the string connected to, ignoring case.
PORT HISTORY>s -d -i connected to
Description
<port>
74
Syntax
Description
ENABLE
port
Port name or number. If a port name, number or ALL is omitted, the action is
performed on the port to which you are connected.
ALL
FILE=<file>
SIZE=<bytes>
Number of bytes that will be buffered on the CCM appliance before being written to
the NFS server file. This threshold is used with the Time value to determine when
accumulated data will be written. Valid values are 0-3584 bytes.
Default = 0 bytes
TIME=<sec>
Maximum number of seconds that will be allowed to elapse before buffered data will
be written to the NFS server file. This threshold is used with the Size value to
determine when accumulated data will be written. Valid values are 0-65536 seconds.
Default = 1 second
DISABLE
Examples
The following command enables NFS on physical port 3, using the default filename specification,
and setting a size threshold of 20 bytes and a time threshold of zero. With this configuration, data
will be buffered according to the non-zero threshold value, 20 bytes, then it will be written to the
NFS history file. The history file will be named P03.hst if the file type is linear, or P03_<4-digit
year>-<2-digit_month>-<2-digit_day> if the file type is daily.
>port 3 nfs ena size=20 time=0 file=
The following command enables NFS on the virtual port named linux3, using the default filename
specification, and the same size and time thresholds as the previous example. In this case, the
history file will be named Plinux3.hst if the file type is linear, or Plinux3_<4-digit year>-<2digit_month>-<2-digit_day> if the file type is daily.
>port linux3 nfs ena size=20 time=0 file=
75
The following command enables NFS on physical port 7, using a substitution string within the
filename specification, and setting zero thresholds for both size and time. (This configuration will
not be acceptable if the file type is daily, because the file specification does not include a date
substitution string that would make each daily file uniquely named.) Assuming the file type is
linear, data will be written to the NFS server file named ccm_1_P07 as soon as it is available,
because both thresholds are zero.
>port 7 nfs ena size=0 time=0 file=ccm_1_%#
Description
<port_name>
ALL
Indicates that connection should be attempted to all virtual ports that are not
already connected.
76
Syntax
Description
<port>
A port number (physical port), port name (physical or virtual port) or CON.
If you are connected to a port and this parameter is omitted, the settings are
applied to the port for this connection; otherwise, this parameter must be
specified. This parameter is required when changing console port
(CON) settings.
ALL
Indicates that the port settings that follow should be applied to all ports, except
the console port.
If you have created virtual ports with Port Add commands, and you issue a Port
All Set command with a parameter that is valid for a virtual port, the specified
change will be applied to all virtual ports as well as all physical ports.
TD=<device>
Target device type. Valid values are Console and SPC. If SPC is specified, only
the Name and Group parameters may be specified with this command.
This parameter is not valid for the console port or for virtual ports.
Default = Console
NAME=<name>
1-32 character port name. The name cannot be Alert, All, Break, History, Logout,
Names, NFS or Set (in any case or any shortened form) or CON. The name must
be unique; two ports cannot have the same name. Port names are case
sensitive. The name cannot begin with a number or a space, nor can it contain a
double quote (), a comma (,) or an asterisk (*). If the name contains spaces,
enclose the name in double quotes.
To return a physical port name to its default value, specify Name= (you cannot
do this for a virtual port, because a virtual port does not have a default name).
This parameter is not valid for the console port.
You may not rename a virtual port when it has an active connection.
If you are using LDAP authentication on the CCM appliance, the port name
cannot contain spaces.
Default (physical ports only) = last 3 octets of MAC address, followed by P and
the port number
BAUD=<baud>
Baud rate. Valid values are: 50, 75, 110, 134, 150, 200. 300, 600, 1200, 2400,
4800, 9600, 19200, 38400, 57600 and 115200.
This parameter is not valid for virtual ports.
Default = 9600
SIZE=<size>
77
Description
PARITY=<parity>
STOP=<stopbits>
FLOW=<signal>
Flow control signal. For hardware flow control, be sure the control signals are
correctly wired, or data loss may occur. The flow control signal cannot also be
used for power status monitoring. Valid values are:
XONXOF
Software XON/XOFF flow control.
RTSCTS
Hardware RTS/CTS flow control.
DTRDCD
Hardware DTR/DCD flow control.
None
No flow control.
This parameter is not valid for virtual ports.
Default = None
TIMEOUT=<time-out>
Number of idle minutes, in the range 1-90, that the CCM appliance will wait
before dropping a connection to the port. If the value is zero or omitted, the port
will use the time-out value specified in the Server CLI command. (To completely
disable port time-outs, the time-out values in the Port Set and Server CLI
commands must both be zero.)
The new value does not affect an active session; it takes effect in
subsequent sessions.
Default = 0 (use value from Server CLI command)
78
Description
SOCKET=<socket>
TCP port that must be entered on the Telnet client to connect to this port. The
new value becomes effective in subsequent sessions.
The valid range is 3000-5999 and 6064-65000 (6000-6063 should not be used).
When SSH is enabled, the CCM appliance automatically adds 100 to the
specified value.
When All is specified, port 1 will be assigned the specified socket value plus 1,
port 2 will be assigned the specified value plus 2, and so on. After physical ports
are assigned values, any virtual ports (sorted in ASCII order) will be assigned
values in sequence.
When All is specified and SSH is enabled, port 1 will be assigned the specified
socket value plus 101, port 2 will be assigned the specified value plus 102, and
so on. Any virtual ports will be assigned values after the physical ports.
When both plain text Telnet and SSH connections are enabled, the +100 value
will not appear in displays.
This parameter is not valid for the console port.
Default = 3000 plus the port number, 3100 plus the port number if SSH is
enabled; see above for action taken if All is specified and when virtual ports
are configured
CHAR=^<cli_char>
TOGGLE=NONE|DTR
When set to DTR, the CCM appliance will toggle the ports DTR-out signal off for
1/2 second each time a connection is made to the port. This toggle is required to
awaken the console port of some devices.
This parameter is not valid for the console port or for virtual ports.
Default = None
POWER=<signal>
Control signal and state that indicates the target device has power on. The entire
value must be specified; abbreviations are not allowed. The specified signal
cannot also be used for flow control.
This parameter is not valid for the console port or for virtual ports.
Valid values are:
None
Disables power status monitoring.
HICTS
CTS high indicates power on.
LOCTS
CTS low indicates power on.
HIDCD
DCD high indicates power on.
LODCD
DCD low indicates power on.
HIDSR
DSR high indicates power on.
LODSR
DSR low indicates power on.
Default = None
79
Description
GROUP=<group>
Group name(s), up to eight characters each. Group names are case sensitive. If
the name contains spaces, enclose the name in double quotes.
A port may belong to up to eight groups.
If you are specifying settings for a single port, you may use one of three forms
(separate multiple groups with commas):
GROUP=<access> to specify all port groups.
GROUP=+<access> to specify only groups to be added.
GROUP=<access> to specify only groups to be deleted.
If you are specifying settings for all ports, you must use the following form:
GROUP=<access> to specify all port groups.
To delete all previously defined groups for the port, specify GROUP=.
This parameter is not valid for the console port.
IP=<address>
IP address of the BMC, in standard dot notation. This value cannot be all zeros,
or a local loopback, broadcast or multicast (224.0.0.0-239.255.255.255) address.
This parameter is valid only for virtual ports and cannot be used with the
All parameter.
USERNAME=<username>
PASSWORD=<password>
Examples
The following command sets a baud rate of 57600 and enables XON/XOFF flow control on
physical port 2.
>port 2 set baud=57600 flow=xonxof
The following command adds a group named acctg3 to the configuration for virtual port VP1
(which was previously configured with a Port Add command).
>port VP1 set group=+acctg3
80
Description
<port>
ALL
Indicates that the port settings that follow should be applied to all ports except the
console port.
IN|OUT
Either IN to specify translation for incoming data or OUT to specify translation for
outgoing data.
CR=<cr>
LF=<lf>|CRLF=CR
Quit Command
The Quit command terminates the current CCM appliance session and terminates your Telnet
connection to the unit.
Access right: none needed
Access level: all
Syntax
QUIT
Resume Command
The Resume command exits the CLI and resumes your connection to the device. The history buffer
contains any data received while you were in CLI mode.
Access right: none needed
Access level: all
Syntax
RESUME
81
Server Commands
The Server command has several forms, as listed in Table 5.21.
Table 5.21: Server Command Summary
Command
Description
Server CLI
Specifies the console port type, CLI access character, modem initialization
string, port history mode operations and port time-out value. You may also
enable/disable device connection from the console port.
For DS operation only: Also enables/disables authentication of console
port sessions and specifies a preemption level to be used when console port
authentication is disabled.
Server Flash
Server Init
Server Ping
Server PPP
Server RADIUS
Server Reboot
Server Security
Server Set
Server Share
Server SNMP
Server SNMP Trap Destination Defines/deletes destinations for enabled SNMP traps.
Server SSH
82
For DS operation only: Specifies a preemption level to be used for console port sessions when
authentication is disabled on that port
Description
TYPE=<type>
Terminal type to be used on the console port. The entire name of the type must
be specified; abbreviations are not permitted. Valid types are: ASCII, VT52,
VT100, VT102, VT220 and VT320.
Default: ASCII
CHAR=^<char>
CONNECT=ON|OFF
Enables or disables the ability to use the Connect command from the console
port. When enabled, a console port user may use the Connect command to
establish a connection to the serial device attached to another CCM appliance
serial port. When disabled, you cannot use the Connect command from the
console port.
Default = ON
83
Description
HISTORY=HOLD|AUTO
,CLEAR|KEEP
Port history file processing options during connection (Hold or Auto) and when a
session ends (Clear or Keep):
Hold
Upon connection you are informed of how much data is in the history
buffer, but the data is not displayed.
Auto
Upon connection you are informed of how much data is in the history
buffer, and it is then displayed.
Clear
The history buffers content is cleared when a session ends.
Keep
The history buffers content is retained when a session ends.
You cannot specify both Clear and Keep or both Hold and Auto.
Default = HOLD,CLEAR
MODEMINIT=<string>
TIMEOUT=<time-out>
Number of idle minutes, in the range 1-90, the CCM appliance will wait before
dropping a connection to a port. A zero value indicates no time-out. This value is
used for any CCM appliance port that has a zero time-out value or no time-out
value in its Port Set command (or Port Add command for a virtual port).
To completely disable port time-outs, the time-out values in the Port Add/Set and
Server CLI commands must both be zero.
Default = 15 minutes
AUTH=ENABLE|
DISABLE
PREEMPT=1|2|3|4
For DS operation only: Preemption level for console port session users when
authentication is disabled for the console port (Auth=disable).
Default = 4
There are two program images that you may update in the CCM appliance Flash. The boot image
file (ccm50bt.img) contains the CCM appliance startup and self-test logic. The application image
(ccm50app.img) contains the program that provides CCM appliance functionality.
84
You will need a TFTP server. Download the latest Flash image from the Avocent web site
(www.avocent.com), and save the image file to the appropriate directory on the TFTP server.
NOTE: Powering down a system in the middle of a boot Flash update may render the unit inoperable. To update
the bootstrap, it is recommended that the unit be placed on a UPS under controlled conditions to avoid
interruption of the boot Flash update process.
Description
BOOT|APP
Indicates either the boot image should be updated or the application image should
be updated.
HOSTIP=<tftp_add>
IMAGE=<host_file>
Example
The following command updates the boot image program using the image filename
c:\winnt\system32\drivers\ccm50bt.img, which is located on the TFTP server host located
at 192.168.1.16.
>ser fla app hos=192.168.1.16 ima=c:\winnt\system32\drivers\ccm50bt.img
Description
CONFIG
Reinitializes the appliance but retains the IP address, subnet mask and gateway.
ALL
85
Description
AO|AA
AO - Authentication only - the LDAP server will authenticate and the local database
will be used to authorize the user.
AA - Authentication and authorization. The LDAP server will authenticate and
authorize the user.
Default = AA
Description
PRIMARY|SECONDARY
Indicates either the primary LDAP server or the secondary LDAP server is
being defined or deleted. You cannot define a secondary LDAP server until a
primary LDAP server is defined.
IP=<address>
IP address of the LDAP server, in dot notation or domain name. The first time
an LDAP server is defined, this parameter must be specified.
86
Description
ACCESS=LDAP|LDAPS
PORT=<port>
DELETE
Description
CSMODE=<csmode>
TDMODE=<tdmode>
Target device authentication mode. Valid values are BASIC, USERATTR and
GROUPATTR. If the CSMODE parameter value is BASIC, this parameter
value must also be BASIC (set in the same command or previously).
Default = BASIC
GROUP=<group>
Name (0-64 characters) of the group container on the LDAP server. Enclose
the name in double quotes if it contains spaces.
Default = Console Switches
GMASK=<gmask>
Mask (0-32 characters) used to select the console switch name. Enclose the
name in double quotes if it contains spaces.
Default = ou=%1
TMASK=<tmask>
Mask (0-32 characters) used to select the target device name. Enclose the
name in double quotes if it contains spaces.
Default = cn=%1
87
Description
ACATTR=<acattr>
Access control attribute (0-32 characters) used to select the access rights.
Enclose the attribute in quotes if it contains spaces.
Default = info
Description
SDN=<cn>
SPASS=<spass>
SBASE=<sbase>
Base distinguished name (0-64 characters) used for searches. Enclose the
name in double quotes if it contains spaces.
Default = dc=yourDomainName,dc=com
UIDMASK=<umask>
Mask (0-32 characters) used to select the UID attribute. Enclose the name in
double quotes if it contains spaces.
Default = sAMAccountName=%1
The Server Ping command enables or disables response to ping requests. When enabled, the CCM
appliance receives and responds to all ping requests. When disabled, ping requests are received and
silently discarded.
Access right: SCON
Access level: APPLIANCEADMIN
88
Syntax
Description
ENABLE|DISABLE
Description
DISABLE|ENABLE
LOCALIP=<local_ip>
IP address to be used to connect the CCM appliance over the PPP connection. Must
be on same subnet as REMOTEIP address.
REMOTEIP=<rem_ip>
IP address to assign to the PPP client end of the PPP connection. Must be on same
subnet as LOCALIP address.
MASK=<subnet>
Examples
The following command enables the PPP server with a local IP address of 192.168.0.1, a remote IP
address of 192.168.0.2 and a subnet mask of 255.255.255.0.
>ser ppp ena loc=192.168.0.1 rem=192.168.0.2 mas=255.255.255.0
89
The following command enables the PPP server with previously configured IP and subnet mask
values. This form of the command would not be valid unless the IP and subnet mask values had
been previously configured.
>server ppp enable
Description
PRIMARY|
SECONDARY
Indicates either the primary RADIUS server or the secondary RADIUS server is
being defined or deleted.
IP=<radius_ip>
SECRET=<secret>
8-24 character text string for shared secret with the RADIUS server. Enclose the
string in quotes if it contains spaces.
USER-RIGHTS=<attr>
AUTHPORT=<udp>
UDP port for RADIUS authentication server, in the range 1-65535. This value is
usually 1645, but may be 1812.
Default = 1645
TIMEOUT=<time-out>
Number of seconds to wait for a response from the RADIUS server, in the range 1-60.
Default = 5
RETRIES = <retry>
Number of attempts to make to authenticate a user after a time-out, in the range 1-10.
Default = 3
90
Description
DELETE
Examples
The following command specifies primary RADIUS server information; default values will be used
for the UDP port, time-out and retries values.
>ser radius primary ip=192.168.0.200 secret=ThePrimaryRadSecret userrights=86
SERVER REBOOT
91
AUTHENTICATION=
<auth>
Description
Authentication method. You may specify multiple values (other than None),
separated by commas. Valid values are:
LOCAL
Use the local CCM user database to authenticate users. You cannot
specify both LOCAL and DOWNLOCAL.
RADIUS
Use the previously defined RADIUS server(s) to authenticate users.
LDAP
Use the previously defined LDAP server(s) to authenticate and/or
authorize users.
DOWNLOCAL Use local authentication if any specified external authentication
methods cannot be used due to lack of connection to the server. If
specified, this should be listed last. You cannot specify both
DOWNLOCAL and LOCAL.
NONE
Do not authenticate users. This method cannot be used when SSH
access is enabled, and it cannot be combined with other
authentication methods.
Default for DS operation = DS,LOCAL
Default for AV operation = LOCAL
When a CCM appliance is Flashed for DS operation, the DS authentication method
is automatically appended to any other configured authentication methods. When the
CCM appliance is Flashed for AV operation, you cannot specify the DS
authentication method.
ENCRYPT=<conns>
Enables/disables plain text Telnet or SSH connections. You may enable both by
specifying both values, separated by a comma. Valid values are:
SSH
Enables SSH connections.
None
Enables plain text Telnet connections.
Default = None
DSMODE=SECURE|
TRUSTALL
DSCLEAR
For DS operation only: Clears any stored credentials used by the DSView 3
software, including the DSMODE setting.
LOCKOUT=<hours>
Enables or disables security lock-out. To enable, specify the number of hours in the
lock-out period, in the range 1-999. To disable, specify a zero value.
Default = 0 (disabled)
92
Description
ACCESS=
BYPORT|BY GROUP
Description
IP=<ip_address>
IP address.
MASK=<subnet>
Subnet mask for the subnet on which the CCM appliance resides.
GATEWAY=<gtwy>
Description
DISABLE
Disables session sharing. Only one connection per port will be allowed.
AUTO
93
Description
QUERY
Enables session sharing when permission is obtained from the session originator
(subject to preemption based on access level). This is the default value.
Description
ENABLE|DISABLE
For more information, see Managing the CCM Appliance Using SNMP on page 46.
Access right: SCON
Access level: APPLIANCEADMIN
Syntax
Description
READCOMM=<name>
94
Description
WRITECOMM=<name>
TRAPCOMM=<name>
1-64 alphanumeric or hyphen character trap community name. If you specify this
parameter, the name must be different from the read and write community names.
Default = public
Description
ADD|DELETE
<ip_address>
Example
The following command adds an SNMP management entity with the IP address of 192.168.0.1.
server snmp manager add 192.168.0.1
95
If you enable a trap but there is no trap destination configured for it, a warning will be issued. In
this case, issue a Server SNMP Trap Destination command.
NOTE: By default, all traps are disabled. The PortAlert trap must be enabled for port alert processing to be performed.
For more information, see Managing the CCM Appliance Using SNMP on page 46 and Supported
Traps on page 125.
Access right: SCON
Access level: APPLIANCEADMIN
Syntax
Description
ENABLE|DISABLE
Enable generates a numbered list of currently disabled traps from which you choose
those to enable. Disable generates a numbered list of currently enabled traps from
which you choose those to disable.
Example
The following command enables the linkUp, UserDeleted and UserLogin SNMP traps.
>server snmp trap enable
Traps now disabled:
1) linkUp
4) UserLogin
2) UserAdded
5) ImageUpgradeStarted
3) UserDeleted
Select trap(s) to enable>1,3-4
96
Description
ADD|DELETE
<ip_address>
Description
ENABLE|DISABLE
AUTH=<auth>
SSH authentication methods. You must enter the entire value; abbreviations are not
permitted. Valid values are:
PW
Password authentication.
KEY
Key authentication.
PW|KEY
Password or key authentication.
KEY|PW
Key or password authentication.
PW&KEY
Password and key authentication.
KEY&PW
Key and password authentication.
Default = PW
Show Commands
The Show command has several forms, as listed in Table 5.41.
Table 5.41: Show Command Summary
Command
Description
Show Group
Show NFS
Show NTP
Show Port
Show Server
Show User
Content
group
Group name.
97
98
SHOW NFS
Table 5.43: Show NFS Command Display Fields
Field
Content
NFS
IP Address
NFS server IP address (from NFS command) or none if NFS has never
been enabled.
Mount point
Mount point on the NFS server (from NFS command) or none if NFS has never
been enabled.
File type
Protocol
NFS status
A status value/description (see NFS Error Codes and Port Status on page 131) or
Not mounted if NFS has never been enabled.
99
Syntax
SHOW NTP
Table 5.44: Show NTP Command Display Fields
Field
Contents
ENABLE or DISABLE
IP Address 1
IP Address 2
Update
Server 1 Status
Indicates if an update from the primary server was attempted, not attempted or is
in progress.
Server 2 Status
Indicates if an update from the secondary server was attempted, not attempted or is
in progress.
Description
<port>
A port number, port name or CON. If the port name contains spaces, it must be
enclosed in double quotes.
Default = your port
ALL
Displays information about all ports. If virtual ports are configured, their information
will be displayed after the physical ports are listed.
NAMES
Displays a list of port numbers (for physical ports only) and port names.
GROUPS <group>
If a group name is not specified, the display lists the port names (and port numbers
for physical ports) and the group(s) assigned to each port, if any.
If a group name is specified, the display lists the port names (and port numbers for
physical ports) associated with a group name.
ALERT
The display for the console port will not include values for the socket, power, TD, toggle, name or
group fields.
100
Table 5.46 lists the display fields for a Show Port command that specifies a single physical port
configured as TD=console. The display fields may appear in a different order than listed in
the table.
A Show Port All command displays the Port, Serial Port Settings, TX Bytes, RX Bytes, Errors and
Power fields for physical ports.
Table 5.46: Show Port Command Display Fields for a Physical Port with TD=Console
Field
Content
Port
Port number.
Comma-separated string of port values: baud rate, number of data bits, parity,
number of stop bits, flow control, socket number, time-out value and CLI access
character (from Port Set command). The CLI character is preceded by POR CLI= if it
was defined with a Port Set command or by SER CLI= if it was defined with a Server
CLI command.
TX Bytes
RX Bytes
Errors
Toggle
Power
Device power status, if monitoring is enabled. ON indicates the device is on, OFF
indicates the device is off.
Power Signal
Signal and state being monitored for device power status (from Port Set command).
If monitoring is disabled, this field indicates None.
Port Name
Port name assigned with the Port Set command or the default name (last three
octets of MAC address plus the port number).
Group
Group names.
Port NFS
ENABLE indicates NFS is enabled, DISABLE indicates NFS is disabled (from Port
NFS command).
File
Size threshold
Time threshold
Status of NFS history file operations. See NFS port status values on page 137 for
more information.
Current file
User *
Level *
101
Table 5.46: Show Port Command Display Fields for a Physical Port with TD=Console (Continued)
Field
Content
Access *
Port Access *
Locked *
Last Login *
Duration *
* Displayed only when the command specifies a single port that has a current connection. User information is
for the session originator.
Table 5.47 lists the display fields for a Show Port command that specifies a single virtual port. User
information is for the session originator. The display fields may appear in a different order than
listed in the table.
Table 5.47: Show Port Command Display Fields for a Virtual Port
Field
Content
Virtual Port
IP Address
Socket
State
Port state:
Connected - A successful connection has been made to the virtual port.
Unconnected - The appliance is trying to connect to the virtual port.
Failed - The appliance failed to connect to the virtual port.
Group
IPMI Username
Password
Port Timeout
Access Char
Port NFS
ENABLE indicates NFS is enabled, DISABLE indicates NFS is disabled (from Port
NFS command).
102
Table 5.47: Show Port Command Display Fields for a Virtual Port (Continued)
Field
Content
File
Size threshold
Time threshold
Status of NFS history file operations. See NFS Port Status Values on page 137 for
more information.
Current file
User *
Level *
Users access level (from User Add and User Set Access commands).
Port Access *
Locked *
Last Login *
Access *
Groups
Duration *
* Displayed only when the command specifies a single port that has a current connection. User information is
for the session originator.
For virtual ports, the Show Port All command displays the virtual port name, IP address, socket and
status, plus the maximum number of virtual ports allowed. The virtual ports are listed in
ASCIIbetical order by port name after the physical ports (for example, port name Vp1 will be listed
before port name ap1).
For ports that were configured with TD=SPC, the Show Port All command display indicates the
type and model of the attached power device. For a Show Port command that specifies a single
port, the display will include all power devices on the physical port.
103
Table 5.48 lists the display fields for a Show Port command (that specifies a single port or All) for
ports that were configured as TD=SPC.
Table 5.48: Show Port Command Display Fields for TD=SPC
Parameter
Description
Port Name
Port name (last 3 octets of MAC address plus the port number).
Status
ONLINE indicates the SPC device is powered up, OFFLINE indicates the SPC device
is powered down.
Device
Version
Minload
Maxload
Socket
Socket number.
Wake
ON Min
OFF Min
The Show Port Names command displays a list of port numbers and their names. If a port has not
been assigned a name with the Port Set command, the default name is displayed.
The Show Port Groups command displays a list of port names and group assignments. Entries for
physical ports also contain the port number.
The Show Port Alert command displays a ports alert strings.
104
SHOW SERVER
Table 5.49 lists the information displayed for the Show Server command. The display fields may
appear in a different order than listed in the table
Table 5.49: Show Server Command Display Fields
Field
Content
Server
Mask
Gateway
Up Time
MAC
S/N
Serial number.
Port
Port number.
Username
Duration *
Duration of session.
Sock or Socket
From Socket
TCP
Network TCP statistics, including in segs, out segs, errors and retransmissions.
UDP
Network UDP statistics, including in, out, errors and no port events.
Maximum Number
of Shares
Share Mode
BOOT
105
Content
APP
Application version that is running, plus its date and time. If the CCM appliance is
Flashed for DS operation, the application version number will be appended with (for
DSView 3).
Contents
CLI Port
Access Character
History
Connect
Indicates whether a valid user on the console port may use the
Connect command.
Local authentication *
106
Syntax
Contents
Authentication
Encryption
Lockout
PING Reply
DS Mode *
107
Contents
DS Server IP #0 *
DS Server IP #1 *
DS Server IP #2 *
DS Server IP #3 *
Preauth Certs *
Fingerprint (Hex)
Fingerprint (BB)
Contents
Server SNMP
Read Community
Write Community
Trap Community
SNMP Managers
Trap Dests
Destinations for enabled SNMP traps (from Server SNMP Trap Destination command).
Enabled Traps
Names of SNMP traps that have been enabled (from Server SNMP Trap command).
108
Description
<username>
Username.
Default: user currently logged in
ALL
GROUP
Displays a list of users and the groups to which they have been assigned.
The Show User command display for one user includes the information in Table 5.54.
Table 5.54: Show User Command Display Fields
Field
Contents
User
Username.
Level
Users access level. If a level was not configured, access rights determine the level:
Users with SCON access => APPLIANCEADMIN.
Users with USER or PCON but not SCON => ADMIN.
Otherwise, USER level is assigned.
Port Access
Locked
Last Login
Access
Users access rights. If the CCM appliance is Flashed for DS operation, the users
preemption level is appended to the access rights.
Groups
Port
Username
Username.
Sock or Socket
From Socket
109
There may be a difference between the display for a Show User command (without a username)
and Show User <current_username>. If you do not specify a username, the command displays the
current user credentials; with a username, the information comes from the database.
For example, assume username Admin is logged in with Access=PALL. Then, a User Set Admin
Access=PALL command is issued and the database is modified. A Show User command (without
a username) will display the access as PALL, while a Show User Admin command will display the
new access without PALL.
A Show User All command display includes the information in Table 5.55.
Table 5.55: Show User All Command Display Fields
Field
Contents
User
Username.
Pass
Key
Lock
Level
Users access level. If a level was not configured, access rights determine the level:
Users with SCON access => APPL (appliance administrator).
Users with USER or PCON but not SCON => ADMN (administrator).
Otherwise, USER level is assigned.
Access
Users access rights. If the CCM appliance is Flashed for DS operation, the users
preemption level is appended to the access rights.
A Show User Group command displays a list of all users and the groups to which they are assigned.
SPC Command
The SPC command changes settings for an SPC power control device.
NOTE: To access the control screen or command line interface provided by the SPC device, this command
should not be used, and the CCM appliance port to which the SPC device is attached should be configured as
TD=Console. When TD=SPC is configured, you cannot connect to the SPC device; all SPC device operations
are performed from the CCM appliance CLI.
110
Description
<device>|ALL
Device number, device name or All, which indicates that the settings that follow
should be applied to all ports configured as TD=SPC. If the name contains spaces, it
must be enclosed in double quotes.
NAME=<name>
MINLOAD=<amps>
Minimum load in amperes in the range 0-30. A zero value indicates no minimum load.
Default = 0
MAXLOAD=<amps>
Maximum load in amperes in the range 0-30. A zero value indicates no maximum load.
Default = 0
The following command sets a maximum load of 20 amps for the SPC device attached to the port
named spc3 on the CCM appliance.
spc spc3 max=20
Description
<device>
SOCKET <socket>|ALL
Socket number, socket name or All, which indicates that the settings that follow
should be applied to all sockets on the specified port.
111
Description
NAME=<name>
Socket name. Socket names are case sensitive and must be unique among all
power devices on the CCM appliance.
WAKE=ON|OFF
State that the socket will enter when the SPC device is powered up.
Default = On
ONMIN=<time>
Minimum amount of time that a socket will stay on before it may be turned off. The value
may be specified with S for seconds, M for minutes or H for hour. Valid values are:
0S, 15S, 30S, 45S, 60S, 75S, 90S, 105S. 120S, 180S, 240S, 300S, 600S, 900S,
1800S, 3600S
0M, 1M, 1M15S, 1M30S, 1M45S, 2M, 3M, 4M, 5M, 10M, 15M, 30M, 60M.
0H, 1 H.
Default = 0S
OFFMIN=<time>
Minimum amount of time that a socket will stay off before it may be turned on. The value
may be specified with S for seconds, M for minutes or H for hour. Valid values are:
0S, 15S, 30S, 45S, 60S, 75S, 90S, 105S. 120S, 180S, 240S, 300S, 600S, 900S,
1800S, 3600S
0M, 1M, 1M15S, 1M30S, 1M45S, 2M, 3M, 4M, 5M, 10M, 15M, 30M, 60M.
0H, 1 H.
Default = 0S
POWER=ON|OFF|
REBOOT
ON causes the specified socket(s) to turn on (after the time specified in Offmin).
OFF causes the specified socket(s) to turn off (after the time specified in Onmin).
REBOOT causes the specified socket(s) to turn off, then on.
Example
The following command turns on all sockets on the SPC power control device attached to port 6 of
the CCM appliance. The sockets will turn on based on their Offmin values.
>spc 6 socket all on
User Commands
The User command has several forms, as listed in Table 5.58.
Table 5.58: User Command Summary
Command
Description
User Add
User Delete
User Logout
User Set
User Unlock
112
Description
<username>
PASSWORD=<pwd>
SSHKEY=<keyfile>
Name of uuencoded public key file on an FTP server. The maximum file size that
may be received is 4K bytes. If this parameter is specified, you must also specify the
FTPIP parameter.
FTPIP=<ftpadd>
FTP servers IP address. If this parameter is specified, you must also specify the
SSHKEY parameter.
KEY=<sshkey>
ACCESS=<access>
Command and port access level or rights. You may specify multiple access rights,
separated by commas, or a level. Valid values for access rights are:
P<n>
Access to the specified physical port number.
P<x-y>
Access to the specified range of physical ports.
PALL
Access to all physical and virtual ports.
USER
User configuration access rights.
PCON
Port configuration access rights.
SCON
Configuration access rights.
SMON
Monitor access rights.
BREAK
Can issue Port Break command.
Valid values for access levels are:
ADMIN
PALL, USER, SMON, PCON and BREAK access rights.
APPLIANCEADMIN
PALL, USER, SCON, SMON, PCON and BREAK
access rights.
Default = PALL,SMON
GROUP=<group>
Name of port group(s) to which the user will be assigned. Up to 8 port groups,
separated by commas, may be defined for a CCM850 appliance user, up to 16 port
groups for a CCM1650 appliance user and up to 48 groups for a CCM485x
appliance user.
113
Description
PREEMPT=1|2|3|4
For DS operation only: Preemption level, in the range 1-4 (lowest to highest).
Default = 4 (highest)
Examples
The following command adds the username JaneDoe, with access to all ports. The name of the SSH
public user key file is ccm_key2.pub. This file is located on the FTP server at IP address 10.0.0.3.
>user JaneDoe add ssh=ccm_key2.pub ftp=10.0.0.3 access=pall
The following command adds the username JDoe, with the password mysecret and the Appliance
Administrator access level, which enables access to all ports and CCM appliance commands.
>user JDoe add pas=mysecret access=applianceadmin
The following command adds the username JohnD with the password pword and the Administrator
access level. JohnD is assigned to the port groups Dev1 and Dev2.
>user JohnD add password=pword access=adm group=Dev1,Dev2
Description
<username>
Username to be deleted.
114
Description
<username>
Description
<username>
Username. This parameter may be omitted only if you are modifying your
own password.
PASSWORD=<pwd>
SSHKEY=<keyfile>
Name of uuencoded public key file on an FTP server. The maximum file size that
may be received is 4K bytes.
FTPIP=<ftpadd>
KEY=<sshkey>
Uuencoded SSH key. To delete an SSH key (whether it was originally specified with
the SSHKEY and FTPIP parameters or with the KEY parameter), specify Key=.
115
Description
ACCESS=<access>
Command and port access rights or level. You may specify multiple access rights,
separated by commas, or a level. If specifying access rights, you may use one of
three forms:
ACCESS=<access> to specify all access rights.
ACCESS=+<access> to specify only access rights to be added.
ACCESS=<access> to specify only access rights to be deleted.
Valid values for access rights are:
P<n>
Access to the specified physical port number.
P<x-y>
Access to the specified range of physical ports.
PALL
Access to all physical and virtual ports.
USER
User configuration access rights.
PCON
Port configuration access rights.
SCON
Configuration access rights.
SMON
Monitor access rights.
BREAK
Can issue Port Break command.
Valid values for access levels are:
ADMIN
PALL, USER, SMON, PCON and BREAK access rights.
APPLIANCEADMIN
PALL, USER, SCON, SMON, PCON and BREAK
access rights.
GROUP=<group>
PREEMPT=1|2|3|4
For DS operation only: Preemption level, in the range 1-4 (lowest to highest).
Default = 4 (highest)
Examples
The following command sets the access rights for JohnDoe, enabling access to all ports with
configuration and monitoring access rights.
>user JohnDoe set access=pall,scon,smon
The following command removes the server configuration and port configuration access right for
JohnDoe, and leaves any other previously configured access rights intact.
>user JohnDoe set access=-SCON,PCON
The following command deletes the SSH key information for JohnDoe. The command will
complete successfully only if JohnDoe has a password configured in a previous User Add or User
Set command, and if there are other users with User access rights.
>user JohnDoe set key=
116
The following command adds the groups Dev3 and Dev4 for JohnD. He may now access the ports
defined in groups Dev3 and Dev4 as well as ports in other groups that were previously configured
for him.
>user JohnD set group=+Dev3,Dev4
Description
<username>
Username to be unlocked.
117
APP ENDICE S
Appendices
Appendix A: Technical Specifications
Table A.1: CCM Appliance Technical Specifications
Item
CCM850 Appliance
CCM1650 Appliance
CCM485x Appliance
Number
16
48
Type
Serial ports
Serial ports
Serial ports
Connectors
Number
Connector
Number
Type
Connector
RJ-45
RJ-45
RJ-45
Heat Dissipation
75 BTU/hr
102 BTU/hr
205 BTU/hr
Airflow
2.5 cfm
2.5 cfm
14 cfm
Power Consumption
22 W
30 W
60 W
Device Ports
Console Port
Network Connection
Dimensions
HxWxD
118
CCM850 Appliance
CCM1650 Appliance
CCM485x Appliance
AC-input power
45 W maximum
45 W maximum
90 W maximum
AC-input maximum
90 to 267 VAC
90 to 267 VAC
0.5 A
0.5 A
1 A maximum
AC-input cable
18 AWG three-wire cable, with a three-lead IEC-320 receptacle on the power supply
end and a country dependent plug on the power resource end
Frequency
50 to 60 Hz
50 to 60 Hz
50 to 60 Hz
Temperature
Operating
0o to 40o Celsius
0o to 40o Celsius
0o to 55o Celsius
Temperature
Nonoperating
(-4o
(-4o
to
+149o Fahrenheit)
to
+149o
Fahrenheit)
Humidity
10% to 90%
noncondensing
10% to 90%
noncondensing
10% to 90%
noncondensing
Regulatory
Compliance
Appendices
119
RS-232 Signal
Direction
Description
RTS
Output
Request to Send
DSR
Input
DCD
Input
RD
Input
Receive Data
TD
Output
Transmit Data
GND
(N/A)
Signal Ground
DTR
Output
CTS
Input
Clear to Send
Modular adaptors are available to convert RJ-45 modular jacks to standard pinout configurations.
Adaptors are available for use with:
Serial reversing cable. Reversing adaptors and cables are recommended for distances greater
than 100 feet.
Description
210122
210120
210124
210123
210125
210121
120
Table B.2: Adaptors for Use with CAT 5 and CAT 6 Cable (Continued)
Part Number
Description
210127
RJ-45 to RJ-45 Male Adaptor for Cisco and Sun Netra console port
750238
Figure B.1 shows the pin assignments for the adaptors listed in Table B.2.
Appendices
RJ-45 8 pin
RJ-45 8 pin
DB-9 DCE
DB-25 DCE
CTS
RTS
CTS
RTS
DTR
DCD
DTR
DCD
DSR
DSR
GND
GND 6
GND
RD
TD
RD
TD
GND 6
TD
RD
TD
RD
DCD 3
DTR
DCD 3
DSR 2
RTS
20 DTR
DSR 2
8
CTS
CTS
210120
RJ-45 8 pin
RTS
RJ-45 8 pin
DB-9 DTE
DB-25 DTE
CTS
CTS
CTS
DTR
DTR
DTR
20 DTR
GND 6
GND
GND 6
GND
TD
TD
TD
TD
RD
RD
RD
RD
DCD 3
DCD
DCD 3
DCD
DSR 2
DSR
DSR 2
DSR
RTS
RTS
RTS
RTS
210122
RJ-45 Male
RJ-45 Female
CTS
DSR 7
DTR
GND 5
GND
RD
TD
TD
RD
GND 4
CD
DTR
DSR
CTS
RTS
RTS
210127
Figure B.1: CAT 5 and CAT 6 Cable Adaptor Pin Assignments
CTS
121
122
Description
210094
210095
210090
210092
210091
210093
210105
RJ-45 to RJ-45 Male Adaptor for Cisco and Sun Netra console port
690226
690227
690228
750122
Wiring Starter Kit (8-wire) - includes all the above adaptors and one 690226 cable
Figure B.2 shows the pin assignments for the adaptors listed in Table B.3.
Appendices
RJ-45 8 pin
RJ-45 8 pin
DB-9 DTE
DB-25 DTE
RTS
RTS
RTS
DSR 7
DSR
DSR 7
DSR
CD
CD
CD
CD
RD
RD
RD
RD
TD
TD
TD
TD
GND
RTS
GND 3
GND
GND 3
DTR
DTR
DTR
20 DTR
CTS
CTS
CTS
210094
RJ-45 8 pin
CTS
DB-9 DCE
RJ-45 8 pin
DB-25 DCE
CTS
RTS
DSR 7
DTR
DSR 7
CD
DSR
CD
DSR
RD
TD
RD
TD
TD
RD
TD
RD
GND 3
GND
GND 3
GND
DTR
CD
DTR
CD
CTS
RTS
CTS
RTS
RTS
20 DTR
210095
RJ-45 Male
RJ-45 Female
CTS
DSR 7
DTR
GND 6
GND
RD
TD
TD
RD
GND 3
CD
DTR
DSR
CTS
RTS
RTS
210105
CTS
123
124
If you choose to use a third party reversing cable, make sure the cable is reversing, as shown in
Figure B.3.
8-WIRE
RTS
DSR
CD
RD
TD
GND
DTR
CTS
1
2
3
4
5
6
7
8
8
7
6
5
4
3
2
1
CCM Port
Modular Adaptor
RTS
DSR
CD
RD
TD
GND
DTR
CTS
Appendices
125
authenticationFailure
linkUp
linkDown
coldStart
Table C.1 lists the supported enterprise traps. The Avocent web site (www.avocent.com) contains
the complete trap MIB.
Table C.1: CCM Appliance Enterprise Traps
Trap
AggregatedServer
StatusChanged
The status of one or more servers (connections paths) has changed. The
appliance always sends this trap upon bootup. Thereafter, it sends the trap when
there is a change in connection path status, and will include only those paths
whose status has changed.
Variable(s): connection path(s)
ConfigurationFile
Loaded
The CCM appliance has loaded a configuration file. This trap applies to
AVWorks software.
Variables: initiating username and name of loaded file
FactoryDefaultsSet
The CCM appliance has received a command to set itself to factory default
values. (The appliance sends this trap after receiving the command, but before
actually reverting to factory default values.)
ImageUpgradeResults
ImageUpgradeStarted
NFSDisableRqstd
NFSEnableRqstd
NFSMountedOK
NFSMountFailedGaveUp
NFS is enabled but repeated mount attempts have failed. No additional mount
retries will be performed.
Variables: primary and secondary NFS error codes (see NFS Error Codes and
Port Status on page 131)
126
NFSMountFailed
Retrying
NFS is enabled and the first mount attempt failed. Additional mount retries are
still being performed.
Variables: primary and secondary NFS error codes (see NFS Error Codes and
Port Status on page 131)
NFS is enabled and a mount completed successfully. That mount was lost and the
first attempt to reestablish that mount has now failed. Additional retries are being
NFSMountLost1stRetryFail
performed.
ed
Variables: primary and secondary NFS error codes (see NFS Error Codes and
Port Status on page 131)
NFSMountLostGaveUp
NFS is enabled and a mount completed successfully. That mount was lost and
repeated attempts to reestablish that mount have failed. No addition mount
retries will be performed.
Variables: primary and secondary NFS error codes (see NFS Error Codes and
Port Status on page 131)
NFSMountLostRetrying
NFS is enabled and a mount completed successfully; however, that mount has
now been lost and is being retried.
Variables: primary and secondary NFS error codes (see NFS Error Codes and
Port Status on page 131)
NFSMountVerifiedOK
NFSPortDisableRqstd
NFSPortEnableRqstd
NFSPortFileClosed
NFSPortFileOpenOK
NFS is enabled on the port and has successfully opened the history file on the
NFS server.
Variable: CCM appliance port number
NFSPortNeedsMount
NFS is enabled on the port, but a mount is required (using an NFS Enable
command) before the port can open and/or write to the history file on the
NFS server.
Variables: CCM appliance port number, port error status (see NFS Error Codes
and Port Status on page 131) plus primary and secondary NFS error codes (see
NFS Error Codes and Port Status on page 131)
Appendices
127
NFSPortNoRecent
Errors
NFS is enabled on the port and has successfully opened the history file on the
NFS server; however, an NFSPortWriteError and/or an NFSPortOverrunError
trap was previously sent for that port. A successful write to the file has since been
performed and 15 minutes have subsequently elapsed without any errors being
encountered.
Variable: CCM appliance port number
NFSPortOpenFailGaveUp
NFS is enabled on the port, but repeated attempts to open the history file on the
NFS server have failed. No additional file open retries will be performed.
Variables: CCM appliance port number, port error status (see NFS Port Status
Values on page 137) plus primary and secondary NFS error codes (see NFS
Error Codes on page 131)
NFSPortOpenFail
Retrying
NFS is enabled on the port, but the first attempt to open the history file on the
NFS server has failed. Additional file open retries are being performed.
Variables: CCM appliance port number, port error status (see NFS Port Status
Values on page 137) plus primary and secondary NFS error codes (see NFS
Error Codes and Port Status on page 131)
NFSPortOverrunError
NFS is enabled on the port and has successfully opened the history file on the
NFS server; however, an overrun error occurred when writing to that file.
Variables: CCM appliance port number, port error status (see NFS Port Status
Values on page 137) plus primary and secondary NFS error codes (see NFS
Error Codes and Port Status on page 131)
NFSPortWriteError
NFS is enabled on the port and has successfully opened the history file on the
NFS server; however, an error occurred when writing to that file.
Variables: CCM appliance port number, port error status (see NFS Port Status
Values on page 137) plus primary and secondary NFS error codes (see NFS
Error Codes and Port Status on page 131)
NFSUnmountedOK
PortAlert
PortPowerOffDetect
The CCM appliance detected that a ports power on/off control signal is in the
state indicating power is off. This trap is sent upon initialization if the condition is
detected. Subsequent traps are sent only if this signal changes state.
Variables: server name and port number
PortPowerOnDetect
The CCM appliance detected that a ports power on/off control signal is in the
state indicating power is on. This trap is sent upon initialization if the condition is
detected. Subsequent traps are sent only if this signal changes state.
Variables: server name and port number
RebootStarted
128
SerialSessionStarted
SerialSessionStopped
SerialSession
Terminated
SolPortAdded
SolPortDeleted
SolPortLcm
SolPortNameChanged
SolPortRcm
SolSessionTerminated
SolStart
SolStopped
SpcDeviceNameChanged
SpcDeviceOffline
SpcDeviceOnline
SpcInletNameChanged
SPCInletTotalLoadHigh
An SPC device inlet total high load threshold has been reached.
SpcInletTotalLoadLow
An SPC device inlet total low load threshold has been reached.
SpcLoginErr
The CCM appliance was unable to log in to the SPC device using the username
configured in the appliance.
Variables: SPC device location, CCM appliance port number and username
SpcSocketNameChanged
SpcSocketOff
Command
Appendices
129
SpcSocketOffSenseFail
An SPC device has detected an off sense failure for a socket. This occurs when
a socket should be in the off state, but is actually in the on state.
Variables: name of server attached to the SPC device socket, SPC device
location name, CCM appliance port number and SPC device socket number
SpcSocketOn
Command
SpcSocketOnSenseFail
An SPC device has detected an on sense failure for a socket. This occurs when
a socket should be in the on state, but is actually in the off state.
Variables: name of server attached to the SPC device socket, SPC device
location name, CCM appliance port number and SPC device socket number
SpcSocketReboot
Command
SpcStatusSocketOff
SpcStatusSocketOn
SpcTotalLoadHigh
An SPC device has exceeded the maximum threshold for total load amperage.
Variables: SPC device location name and CCM appliance port number
SpcTotalLoadLow
The total load amperage on an SPC device has gone below the
minimum threshold.
Variables: SPC device location name and CCM appliance port number
TdTypeChanged
UserAdded
A new user has been added to the CCM appliance user database.
Variables: initiating username and new username
UserAuthentication
Failure
UserDatabaseFile
Loaded
The CCM appliance has loaded a user database file. This trap applies to
AVWorks software.
Variables: initiating username and name of loaded file
UserDeleted
A user has been deleted from the CCM appliance user database.
Variables: initiating username and deleted username
130
UserLocked
UserLogin
UserLogout
UserModified
A users definition has been modified in the CCM appliance user database.
Variables: initiating username and modified username
UserUnlocked
Appendices
131
Description
An unidentified error was encountered. Check the console output for possible additional information.
10
11
12
13
14
15
16
17
From the remote procedure call: the server cannot decode the arguments.
18
19
20
21
From the remote procedure call: the program was not registered.
22
From the remote procedure call: the RPC failed due to an unspecified error.
23
132
Description
24
25
From the remote procedure call: the remote address was unknown.
26
27
28
29
30
31
32
33
34
35
36
37
Out of memory.
38
39
40
41
42
43
44
45
46
47
48
49
Appendices
133
Description
50
51
52
53
54
55
56
57
58
59
60
61
62
63
The operation was not allowed because the caller is either not a privileged user (root) or not the
owner of the operations target.
64
65
A hard I/O error (such as a disk error) occurred while processing the requested operation.
66
67
The operation was not allowed because the caller does not have the correct permission to perform
the requested operation. (This error differs from error 63, which is restricted to owner or privileged
user permission failures.)
68
69
70
71
72
134
Description
73
An invalid argument or unsupported argument was supplied for an operation. For example,
attempting a READLINK on an object other than a symbolic link.
NFSv3 example: attempting to SETATTR with a time field on a server that does not support the
operation. NFSv4 example: specifying a value for an enum field that is not defined in the protocol
(such as nfs_ftype4).
74
For NFSv2: The operation caused a file to grow beyond the servers limit.
For NFSv3 and NFSv4: The operation would have caused a file to grow beyond the servers limit.
75
For NFSv2: The operation caused the servers file system to reach its limit.
For NFSv3 and NFSv4: The operation would have caused the servers file system to exceed its limit.
76
77
78
79
80
For NFSv2: The clients disk quota on the server has been exceeded.
For NFSv3 and NFSv4: The users resource limit on the server has been exceeded.
81
The file handle specified in the arguments was invalid - it either no longer exists or access to it has
been revoked.
82
The file handle specified in the arguments referenced a file on a nonlocal file system on the server
(that is, there were too many levels of remote in the path).
83
The servers write cache used in the WRITECACHE call was flushed to the disk.
84
85
86
87
88
89
An error occurred n the server which does not map to any of the legal NFS protocol error values. The
client should translate this into an appropriate error. UNIX clients may choose to translate this to EIO.
90
An attempt was made to create an object of a type not supported by the server.
Appendices
135
Description
91
The server initiated the request, but was not able to complete in a timely manner. The client should
wait and then try the request with a new RPC transaction ID. For example, this error should be
returned from a server that supports hierarchical storage and receives a request to process a file that
has been migrated. In this case, the server should start the immigration process and respond to the
client with the error.
For NFSv4: this error may also occur when a necessary delegation recall makes processing a
request in a timely manner impossible.
92
The attributes compared were the same as provided in the clients request. This error is returned by
the NVERIFY operation.
93
An attempt to lock a file was denied. Since this may be a temporary condition, the client is
encouraged to retry the lock request until the lock is accepted.
94
95
96
The server is in its recovery or grace period, which should match the servers lease period.
97
The file handle provided is volatile and has expired at the server.
98
At attempt to OPEN a file with a share reservation has failed because of a share conflict.
99
The security mechanism being used by the client for the operation does not match the servers
security policy. The client should change the security mechanism being used and retry the operation.
100
The SETCLIENTID operation has found that a client ID is already in use by another client.
101
The server has exhausted available resources while processing the COMPOUND procedure, and
cannot continue processing operations within the COMPOUND procedure.
102
The file system that contains the current file handle object has been relocated or migrated to another
server. The client may determine the new file system location by obtaining the fs_locations attribute
for the current file handle.
103
The logical current file handle value (or the saved file handle value in the case of RESTOREFH) has
not been properly set. This may have resulted from a malformed COMPOUND operation (that is, no
PUTFH or PUTROOTFH before an operation that requires the current file handle to be set).
104
The server has received a request that specifies an unsupported minor version. The server must
return a COMPOUND4res with a zero length operation result array.
105
A client ID not recognized by the server was used in a locking or SETCLIENTID_CONFIRM request.
106
107
A state ID that designates the locking state for a lockowner-file at an earlier time was used.
136
Description
108
A state ID generated by the current server instance (that does not designate any locking state either
current or superseded) for a current lockowner-file pair was used.
109
The sequence number in a locking request is neither the next expected number nor the last
number processed.
110
The attributes compared were not the same as provided in the clients request. This error is returned
by the VERIFY operation.
111
A lock request is operating on a sub-range of a current lock for the lock owner and the server does
not support this type of request.
112
The current file handle provided for a LOOKUP is not a directory but a symbolic link. This error is
also issued if the final component of the OPEN path is a symbolic link.
113
The RESTOREFH operation does not have a saved file handle (identified by SAVEFH) to operate on.
114
A lease being renewed is associated with a file system that has been migrated to a new server.
115
A specified attribute is not supported by the server. This does not apply to the GETATTR operation.
116
A reclaim of the client state has fallen outside of the servers grace period. As a result, the server
cannot guarantee that a conflicting state has not been provided to another client.
117
The reclaim provided by the client does not match any of the servers state consistency checks and
is bad.
118
The reclaim provided by the client has encountered a conflict and cannot be provided. This could
indicate a misbehaving client.
119
120
A CLOSE was attempted and file locks would exist after the CLOSE.
121
The client attempted a READ, WRITE, LOCK or SETATTR operation that was not sanctioned by the
state ID passed (for example, writing to a file opened only for reading).
122
An owner, owner group or ACL attribute value cannot be translated to local representation.
123
A UTF-8 string contains a character that is not supported by the server in the context in which it is
being used.
124
A name string in a request contains valid UTF-8 characters supported by the server, but the name is
not supported by the server as a valid name for the current operation.
125
The range for a LOCK, LOCKT or LOCKU operation is not appropriate for the allowable range of
offsets for the server.
126
The server does not support the atomic upgrade or downgrade of locks.
Appendices
137
Description
127
An illegal operation value has been specified in the arg op field of a COMPOUND or
CB_COMPOUND procedure.
128
The server determined a file locking deadlock condition for a blocking lock request.
129
The operation cannot be successfully processed because a file used in the operation is currently open.
130
Due to administrator intervention, the lock owners record locks, share reservations and delegations
have been revoked by the server.
131
132
The NFS server does not support the TCP protocol for this service. To resolve this, issue an NFS
Enable command with the Protocol=UDP parameter.
9999
No error.
Description
Mount needed
Current overrun encountered and no recent write errors have occurred (unable to write to the file
fast enough)
Recent overrun encountered and no recent write errors have occurred (unable to write to the file
fast enough)
9999
No recent errors
138
From the CCM appliance CLI, you may use the IPMI command to access the BMU.
If no SoL connection is established, or if no virtual port name is specified with the command, you will be prompted for server login information, including the IP address, username and password. If you issue the IPMI command with a valid virtual port name and the
configured login credentials are correct, an IPMI session will be established to the
specified BMC.
If you are serially connected to a valid virtual port, typing IPMI at the command prompt
will establish an IPMI session to that port. Typing IPMI <port_name> will establish an
IPMI session to the specified port, which is not necessarily the same port to which you
are connected.
After you have accessed the BMU, the BMU> prompt appears and you may issue
BMU commands.
When you are finished, exit the BMU to return to the CCM appliance CLI.
From the CCM appliance CLI, you may use an IPMI shortcut command. A shortcut
command accesses the BMU on a specified virtual port, passes a BMU command and then
returns to the CCM appliance CLI.
The IPMI shortcut commands condense the Access BMU -> Issue BMU command -> Exit
BMU three-command sequence to one command.
To use the IPMI shortcut commands, the virtual port must already be configured (Port Add/Set
command) with a valid IP address, username and password. Additionally, the BMU must not
already have four existing IPMI connections.
IPMI shortcut commands are available for all BMU commands except Exit, Help and Quit.
IPMI Shortcut ?
Description
Alert
Yes
Exit
No
Ends the BMU command session and returns you to the CCM appliance
CLI prompt.
Help
No
Identify
Yes
Appendices
139
IPMI Shortcut ?
Description
Pet
Yes
Power
Yes
Quit
No
Ends the BMU command session and returns you to the CCM appliance
CLI prompt.
Sel
Yes
Sensor
Yes
Sol
Yes
Sysinfo
Yes
User
Yes
Command conventions
The IPMI shortcut commands require the same access rights/access level as the IPMI command:
PCON or SCON access rights, or ADMIN or APPLIANCEADMIN access level.
The BMU command keywords and parameters must be entered in their entirety - there are no valid
abbreviations. If you are using an IPMI shortcut command, you may abbreviate the keyword IPMI
to IPM, but other keywords and parameters cannot be abbreviated.
Command keywords are not case sensitive.
The following command descriptions may contain two Syntax headings.
The Syntax - IPMI shortcut command indicates what you would enter at the CCM appliance
CLI prompt.
The Syntax - BMU command assumes you have already accessed the BMU of the desired
virtual port, and indicates what you would enter at the BMU> prompt.
Alert command
The Alert command enables or disables the sending of SNMP traps by the BMC to the
destination(s) specified with the Pet command.
Syntax - IPMI shortcut command
ALERT ENABLE
ALERT DISABLE
140
Description
<port_name>
ENABLE
DISABLE
Exit command
The Exit command ends the BMU command session and returns you to the CCM appliance CLI
prompt. This command is equivalent to the BMU Quit command.
Syntax - BMU command
EXIT
Help command
The Help command displays information about BMU commands. If no parameter is specified,
general syntax is provided for all commands.
Syntax - BMU command
HELP [<command>]
Table E.3: BMU Help Command Parameter
Parameter
Description
command
Identify command
The Identify command controls the LED on the servers front panel.
Syntax - IPMI shortcut command
Description
<port_name>
Appendices
141
Table E.4: IPMI Shortcut and BMU Identify Command Parameters (Continued)
Parameter
Description
ON
Turns on the LED. If the BMC supports the IPMI extension Chassis Identify On
command, this parameter turns the LED on until an Identify Off command is issued.
Otherwise, the LED will be turned on for the number of seconds specified with the -T
<seconds> parameter or (if the -T <seconds> parameter is omitted) 255 seconds.
-T <seconds>
Number of seconds, in the range 1-255, the LED will be turned on.
OFF
Pet command
The Pet command displays or configures SNMP trap gateway and destination information.
Syntax - IPMI shortcut command
Description
<port_name>
CONFIG
-DEST<x> <destip>
Destination number (1-4) and the SNMP trap destination IP address. Up to four
destinations may be configured.
-GW <gateway>
Power command
The Power command displays or controls the servers power state.
Syntax - IPMI shortcut command
POWER ON
POWER CYCLE
142
POWER STATUS
POWER RESET
POWER OFF [-FORCE]
Table E.6: IPMI Shortcut and BMU Power Command Parameters
Parameter
Description
<port_name>
ON
CYCLE
STATUS
RESET
OFF
-FORCE
Simulates pressing the servers power button and forces the system off.
Quit command
The Quit command ends the BMU command session and returns you to the CCM appliance CLI
prompt. This command is equivalent to the BMU Exit command.
Syntax - BMU command
QUIT
Sel command
The Sel command performs operations on the system event log.
Syntax - IPMI shortcut command
SEL CLEAR
SEL STATUS
SEL SET -TIME <time>
SEL GET [-BEGIN <index1>] [-MAX <count>] [-END <index2>] [-LAST <n>]
Appendices
143
Description
<port_name>
CLEAR
STATUS
TIME <time>
Specifies a point in time as the timestamp value. The valid format is:
YYYY/MM/DD hh:mm:ss
This format must be followed exactly: a four-digit year, a two-digit month and a two-digit
day, delimited with forward slashes (/), followed by a space, then a two digit hour,
minute and second, delimited with colons (:).
GET
-BEGIN <index1>
-MAX <count>
Maximum number of records to display. If this value is larger than the total number of
records, this option will not apply and the last record displayed will be the last one in the
event log.
-END <index2>
-LAST <n>
Number of records to be displayed, beginning from the last record and counting back.
Sensor command
The Sensor command displays current sensor information in the following format:
<sensor_name> | <sensor_type> | <sensor_#> | <status> [|<value> | <units>]
Syntax - IPMI shortcut command
Description
<port_name>
144
Table E.8: IPMI Shortcut and BMU Sensor Command Parameters (Continued)
Parameter
Description
-F <threshold>
Displays sensors that are at or above the specified threshold. For example, setting the
threshold to CR will display all sensors with critical, non-recoverable and unspecified
conditions. Valid values and their hierarchy are:
OK
Operating in normal ranges.
NC
Non-critical condition caused by a sensor outside of its normal ranges.
CR
Critical (potentially fatal) condition caused by a sensor exceeding its
specified ratings.
NR
Non-recoverable condition that has potential to damage hardware.
US
Unspecified status indicating a fault with unknown severity.
<group>
Sensor group. If omitted, all groups for which information is available will be displayed.
Valid values are TEMP, FAN, VOLT, DISCRETE and NUMERIC.
Sol command
The Sol command displays current SoL configuration information, enables and configures SoL or
disables SoL.
When you configure a target server using the Sol command, the specified baud rate must match the
equivalent BIOS setting for the target server. These values set the baud rate for a serial port that is
used by the target operating system to provide the data to the SoL logic in the BMC on the target
server. When these baud rates do not match, serial data will not be transmitted or received correctly
across the SoL connection.
Syntax - IPMI shortcut command
SOL
SOL ENABLE [CONFIG [-BAUD <baud>] [-PRIV <priv>] [-RETRYCOUNT <count>]
[-RETRYINTERVAL <interval>]]
SOL DISABLE
Table E.9: IPMI Shortcut and BMU Sol Command Parameters
Parameter
Description
<port_name>
ENABLE
Enables SoL.
CONFIG
Appendices
Table E.9: IPMI Shortcut and BMU Sol Command Parameters (Continued)
Parameter
Description
-BAUD <baud>
Baud rate. Valid values are 9600, 19200, 38400, 57600 and 115200.
-PRIV <priv>
-RETRYCOUNT <count>
-RETRYINTERVAL <interval>
DISABLE
Disables SoL.
Sysinfo command
The Sysinfo command displays system information.
Syntax - IPMI shortcut command
SYSINFO FRU
SYSINFO ID
Table E.10: IPMI Shortcut and BMU Sysinfo Command Parameters
Parameter
Description
<port_name>
FRU
ID
User command
The User command displays or configures a users username, password and/or privilege.
Syntax - IPMI shortcut command
145
146
Description
<port_name>
CONFIG
userx
-NAME <username>
Username.
-PASSWORD <password>
Password.
-PRIV <priv>
Appendices
Direction
Used for
TCP 22
Inbound on appliance
SSH2, if enabled
TCP 23
Inbound on appliance
Telnet
UDP 69
TFTP
TCP/UDP 111
Outbound on device
NFS, if enabled
UDP 123
Outbound on device
NTP, if enabled
UDP 161
Inbound on appliance
SNMP, if enabled
TCP/UDP 2049
Outbound on device
NFS, if enabled
UDP 3211
Inbound on appliance
TCP 3211
Inbound on appliance
TCP 3001-30xx
Inbound on appliance
TCP 3101-31xx
Inbound on appliance
TCP 3871
Inbound on appliance
TCP 3871
Outbound on appliance
147
148
Check the pertinent section of the manual to see if the issue can be resolved by following the
procedures outlined.
2.
Check our web site at www.avocent.com/support to search the knowledge base or use the online service request.
3.
149
INDE X
Index
A
Sel 142
Sensor 143
Sol 144
about 33
summary 138
Sysinfo 145
User 145
BootP 9
C
Cabling 119
CLI
accessing 51
changing the access character 30, 75, 81
displaying access character 105
displaying the access character 31
mode 30
Commands
abbreviations 53
Connect 61
conventions 52
Disconnect 62
BMU commands
Alert 139
conventions 139
Exit 140
Help 140
Identify 140
Pet 141
Power 141
Quit 142
Group Delete 64
Group Set 64
Help 65
IPMI 65
line editing for ASCII TTY devices 52
line editing for VT100 compatible devices 51
NFS 66
NTP 67
Port Add 69
Port Alert Add 70
150
Show Group 97
Show NFS 98
Port Break 72
Show NTP 98
Show Port 99
Port Delete 72
Port History 73
Port Logout 73
Port NFS 73
Port Refresh 75
Port Set 75
Quit 80
Resume 80
SPC 109
Server CLI 81
summary 55
Server Flash 83
syntax 52
Server Init 84
Server Ping 87
Server PPP 88
Configuration
Server RADIUS 89
Server Reboot 90
Server Security 90
Server Set 92
Server Share 92
Connect command 61
Server SNMP 93
Console port
configuring 81
specifying in commands 53
Server SSH 96
Show command summary 97
Conventions in commands 52
Index
about 21
Hardware installation 7
dial-in 23
Help command 65
History buffer
session time-out 31
about 40
using PPP 23
using SSH 24
using Telnet 21
Dial-in connections
about 23
Disconnect command 62
about 43
DS operation 2, 12
DSView 3 software 2
Encryption
filenames 44
configuring 90
displaying configuration information 106
Initial login 10
Installation
configuring address settings 8
hardware 7
Gateway
changing 92
configuring 8
displaying 104
151
IP address
changing 92
configuring 8
displaying 104
152
IPMI
IPMI command 65
LDAP
groups 18
about 36
name 53
session time-out 31
NFS command 66
NTP command 67
PPP
about 23
Ping response 87
Port
Preemption 27
access 17
Index
153
Quit command 80
Quit command (BMU) 142
RADIUS
about 35
Session
Security lock-out
about 40
enabling/disabling 40, 90
unlocking a user 40, 116
SNMP
about 46
enabling/disabling 47, 93
154
Telnet
connections to devices 21
options 2
Time-out. See Session time-out
about 3
Commands
U
User accounts
access levels and rights 33
sockets 110
SSH
displaying 32
about 24
authenticating users 25
disabling access 27, 96
displaying configuration information 27, 106
enabling access 26, 27, 90, 96
server keys 24
user keys 26
Statistics
predefined 10
User Add command 112
User command (BMU) 145
User command summary 111
User Delete command 113
User Logout command 113
network 104
port 99
Subnet mask
changing 92
configuring 8
displaying 104
Sysinfo command (BMU) 145
V
Virtual ports
about 1
accessing 3
adding 20, 69
attempting reconnection 75
Technical
deleting 20, 72
specifications 117
support 148
displaying 101
settings 19
USA Notification
Warning: Changes or modifications to this unit not expressly approved by the party responsible for compliance
could void the users authority to operate the equipment.
Note: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant
to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful
interference when the equipment is operated in a commercial environment. This equipment generates, uses and
can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may
cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to
cause harmful interference in which case the user will be required to correct the interference at his own expense.
Canadian Notification
This digital apparatus does not exceed the Class A limits for radio noise emissions from digital apparatus set out
in the Radio Interference Regulations of the Canadian Department of Communications.
Le prsent appareil numrique nmet pas de bruits radiolectriques dpassant les limites applicables aux
appareils numriques de la classe A prescrites dans le Rglement sur le brouillage radiolectrique dict par le
Ministre des Communications du Canada.
Japanese Approvals
European Union
Warning: This is a Class A product. In a domestic environment, this product may cause radio interference in
which case the user may be required to take adequate measures.
Taiwanese Notification
CCM
Installer/User Guide
Avocent Corporation
4991 Corporate Drive
Huntsville, Alabama 35805-6201 USA
Tel: +1 256 430 4000
Fax: +1 256 430 4031
Avocent Germany
Gottlieb-Daimler-Strae 2-4
D-33803 Steinhagen
Germany
Tel: +49 5204 9134 0
Fax: +49 5204 9134 99
Avocent Canada
20 Mural Street, Unit 5
Richmond Hill, Ontario
L4B 1K3 Canada
Tel: +1 877 992 9239
Fax: +1 877 524 2985
590-434-501E