bullion S

Remote Hardware
Management CLI Quick
Reference Guide

86 A1 47FL 12 - December 2021 -1

The following copyright notice protects this book under Copyright laws which prohibit such actions
as, but not limited to, copying, distributing, modifying, and making derivative works.

Copyright ©Bull SAS 2021

Printed in France

Trademarks and Acknowledgements

We acknowledge the right of proprietors of trademarks mentioned in this manual.

All brand names and software and hardware product names are subject to trademark and/or
patent protection.
Quoting of brand and product names is for information purposes only and does not represent
trademark and/or patent misuse.

Hardware

December 2021

Bull Cedoc
357 avenue Patton
BP 20845
49008 Angers Cedex 01
FRANCE

The information in this document is subject to change without notice. Bull will not be liable for errors contained
herein, or for incidental or consequential damages in connection with the use of this material.
Table of Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . p‐1
Intended Readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . p‐1

Chapter 1. Alphabetic List of Hardware Management CLIs . . . . . . . . . . . . . . . . . . . . 1-1

1.1. Common Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
1.2. Commands List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Chapter 2. Hardware Management CLIs for Server Actions . . . . . . . . . . . . . . . . . . . 2-1

2.1. Setting up Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
2.2. Configuring Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.3. Powering Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.4. Monitoring Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
2.5. Maintenance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

Contents i
Preface
This guide provides a summary of the Hardware Management CLIs (Command
Line Interface) for bullion S servers.

See Refer to the bullion S Remote Hardware Management CLI Reference

Guide, 86 A1 43FL for more information.

W059 WARNING
W059:
Only qualified support personnel are authorized to use Maintenance
Hardware Management CLIs.

Note You are advised to consult the Bull Support Web site for the most
up-to-date product information, documentation, firmware updates,
software fixes and service offers: http://support.bull.com

Intended Readers
This guide is intended for System Administrators and Operators in charge of
managing systems locally and remotely and of writing server management batch
scripts.

Preface p‐1
Chapter 1. Alphabetic List of Hardware Management
CLIs
This section lists all the Hardware Management CLIs in alphabetical order.

See Refer to the bullion S Remote Hardware Management CLI Reference

Guide, 86 A1 43FL for more information.

1.1. Common Options

-h Displays command usage
­l level Specifies the message severity to be logged in syslog
0: no message is logged (default)
1: only the FAILED completion of the command is
logged
3: FAILED and successful completion of the command
are logged
­m interface Target server interface: lanplus
­H host Module IP address or DNS name
­u user MC user
­p password MC user password
-Y cipher Cipher suite ID to be used by lanplus interface: from 0
to 14 according to the security level
Default is 3: Authentication (RAKP-HMAC-SHA1),
Integrity (HMAC-SHA1-96), Confidentiality
(AES-CBC-128)
-o outfile Output file name to which stdout and stderr outputs
are redirected

Important The MC user password must not contain space, quote,

double quote, slash, backslash, percent, pipe, parenthesis
and the following characters: .;,+&*=<>:~?`^%#$.

Chapter 1. Alphabetic List of Hardware Management CLIs 1-1

1.2. Commands List
Note Maintenance Hardware Management CLIs are marked with an asterisk
(*).

W059 WARNING
W059:
Only qualified support personnel are authorized to use Maintenance
Hardware Management CLIs.

Main Options Description

bsmAddHardwareExclusion
Excludes hardware components
bsmAddHardwareExclusion.sh [-h] [-l level]­m interface -H host -C
componentList [-u user] [-p password] [-Y cipher] [-o outfile]]
-C componentList Hardware components list. Possible values:
MMRx_CHy_DIMMz, XQPIx, moduleX,
ultracapa

bsmBIOS
Manages BIOS for a module
bsmBios.sh [-h] [-l level] [-m interface] -H host -a action [-F File] [-u
user] [-p password] [-Y cipher] [-o outfile]
-a getBiosInfo Returns BIOS image information
-a getMemorySize Gets the BIOS memory size saved in the
BMC

bsmBiosLog
List, get, remove, get the size of BIOS log message files from the SD card
bsmBiosLog.sh [­h] [­l level] [­m interface] ­H host [­u user] [­p password]
[­Y cipher] [­f filename] [­d directory] [­o outfile] -a action arglist
-a list Returns the name of the BIOS log files
present on the SD card
-a get Copies the specified BIOS log file, or all BIOS
log files, or the most recent BIOS log files,
into the specified directory (default /tmp
directory)
-a size Returns the size of the specified BIOS log file
-a rm Removes the specified BIOS log file, or all
BIOS log files, or the oldest files, or the files
dated a month, from the SD card
­d directory Directory path for destination (default /tmp)
­f filename BIOS log file name on SD card

1-2 Quick Reference Guide

 Main Options Description
bsmBiosSettings
List, get, set, reset the BIOS settings
bsmBiosSettings.sh [­h] [­l level] [­m interface] ­H host [­u user] [­p
password] [­Y cipher] [­o outfile] -a action arglist
-a list Returns all the BIOS settings values
-a get Returns the required BIOS settings. The
BIOS settings are noted in a file or in the
command line
-a set Sets the required BIOS settings. The BIOS
settings and the values are given in a file or
in the command line
-a reset Sets the BIOS settings to the default values
-a copy Copies the BIOS settings file to a SD card
­f filename File name for the required BIOS setting
-n settingname List of BIOS settings or list of BIOS settings
and the values

bsmBMCcfg
Backups the BMC configuration parameters of all modules included in a
partition or restores the BMC configuration parameters for a module
bsmBMCcfg.sh [-h] [-l level][-m interface] -H host -a action [-F file -D
backupDir -M module] [-u user] [-p password] [-Y cipher] [-o outfile]
-a backup Backups the BMC configuration parameters
of all modules included in a partition
-a restore Restores the BMC configuration parameters
for a module
-D backupDir Full directory path for backup files (used with
restore action)
-F config Type of file to be restored (used with restore
action)
-F pef Type of file to be restored (used with restore
action)
-F system Type of file to be restored (used with restore
action)
-M module Module identifier from 0 to 3 (used with
restore action)

bsmBootDevice
Get and set the BIOS boot device configuration
bsmBootdevice.sh [­h] [­l level] [­m interface] ­H host [-d device] [-i
instance] [-O options] [­u user] [­p password] [­Y cipher] [­o outfile]
-d device Sets the boot device: bios, pxe, disk, diag,
none
-i instance Instance number for disk and pxe
--O options Sets the options: persistent, efiboot,
clear-cmos

Chapter 1. Alphabetic List of Hardware Management CLIs 1-3

 Main Options Description
bsmevent
Adds events attached to a sensor to the SEL repository
bsmevent.sh [h] [l level] - a action -m interface -H host [-u user] [-p
password] -s sensorID [-b state] [-e eventDir] [-i i2csaAdr] [-d landest]
[-Y cipher] [-o outfile]
-a setEvent Inserts events attached to a sensor into the
SEL repository
-a testEvent Tests trap events sent without writing
messages in the SEL repository
-s sensorID Sensor identifier (placed between
double-quotes)
-d landest Alert destination number
-b state State for the sensor identifier (default is
list). Possible states are: list, lnr, lcr, lnc,
unc, ucr, unr, present
-e eventDir Direction taken by the state (default is
assert)
-i i2csaAdr Address of the device generating the event
(default is the BMC address)

bsmfru
Displays the FRU contents using standard output
bsmfru.sh [-h] -m lanplus -H host [–u user] [–p password] [-o outfile] [-l
level]

bsmFWupg*
Updates, using an external tool, the firmware of Remote Management Modules
bsmFWupg.sh [­h] ­H host –F [fw_binfile] [­u user] [­p password] ­a action
[­E component] [­M module] [­m interface] [­d fw_bindir] [­o outfile]
-a ver Displays component firmware versions
-a listhw Displays the list of components which can be
updated
-a upg Updates component firmware
-E component_id Component name
-M module_id Module identifier

bsmFwGlobalUpg
Checks the installed firmware versions and, if necessary, updates them with
the versions on the Resource and Documentation DVD
bsmFwGlobalUpg.sh [­h | -V] -a action -D dir [­H host ­u user ­p password]
[-M module_id] [-f [-T action_to]] [-L y|n] [-r] [­o outfile] [-d]
-a list Lists the component firmware provided on
the Resource and Documentation DVD
-a check Checks the installation prerequisites for all
the components that need updating

1-4 Quick Reference Guide

 Main Options Description
-a diff Compares the installed firmware version with
the firmware version referenced on the
Resource and Documentation DVD for all
components
-a upg Updates all the components that can be
updated with the versions available on the
Resource and Documentation DVD
-L y (yes): checks and updates lower and higher
versions (default)
-L n (no): checks and updates lower versions
-D directory DVD mount point (full path)
-M module_id Module identifier
-f [-T action_to] Forces the update of the prerequisites. The
default timeout can be changed

bsmGetConfParam
Gets various configuration parameter values
bsmGetConfParam.sh [-h] [-l level] -a action -m interface -H host [-u user]
[-p password] [-Y cipher] [-o outfile]
-a getPrimaryNTP Gets the primary NTP server which gives the
date and time
-a getSecondaryNTP Gets the secondary NTP server which gives
the date and time
-a getPowerRestorePolicy Gets the power restore policy (On, Off or
Restore) which is applied to the system after
an AC power loss
-a getTSnumber Gets the Technical State number
-a getDisableBCS Gets the BCS status
-a getBiosNoMemoryHole Returns this feature setting. This feature
allows to manage memory gaps. For VMware
only.
-a getBiosBootTimeout Returns the BIOS boot timeout.
-a Returns this feature setting. This feature
getBiosVMwareMaxMemPerMod allows to manage DRAM slices pre-allocation.
ule For VMware only.

bsmGetFunctionalProfile
Displays the state of the functional profile identifier (active or not) for a
partition and the state of its Power Restore Policy (on or off)
bsmGetFunctionalProfile.sh [­h] [­l level] ­m interface ­H host [­u user]
[­p password] ­n functionalProfileID [­Y cipher] [­o outfile]
-n functionalProfileID Functional Profile (0 to 1)

bsmGetHardwareExclusion
Gets hardware component exclusion list for a server
bsmGetHardwareExclusion.sh [-h] [-l level]‐m interface -H host [-u user][-p
password] [-Y cipher] [-o outfile]

Chapter 1. Alphabetic List of Hardware Management CLIs 1-5

 Main Options Description
bsmGetModuleLevelInfo
Gets information about a partition module
bsmGetModuleLevelInfo.sh [­h] [­l level] ­m interface ­H host [­u user] [­p
password] [­k keyname] [­Y cipher] [­o outfile]
-k module_id Module identifier
-k model_type Model type
-k model_name Model name

bsmGetPartitionLevelInfo
Gets information about the partition composition for a platform
bsmGetPartitionLevelInfo.sh [­h] [­l level] ­m interface ­H host [­u user]
[­p password] [­k keyname] [­Y cipher] [­o outfile]
-k partition_composition Lists the modules included in the partition
-k master_id Current master module identifier
-k next_master_id Master module identifier which will be set
after the next power on
-k ip_emm_list Lists the module IP addresses for the
platform
-k partition_name Name of the partition

bsmGetPlatformLevelInfo
Gets platform information
bsmGetPlatformLevelInfo.sh [­h] [­l level] ­m interface ­H host [­u user]
[­p password] [­k keyname] [­Y cipher] [­o outfile]
-k platform_id Platform identifier
-k platform_name Platform label
-k module_count Number of modules in the platform
-k prefix_ip Internal network IP address prefix
-k ip_emm_list Lists platform module's IP addresses
-k is_flexible Possibility to change the partition
composition
-k get_reset Gets the value set for automatic reset
-k get_uc_presence Gets the value set to power the
ultracapacitors

bsmGUID
Manages the GUID for each partition of the platform
bsmGUID.sh [­h] ­m lanplus ­H host ­u user [­p password] [­l level] ­a
action [­o outfile] [­Y cipher]
-a set Sets the GUID for each partition of the
platform
-a get Gets the GUID for each partition of the
platform

1-6 Quick Reference Guide

 Main Options Description
bsmidentify
Physically identifies a remote host via user visible lights or beeps for a
defined interval
bsmidentify.sh [­h] ­m lanplus ­H host ­u user [­p password] [­l level] ­C
value [­o outfile] [­Y cipher]
-C value Specifies the identification time period

bsminfo
Gets IPMI details such as BMC parameters, LAN configuration parameters,
users list, and Alert parameters
bsminfo.sh [-h] -m lanplus -H host –a param -u user [-p password] [-o
outfile] [-l level] [-Y cipher]
-a bmc_info Gets IPMI detaila such as the BMC Firmware
revision, Manufacturer, BMC Device support
-a lan_print Gets the configuration parameters of the LAN
channel used to access the BMC with an
OutOfBand connection
-a user_list Gets details about the users configured for
the LAN channel used to access the BMC
with an OutOfBand connection
-a get_lan_alert_dest Gets details about the LAN alert destinations
configured for the LAN channel used to
access the BMC with an OutOfBand
connection
-a get_pef_policy Gets details about the Alert Policy Table used
by the BMC for Alert processing
-a get_pef_list Gets details about the Platform Event Filter
Table used by the BMC for Alert processing

bsmlog
Directs system log contents (SEL) to standard output or writes messages and
internal traces to the BMC into a filename and clear them
bsmlog.sh [­h] ­m lanplus ­H host ­u user [­p password] [­n range] [­a
action [­D backupdir] [­s suffix] [­M module]] [­o outfile] [­l level] [­Y
cipher] [­v]
-a get_sel Directs system log contents (SEL) to the
standard output
-a clear_sel Clears the system logs contents (SEL)
-a get_logs Writes BMC messages and internal traces to
the BMC into a file name
-a clear_logs Clears the BMC messages and internal traces
to the BMC
-v Displays record details
-n n Displays the n most recent records
-n r1­r2 Displays records from r1 to r2

Chapter 1. Alphabetic List of Hardware Management CLIs 1-7

 Main Options Description
bsmMAINTBMCcfg*
Restores the default factory keys
bsmMAINTBMCcfg.sh [-h] [­m interface] -H host [-u user] [-p password] -a
action
-a restoreFactory Restores the default factory keys

bsmMAINTDisplayModuleConfigur ation*
Gets all configuration details for a module. For multi-module configurations.
bsmMAINTDisplayModuleConfiguration.sh [-h] [-l level][­m interface] -H
host [-u user] [-p password] [-Y cipher]

bsmOSpm
Controls the CPU policy and frequency of platform via the cpufrequtils
package
bsmOSpm.sh [­h] [­l level] ­m interface –H host [–u user] [­o outfile] [­I
idfile] [­d cfgdir] [­C configfile] [­D pathdir] –a action arglist
-a getpolicy Gets the governor and the frequency range
for one or all CPUs
-a setpolicy Sets the CPU governor and the frequency
range for all CPUs for the usespace governor
-a getCurrentFreq Gets the current frequency of one or all CPUs
-a setCurrentFreq Sets the current frequency for one or all
CPUs
-a getHWlimits Gets the minimum and maximum CPU
frequency allowed
-C ConfigFile Config file used for remote connection
-I idfile Identity file used for remote connection
-d cfgdir Full path directory containing config file and
identity file
-D pathdir Full path directory containing script
bsmOSpm_local on remote host

bsmPDUpower
Monitors and manages remote controlled PDUs (Only PDUs from APC are
supported)
bsmPDUpower.sh [­h] [­l level] ­m interface –H host [­o outfile] –a action
-arglist
-a on Sets on one, or all, outlets for a PDU
-a off Sets off one, or all, outlets for a PDU
-a status Displays the status for one, or all outlets, of
a PDU
-a getPowerConsumption Gets the power consumption (in Watts) for
all outlets of a PDU
-arglist Lists arguments specific to the action

1-8 Quick Reference Guide

 Main Options Description
bsmpower
Performs system POWER ON/OFF and FORCE POWER OFF operations and
checks the power state
bsmpower.sh [-h] [-q] -a action -m lanplus -H host [-u user] [-p password]
[-o outfile] [-Y cipher]
-a status Displays power status
-a diag Sends a diagnostic interrupt to the processor.
It is used to make the Operating System
perform a diagnostic dump for
troubleshooting purposes
-a on Power On

-a off Power Off

-a off_force Force Power Off

bsmPSUcmd*
Gets and sets the time of the next Power Supply Unit cold redundancy test
bsmPSUcmd.sh [-h] [-l level] [­m interface] -H host -a action [-x time] [-u
user] [-p password] [-Y cipher] [-o outfile]
-a getTime Returns the time set for the PSU cold
redundancy test
-a setTime Sets the time (hh:mm) for the PSU cold
redundancy test
-a get_psu_redundancy Gets the power supply redundancy policy
-a set_psu_redundancy Sets the power supply redundancy policy
-a test_psu_redundancy Tests the PSU cold redundancy immediately
-x time Time with format hh:mm

bsmRegDump
Manages registries dumps from SD card
bsmRegDump.sh [-h] ­m interface -H host -C componentList [-u user] [-p
password] [-Y cipher][-d directory] [-f filename] -a action arglist [-o
outfile]
-a config Copies the configuration file to the SD card
-a dump Launches a dump of the registries
-a list Lists all the registry dump files present on
the SD card
-a get Gets the specified registry dump file
-a size Gets the size of the specified registry dump
files
-a rm Removes the specified registry dump file
-f filename Name of the registry dump file / Name of the
configuration file
-d directory Name of the destination directory (default
/tmp)

Chapter 1. Alphabetic List of Hardware Management CLIs 1-9

 Main Options Description
bsmRemoveHardwareExclusion
Removes component or module exclusion for a platform
bsmRemoveHardwareExclusion.sh [-h] [-l level]­m interface -H host -C
componentList [-u user] [-p password] [-Y cipher] [-o outfile]]
-C componentList Hardware components list. Possible values:
MMRx_CHy_DIMMz, XQPIx, moduleX,
ultracapa

bsmreset
Forcibly power resets a server or resets the BMC
bsmreset.sh [-h] [-q] -m lanplus -H host -a action [-u user] [-p password]
[-o outfile] [-l level]
-a HARDreset Reset the server and reboot
-a BMCreset Reset the BMC
-a UNITreset Reset components (CMM, ESM)
-a FPGAreset Reset the MSM FPGA
-a BCM1reset Reset the MSM BCM1
-a BCM2reset Reset the MSM BCM2

bsmResetAllEMMPartition
Resets the firmware for all partition modules. For multi-module configurations
only
bsmResetAllEmmPartition.sh [­h] [­l level] ­m interface ­H host [­u user][­p
password] [­Y cipher] [­o outfile]

bsmsdr
Obtains information from the Sensor Data Repository for all sensors.
bsmsdr.sh [­h] [­l level] [­m interface] ­H host [­u user ­p password]
[­Y cipher] ­a action [­s sensor_ids] [­i i2csa_addr] [­t sensor_type]
[­e entity_type] [­F filename] [­X] [­x value] [­o outfile]
­a action Possible values:
list: Lists sensor data including type, ID and
status
info: Displays SDR details
dump: Dumps SDR data into a text file
cclear: Clears the SDR cache
get: Gets specific sensor data either by type,
ID, address or entity
s sensor_ids Specifies sensor names separated by
commas (between double quotes)
­i i2csa_addr Specifies the address of the device
generating a event (default is the BMC
address)
­t sensor_type Specifies sensor type by string or code (0x..)
or list
­e entity_type Specifies entity type by string or decimal
(entity_id[.entity_instance]) or list
­F filename Name of the SDR dump file

1-10 Quick Reference Guide

 Main Options Description
­X Optional parameter for the list action:
display extended list
­x value Optional values for the list action:
all: All sensors
full: Full Sensor Record
compact: Compact Sensor Record
event: Event-Only Record
mcloc: Management Controller Device
Locator Record
fru: Fru Device Locator Record
generic: Generic
­o outfile Output file name

bsmseld
Logs SEL messages in syslog file (for Linux only)
bsmseld.sh [­h] [­v] ­m lanplus ­H host ­u user [­p password] [­a action]
[­M module]
-a start Starts the SEL syslog logging daemon
-a stop Stops the SEL syslog logging daemon

bsmsensor
Directs sensor values to the standard output
bsmsensor.sh [­h] [­v] ­m lanplus ­H host ­u user [­p password] [­c] [­o
outfile] [­l level] [­s sensorid_list] [­t type [­a]] [­Y cipher]
-v Displays details of each sensor
-c Compact form for sensor details
-s sensorid Specifies a list of sensor(s), specified
between quotes “" and separated by
comma(s), to be read
-t type Processes sensors of the specified type only
(as defined in IPMI specification)
-a Processes analog sensors only of the type
specified with the -t type

Chapter 1. Alphabetic List of Hardware Management CLIs 1-11

 Main Options Description
bsmSetConfParam
Sets the values of various configuration parameters
bsmSetConfParam.sh [-h] [-l level] -a action -m interface -H host -x value
[-u user] [-p password] [-Y cipher] [-o outfile]
-a setPrimaryNTP Sets the IP address for the primary NTP
server which gives the date and time
-a setSecondaryNTP Sets the IP address for the primary NTP
server which gives the date and time
-a setPowerRestorePolicy Sets the power restore policy (On, Off or
Restore) which will be apply to the system
after an AC power loss
-a setTSnumber Sets the Technical State number
-a setBiosNoMemoryHole Removes all gaps in memory allocation for
the modules. For VMware only.
-a setDisableBCS Disables the BCS
-a Pre-allocates a DRAM slice per module. For
setBiosVMwareMaxMemPerMod VMware only.
ule
-a setBiosBootTimeout Sets the BIOS boot timeout.
-x value IP address (setPrimaryNTP,
setSecondaryNTP)
'On', 'Off', 'Restore' (setPowerRestorePolicy)
yes, no (setBiosNoMemoryHole,
setDisableBCS)
Technical State number (setTSnumber)

bsmSetPartitions
Sets global partitioning. All partitions are defined in one way. For
multi-module configurations.
bsmSetPartitions.sh [­h] [­l level] [­m interface] ­H host –C composition
[-r reset] [­u user] [­p password] [­Y cipher] [­o outfile]
-C composition Partition composition
-r reset If present, bmc reset will not be executed

bsmSetPlatformLevelParam
Sets some platform parameters. Setting is done for all modules belonging to
the platform
bsmSetPlatformLevelParam.sh [­h] [­l level] ­m interface ­H host [­u
user][­p password] [[­N name][­I prefix_ip]] [[-a action][-M module][-x
value]] [­Y cipher] [­o outfile]
-x value 'yes' or 'no'

1-12 Quick Reference Guide

 Main Options Description
bsmsnapshot
Collects sensors data, SELs, messages, FRU, BMC configuration files, BIOS
logs and firmware versions in an archive file
bsmsnapshot.sh [­h] [­l level] [­m interface] [­H host] [-d directory] [­u
user] [­p password] [­Y cipher] [­o outfile]
-d directory Directory path for tar.gz file (default: /var)

bsmsol
Establishes a Serial-Over-Lan session and obtains or sets Serial-Over-Lan
parameters
bsmsol.sh [-h] -m lanplus -a action [-k keyname] [-x value] -H host -u user
[-p password] [-l level] [-Y cipher]
-a set Sets the Serial-Over-Lan parameters
-a info Obtains the Serial-Over-Lan parameters
-a activate Activates the Serial­Over­Lan session
-a deactivate Closes the Serial­Over­Lan session
-k Enable_SOL (value = Yes, No)
-k (value = Yes, No)
Force_SOL_Payload_Encryption
-k (value = Yes, No)
Force_SOL_Payload_Authentica
tion
-k SOL_Privilege_Level (value = User, Operator, Administrator,
OEM_Proprietary)
-k (value= time in 5ms increments)
Character_Accumulate_Interv al
-k Character_Send_Threshold (value = N: a number)
-k SOL_Retry_Count (value = N: a number)
-k SOL_Retry_Interval (value = time in 10ms increments)
-k Non_Volatile_Bit_Rate (value = Serial, 9600, 19200, 38400, 57600,
115200)
-k Volatile_Bit_Rate (value = Serial, 9600, 19200, 38400, 57600,
115200)
-x value For set action. Value must be put between
quotes
-L priv Remote session privilege level (default:
Administrator)

bsmUCMcmd
Performs UCM management
bsmUCMcmd.sh [­h] [­l level] ­a action ­H host [­u user] [­p password] [­m
interface] -M module [­Y cipher] [­o outfile]
-a charge Charges the UCM
-a discharge Discharges the UCM

Chapter 1. Alphabetic List of Hardware Management CLIs 1-13

Chapter 2. Hardware Management CLIs for Server
Actions
This chapter indicates which CLIs should be used to perform the different
actions required to set up, configure, power, monitor and maintain a server.
The commands are organized as below:
• Setting up Commands, on page 2-2
• Configuring Commands, on page 2-7
• Powering Commands, on page 2-8
• Monitoring Commands, on page 2-9
• Maintenance Commands, on page 2-11

See Refer to the bullion S Remote Hardware Management CLI Reference

Guide, 86 A1 43FL for more information.

Chapter 2. Hardware Management CLIs for Server Actions 2-1

2.1. Setting up Commands
Note Maintenance Hardware Management CLIs are marked with an asterisk
(*).

W059 WARNING
W059:
Only qualified support personnel are authorized to use Maintenance
Hardware Management CLIs.

Action Command Main Options

PARTITIONING
-k platform_id |
platform_name
|module_count | prefix_ip
Checks the platform
bsmGetPlatformLevelInfo | ip_emm_list |
configuration
is_flexible |
get_reset |
get_uc_presence
Sets global partitioning bsmSetPartitions -C composition
Sets platform IP
bsmSetPlatformLevelParam -I prefix_ip
address prefix
-k partition_composition |
master_id |
Checks the partition next_master_id |
bsmGetPartitionLevelInfo
configuration ip_emm_list |
partition_name |
get_clear_nvram
Checks the module bsmMAINTDisplayModuleConfig
configuration uration*
Checks some module -k module_id | model_type
bsmGetModuleLevelInfo
information | model_name
Manages the GUID for
each partition of the bsmGUID -a set | -a get
platform

2-2 Quick Reference Guide

 Action Command Main Options
HARDWARE COMPONENTS
Physically identifies a
bsmidentify -C duration
remote host
Excludes RDIMM, XQPI,
bsmAddHardwareExclusion -C componentList
module or ultracapa
Includes RDIMM, XQPI,
bsmRemoveHardwareExclusion -C componentList
module or ultracapa
Checks hardware
component exclusion bsmGetHardwareExclusion
list
Checks the time set for
a PSU cold redundancy bsmPSUcmd* -a getTime
test
Sets the time (hh:mm)
for a PSU cold bsmPSUcmd* -a setTime
redundancy test
Gets the power supply
bsmPSUcmd* -a get_psu_redundancy
redundancy policy
Sets the power supply
bsmPSUcmd* -a set_psu_redundancy
redundancy policy
Tests the PSU cold
-a
redundancy bsmPSUcmd*
test_psu_redundancy
immediately
Sets on one, or all,
outlets for a PDU (APC bsmPDUpower -a on
only)
Sets off one, or all,
outlets for a PDU (APC bsmPDUpower -a off
only)
Displays the status for
one, or all outlets, of a bsmPDUpower -a status
PDU (APC only)
Gets the power
consumption (in Watts) -a
bsmPDUpower
for all outlets of a PDU getPowerConsumption
(APC only)
Charges the UCM bsmUCMcmd -a charge
Discharges the UCM bsmUCMcmd -a discharge
Gets the BCS satus bsmGetConfParam -a getDisableBCS
Disables the BCS bsmSetConfParam -a setDisableBCS

Chapter 2. Hardware Management CLIs for Server Actions 2-3

 Action Command Main Options
BIOS
Returns BIOS image
bsmBios -a getBiosInfo
information
Checks the BIOS
memory size saved in bsmBios -a getMemorySize
the BMC
Returns all the BIOS
bsmBiosSettings -a list
settings
Returns a required
bsmBiosSettings -a get
BIOS settings list
Sets a required BIOS
bsmBiosSettings -a set
settings list
Sets the BIOS settings
bsmBiosSettings -a reset
to the default values
Copies the BIOS
settings file to a SD bsmBiosSettings -a copy
card
Returns the BIOS boot
bsmBootDevice
device and options
-d device
Sets the BIOS boot
bsmBootdevice -i instance
device and options
-O options
Removes gaps in
memory allocation for -a
bsmSetConfParam
the modules. For setBiosNoMemoryHole
VMware.
Checks this feature -a
bsmGetConfParam
setting. For VMware. getBiosNoMemoryHole
Sets the BIOS boot
bsmSetConfParam -a setBiosBootTimeout
timeout
Returns the BIOS boot
bsmGetConfParam -a getBiosBootTimeout
timeout
Pre-allocates DRAM -a
slices per modules. For bsmSetConfParam setBiosVMwareMaxMem
VMware. PerModule
-a
Checks this feature
bsmGetConfParam getBiosVMwareMaxMem
setting. For VMware.
PerModule

2-4 Quick Reference Guide

 Action Command Main Options
BMC
Checks MC firmware
revision, Manufacturer, bsminfo -a bmc_info
MC Device support
Backups the MC
bsmBMCcfg -a backup
configuration
Restores the MC
bsmBMCcfg -a restore
configuration
LAN channel used to access the BMC with an OutOfBand connection:
Checks information
about LAN alert bsminfo -a get_lan_alert_des
destinations
Checks information
bsminfo -a user_list
about configured users
Checks LAN channel
configuration bsminfo -a lan_print
parameters

Chapter 2. Hardware Management CLIs for Server Actions 2-5

 Action Command Main Options
SERIAL OVER LAN SESSION
-a set
-k Enable_SOL |
Force_SOL_Payload_Encry
ption |
Force_SOL_Payload_Authe
Establishes a ntication |
Serial-Over-Lan session SOL_Privilege_Level |
bsmsol
and set Serial-Over-Lan Character_Accumulate_Lev
parameters el |
Character_Send_Threshold
| SOL_Retry_Count |
SOL_Retry_Interval |
Non_Volatile_Bit_Rate |
Volatile_Bit_Rate
Checks the
Serial-Over-Lan bsmsol -a info
parameters

NTP SERVER
Sets the IP address for
bsmSetConfParam -a setPrimaryNTP
the primary NTP server
Sets the IP address for
the secondary NTP bsmSetConfParam -a setSecondaryNTP
server
Checks the IP address
for the primary NTP bsmGetConfParam -a getPrimaryNTP
server
Checks the IP address
for the secondary NTP bsmGetConfParam -a getSecondaryNTP
server

2-6 Quick Reference Guide

2.2. Configuring Commands
Action Command Main Option
POWER POLICY
Sets the power restore
bsmSetConfParam -a setPowerRestorePolicy
policy
Gets the power restore
bsmGetConfParam -a getPowerRestorePolicy
policy
Displays the state of the
functional profile
bsmGetFunctionalProfile -n functionalProfileID
identifier and its Power
Restore Policy

CPU POLICY
Checks the current
bsmOSpm -a getCurrentFreq
frequency for CPUs
Checks the limits
allowed for CPU bsmOSpm -a getHWlimits
frequency
Checks the governor
and frequency range for bsmOSpm -a getpolicy
CPUs
Sets the governor and
frequency range for bsmOSpm -a setpolicy
CPUs

TECHNICAL STATE
Gets the Technical State
bsmGetConfParam -a getTSnumber
number
Sets the Technical State
bsmSetConfParam -a setTSnumber
number

Chapter 2. Hardware Management CLIs for Server Actions 2-7

2.3. Powering Commands
Action Command Main Option
POWERING THE SERVER
Powers On bsmpower -a on
Powers Off bsmpower -a off
Forces Power Off bsmpower -a off_force
Checks the power status bsmpower -a status
Sends a diagnostic
interrupt to the bsmpower -a diag
processor
Forcibly resets power bsmreset

2-8 Quick Reference Guide

2.4. Monitoring Commands
Action Command Main Option
SYSTEM EVENT LOGS
Inserts events attached
to a sensor into the SEL bsmevent -a setEvent
repository
Tests trap events bsmevent -a testEvent
Displays the system log
bsmlog -a get_sel
contents (SEL)
Clears the system log
bsmlog -a clear_sel
contents (SEL)
Collects sensors, SELs,
messages, FRU, BMC
configuration files, BIOS
bsmsnapshot
logs and firmware
versions into an archive
file
Starts the SEL
messages logging bsmseld -a start
daemon (Linux only)
Stops the SEL messages
logging daemon (Linux bsmseld -a stop
only)

BMC MESSAGES
Writes BMC messages
bsmlog -a get_logs
and traces in a file
Clears BMC messages
bsmlog -a clear_logs
and traces

SENSOR
Displays sensor values bsmsensor
Obtains sensor
information from the bsmsdr
Sensor Data Repository
Collects sensors and
bsmsnapshot
SEL in an archive file

Chapter 2. Hardware Management CLIs for Server Actions 2-9

 Action Command Main Option
BIOS LOG FILES
Lists the BIOS log files
bsmBiosLog -a list
present on the SD card
Copies one or all BIOS
log files or the most
recent BIOS log files bsmBiosLog -a get
from SD card into a
directory
Returns the size of a
bsmBiosLog -a size
BIOS log file
Removes from SD card
one or all BIOS log files,
or the oldest BIOS log bsmBiosLog -a rm
files or the BIOS log
files dated a month

REGISTERY DUMP
Lists the registery dump
files present on the SD bsmRegDump -a list
card
Gets the specified
bsmRegDump -a get
registery dump file
Gets the size of the
specified registery dump bsmRegDump -a size
file
Removes the specified
bsmRegDump -a rm
registery dump file
Copies the configuration
bsmRegDump -a config
file to the SD card
Launches a dump of the
bsmRegDump -a dump
registries

2-10 Quick Reference Guide

2.5. Maintenance Commands
Note Maintenance Hardware Management CLIs are marked with an asterisk
(*).

W059 WARNING
W059:
Only qualified support personnel are authorized to use Maintenance
Hardware Management CLIs.

Action Command Main Option

FRU
Displays the FRU
bsmfru
contents

FIRMWARE
Manages global
firmware versions using
bsmFwGlobalUpg -a list | check | diff | upg
the Resource and
Documentation DVD
Manages component
bsmFWupg* -a ver | listhw | upg
firmware versions

RESETTING
Resets the management
bsmreset -a BMCreset
controller
Resets the server and
bsmreset -a HARDreset
reboot
Resets components
bsmreset -a UNITreset
(CMM, ESM)
Reset the MSM FPGA bsmreset -a FPGAreset
Reset the MSM BCM1 bsmreset -a BCM1reset
Reset the MSM BCM2 bsmreset -a BCM2reset
Resets the firmware for
bsmResetAllEmmPartition
all partition modules
Restore the default
bsmMAINTBMCcfg* -a restoreFactory
factory keys

Chapter 2. Hardware Management CLIs for Server Actions 2-11

Bull Cedoc
357 avenue Patton
BP 20845
49008 Angers Cedex 01
FRANCE