IPRCONFIG(8)
hey bestie π welcome to the iprconfig page from the System Manager's Manual, section 8. This is your girl for all things IBM Power RAID storage adapters β config, info, recovery, the whole vibe. Let's get into it β¨
NAME πΈ
iprconfig β IBM Power RAID storage adapter configuration/recovery utility. no cap, that's literally her job description π
SYNOPSIS π¦
iprconfig [-e editor] [-k dir] [-c command]
iprconfig --version --debug --force
DESCRIPTION π
iprconfig is used to configure IBM Power RAID storage adapters, display information about them, and to perform adapter and disk unit recovery. The menu options are:
- Display hardware status. This option can be used to display various information regarding the IBM Power RAID adapters attached to the system and the disk units controlled by them. For each adapter and disk unit, their
/devname, physical location, description, vendor/product ID, and hardware status will be available. Beside each resource is an OPT field. By entering a1beside any resource, detailed information about that resource can be obtained. For an adapter resource, this will display the adapter firmware version and the physical location amongst other things. - Work with Disk Arrays This option will present a second menu containing disk array related commands.
- Display disk array status is used to display the status of disk arrays on the system.
- Create a disk array is used to create a disk array.
- Delete a disk array is used to delete disk arrays. Selecting this option will provide you with a list of disk arrays which can be deleted.
- Add a device to a disk array is used to include devices of similar capacity into an existing disk array. This function is currently only supported for RAID 5 and RAID 6 disk arrays.
- Format device for advanced function is used to format disks to 522 bytes/sector so that they may be used in a disk array. Only disks which are not formatted for advanced function or are formatted for advanced function but are not known to be zeroed will be available for selection for this function.
- Format device for JBOD function (512) is used to format disks to 512 bytes/sector so that they may be used as standalone disks. Only disks which are not formatted for JBOD function or are formatted for JBOD function and are in the Format Required state will be available for this function.
- Work with hot spares is used to create a hot spare which designates a device as a dedicated hot spare. It is also used to delete a hot spare which unconfigures a previously configured hot spare.
- Work with asymmetric access is used to select which path of a disk array will be the primary path in a dual controller environment. Asymmetric Access must be enabled on the adapter first. Not all adapters support asymmetric access and adapters that do provide support may require updated microcode.
- Force RAID Consistency Check is used to force a consistency check on a RAID array. All ipr adapters continually perform background consistency checking when idle. This option can be used to force a consistency check to be performed.
- Migrate disk array protection is used to change the RAID protection level for an array to another supported level. In some cases, this will require adding more disks to the array. In other cases, disks will be freed.
- Work with disk unit recovery is used to perform the following disk unit recovery actions:
- Concurrent add device is used to concurrently add a new disk to a running system. This feature is only supported with SES (SCSI Enclosure Services) packaging.
- Concurrent remove device is used to concurrently remove a disk from a running system. This feature is only supported with SES (SCSI Enclosure Services) packaging.
- Initialize and format disk unit is used to issue a SCSI format command to attached devices. A format unit command has special meaning to the adapter and is used as a service action for certain error conditions. Formatting a disk unit will lose all data on that drive. If the disk is attached to an ipr adapter that does not support RAID, the drive will be formatted to 512 bytes/sector. If the disk is attached to an ipr RAID adapter, the block size will not be changed. To change the block size, use the format menu options under the disk arrays menu.
- Reclaim IOA cache storage is used to repair cache error conditions. ATTENTION: Use this option with care. This is used to discard data from the cache and may result in data loss. This option is designed to be used by authorized IBM hardware customer engineers.
- Rebuild disk unit data is generally used following concurrent maintenance. Select this option after a failing array member device has been replaced to reconstruct the device as an active array member.
- Work with resources containing cache battery packs is used to display information regarding rechargeable cache battery packs and to force rechargeable cache battery packs into an error state so that they can be replaced prior to failure. ATTENTION: Once an error has been forced on a rechargeable cache battery pack write caching will be disabled until the battery pack is replaced.
- Work with SCSI bus configuration is used to change configurable SCSI bus attributes, such as maximum SCSI bus speed, SCSI initiator ID, etc.
- Work with driver configuration is used to change driver configurable attributes, such as
log_level. - Work with disk configuration is used to change configurable disk attributes, such as queue depth.
- Work with adapter configuration is used to change configurable adapter attributes, such as dual adapter settings. Refer to the following command line options:
primary,secondary,query-ha-mode,set-ha-mode,set-ioa-asymmetric-accessandset-array-asymmetric-accessfor more information regarding these settings. - Download microcode is used to download microcode to ipr adapters and attached SCSI disks.
- Analyze Log is an option available to analyze
/var/log/messages*files. By default it will usevias the editor to open the concatenated error log files. This can be changed by using option6on the Kernel Messages Log menu. Selecting option1on the Kernel Messages Log menu will display only the most recent errors logged by the ipr device driver and may be useful to filter out some of the clutter. Option2will display all recorded errors logged by the ipr device driver. Option3will display all kernel messages. Option4will display errors logged by theiprconfigutility. This may be useful for debugging problems. Option5can be used to change where the tool looks to find the kernel messages files. The default is to look in/var/log.
OPTIONS β¨
-eeditor β Default editor for viewing error logs. The default editor isvi, but can be changed with this parameter.-kdirectory β Kernel messages root directory. Root directory to look for kernel messages. Default is/var/log.-ccommand β Command line, non-interactive commands. Currently supported commands include:show-configβ Show ipr configuration.show-alt-configβ Show alternate ipr configuration information.show-ioasβ Show all ipr adapters.show-arraysβ Show all ipr arrays.show-battery-info [IOA]β Show cache battery information for specified IOA. Example:iprconfig -c show-battery-info sg5show-details [device]β Show device details for specified device. Example:iprconfig -c show-details sdashow-hot-sparesβ Show all configured hot spares.show-af-disksβ Show disks formatted for Advanced Function that are not configured in an array or as a hot spare.show-all-af-disksβ Show all disks formatted for Advanced Functionshow-jbod-disksβ Show all disks formatted for JBOD Function.show-slotsβ Show all disks slots available on the system.status [device]β Show the status of the specified device. This is the same status as which shows up in the last column of the Display hardware status menu. Can specify either a/dev/sdXname or a/dev/sgXname. Example:iprconfig -c status /dev/sdaalt-status [device]β Show the status of the specified device. This is the same status as above with the exception of when a long running command is executing to the device, in which case the percent complete for the long running command is printed.query-raid-create [IOA]β Show all devices attached to the specified IOA that are candidates for being used in a RAID array. Example:iprconfig -c query-raid-create sg5query-raid-delete [IOA]β Show all RAID arrays attached to the specified IOA that can be deleted.iprconfig -c query-raid-delete sg5query-hot-spare-create [IOA]β Show all devices attached to the specified IOA that are candidates for being hot spares.query-hot-spare-delete [IOA]β Show all hot spares attached to the specified IOA that can be deleted.query-raid-consistency-checkβ Show all RAID arrays that are candidates for a RAID consistency check.query-format-for-jbodβ Show all disks that can be reformatted for JBOD function.query-reclaimβ Show all IOAs that may need a reclaim cache storage.query-arrays-raid-includeβ Show all RAID arrays that can have disks included in them to increase their capacity.query-devices-raid-include [array]β Show all disks that can be added to the specified array to increase its capacity.query-supported-raid-levels [IOA]β Show all RAID levels supported by the specified adapter.query-include-allowed [IOA] [raid level]β Some RAID levels allow for adding additional disks to existing disk arrays to increase their capacity. Prints "yes" to stdout if the specified RAID level supports this function, else prints "no".query-max-devices-in-array [IOA] [raid level]β Print the maximum number of devices allowed in a RAID array of the specified RAID level for the specified RAID adapter.query-min-devices-in-array [IOA] [raid level]β Print the minimum number of devices allowed in a RAID array of the specified RAID level for the specified RAID adapter.
query-min-mult-in-array [IOA] [raid level]β okay so bestie, this one prints the minimum multiple of devices required in a RAID array of the specified RAID level for the specified RAID adapter. no cap. β¨query-supp-stripe-sizes [IOA] [raid level]β this prints all supported stripe sizes supported for RAID arrays of the specified RAID level on the specified RAID adapter. Stripe sizes are printed in units of KB. lowkey useful. πquery-recommended-stripe-size [IOA] [raid level]β prints the default/recommended stripe size for RAID arrays of the specified RAID level on the specified RAID adapter. Stripe size is in units of KB. it's giving helpful. πquery-recovery-formatβ shows all disks that can be formatted for error recovery purposes. π¦query-raid-rebuildβ shows all disks in RAID arrays that can be rebuilt. πquery-format-for-raidβ shows all disks that can be formatted such that they can be used in a RAID array or as a hot spare. πquery-ucode-level [device]β shows the microcode level currently loaded on the specified device. Note: the device specified may be the sg device associated with an IOA, in which case the IOA's microcode level will be shown. iykyk. πssd-report [device]β displays info about Read Intensive SSD devices in the system. πshow-ucode-levelsβ shows the microcode level currently loaded for every device and adapter in the system. If newer microcode is available on the filesystem than what is loaded on the device, an*character will be displayed next to the device. periodt. βquery-format-timeout [device]β shows the current format timeout to be used when formatting the specified disk. This value is only applicable when the device is currently in Advanced Function format. πquery-qdepth [device]β shows the queue depth currently being used for the specified disk. πquery-tcq-enable [device]β prints1to stdout if tagged queuing is enabled for the specified device, else prints0to stdout. πquery-log-level [IOA]β prints the current log level being used for the specified IOA. Can be a number from0ton. π₯
query-add-deviceβ shows all empty disk slots that can have a disk concurrently added. β¨query-remove-deviceβ shows all disk slots which are either empty or have disks in them which can be concurrently removed from the running system. π«Άquery-initiator-id [IOA] [busno]β shows the current SCSI initiator ID used by the IOA for the specified SCSI bus. πquery-bus-speed [IOA] [busno]β shows the current maximum SCSI bus speed allowed on the specified SCSI bus. βquery-bus-width [IOA] [busno]β shows the current SCSI bus width in units of bits for the specified SCSI bus. πquery-path-status [IOA]β shows the current dual path state for the SAS devices attached to the specified IOA. π¦query-path-details [device]β shows the current dual path details for the specified SAS device. πΈquery-arrays-raid-migrateβ shows the arrays that can be migrated to a different protection level. πquery-devices-raid-migrate [array]β shows the AF disks that are candidates to be used in a migration for a given array. πquery-raid-levels-raid-migrate [array]β shows the protection levels to which the given array can be migrated. π₯query-stripe-sizes-raid-migrate [array] [raid level]β given an array and a protection level, shows the valid stripe sizes to which the array can be migrated. β¨query-devices-min-max-raid-migrate [array] [raid level]β shows the number of devices that will be removed for a migration to a protection level that requires fewer devices. Or, shows the minimum number of devices required, the maximum number of devices allowed, and the multiple of the number of devices required for a migration that requires more devices. π
query-ioas-asymmetric-accessβ shows the IOAs that support asymmetric access. πquery-arrays-asymmetric-accessβ shows the disk arrays that are candidates for setting their asymmetric access mode to Optimized or Non-Optimized. πquery-ioa-asymmetric-access-mode [IOA]β shows the current asymmetric access mode for the given IOA. πquery-array-asymmetric-access-mode [array]β shows the current asymmetric access mode for the given disk array. π¦query-ioa-caching [IOA]β shows whether or not the user requested caching mode for the given IOA is set to default or disabled. πquery-array-label [label]β shows the device name of the array with the specified label. Label must have been specified when creating the RAID array. Seeraid-createcommand. πquery-array-rebuild-rate [IOA]β shows the array rebuild rate for the given IOA. π₯query-array-rebuild-verify [IOA]β shows whether array rebuild verification is enabled for the given IOA. βquery-array [location]β shows the device name of the array of which one of the disks in the array has the specified platform location code. πquery-device [location]β shows the device name of the disk that has the specified platform location code. πquery-location [device]β the device specified can be either the device name of a disk or the device name of a single disk RAID 0 array. If the specified device name is a disk, the platform location code will be displayed. If the specified device name is a single device RAID 0 array, the platform location of the disk which is a member of the specified array will be displayed. π§query-write-cache-policy [device]β shows the current write cache policy for[device]. π
raid-createβ creates a RAID array. Here's the full syntax bestie:
raid-create [-r raid_level] [-s stripe_size_in_kb] [-l label]
[--skip-format] [-c cache_policy] [devices...]
RAID level can be any supported RAID level for the given adapter, such as 0, 10, 5, 6. Currently supported stripe sizes in kb include 16, 64, and 256. If raid_level is not specified, it will default to RAID 5. If stripe size is not specified, it will default to the recommended stripe size for the selected RAID level. Available cache policies are the same that can be passed to set-write-cache-policy command. If none is specified, write back is assumed. Devices are specified with their full name, either the /dev/sd name or the /dev/sg name is acceptable. On some RAID adapters, a label can also be specified. Example array creation:
iprconfig -c raid-create -r 5 -s 64 /dev/sda /dev/sdb /dev/sdc
This would create a RAID 5 array with a 64k stripe size using the specified devices. π
raid-delete [RAID device]β deletes the specified RAID array. Specify either the/dev/sdname or the/dev/sgname. Only 1 array can be deleted with a single command. Example:
iprconfig -c raid-delete /dev/sda
This would delete the disk array represented by /dev/sda. π
raid-include [array] [disk] ... [disk]β adds the specified devices to the specified disk array to increase its capacity. Example:
iprconfig -c raid-include sda sg6 sg7
π«Ά
raid-migrateβ migrates an existing RAID array to a new RAID protection level. Optionally, a new stripe size can be given. In some cases one or more new disks must be added for the migration to succeed. Here's the syntax:
raid-migrate -r raid_level [-s stripe_size_in_kb] array [disk] ... [disk]
Example:
iprconfig -c raid-migrate -r 10 -s 64 sda sg5 sg6
π₯
format-for-raid [disk] ... [disk]β formats the specified disks for Advanced Function so they can be used in a RAID array or as a hot spare. β¨format-for-jbod [disk] ... [disk]β formats the specified disks for JBOD Function so they can be used as standalone disks. π¦recovery-format [disk] ... [disk]β formats the specified disks as directed by the reference guide for error recovery purposes. πhot-spare-create [disk]β creates a hot spare using the specified Advanced Function disk. πhot-spare-delete [disk]β deletes the specified hot spare. πdisrupt-device [disk]β forces the specified Advanced Function device failed. πreclaim-cache [IOA]β reclaims the specified IOA's write cache.
ATTENTION: Use this option with care. This is used to discard data from the cache and may result in data loss. This option is designed to be used by authorized IBM hardware customer engineers.
π
reclaim-unknown-cache [IOA]β reclaims the specified IOA's write cache and allows unknown data loss.
ATTENTION: Use this option with care. This is used to discard data from the cache and WILL result in data loss. This option is designed to be used by authorized IBM hardware customer engineers.
π
raid-consistency-check [array]β forces a full RAID consistency check on the specified array. This command will return before the RAID consistency check has completed. Use thestatuscommand to check the status of the command. βraid-rebuild [disk]β so you swapped out a dead disk in your RAID array, bestie? π This is the glow-up command: it rebuilds that failed disk's data onto the shiny new one and puts the array back into the Active state. Iconic recovery arc, no cap.update-ucode [device] [microcode file]β updates the microcode on the device you name (an IOA or a disk) using the microcode file you name. ATTENTION π¨: the checking of that microcode image is limited, so pls pls pls make absolutely sure the file you're passing is the correct file for that exact device. Don't be out here guessing.update-all-ucodesβ updates the microcode of every device with the latest version found in the system. One command, all the devices, full makeover energy β¨set-format-timeout [disk] [timeout in hours]β sets the format timeout that gets used when formatting the specified disk. In hours, bestie, so you know it's not playing around.set-qdepth [device] [queue depth]β sets the queue depth for the device or disk array you point at. π«Άset-tcq-enable [device] [0 = disable, 1 = enable]β turns tagged command queueing on or off for the specified device.0= disable,1= enable, that's the whole vibe.set-log-level [IOA] [log level]β sets how chatty the error logging is for that IOA. Default is2. π₯set-write-cache-policy [device] [writeback|writethrough]β sets the write cache policy for[device]. The available policies arewritebackandwritethrough. This one supports JBOD disk (write cache) and Volume Sets (vset write cache). Example:
iprconfig -c set-write-cache-policy sdp writeback
identify-disk [disk] [0 = turn off identify LED, 1 = turn on identify LED]β turns the disk identify LED on or off for the specified disk. Heads up though: this function may or may not be available depending on the hardware packaging. πidentify-slot [location] [0 = turn off identify LED, 1 = turn on identify LED]β turns the disk identify LED on or off for the specified location. Same disclaimer: this function may or may not be available depending on the hardware packaging. Example:
iprconfig -c identify-slot 0000:d8:01.0/0:1:1: 1
remove-disk [disk] [0 = turn off identify LED, 1 = turn on identify LED]β turns the disk remove identify LED on or off for the specified device. When you pass1as the second argument, the specified disk gets set to the remove state. While it's in that state, the disk may be removed. Once the disk has been physically removed, you have to invokeiprconfigagain with the second argument set to0. That turns off the slot identifier light and logically removes the disk from the host operating system. Two-step process, don't skip step two πremove-slot [location] [0 = turn off identify LED, 1 = turn on identify LED]β turns the disk remove identify LED on or off for the specified location. Pass1as the second argument and the specified location goes into the remove state, where the disk may be removed. Once it's been physically removed, invokeiprconfigagain with the second argument set to0β that kills the slot identifier light and logically removes the disk from the host operating system. Example:
iprconfig -c remove-slot 0000:d8:01.0/0:1:1: 1
add-slot [location] [0 = turn off identify LED, 1 = turn on identify LED]β turns the disk insert identify LED on or off for the specified location. Pass1as the second argument and the location goes into the insert state, where a disk may be inserted. Once it's been physically inserted, invokeiprconfigagain with the second argument set to0β that turns off the slot identifier light and logically adds the disk to the host operating system. Example:
iprconfig -c add-slot 0000:d8:01.0/0:1:1: 1
set-initiator-id [IOA] [busno] [initiator id]β sets the IOA's SCSI initiator ID for the specified bus. It must be a value between0and7, and it must not conflict with any other device on the SCSI bus. Rules are rules πset-bus-speed [IOA] [busno] [speed in MB/sec]β sets the maximum SCSI bus speed allowed on the specified SCSI bus. Zoom zoom π¦set-bus-width [IOA] [busno] [bus width in # bits]β sets the SCSI bus width to use for the specified SCSI bus. Example:
iprconfig -c set-bus-width sg5 0 16
primary [IOA]β sets the adapter as the preferred primary adapter. This is what you use in dual initiator RAID configurations to say which adapter should be the primary one. The primary adapter should be the adapter receiving the majority of the I/O β main character adapter energy π Example:
iprconfig -c primary sg5
secondary [IOA]β sets the adapter to indicate it is not the preferred primary adapter. Check the notes for the preferred primary for the extra info. Example:
iprconfig -c secondary sg5
set-all-primaryβ sets all attached ipr adapters as the preferred primary adapter. This can be used when you're running a dual initiator RAID HA configuration. You can run this command on the primary system to quickly enable preferred primary mode for all attached adapters. Go look at/etc/ha.d/resource.d/iprhafor an example of how this might be used. Example:
iprconfig -c set-all-primary
set-all-secondaryβ sets all attached ipr adapters to indicate they are not the preferred primary adapter. Example:
iprconfig -c set-all-secondary
query-ha-mode [IOA]β when an adapter is configured in a highly available dual adapter configuration, it may be able to be configured one of two ways. The default mode is Normal. That mode is used for all SCSI adapters and many SAS adapters. Some SAS adapters also support a JBOD dual adapter configuration β that mode is for when the dual adapter configuration is going to consist of JBOD disks rather than RAID arrays. And if the adapter is NOT going to be used in a dual adapter configuration, this mode MUST be set to Normal. Like, must must. π Example:
iprconfig -c query-ha-mode sg5
set-ha-mode [IOA] [Normal | RAID]β used to set the high-availability mode of the adapter. Peep thequery-ha-modecommand for more info about these settings. Example:
iprconfig -c set-ha-mode sg5 Normal
set-array-asymmetric-access-mode [array] [Optimized | Non-Optimized]β used to set the asymmetric access mode of the disk array. Example:
iprconfig -c set-array-asymmetric-access-mode sda Optimized
set-ioa-asymmetric-access-mode [IOA] [Enabled | Disabled]β used to set the asymmetric access mode of the IOA. Example:
iprconfig -c set-ioa-asymmetric-access-mode sg5 Enabled
set-ioa-caching [IOA] [Default | Disabled]β used to set the requested caching mode of the IOA. Example:
iprconfig -c set-ioa-caching sg5 Disabled
set-array-rebuild-verify [IOA] [enable | disable | default]β used to define whether verification happens during an array rebuild. Heads up: enabling this can affect performance. The default value isdisabled. Example:
iprconfig -c set-array-rebuild-rate sg5 disable
set-array-rebuild-rate [IOA] [Rebuild Rate | default]β used to set the rebuild rate ratio of the IOA.[Rebuild Rate]must be in the range10..100. Ifdefaultis used, the IOA resets to the implementation default rate. And ngl, the value that actually gets configured may not be the exact rate you configured β it may be an approximation to the closest rate supported by the IOA. Close enough is close enough π Example:
iprconfig -c set-array-rebuild-rate sg5 10
get-live-dump [IOA]β dumps the IOA's implementation-unique critical information. The dump data gets saved in the/var/log/directory with the patternipr-CCIN-PCI_ADDRESS-dump-TIMESTAMP. Example:
iprconfig -c get-live-dump sg5
dumpβ displays detailed hardware and system information on standard output. If you need an actual report file, theiprsoscommand will create one at/var/log/iprsos.log. Example:
iprconfig -c dump
--versionβ print the version number ofiprconfig. β--debugβ enable additional error logging. Turning this on means additional errors get logged to/var/log/messages. π--forceβ disable safety checks. Use this to disable safety checks iniprconfig. It'll let you format devices that are not at the appropriate code levels. Only use this option if you really know what you are doing. Like, genuinely, bestie. This is the "I know a guy" of flags π
πΈ AUTHOR πΈ
Brian King <brking@us.ibm.com> β the actual legend who wrote this π«Ά
π NOTES β¨
π¦ Notes on using under iSeries 5250 telnet π¦
Okay bestie, real talk: only use this utility across 5250 telnet when there are literally no other options available to you. But likeβ¦ sometimes 5250 telnet is your only way in to your iSeries Linux console, so every attempt has been made to make this utility usable under 5250 telnet. Follow a few lil guidelines and your 5250 telnet experience goes from crying in the terminal π to actually productive and wayyy less frustrating. π
- First of all, it's giving "know your keys" β it will be helpful to know how the keys are mapped under 5250 telnet. From the 5250 telnet window, hit
ESC. This gets you to the Send TELNET Control Functions menu. Take option6to display the keyboard map. Take note of howTAB,ESC,CTLC, andSENDWOCRare bound. They will be useful in the future. no cap. π₯ - When selecting menu options, enter the menu number, followed by the enter key, same as usual. iconic behaviour, nothing new here. π
- When typing single character commands (eg.
r=Refresh), type the single character followed by theSENDWOCRkey (F11by default). yes queen, that's the whole move. β¨ - When on a device/array/IOA selection screen (eg.
Display Disk Unit Details), do NOT use the arrow keys to navigate. Instead use theTABkey (F7by default) to navigate these screens. the arrow keys will betray you, I'm so serious. π - Beware of the backspace and delete keys. As a rule do NOT use them. likeβ¦ just don't. π
- When editing the root kernel message log directory or the default editor, you may use the arrow keys, but not the backspace and delete keys. Use the space bar to remove already typed characters. that's the trick, bestie β space bar is your bestie fr fr. πΈ
and that's the whole page, my love π«Ά this was IPRCONFIG(8), dated August 2009 β yes she's an elder but she still slays, and you're now fully certified to talk to her in 5250 telnet. go forth and be the main character of your console. ππβ
π¦ where this page comes from
- centos-stream 9: iprutils 2.4.19-5.el9 Β· CPL
- opensuse-leap 16.0: iprutils 2.4.19-160000.3.2 Β· CPL-1.0
- ubuntu resolute: iprutils 2.4.19-4 Β· CPL
- ubuntu stonking: iprutils 2.4.19-4 Β· CPL
- Copyright 2000, 2009 International Business Machines Corporation and others
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms