Configure an enclosure with an OA configuration script

About OA configuration scripts

Use configuration scripts to simplify new enclosure deployment and configuration, particularly when setting up multiple enclosures, eliminating the need to configure each enclosure manually. You can GET an enclosure configuration script from a logical enclosure or enclosure group. You can UPDATE and DELETE an enclosure configuration script on individual logical enclosures.

To create a configuration script, do one of the following:

Extract a script from a configured OA.
Copy an existing configuration script from a logical enclosure or enclosure group.

By entering a configuration script on the Enclosure Groups screen, a copy of the configuration script is stored with every logical enclosure you add that is associated with that enclosure group.

The configuration script is run on the physical enclosure when:

You add an enclosure and the associated enclosure group contains a configuration script.
You GET the configuration script of a logical enclosure, make changes and then update (PUT) the script.
You refresh an enclosure which re-runs the enclosure configuration script associated with the enclosure (not the enclosure group).

You can initially enter passwords, SNMP community strings, and pass phrases in plain text as you create an enclosure or enclosure group script. However, all passwords, SNMP community strings, and pass phrases are masked (replaced by *********) in any UI or REST API response and are never displayed in plain text.

If you replace the ********* password string with another string and rerun the script, the password is changed to the new string. Note that some commands cannot be run a second time. For example, if you rerun the ADD USER username ********* command on the same enclosure and have changed the ********* string, the command will fail because that user already exists. In this situation, remove the newly added user before you rerun the script.

If any part of the command that is returned with ********* is changed, and you do not replace ********* with another string, the value of the password or the SNMP community string becomes *********. For example, if you submit the script with the command SET USER PASSWORD user_name1 new_password, the script returns SET USER PASSWORD user_name1 *********. If you change the command to SET USER PASSWORD user_name2 *********, the password for user_name2 is set to *********, and not new_password.

A subset of OA commands is disallowed in the enclosure configuration script to prevent conflicts with the appliance configuration and settings. There is no syntax checking or other validation of the remaining script. See Disallowed OA commands for a list of the OA commands not allowed in a configuration script.

View or download OA command documentation for a complete reference of OA commands.

Extract a script from a configured OA

Prerequisites

Minimum required session ID privileges: Administrator

Extracting a script from a configured OA using REST APIs
When you perform a `GET` operation on an enclosure, the script URI is returned inside of the response body. Select an enclosure. `GET /rest/logical-enclosures` Get the enclosure using the URI from step 1. `GET /rest/logical-enclosures/{id}` Get the script using the configuration script URI returned in step 2. `GET /rest/logical-enclosures/{id}/script`

For security, the retrieved current configuration does not contain any user passwords. You can manually edit the script to add the user passwords after the user name on the ADD USER lines.

Copy an OA configuration script

Get a copy of an existing configuration script from a logical enclosure or enclosure group.

Prerequisites

Minimum required session ID privileges: Server administrator

Copying an OA configuration script using REST APIs

Copying an OA configuration script using REST APIs
When you perform a `GET` operation on a logical enclosure or enclosure group, the script URI is returned inside of the response body. You can copy this script, make updates, and then reapply (`PUT`) the script to another enclosure. Select an enclosure or enclosure group. `GET /rest/enclosures` `GET /rest/enclosure-groups` Get the enclosure or enclosure group using the URI from step 1. `GET /rest/enclosures/{id}` `GET /rest/enclosure-groups/{id}` Get the script using the configuration script URI returned in step 2. `GET /rest/logical-enclosures/{id}/script`

When you perform a GET operation on a logical enclosure or enclosure group, the script URI is returned inside of the response body. You can copy this script, make updates, and then reapply (PUT) the script to another enclosure.

Select an enclosure or enclosure group.

GET /rest/enclosures

GET /rest/enclosure-groups
Get the enclosure or enclosure group using the URI from step 1.

GET /rest/enclosures/{id}

GET /rest/enclosure-groups/{id}
Get the script using the configuration script URI returned in step 2.

GET /rest/logical-enclosures/{id}/script

View or download OA command documentation

For a complete reference of OA commands, view or download the HPE BladeSystem Onboard Administrator Command Line Interface User Guide from the HPE Support Center.

Viewing or downloading OA command documentation

Go to http://www.hpe.com/support/hpesc
Select Manuals from the left navigation pane.
Enter HPE Onboard Administrator in the Search box.
Select the returned result, HPE Onboard Administrator.
Select User guide.
Find the HPE BladesSystem Onboard Administrator Command Line Interface User Guide title and view or download to your local computer.

Disallowed OA commands

The following commands are not allowed in an enclosure configuration script because they conflict with the appliance configuration and could prevent the appliance from operating properly and securely.

Disallowed OA commands
ADD EBIPA	REMOVE CA CERTIFICATE	SET ENCLOSURE NAME
ADD EBIPAV6	REMOVE EBIPA	SET ENCLOSURE SERIAL_NUMBER
CLEAR NTP	REMOVE EBIPAV6	SET ENCRYPTION
CLEAR VCMODE	REMOVE HPSIM CERTIFICATE	SET FACTORY
DISABLE DHCP_DOMAIN_NAME	REMOVE OA ADDRESS IPV6	SET FIPS MODE
DISABLE EBIPA	REMOVE SNMP TRAPRECEIVER	SET HPSIM TRUST MODE
DISABLE EBIPAV6	REMOVE SNMP TRAPRECEIVER V3	SET IPCONFIG
DISABLE FIRMWARE MANAGEMENT	REMOVE SNMP USER	SET NTP
DISABLE HTTPS	REMOVE TRUSTED HOST	SET NTP PRIMARY
DISABLE IPV6	REMOVE USER CERTIFICATE	SET OA DOMAIN_NAME
DISABLE IPV6DYNDNS	REMOVE USER vcmuser	SET OA NAME
DISABLE NTP	REMOVE USERS ALL	SET PASSWORD
DISABLE SLAAC	SAVE EBIPA	SET SNMP COMMUNITY READ
DISABLE SNMP	SAVE EBIPAV6	SET SSO TRUST MODE
DISABLE TRUSTED HOST	SET DATE	SET TIMEZONE
DISABLE USER vcmuser	SET EBIPA	SET USER ACCESS vcmuser
ENABLE DHCP_DOMAIN_NAME	SET EBIPAV6	SHOW ALL
ENABLE EBIPA	SET EBIPA INTERCONNECT	SHOW SYSLOG { OA \| HISTORY }
ENABLE EBIPAV6	SET EBIPA SERVER	UNASSIGN { SERVER \| INTERCONNECT } { <bay number> \| ALL \| <bay number range> } vcmuser
ENABLE FIRMWARE MANAGEMENT	SET ENCLOSURE ASSET TAG	UNASSIGN OA vcmuser

Sample OA configuration script

Sample OA-Script.cfg script

#Sample script for HPE OneView
#

#NOTE: Set Enclosure Information
SET RACK NAME "Insert_Rack_Name"

#Optionally Configure Power 
SET POWER MODE REDUNDANT
SET POWER SAVINGS ON
SET ENCLOSURE POWER_CAP OFF
SET ENCLOSURE POWER_CAP_BAYS_TO_EXCLUDE None

#Set Interconnect PowerDelay Information
SET INTERCONNECT POWERDELAY 1-8 0
#Set Server Power Delay Information
SET SERVER POWERDELAY 1-16 0

#Optionally Configure Alertmail
SET ALERTMAIL SMTPSERVER 
DISABLE ALERTMAIL

#Optionally Configure NTP
SET NTP SECONDARY
SET NTP POLL 720

#Optionally Set Remote Syslog Information
SET REMOTE SYSLOG SERVER ""
SET REMOTE SYSLOG PORT 514
DISABLE SYSLOG REMOTE

#Optionally ADD a new user account and set as Admin on ALL bays
ADD USER "admin" "password"
SET USER CONTACT "admin" ""
SET USER FULLNAME "admin" ""
SET USER ACCESS "admin" ADMINISTRATOR
ASSIGN SERVER 1-16 "admin"
ASSIGN INTERCONNECT 1-8 "admin"
ASSIGN OA "admin"
ENABLE USER "admin"

#Optionally reset the default Administrator password
Set USER Administrator "enter new password here" 

#Set Login Banner Text Information
CLEAR LOGIN_BANNER_TEXT
DISABLE LOGIN_BANNER

#Set Network Information
#NOTE: Setting your network information through a script while
#      remotely accessing the server could drop your connection.
#      If your connection is dropped this script may not execute to conclusion.
#NOTE: Set the IP address and DNS name for both OA1 and OA2
SET NIC AUTO 1
SET NIC AUTO 2
ENABLE ENCLOSURE_IP_MODE
SET LLF INTERVAL 60
ENABLE LLF
DISABLE DHCPV6

prev	up	next
Update enclosures in the logical enclosure from the enclosure group	home	Download a logical enclosure support dump