HPE iLO 5 Scripting and Command Line Guide
Part Number: 30-E8969F9F-004
Published: June 2024
Edition: 1
HPE iLO 5 Scripting and Command Line Guide
Abstract
This document describes how to use RIBCL XML scripts, the SMASH CLP, IPMI, Secure Shell, and PERL scripting with iLO. This document is
for the person who installs, administers, and troubleshoots servers and storage systems. Hewlett Packard Enterprise assumes you are
qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy levels.
Part Number: 30-E8969F9F-004
Published: June 2024
Edition: 1
© Copyright 2017-2024 Hewlett Packard Enterprise Development LP
Notices
The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and
services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained
herein.
Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistent with FAR
12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are
licensed to the U.S. Government under vendor's standard commercial license.
Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard Enterprise has no control over and is
not responsible for information outside the Hewlett Packard Enterprise website.
Acknowledgments
Ampere® and Altra® are registered trademarks of Ampere Computing.
Arm® is a registered trademark of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other
countries.
Java® and Oracle® are registered trademarks of Oracle and/or its affiliates.
Google™ is a trademark of Google Inc.
Google Chrome™ browser is a trademark of Google Inc.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
Red Hat® is a registered trademark of Red Hat, Inc. in the United States and other countries.
VMware® is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions.
Intel® and Intel® Xeon® are trademarks of Intel Corporation in the U.S. and other countries.
SD is a trademark or registered trademark of SD-3C in the United States, other countries or both.
All third-party marks are property of their respective owners.
Base commands
This module describes CLP escape commands.
Following are the base commands for use on the command line:
help
Displays context-sensitive help and all supported commands
command help/?
Displays the help message specific to that command
exit
Terminates the CLP session
cd
The command sets the current default target. The context works like a directory path. The root context for the server is a forward
slash (/) and is the starting point for a CLP system. Shorten commands by changing the context.
For example, to find the current iLO firmware version, enter the following command:
show /map1/firmware1
show
The command displays values of a property or contents of a collection target.
For example:
hpiLO-> show
status=0
status_tag=COMMAND COMPLETED
/
Targets
system1
map1
Properties
Verbs
cd version exit show
The first line of information returned by the show command is the current context. In the example, / is the current context.
Following the context is a list of subtargets (Targets) and properties (Properties) applicable to the current context. The verbs (Verbs)
section shows which commands are applicable to this context.
Specify the show command with an explicit or implicit context as well as a specific property. For example, an explicit context is /ma
p1/firmware1 and is not dependent on the current context, while an implicit context assumes that the context specified is a child
of the current context. If the current context is /map1 then a show firmware command displays the /map1/firmware1
data.
If you do not specify a property, then all properties are shown. In the /map1/firmware1 context, two properties are available: v
ersion , and date . If you execute show /map1/firmware1 date , only the date is shown.
create
Creates a new instance of the MAP in the namespace.
delete
Removes instances of the MAP in the namespace.
load
HPE iLO 5 Scripting and Command Line Guide
3
Moves a binary image from a URL to the MAP.
reset
Causes a target to cycle from enabled to disabled, and back to enabled.
set
Sets a property or set of properties to a specific value, and resets iLO to implement the changes.
start
Causes a target to change the state to a higher run level.
stop
Causes a target to change the state to a lower run level.
version
The command queries the version of the CLP implementation or other CLP elements.
For example:
hpiLO-> version
status=0
status_tag=COMMAND COMPLETED
SM-CLP Version 1.0
oemhpe_ping
The command determines if an IP address is reachable from the current iLO session.
For example:
hpiLO-> oemhpe_ping 192.168.1.1
Where 192.168.1.1 is the IP address you are testing.
oemhpe_clearRESTAPIstate
The command clears any data cache stored by the HPE RESTful interface.
For example:
hpiLO-> oemhpe_clearRESTAPIstate
oemhpe_ip6
The command displays the iLO IPv6 settings and allows settings to be changed.
Syntax:
oemHPE_ip6 OBJECT [COMMAND [args]] [dev n]
HPE iLO 5 Scripting and Command Line Guide
4
OBJECTS
Explanation
addr
Specifies an IPv6 address/prefix for the NIC.
route
Specifies an IPv6 route via a gateway.
gateway
Specifies an IPv6 address for a gateway.
dns
Specifies an IPv6 address for a DNS server.
options
Options can be set to yes or no:
IPV6_ACTIVE
SLAAC_ADDR_CFG
DHCPV6_ADDR_CFG
DHCPV6_OTHER_CFG
DHCPV6_RAPID_COMMIT
USE_DHCPV6_DNS
USE_DHCPV6_DOMAIN
USE_DHCPV6_NTP
IPV6_PREFERRED
IPV6_ENABLE_DDNS
dev <0|1>
Specifies the NIC. A value of 1 specifies the sideband NIC. A value of 0 (zero) specifies the
dedicated NIC. If the dev is not specified, the currently active interface will be the target of the
command.
COMMANDS
Explanation
add
Adds the OBJECT.
del
Deletes the OBJECT.
set
Sets an OPTION to the specified value.
default
Returns an OPTION to the default value.
NOTE:
The command set can only be used when OBJECT=options. The command default can be
used when OBJECT=options, or can be used alone( oemHPE_ip6 default ) to return all IPv6
settings to default. Entering an OBJECT without a COMMAND displays the OBJECT status. Entering
just oemhpe_ip6 displays the status for all IPv6 settings related to the active Ethernet device.
For example:
</>hpiLO-> oemHPE_ip6 addr {add | del} <address6/prefix>
</>hpiLO-> oemHPE_ip6 route {add | del} <dest_addr6/prefix> via
<gw_addr6>
</>hpiLO-> oemHPE_ip6 dns
{add | del} <address6>
</>hpiLO-> oemHPE_ip6 gateway {add | del} <address6>
</>hpiLO-> oemHPE_ip6 options <set opt_name>=<value>
</>hpiLO-> oemHPE_ip6 options <default {opt_name | IPV6_ALL}>
</>hpiLO-> oemHPE_ip6 default
oemhpe_nicautosel
The command allows iLO to automatically select between either the shared or dedicated network ports at startup. The feature looks
for network activity on the ports, and the first port found with network activity is selected for use. Any changes to this setting do not
take effect until the iLO is reset.
Syntax:
oemhpe_nicautosel Method [sbvlan= <0-4094>] [sbport= <1-2>]
[sbport_limit=<0 or 2>]
[delay=<90-1800>]
HPE iLO 5 Scripting and Command Line Guide
5
Argument
Effect
sbvlan
Optional. Specifies the VLAN tag to be used for the shared NIC port. A value of zero disables
the VLAN tag.
sbport
Optional. Specifies which port of the shared NIC will be shared with iLO. Verify your server and
network adapter can support any values greater than 1.
sbport_limit
Optional. Specifies when shared NIC ports will be tested by NIC Auto-selection in addition to
the dedicated NIC. Value must be 0 or 2:
0 = Test only the currently configured port
2 = Auto mode, tests both shared NIC ports 1 and 2
The default is 0.
delay
Optional. Specifies the number of seconds to test each NIC connection before moving to the
next while searching. Default is 90 seconds.
Methods
disabled
Disables NIC auto-selection.
linkact
Enables NIC auto-selection for any activity detection.
rcvdata
Enables NIC auto-selection for received data packet activity detection.
dhcp
Enables NIC auto-selection for DHCP address assignment.
For example:
hpilLO-> oemhpe_nicautosel rcvdata
This command enables the feature for received data packet activity detection.
oemHPE_nicfailover
The command configures the NIC failover feature.
Syntax:
oemHPE_nicfailover Method [delay=<30-3600>]
Methods
Effect
disabled
Disables NIC failover.
linkact
Enables NIC failover to a NIC with any activity detection.
rcvdata
Enables NIC failover to a NIC with received data packet activity detection.
dhcp
Enables NIC failover to a NIC with a DHCP address assignment.
Argument
delay
Optional. Specifies the number of seconds to test each NIC connection before moving to the
next while searching. Default is 300 seconds.
NOTE:
The command oemHPE_nicautosel must also be enabled for oemHPE_nicfailover to operate. If not
already configured, oemHPE_nicautosel will be enabled for the same Method with a default delay
value.
Subtopics
HPE iLO 5 Scripting and Command Line Guide
6
Using the NIC auto-selection feature
HPE iLO 5 Scripting and Command Line Guide
7