Enable serial console redirection

Enable serial console redirection in order to access the serial console of an x86 or Lenovo System x compute node when the operating system is being installed, and when the operating system is running.

About this task

IBM® Spectrum Cluster Foundation Community Edition allows users to access the serial console of a compute node when the operating system is being installed, and when the operating system is running. To ensure that the serial console is accessible in both cases, the serial console redirection must be enabled in the uEFI of a compute node before the operating system starts installing, or boots up. Complete the following steps to enable the uEFI of a compute node:

Procedure

  1. Log in to the IBM Spectrum Cluster Foundation Community Edition management node as a root user.
  2. You must download and install the tool that is used to update the Unified Extensible Firmware Interface (UEFI) settings. Download the IBM Advanced Settings Utility (ASU) v9.30 (Linux 64-bit) .tar package from the IBM Support Site, found here: http://www-947.ibm.com/support/entry/portal/docdisplay?lndocid=TOOL-ASU
  3. Run the following commands:
       # tar -xzvf ibm_utl_asu_asut79n-9.30_linux_x86-64.tgz  
       # mkdir runimage
       # cp asu64 runimage
  4. Create an UEFI settings file in ./runimage/uefi.settings. The UEFI settings file can be used with all Lenovo System x servers that IBM Spectrum Cluster Foundation Community Edition supports.
    # vi ./runimage/uefi.settings
    DevicesandIOPorts.COMPort1=Enable
    DevicesandIOPorts.COMPort2=Enable
    DevicesandIOPorts.RemoteConsole=Enable
    DevicesandIOPorts.SerialPortSharing=Enable
    DevicesandIOPorts.SerialPortAccessMode=Dedicated
    DevicesandIOPorts.SPRedirection=Enable
    DevicesandIOPorts.LegacyOptionROMDisplay=COM Port 1
    DevicesandIOPorts.Com1BaudRate=115200
    DevicesandIOPorts.Com1DataBits=8
    DevicesandIOPorts.Com1Parity=None
    DevicesandIOPorts.Com1StopBits=1
    DevicesandIOPorts.Com1TerminalEmulation=ANSI
    DevicesandIOPorts.Com1ActiveAfterBoot=Enable
    DevicesandIOPorts.Com1FlowControl=Hardware
    DevicesandIOPorts.Com2BaudRate=115200
    DevicesandIOPorts.Com2DataBits=8
    DevicesandIOPorts.Com2Parity=None
    DevicesandIOPorts.Com2StopBits=1
    DevicesandIOPorts.Com2TerminalEmulation=ANSI
    DevicesandIOPorts.Com2ActiveAfterBoot=Enable
    DevicesandIOPorts.Com2FlowControl=Hardware
    Note: When the UEFI settings file is applied to a compute node, the new values in the file overwrite any existing values that are set in the UEFI file.
  5. Create a runme.sh script that runs the ASU utility to import the UEFI settings. The script must be executable.
    # cat ./runimage/runme.sh
    
    #!/bin/sh
    ./asu64 restore ./uefi.settings
    
    # chmod +x runme.sh
  6. Create a .tar file that contains the runme.sh script and the UEFI settings file. Put this file in the /install/pcm/work directory.
    # cd runimage 
    # tar -zcvf uefi-config.tgz .
    # mkdir -p /install/pcm/work/
    # cp uefi-config.tgz /install/pcm/work/
  7. Associate the .tar file that you built in step 6 with the hardware profiles that match the server types in your cluster. For example, if your cluster has Lenovo Flex System x machines, issue the following command on one line:
    # chdef  -t group __HardwareProfile_IBM_Flex_System_x chain='runcmd=bmcsetup,
    runimage=http://$XCATMASTER/install/pcm/work/uefi-update.tgz' 
    If you have other IBM server types, you must rerun the command for each server type. Each time you run the command, replace the hardware profile name with the hardware profile that corresponds to that server type. See the following table for the correct hardware profile names.
    Table 1. Hardware profile names
    IBM Server Type Hardware Profile Name
    Lenovo Flex System x220, x240, and x440 __HardwareProfile_IBM_Flex_System_x
    Lenovo System x3550 M4, x3650 M4, x3750 M4 __HardwareProfile_IBM_System_x_M4
    Lenovo System x iDataPlex dx360 M4 __HardwareProfile_IBM_iDataPlex_M4
    Note: If the default serial speed of the used hardware profile is changed, you must change the baud rate of the COM ports in step 4. For example, if you are using hardware profile __HardwareProfile_IBM_Flex_System_x and the serial speed of it is changed from 115200 to 57600, you must change the value of DevicesandIOPorts.Com1BaudRate and DevicesandIOPorts.Com2BaudRate to 57600 in the UEFI settings file created in step 4.