C H A P T E R  3

Configuring ALOM

This chapter provides help in some basic configuration tasks including:


ALOM Configuration Steps

Your ALOM software comes preinstalled on your host server, so it works as soon as you apply power to the server. You can connect a terminal to the serial management port (SERIAL MGT) and immediately start working with ALOM. On some servers (Sun Fire V215, V245, and V445), DHCP is enabled by default on the network management port. This allows an administrator network access to ALOM without first requiring a serial connection to the serial management port. To be secure by default, there are specific steps and constraints for the initial login through the network.

However, if you want to customize ALOM for your installation, you must perform some basic tasks.

Here are the tasks you must complete to customize ALOM:

1. Plan how to customize your configuration. See Planning Your ALOM Configuration.

2. Use the configuration worksheet to record your settings. See Configuration Variable Worksheet.

3. Power on your host server. See Powering On Your Host Server.

4. Run the setupsc command. See Setting Up ALOM.

5. Use the configuration variables to customize the ALOM software. See To Use Configuration Variables in the ALOM Command Shell.

Explanations of the listed tasks follow.


Planning Your ALOM Configuration

ALOM software comes preinstalled on your host server and is ready to run when you apply power to the server. You only need to follow the directions in this section if you decide to change the default configuration of ALOM to customize it for your installation.



Note - Refer to your host server's documentation to find the location of the serial management and network management ports.



Before you run the setupsc command, you must decide how you want ALOM to manage your host server. You must make the following decisions about your configuration:

Once you make those decisions, print the configuration worksheet shown in Configuration Variable Worksheet, and use it to record your responses to the setupsc command prompts.


Choosing ALOM Communication Ports

The ALOM hardware contains two types of communication ports:

Both ports give you access to the ALOM command shell. By default ALOM communicates through the SERIAL MGT port at startup. All initial configuration must de done through the serial management port on the Sun Fire V210, V240, V250, and V440 servers and Netra 210, 240, 440 servers. Some servers (Sun Fire V215, V245, and V445) support DHCP by default on the network management port. These servers can be configured from the serial management port or network management port, if the attached subnet has a DHCP server. The default network configuration allows a Secure Shell session to be started.



Note - Refer to your host server's documentation to find the location of the server's serial management and network management (Ethernet) connections.



Serial Management Port

You can connect to the ALOM serial management port with an ASCII terminal. This port is not an all-purpose serial port; it can be used to access ALOM and the server console through ALOM. On the host server, this port is referred to as the SERIAL MGT port. Refer to your server's documentation for more information.

The serial management port (SERIAL MGT) has a dedicated purpose. It enables ASCII communication between an external terminal and ALOM or the host server. This port takes a standard RJ-45 connector.

The port can only be used with an external terminal or with a terminal emulator, such as a serial connection from a workstation. It is not a general-purpose serial port. However, the Solaris Operating System sees this port as ttya.

If you want to use a general-purpose serial port with your server, use the regular
7-pin serial port on the back panel of your server. The Solaris Operating System sees this port as ttyb. For more information about the server's serial port, refer to your server's documentation.

Make sure that your console serial port is set to the following parameters:

The host server automatically sets these parameters for ALOM when it starts up. The settings are read-only, and cannot be changed from the ALOM sc> prompt. To view the settings for the parameters from the sc> prompt after you establish an ALOM session, check the serial port variables. See Serial Management Port Variables for more information.


procedure icon  To Connect to the Serial Port

1. Connect to ALOM.

See Connecting to ALOM and Logging in to Your ALOM Account for detailed instructions on establishing an ALOM system controller session.

The ALOM shell prompt (sc>) is displayed.

2. To connect to the system console, in the ALOM system controller window, type:


sc> console

3. To return to the ALOM shell prompt (sc>) type #. (pound period).



Note - The #. (pound-period) character sequence is the default escape character sequence for ALOM. You can change the first character in the escape sequence by using the sc_escapechars variable. See sc_escapechars for more information.



Network Management (Ethernet) Port

The Ethernet port enables you to access ALOM from within your company network. You can connect to ALOM remotely using any standard Telnet client with Transmission Control Protocol/Internet Protocol (TCP/IP) or Secure Shell (ssh). On your host server, the ALOM Ethernet port is referred to as the NET MGT port.



Note - The Sun Fire V210, V240, V250, and V440 servers and Netra 210, 240, and 440 servers support 10BASE-T only. The Sun Fire V215, V245, and V445 servers support 10/100BASE-T. ALOM does not support one-gigabit networks.



The network management port is disabled by default on the Sun Fire V210, V240, V250, and V440 servers and Netra 210, 240, and 440 servers. It is enabled by default on the Sun Fire V215, V245, and V445 servers to support DHCP.

Refer to your server's documentation for more information on hardware capability.

Default DHCP Connection (Sun Fire V215, V245, and V445 Servers)

When Dynamic Host Configuration Protocol is enabled, the SC acquires its network configuration, such as IP address, automatically from a DHCP server. DHCP is enabled by default on Sun Fire V215, V245, and V445 servers. It is disabled by default on all other servers and must be manually configured.

DHCP enabled-by-default allows a network connection to be established to the SC without first requiring a serial connection to manually configure the network. To make best use of this feature, the administrator must be aware of the associated default configuration variables and default parameters for the DHCP server and for log in to the SC.

The following ALOM variables and the default contents support DHCP on-by-default:


TABLE 3-1 DHCP Default Contents for ALOM Configuration Variables

Configuration Variable

Default Contents on Sun Fire V215, V245, and V445 Servers

Default Contents on All Other ALOM Servers

if_network

true

false

if_connection

ssh

none

netsc_dhcp

true

false


A DHCP client, in this case the SC, provides a unique client identifier (clientid) to identify itself to the DHCP server. The clientid is based on a system property easily obtainable by an authorized administrator with physical access to the system. Once a clientid is determined, the DHCP server can be preconfigured to map the clientid to a known IP address. After the SC is assigned an IP address, it starts the SSH server. An administrator can then initiate an ssh session with the SC. If the system is brand-new out-of-box, or upon reboot after the setdefaults -a command is run, the default admin user account requires a default password to log in. The default password is also composed of a system property that is easily obtainable by an administrator with physical access to the system. The next two sections show how clientid and default password can be constructed.

Client Identifier (clientid)

The clientid is based on the base Ethernet address for the system. The base Ethernet address is available on the Customer Information Sheet that is delivered with each system and is also available on a label on the back panel of the system chassis. The clientid is composed of the following concatenation:

SUNW,SC=base-ethernet-address

For example, if the base-ethernet-address is 08:00:20:7C:B4:08, then the clientid that the SC generates is the string prefix SUNW,SC= concatenated with the 12-digit base-ethernet-address minus the colons:

SUNW,SC=0800207CB408

This clientid is in ASCII format. It should be possible to program the DHCP server with an ASCII clientid. The actual entry into the DHCP mapping table is the hexadecimal equivalent.

Default Password

When a system is shipped new from the factory, or upon reboot after a setdefaults -a command, a default password is required to log in from an ssh session. The default password is unique for each system. It is derived from the chassis serial number. The chassis serial number can be found on the Customer Information Sheet shipped with each server and can be found on a label attached to the back panel of the chassis. The default password is composed of the last 8 digits of the chassis serial number. For example, if the chassis serial number is 0547AE81D0 then the default password is:

47AE81D0



Note - After an admin password is set, then the admin password is required for login. The default password is no longer applicable, unless a setdefaults -a command is run. For example, if a setdefaults command is run without the -a option, then the admin password remains the same as it was before the setdefaults command was run.



High-Level Steps to Use DHCP on a New Out-of-Box System

1. Determine the clientid from the host system base Ethernet address. The base Ethernet address can be obtained from the Customer Information Sheet or label on the back panel of the chassis.

2. Determine the default admin user login password from chassis serial number. The chassis serial number can be obtained from the Customer Information Sheet or label on the back panel of the chassis.

3. Program the DHCP server to serve the new clientid.

4. Attach the Sun Fire V215, V245, or V445 system to the network and ensure the system has AC power.

5. Start the ssh session using the IP address assigned by the DHCP server.

6. Log in as the admin user using the predetermined default password.



Note - It is not necessary to preprogram the DHCP server to map the SC clientid to an explicit IP address; however, it is a best practice and can make long-term administration easier.



If the DHCP server is configured to pull from a block of IP addresses, then the administrator can use a DHCP administrative utility to determine the IP address that was assigned, although it may first be necessary to convert the clientid to a hexadecimal equivalent. For example, if the DHCP server is running the Solaris OS, then the pntadm(1M) command can be used to display the IP address assignments. In the following example, the SC with Ethernet address 123456789012 is connected to the .203 subnet.


# pntadm -P 129.156.203.0
Client ID                                   Flags  Client IP   ...
 
53554E572C5353433D313233343536373839404142  00     129.156.203.240 ...
...
 

In this case it is necessary to convert ASCII to a hexadecimal equivalent clientid to determine the IP address assignment. For example:

53|55|4E|57|2C|53|43|3D|31|32|33|34|35|36|37|38|39|30|31|32

S U N W , S C = 1 2 3 4 5 6 7 8 9 0 1 2


Configuring an External Modem

If you want to connect to ALOM from an external PC or terminal using a modem, you can connect an external modem to the serial management port (SERIAL MGT). This allows you to run the ALOM software using your remote PC.

However, you can only use the modem for incoming ASCII connections to connect to the serial port to obtain the ALOM command prompt (sc>). Outgoing calls from ALOM using a modem are not supported.

Before attaching the modem to the ALOM serial port, set to factory default settings. On many modems, setting the factory default settings is done by using the AT&F0 command.

Using a Sun Connector

In order to connect the modem to the ALOM serial management port, a specific connector needs to be created or purchased with the specific pinout requirements.

One way to connect a modem to this port is to use a modified RJ-45 to DB-25 connector, Sun part number 530-2889-03, and a crossover RJ-45 to RJ-45 cable. The connector 530-2889-03 is modified by extracting the DB-25 pin in the pin 6 position and inserting it into the pin 8 position.

Creating Your Own Connector

If you want to connect wiring yourself, translate the signals between the RJ-45 and DB-25 according to the information shown in TABLE 3-2:


TABLE 3-2 Signal Translation Between RJ-45 and DB-25 Connectors

RJ-45

DB-25

1 - RTS

5 - CTS

2 - DTR

6 - DSR

3- TXD

3 - RXD

4 - GND

7 - GND

5 - RXD

7 - GND

6 - RXD

2 - TXD

7 - DCD

8 - DCD

8 - CTS

4 - RTS


FIGURE 3-1 and TABLE 3-3 include information about pin assignments and signal description relevant to an RJ-45 connector.


FIGURE 3-1 RJ-45 Connector Pin Locations

Figure shows 8-pin RJ-45 connector with Pin 1 at left and Pin 8 at right.


 


TABLE 3-3 Signal Description of an RJ-45 Connector

Pin

Signal Description

Pin

Signal Description

1

Request To Send (RTS)

5

Ground

2

Data Terminal Ready (DTR)

6

Receive Data (RXD)

3

Transmit Data (TXD)

7

Data Carrier Detect (DCD)

4

Ground

8

Clear To Send (CTS)


FIGURE 3-2 and TABLE 3-4 include information about the serial port connector and signals relevant to a DB-25 connector.


FIGURE 3-2 DB-25 Female Connector Pin Locations

Figure shows 25-pin DB-25 connector with Pins 13 and 25 at left and Pins 1 and 14 at right.


 


TABLE 3-4 Signal Description of a DB-25 Female Connector

Pin

Number

Function

I/O

Signal Description

1

none

none

N.C.[1]

2

TXD_A

O

Transmit Data

3

RXD_A

I

Receive Data

4

RTS_A

O

Ready To Send

5

CTS_A

I

Clear To Send

6

DSR_A

I

Data Set Ready

7

GND

 

Signal Ground

8

DCD_A

I

Data Carrier Detect

9

none

none

N.C.*

10

none

none

N.C*

11

DTR_B

O

Data Terminal Ready

12

DCD_B

I

Data Carrier Detect

13

CTS_B

I

Clear To Send

14

TXD_B

O

Transmit Data

15

TRXC_A

I

Transmit Clock

16

RXD_B

I

Receive Data

17

RXD_A

I

Receive Clock

18

RXD_B

I

Receive Clock

19

RTS_B

O

Ready To Send

20

DTR_A

O

Data Terminal Ready

21

none

none

N.C.*

22

none

none

N.C.*

23

none

none

N.C.*

24

TXC_A

O

Transmit Clock

25

TXC_B

O

Transmit Clock


For more information, see if_modem.


Configuration Worksheet

You only need to use this worksheet if you want to customize ALOM for your installation.

To customize ALOM, you use the configuration variables. See Using ALOM Configuration Variables for details of variables.

There are two ways to set up the configuration variables for ALOM:

Print this section and use the table to record your inputs. This table can also serve as your record of the host server configuration in case you must reinstall the server software or modify the ALOM settings.

Make sure that your terminal device is connected to ALOM before you customize the ALOM software. Choosing ALOM Communication Ports details the process. See your host server's documentation to find the location of the serial and Ethernet connections for ALOM.

Configuration Variable Worksheet

TABLE 3-5 identifies the configuration variables responsible for Ethernet control and their default values. Enter your values in the extreme right column.


TABLE 3-5 Ethernet Variables by Function

Function

Value/Response

Configuration Variable

Default Variable

Your Values

How do you want to control network configuration?

Manually, see Configuring Your Network Manually.

 

Using DHCP, see Configuring Your Network Using DHCP.

 

 

 

Remote connection to your server

none, ssh, or telnet

if_connection, see if_connection.

none or ssh depending on server type

 

IP address for ALOM

 

netsc_ipaddr, see netsc_ipaddr.

0.0.0.0

 

IP address for the subnet mask

 

netsc_ipnetmask see netsc_ipnetmask.

255.255.255.0

 

IP address for the default gateway to use when the destination is not on the same subnet as ALOM

 

netsc_ipgateway, see netsc_ipgateway.

0.0.0.0

 

Do you want ALOM to send alerts by email?

Email addresses to use for sending alerts (maximum of two mail servers supported)

 

mgt_mailalert, see mgt_mailalert.

[]

The default has no email addresses configured

 

IP address for your Simple Mail Transfer Protocol (SMTP) server (maximum of two mail servers supported)

 

mgt_mailhost

see mgt_mailhost.

0.0.0.0

 




Note - You can also set up user accounts manually, but not by using the setupsc script. To set up user accounts manually, see Adding ALOM User Accounts.



Related Information

Configuring Your Network Using DHCP

When Dynamic Host Configuration Protocol is enabled, the SC acquires its network configuration, such as IP address, automatically from a DHCP server. DHCP is enabled by default on Sun Fire V215, V245, and V445 servers; see Default DHCP Connection (Sun Fire V215, V245, and V445 Servers) for more information. DHCP is disabled by default on all other servers and must be manually configured.

There are two ways to configure DHCP for ALOM:



Note - It is a best practice to set the ALOM device name associated with the Internet Protocol (IP) address in name server maps, such as the network information service (NIS) or domain name service (DNS), to be the name of the host server with -sc appended to it. For example, if your host server's name is bert, the ALOM device name is bert-sc.



If you use DHCP to control your network configuration, configure the DHCP server to assign a fixed IP address to ALOM.

Configuring Your Network Manually

There are two ways to manually configure the network for ALOM:

If you set each variable individually, you must set the following variables:



Note - It is a best practice to set the ALOM device name associated with the IP address in name server maps (NIS or DNS) to be the name of the host server with -sc appended to it. For example, if your host server's name is bert, the ALOM device name is bert-sc.



Powering On Your Host Server

Refer to your host server documentation for information about how to power on the system. If you want to capture ALOM messages, power on the terminal that you have connected to the SERIAL MGT port before powering on the host server.

As soon as power is applied to the host, the SERIAL MGT port connects to the host server's console stream. To switch to ALOM, type #. (pound-period). At startup, ALOM has one pre-configured administrator account admin.

When you switch to ALOM from the system console, you are prompted to create a password for this account. See the password command section in password on for a description of acceptable passwords.

The default admin account has full ALOM user permissions (cuar). For more on permissions, see userperm. You can use this account to view the console output from the host, to set up other user accounts and passwords, and to configure ALOM.

Related Information


Configuring Email Alerts

To send email alerts, the ALOM Ethernet port must be enabled. See Network Management (Ethernet) Port.

When a problem occurs on a host server, ALOM sends an alert message to all users who are logged in to ALOM accounts on that host. In addition, you can configure ALOM to send alerts by email to users who are not logged in. When a user receives an alert, that user can connect to the ALOM account for that host server and address the alert condition.

Setting Up Email Alerts

The ALOM software allows you to set up to eight unique email addresses to receive alerts. You can configure each email address to receive its own severity level of alerts (critical, major, or minor). See Sending Customized Alerts.


Setting Up ALOM

After you have finished planning your configuration, run the setupsc command described on setupsc. Follow the prompts on the screen to customize the ALOM software for your installation.



Note - You do not have to customize the ALOM software before you can use it. The ALOM software works as soon as you connect power to the host server.



The setupsc command runs a script that steps you through each ALOM function that you can customize. Each function is associated with one or more configuration variables. For more on configuration variables, see Chapter 6. To configure a function, type y when the setupsc script prompts you to do so. To skip a function, type n.

If you later must change a setting, run the setsc command as described in setsc.

Customize the ALOM Software

The setupsc script enables you to set up a number of configuration variables at once. See Chapter 6 for more information. If you want to change one or more configuration variables without running the setupsc script, use the setsc command as shown on To Use the setsc Command.

Related Information


1 (TableFootnote) N.C. means "No Connection"