User guide

HP Scripting Toolkit for Windows User
Guide
Abstract
This document provides information about the Scripting Toolkit for Windows utilities and how best to use the Scripting Toolkit
for Windows to configure HP ProLiant servers and BladeSystem infrastructure in a Windows environment. This document is
intended for IT experts with experience in scripting operating system installations and configuring HP ProLiant server hardware.
HP Part Number: 415598-409
Published: October 2012
Edition: 18

Summary of content (62 pages)

ENGUSAus
Disabled
Auto Set
COM1
IRQ4
Disabled
Undefined
LPT1
IRQ7
PAGE 28

01 03 02 04 ff ff ff

EMPTY_DELETE
80 86 25 a3 00 00 fa 41 0e 11 ff ff 00
  • PAGE 29

    Command line argument Description -f{file.xml} Name of the input or output file. If not specified, the XML configuration defaults to hprcu.xml. -h This argument displays program usage. -t Outputs the help and warning text for each feature. Only valid with the -s option. HPRCU return codes Command line argument Description 0 The command was completed successfully. 1 The server is not supported by this utility. 2 The input XML file is missing or is in an invalid format.

  • PAGE 30

    For more information, see the Configuring Arrays on HP Smart Array Controllers Reference Guide on the HP website at http://www.hp.com/support/CASAC_RG_en. Users familiar with the previous versions of ACU Scripting must now install the ACU CLI application to obtain the scripting executable. The new ACU scripting executable (hpacuscripting) replaces the former executable (cpqacuxe) in all scripts.

  • PAGE 31

    Creating an ACU script file To create a valid ACU script file, use one of the following methods: • Modify the sample custom input script (page 31). • Create a Capture file for capturing a configuration (page 30). You can create a capture file from any server that has ACU loaded, and then modify the values of options in the file as necessary for the target system. This method is useful for applying a standard configuration to several servers that have similar storage resources.

  • PAGE 32

    PreferredPathMode = Auto|Manual ; COMMENT: the following five entries are used to optimize the controller performance for video MNPDelay = 0|1|2|...|60 ; units are minutes, zero indicates disabled IRPEnable = Yes|No DPOEnable = Yes|No ElevatorSortEnable = Yes|No QueueDepth = 2|4|8|16|32|Auto Array = A|B|C|D|E|F|G|...Z|a|b|c|d|e|f OnlineSpare = None | N | Port:ID,Port:ID... | Box:Bay,Box:Bay... | Port:Box:Bay,Port:Box:Bay,... ; COMMENT: These values are available only in Custom method mode.

  • PAGE 33

    The options for each category are listed in the following table and described in more detail in the remainder of this section. Category Options Description Control Action Use these options to define the overall behavior of ACU when it processes scripts and creates configurations. Control options can occur only once in a script file and must be listed first.

  • PAGE 34

    Action mode You must specify an Action mode: • In Configure mode, you can create new arrays, but you cannot modify existing arrays. The controller must be connected to unassigned physical drives for this mode to be available. • In Reconfigure mode, you can modify existing arrays. For example, you can set up an array expansion, a logical drive extension, or a migration. These procedures do not destroy data, unless you specifically want the data to be deleted.

  • PAGE 35

    ChassisName Enter the user-defined character string that identifies the controller. You can use any of the following characters in the string: a–z, A–Z, 0–9, !, @, #, *, (, ), ,, -, _, +, :, ., /, [space] You do not need to use quotation marks around the string, but doing so allows the string to begin with a space character. However, the string cannot end with a space character.

  • PAGE 36

    Read:write ratio RA4x00 with 16MB cache RA4x00 with 48MB cache All other controllers with battery-backed write cache All other controllers without battery-backed write cache 70:30 + + – – 60:40 + + – – 50:50 + + + – 40:60 – + – – 30:70 – + – – 25:75 – + + – 0:50* + – – – 0:75* – + – – 0:100 – – + – * The cache ratio percentages do not total 100 in these cases because the additional 16-MB or 48-MB cache modules are not used.

  • PAGE 37

    Array category The Array category has the following options: • “Array” (page 37) • “Drive” (page 37) • “DriveType” (page 37) • “OnlineSpare” (page 38) Array Enter a letter or pair of letters to identify the array you are creating or reconfiguring, and observe these additional limitations: • In Configure mode, ACU creates a new array.

  • PAGE 38

    OnlineSpare The value for this option determines whether the array specified previously in the script will be configured with spare drives. Method mode Possible values Default value Custom To specify exactly which drives to use as spares, In Configure action mode: None. use the applicable convention (port:ID, box:bay, In Reconfigure action mode, ACU ignores any or port:box:bay).

  • PAGE 39

    The following defaults apply: • For new logical drives, the default value is Disabled. • For existing logical drives, the default value is the current logical drive setting. ParityGroups When you create a RAID 50 or RAID 60 configuration, you must also set the number of parity groups. You can use any integer value greater than 1 for this setting, with the restriction that the total number of physical drives in the array must be exactly divisible by the number of parity groups.

  • PAGE 40

    array, as long as the operating system supports logical drive extension. You cannot reduce the size of the logical drive. CAUTION: Back up all data before extending a logical drive. SSPAdaptersWithAccess Enter values here to identify the SSP adapters that you want to have access to a logical drive. The values are processed only if either SSPState or LogicalDriveSSPState is set to Enable. Otherwise, the values are ignored.

  • PAGE 41

    The string can consist of the following: • A maximum of 16 characters • Embedded space characters but cannot end with a space character • Any of the following characters: a–z, A–Z, 0–9, !, @, #, *, (, ), -, _, +, :, ., /, and [space] HBA_WW_ID This option specifies which HBA, based on its assigned WWN, is modified by the configuration changes. HostMode This option specifies the HostMode for a selected HBA. Setting the Host Mode optimizes the storage array for the selected operating system.

  • PAGE 42

    Error code Error message Comment or clarification between operations. Limit the number of such configuration changes in the script. 42 1091 Controller does not support SSP. — 1093 Controller requires physical drives to set license keys. — 1102 Slot information is not available. You cannot run a script in Input mode on internal controllers that do not have slot information online. Systems running Microsoft Windows must have the System Management Driver loaded.

  • PAGE 43

    Error code Error message Comment or clarification 2831 Cannot change array spare. This error message appears if you try to change the number of spares in an array when the configuration does not support the addition or subtraction of spares. 2832 Invalid physical drive. A specified physical drive is not a valid physical drive, or it cannot be placed in the array. 2833 Invalid spare. A specified spare is not a valid spare drive, or it cannot be placed in the array as a spare.

  • PAGE 44

    Error code Error message Comment or clarification 2851 Invalid RAID Array ID. The scripted RAID Array ID is invalid. Use characters from the set a–z, A–Z, 0–9, !, @, #, *, (, ), ,, -, _, +, :, ., /, and [space]. The ID cannot end with a space character or exceed the maximum number of characters allowed by the controller. 2852 Invalid SSP state. — 2853 Cannot change SSP settings. — 2854 Invalid SSP adapter ID. — 2855 Controller does not support logical drive SSP states.

  • PAGE 45

    Error code Error message Comment or clarification 2882 Invalid value for MNPDelay. Valid range is 0 (disabled) to 60 minutes. — 2883 Invalid controller configuration value. Expecting Yes or No. — 2884 Invalid value for QueueDepth. Valid range — is from 2 to 32, or Auto. Using HPLPCFG You must edit the text file to insert the WWID of the boot volume and the LUN number that the WWID boots from.

  • PAGE 46

    Value Meaning 5 There was no adapter or Emulex HBA found on this host. 6 There was an error retrieving the I/O address. 7 The WWID was invalid because of one of the following: • An invalid value for WWID and BootDeviceWWID, and not a hex value • The WWID specified for HBA in the .ini file does not match any HBAs found on the host (for the /l option only) 8 The LUN was invalid.

  • PAGE 47

    LO100CFG command-line arguments Command-line argument Description -x This argument displays example XML to perform configuration. -v This argument outputs the current copyright and version information and then exits. -s This argument captures the current status and outputs it to the console. -h The argument lists basic command line arguments and supported XML tags. -i "file.xml" This argument loads and runs the given XML configuration file. -o "file.

  • PAGE 48

    PAGE 49

    HPQLAREP return codes Value Meaning 0 The command was completed successfully. 1 There was an invalid command line option. 2 There was a file open error. 3 There was an NVRAM checksum error. 4 There was an NVRAM data error. 5 There was no adapter found on this host. 6 There was an error retrieving the I/O address. 7 The WWID was invalid. 8 The LUN setting was invalid. 9 The EFI Enable Selective LUN setting was invalid. 10 The BIOS Enable setting was invalid.

  • PAGE 50

    You must then invoke the tool to load the contents of hba.ini input to the HBA NVRAM: hpqlarep /l hba.ini. Using HPONCFG HP offers support for the iLO features available on HP ProLiant servers with the HPONCFG utility. HPONCFG is an online configuration tool used to set up and reconfigure iLO without requiring a reboot of the server operating system. The utility runs in a command-line mode and must be executed from an operating system command line.

  • PAGE 51

    HPONCFG return codes Value Meaning 0 The script was sent successfully to the device. 1 The script could not be sent to the device. If the script itself fails, errors are reported in the log file created by HPONCFG. HPONCFG command file contents HPONCFG can be used to perform the following tasks: • Obtain an entire configuration • Obtain a specific configuration • Set a configuration Obtaining an entire configuration HPONCFG can be used to obtain an entire configuration from iLO.

  • PAGE 52

    PAGE 53

    Setting a configuration A specific configuration can be sent to the iLO by using the command format: HPONCFG /f add_user.xml /l log.txt In this example, the input file has the following contents: PAGE 54

    5 Troubleshooting Troubleshooting table 54 Issue Troubleshooting Data loss in STK Improper use of the Scripting Toolkit utilities and modification of the CONREP data files can result in loss of critical data. Because of the potential data-loss risk, only experienced individuals should use the Scripting Toolkit utilities. Before using the Scripting Toolkit, all necessary precautions must be taken to ensure that mission-critical systems remain online if a failure occurs.

  • PAGE 55

    6 Support and other resources Information to collect before contacting HP Be sure to have the following information available before you contact HP: • Software product name • Hardware product model number • Operating system type and version • Applicable error message • Third-party hardware or software • Technical support registration number (if applicable) How to contact HP Use the following methods to contact HP technical support: • See the Contact HP worldwide website: http://www.hp.

  • PAGE 56

    Typographic conventions Table 1 Document conventions Convention Element Blue text: Table 1 (page 56) Cross-reference links and e-mail addresses Blue, underlined text: http://www.hp.

  • PAGE 57

    environment through HP Insight Online, and is also the recommended version for HP Proactive Care Service. • HP Insight Remote Support Advanced supports medium-sized to large environments with up to 3,500 devices. It can be installed on a Windows ProLiant hosting device or a Windows ESXi Virtual Machine and requires HP Systems Insight Manager. Optionally, customers using HP Operations Manager or SAP Solution Manager to manage their environment can easily integrate these platforms to create a single view.

  • PAGE 58

    7 Documentation feedback HP is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hp.com). Include the document title and part number, version number, or the URL when submitting your feedback.

  • PAGE 59

    Acronyms and abbreviations ACU Array Configuration Utility ADG Advanced Data Guarding (also known as RAID 6) API application program interface BIOS Basic Input/Output System CONREP Configuration Replication utility CPQACUXE Array Configuration Utility XE CPQLOCFG Lights-Out Configuration Utility DHCP Dynamic Host Configuration Protocol DOS disk operating system GUI graphical user interface HBA host bus adapter HPDISCOVERY HP Discovery Utility HPONCFG HP Lights-Out Online Configurati

  • PAGE 60

    WOL Wake-on LAN WWID World Wide ID WWN World Wide Name WWPN worldwide port name XML extensible markup language 60 Acronyms and abbreviations

  • PAGE 61

    Index A acronyms and abbreviations, 59 ACU script file, 31 array configurations erasing, 15 C clearing a configuration, 35 configuration capturing, 30 target server, 11 configurations capturing, 10 CONREP, 24 arguments, 25 command file contents, 27 command-line syntax, 24 data file sample HP ProLiant 100 series, 26 Load from Data file example, 26 return codes, 25 screen output, 25 Store to Data file example, 26 conventions document, 56 text symbols, 56 D deployment overview, 7 deployment procedure, 7 dete

  • PAGE 62

    command-line syntax, 46 return codes, 47 logical drive capacity extension, 39 video performance optimization, 36 W M MaxBoot setting, 39 N network share creating, 8 O online help, 16 Online ROM Flash Component Utility, 13 operating system installation, 11 operators and terms, 22 R RBSURESET, 19 arguments, 19 command-line syntax, 19 return codes, 20 REBOOT, 17 arguments, 17 command-line examples, 17 command-line syntax, 17 return codes, 17 ROM updating, 13 S Scripting Toolkit utilities, 16 SETBOOTORDE