ibm_utl_bomc_v.r.m_distribution - Create bootable media using the CLI

Description

If you run this command with no options, the graphical interface is displayed.

While Bootable Media Creator is busy waiting for operations that take more than a few seconds to finish (such as acquiring updates or inventory collection), a series of dots (.) is displayed, about one dot for every 2 seconds.

If you do not specify a bootable media option (--cd, --iso, --pxe, or --usbkey), then the updates for the specified machine type are downloaded to the specified working directory.

Options

v.r.m_distribution

Specifies the version and operating system on which this command is being run.

Operating system	Command name
Windows	ibm_utl_bomc_v.r.m_windows_i386.exe
Red Hat Enterprise Linux7.0	ibm_utl_bomc_v.r.m_rhel7_x86-64.bin
Red Hat Enterprise Linux 6.0	ibm_utl_bomc_v.r.m_rhel6_i386.bin
Red Had Enterprise Linux 6.0 64-bit	ibm_utl_bomc_v.r.m_rhel6_x86-64.bin
Red Hat Enterprise Linux 5.0	ibm_utl_bomc_v.r.m_rhel5_i386.bin
Red Hat Enterprise Linux 5.0 64-bit	ibm_utl_bomc_v.r.m_rhel5_x86-64.bin
Red Hat Enterprise Linux 4.0	ibm_utl_bomc_v.r.m_rhel4_i386.bin
Red Hat Enterprise Linux 4.0 64-bit	ibm_utl_bomc_v.r.m_rhel4_x86-64.bin
SUSE Linux Enterprise Server 11	ibm_utl_bomc_v.r.m_sles11_i386.bin
SUSE Linux Enterprise Server 11 64-bit	ibm_utl_bomc_v.r.m_sles11_x86-64.bin
SUSE Linux Enterprise Server 10	ibm_utl_bomc_v.r.m_sles10_i386.bin
SUSE Linux Enterprise Server 10 64-bit	ibm_utl_bomc_v.r.m_sles10_x86-64.bin

where v.r.m is the version, release and modification of IBM ToolsCenter Bootable Media Creator (for example, 9.6.3).

--arch=x86 | x64

Specifies the architecture type to be supported by the created ServerGuide image. The default value is x64. Valid values are x86 and x64.

--autorun={uxspi | dsa | none}

Specifies the tool that will run automatically when the created bootable media boots from an IBM system. You can specify one of these tools:

• uxspi: Runs UpdateXpress System Pack Installer automatically when the bootable media is booted. This is the default value.
• dsa: Runs the Dynamic System Analysis tool automatically when the bootable media is booted.
• none: No tool runs automatically when the bootable media is booted.

Note: This option is not valid if the serverguide option was selected with the --function option.

--cd=volume

Creates a bootable CD or DVD identified by the specified volume.

(Windows only) Volume specifies the volume letter where the CD or DVD is located. Include the colon character (for example, --cd=d:)

(Linux only) Volume specifies the CD or DVD device name (for example, --cd=/dev/cdrom).

Attention: If the CD or DVD is read-writable, existing data will be deleted, regardless of whether the --force option is specified. No warning is displayed if data currently exists on the CD or DVD.

Note: You cannot combine this option with the --iso, --pxe, and --usbkey options.

--check-update

Checks the web for the latest version of IBM ToolsCenter Bootable Media Creator, and downloads the newer version, if available, to the directory in which this command is running.

Notes:

• IBM ToolsCenter Bootable Media Creator is ready to run after it is downloaded. It does not need to be installed.
• If --check-update is used in combination with other options; the other options are ignored.

--configfile=file_name

Retrieves option arguments from the specified configuration file

Example: --configfile=c:\path\config.txt

Notes:

• You cannot combine this option with any other options.
• The specified configuration options are saved in a configuration file named bomc.config in the working directory and bootable media each time you create a bootable media.

--description=description

Specifies descriptive text that is displayed on the screen when you boot the target system using the created bootable media.

Note: If you do not specify descriptive text, "Bootable media - date" is displayed by default, where date is the date that the bootable media was created.

--force

Overwrites existing data on the bootable media (ISO image, USB flash drive, or PXE files) without displaying a warning message. If this option is not specified, existing bootable media is not overwritten.

Note: Existing data on a read/writable CD or DVD is automatically overwritten, regardless of whether this option is specified.

--function=uxspi,dsa,serverguide

Includes the specified tools on the bootable CD, DVD, or USB flash drives. You can specify one or more of these tools, separated by a comma.

Note:

• If dsa is selected, the bootable media will contain a stand-alone memory test utility that will not be run by default.
• The serverguide option is supported for Windows only.
• You cannot combine the dsa and serverguide options.

-h | -? | --help

Detailed information about the command is displayed, including the syntax, a description of the command, a description of the options, error codes, and examples.

--iso=file_name

Creates a bootable ISO 9660 file with the specified file name (for example, --iso=bios.iso).

Notes:

• The specified file name must end in "iso" (for example, bios.iso).
• By default, the ISO file is created in the working directory, specified by the --local option. To create the file in a different directory, specify the path and file name (for example, c:\bios.iso or ..\bios.iso).
• You cannot combine this option with the --cd, --pxe, and --usbkey options.

--kernel-args="key=value[ key=value...]"

Appends the specified kernel arguments to the boot loader configuration file, such as img1a.cfg or pxelinux.cfg. For example, for Serial Over LAN (SOL) support specify: --kernel-args="console=ttyS1,19200 console=tty1".

Notes:

• This option is not valid when serverguide is selected as the function option.
• The kernel options are in addition to other options that are already specified in the bootable media itself.
• Enclose the key-value pairs in quotation marks.
• Separate the key-value pairs using a space.
• When you specify a serial console argument (ttyS0 or ttyS1) and the tty1 console argument using the --kernel-args option, you must specify the serial console first.

Note: Using the ipstatic and ipstatic6 options

The ipstatic optional kernel parameter is used to assign IPv4 addresses to NICs. If you use the ipstatic option, be aware of the following limitations:

• If you do not specify an ipstatic or ipstatic6 kernel argument, IP addresses will be assigned to all NICs using DHCP.
• If you specify ipstatic=auto, IP addresses will be assigned to all NICs sequentially, beginning with 192.168.0.100, and adding addresses incrementally until reaching 192.168.0.255.
• You can specify the IP address of a single NIC explicitly: ipstatic=eth0;192.168.0.125:255.255.255.0:192.168.0.1. This will set one NIC to the specified address. Note that for NIC firmware updates to succeed, the NICs must be configured with an IP address. Therefore, if you use this option and are performing firmware updates, only the NIC specified in the argument (in this example, eth0) will succeed. Firmware updates for all of the other NICs in the system will fail.
• You can specify a starting IP address and allow the auto parameter to assign IP addresses sequentially beginning with that address, as shown below.

  ipstatic=eth0;192.168.0.125:255.255.255.0:192.168.0.1;auto

• If you specify a static IPv4 address when creating a PXE image, the boot will fail as this will force an address reassignment, which will cause the connection between the target server and the PXE server to be lost.

The ipstatic6 optional kernel parameter is used to assign IPv6 addresses to NICs. If you use the ipstatic6 option be aware of the following limitations:

• If you do not specify an ipstatic or ipstatic6 kernel argument, IP addresses will be assigned to all NICs using DHCP.
• If you specify ipstatic6=auto, IP addresses will be assigned to all NICs sequentially, beginning with adapter eth0 and 2001::1234:abcd/64 and adding addresses incrementally. That is, eth1 will receive address 2001::1234:abce/64, eth2 will receive address 2001::1234:abcf/64, and so on.
• You can specify the IPv6 address of a single NIC explicitly: ipstatic6=eth0;2001::1234:abcd/64. This will set one NIC to the specified address. Note that in order for NIC firmware updates to succeed, the NICs must be configured with an IP address. Therefore, if you use this option and are performing firmware updates, only the NIC specified in the argument (in this example, eth0) will succeed. Firmware updates for all of the other NICs in the system will fail.
• You can specify a starting IPv6 address and allow the auto parameter to assign IP addresses sequentially beginning with that address, as shown below.

  ipstatic6=eth0;2001::1234:abcd/64;auto

• If you specify an IPv6 address with no postfix, the postfix will be set to 0 by default.
• If you specify an IPv6 static address when creating a PXE image, the boot might fail, as there is no remote boot specification for IPv6 equivalent to PXE.

--latest

Acquires the latest individual updates from the IBM website and places the files in the working directory specified by the --local option. If not specified, this command acquires complete UpdateXpress System Packs.

Notes:

• IBM ToolsCenter Bootable Media Creator acquires the latest tools and boot environment automatically each time this command is run if they do not already exist in the working directory specified by the --local option.
• ISO files that are located in the specified working directory are not copied to the bootable media being created.

--license

License information is displayed and then exits.

-l directory | --local=directory

Specifies the fully-qualified working directory (for example, --local=c:\workingdir).

This is the directory that contains the files needed to create the bootable media. This is also the default directory where the bootable ISO image and Preboot Execution Environment (PXE) files are created. if not otherwise specified with the --iso or --pxe options.

Notes:

• If you specify the --no-acquire option, this directory must contain all of the files needed to create the bootable media, including the UpdateXpress System Packs, tools, and boot environment. The files must be in specific locations within this directory.
• HTTP and FTP URL style addresses are not supported.

-m [all | {machine_type[,machine_type} | none] | --machine-type=[all | {machine_type[,machine_type} | none ]

Targets one or more specified machine types, separated by a comma (for example, --machine-type=4362, 4363). If you specify all, this command creates bootable media that supports all IBM System x® and BladeCenter® machine types.

Notes:

• Beginning with BoMC 9.51, if you specify the -m all option to acquire all firmware packages for all supported systems, the machine type list to the ECC server will include all of the systems in the support list for BoMC, not "all".
• The machine type must be a 4-digit number. The wildcards are not allowed.
• Spaces are not allowed in a comma separated list.
• You can find a list of valid machine types from the IBM ToolsCenter Bootable Media Creator graphical user interface.

--new

Allows you to choose to update all firmware packages later with the following options:

• It can be detected after system boots into the media.
• The package version on the media is larger than the version installed on the target system.
• In the updateSelection field of the package’s XML file, the value is specified as never.

Note: --new only works in TUI mode.

--no-acquire

Acquires UpdateXpress System Pack or individual updates from existing files in the working directory. If this option is not specified, UpdateXpress System Pack or individual updates are acquired from the IBM website.

--no-eject

Prevents ejection of the CD/DVD in the media tray after the Bootable Media Creator exits. If this option is not specified, the media will be ejected.

Note: This option is not valid if the serverguide option was selected with the --function option.

--no-firmware

Indicates that no firmware updates are to be included in the IBM ServerGuide Setup and Installation CD.

--proxy-address=address

Specifies the host name, IP address, or DNS address for the HTTP proxy server (for example, --proxy-address=10.0.0.10).

Notes:

• Specify this option if you require an HTTP proxy to connect to the web.
• If you specify this options, you must also specify the --proxy-port option.

--proxy-password=password

Specifies the proxy user password for authenticating to the HTTP proxy server.

Notes:

• Specify this option if you require an HTTP proxy to connect to the web and credentials must be provided to authenticate to the HTTP server.
• If you specify this options, you must also specify the --proxy-user option.
• The proxy password is not persistent and is not stored in the configuration file.

--proxy-port=port

Specifies the proxy port number for the HTTP proxy server.

Notes:

• Specify this option if you require an HTTP proxy to connect to the web.
• If you specify this options, you must also specify the --proxy-address option.

--proxy-user=user_ID

Specifies the proxy user ID for authenticating to the HTTP proxy server.

Notes:

• Specify this option if you require an HTTP proxy to connect to the web and credentials must be provided to authenticate to the HTTP proxy server.
• If your proxy server does not require a password, this option can be omitted.
• The proxy user ID is stored in the configuration file, but the proxy password is not stored.

--pxe=directory

Creates bootable Preboot Execution Environment (PXE) files in the specified directory (for example, --pxe=pxe_dir).

Notes:

• The specified directory is relative to the working directory specified by the -l | --local option.
• You cannot combine this option with the --cd, --iso, and --usbkey options.
• The PXE files include pxelinux.cfg/default, img3a, img2a, pxelinux.0, tcrootfs and tc.zip.
• You cannot use this option if serverguide was chosen with the --function option.

--rollback-supportlist

Reverts to the original bundled system support list for each function.

--show-supportlist

Shows the system support list currently in use for each function (diagnostic, update, and deployment).

--timeout=1-65535

Specifies the amount of time, in seconds, that you have to press a key before the specified tool starts automatically after you boot using the bootable media. You can specify 1 - 65535 seconds. The default value is 60 seconds.

Note: This option is not valid if the serverguide option was selected with the --function option.

--tftp-pxe-address=ip_address

Specifies the IP address of the TFTP server to use for PXE booting.

-t file_name | --toolzip=file_name

Uses the specified bootable-environment file that exists in the working directory instead of acquiring it from the IBM website.

Note: This option is not valid if the serverguide option was selected with the --function option.

--tui

Runs the selected tools in a text user interface. If this option is not specified, the tools run in a graphical user interface.

Note: This option is not valid if the serverguide option was selected with the --function option.

--unattended=protocol://address/directory

Specifies that the created media is to run in unattended mode, and indicates the upload location for the log file package. When using this option, the --autorun parameter is disabled.

protocol

specifies the protocol to use when uploading the log file package. Valid values are:

• tftp
• ftp
• nfs
• smb
• usb

Note:

1. In order to specify a port number when using an IPv6 address with FTP and TFTP, you must enclose the IPv6 address in brackets, as shown:

   --unattended=tftp://[2001::1234:abcd]:21/logdir

2. Use of IPv6 addressing with NFS is not supported.

address

indicates the address of the server.

directory

indicates the name of the directory.

--update-supportlist

Updates the system support list for all functions by acquiring a new ECC list.

Note: You can use the --update-supportlist (CLI) or the Update List button (GUI) to update the support list from the IBM website. This enables the tool to support new systems or new versions of VMWare ESXi update that are released after the current version of the tool.

--usbkey=volume

Creates a bootable USB flash drive identified by the specified volume.

(Windows only) Volume specifies the USB flash drive. Include the driver letter and the colon character (for example, --usbkey=d:).

(Linux only) Volume specifies the device name of the USB flash-drive (for example, --usbkey=/dev/sdb4). Existing data will be deleted from the USB flash drive.

Notes:

• You cannot combine this option with the --cd, --iso, and --pxe
• You cannot use this option if serverguide was chosen with the --function option.
• Only 4 is supported as a primary partition number for the Linux operating systems. Volume specified in the option --usbkey is like /dev/sdx4, in which sdx is the hard drive of USB key.

-V | --version

Display the version of IBM ToolsCenter Bootable Media Creator.

--vlan-id

Allows you to set the vlan-id.

--vlan-ip

Allows you to set the vlan-ip address.

Exit status

• 0: The operation completed successfully.
• 101: An option argument is not valid.
• 120: FTP error: Failed to download file(s).
• 200: One or more files were not saved.
• 201: The specified directory could not be created.
• 202: An applicable update is not available for specified machine-type.
• 203: Acquisition error: Failed to find update by specified update id: %s.
• 204: An unrecoverable error occurred while downloading updates from the IBM update repository.
• 205: One or more specified machine types are not valid.
• 220: The bootable environment is not found in the working directory.
• 221: The specified directory or file is not found.
• 222: The specified directory or files cannot not be created.
• 223: The specified zip file cannot be uncompressed.
• 224: The specified zip file does not have the .zip extension
• 225: No suitable updates were found. SLES10 updates are needed in the created bootable media. Acquire SLES10 updates before creating bootable media.
• 226: The mode change failed on one or more files.
• 227: The specified ISO file does not have the .iso extension
• 228: The ISO file cannot be created.
• 229: The CD or DVD cannot be burned.
• 230: The specified volume name for the USB flash drive is not found.
• 231: The function cannot be performed.
• 232: The USB flash drive has not been initialized.
• 235: The specified volume is not a valid CD or DVD volume.
• 240: A newer version of IBM ToolsCenter Bootable Media Creator is not available. You are running the latest tool.
• 245: VLAN id and ip should be specified together.
• 255: An unknown error occurred.

Examples

1. Check for a new version of IBM ToolsCenter Bootable Media Creator

   This example illustrates how to check for and download a new version of IBM ToolsCenter Bootable Media Creator on a Linux environment.

   ibm_utl_bomc_9.63_windows_i386.exe --check-update

   ./ibm_utl_bomc_9.63_sles10_i386.bin --check-update

2. Download the latest UpdateXpress System Pack updates and the boot environment

   This example illustrates how to download the latest UpdateXpress System Pack updates and the latest boot environment for systems with machine type 8843. Files are copied to the c:\workingdir directory.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 -l c:\workingdir

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 -l c:/workingdir

3. Create a bootable CD using an HTTP proxy

   This example illustrates how to create a bootable CD for a system with machine type 8843. The updates and files are acquired from an HTTP proxy server with IP address hkce01.hk.ibm.com and using port 80.

   Note: The HTTP proxy server must support SSL.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 --cd=E: -l workingdir --proxy-address=hkce01.hk.ibm.com --proxy-port=80

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 --cd=/dev/hda -l workingdir --proxy-address=hkce01.hk.ibm.com --proxy-port=80

4. Create a bootable ISO image

   This example illustrates how to create a bootable ISO image named tc.iso for a system with machine type 8843 that includes the UpdateXpress System Pack Installer. UpdateXpress System Pack Installer runs automatically when the bootable media boots. The tc.iso file is created in the workingdir directory.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 --iso=tc.iso -l c:\workingdir --autorun=uxspi

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 --iso=tc.iso -l workingdir --autorun=uxspi

5. Create bootable USB flash drive

   This example illustrates how to create a bootable USB flash drive for a system with machine type 8843 that includes the UpdateXpress System Pack Installer. The updates and files are acquired the IBM website. For the Windows example, the USB flash drive uses the F: drive. For the SLES10 example, the USB flash drive uses the /dev/sdb device.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 --usbkey=F: -l c:\working_dir

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 --usbkeykey=/dev/sdb4 -l working_dir

6. Create bootable PXE files

   This example illustrates how to create bootable PXE files (including pxelinux.cfg/default, initrd.gz, vmlinux, pxelinux.0, tcrootfs and tc.zipin) in the c:\workingdir\pxedir directory for a system with machine type 8843 that includes the UpdateXpress System Pack Installer. The updates and files are acquired the IBM website. UpdateXpress System Pack Installer runs automatically when the bootable media boots.

   Note: This example requires you to change the Trivial File Transfer Protocol (TFTP) IP address of pxelinux.cfg/default. For more information, see Using bootable media.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 --pxe=pxedir -l workingdir --tftp-pxe-address=192.168.1.6 --autorun=uxspi

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 --pxe=pxedir -l workingdir --tftp-pxe-address=192.168.1.6 --autorun=uxspi

7. Create bootable media using a configuration file

   This example illustrates create bootable media using option arguments that are set in the c:\config.txt configuration file.

   ibm_utl_bomc_9.63_windows_i386.exe --configfile=c:\config.txt

   ./ibm_utl_bomc_9.63_sles10_i386.bin --configfile=/root/config.txt

8. Create bootable media with a single update

   This example illustrates how to create a bootable ISO image named bios.iso using the existing BIOS firmware update located in the working_dir directory. The UpdateXpress System Pack Installer tool and bootable environment are acquired from the IBM website by default.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi --no-acquire --iso=bios.iso -l c:\working_dir

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi --no-acquire --iso=bios.iso -l working_dir

9. Create bootable media using files on the local system

   This example illustrates how to create a bootable ISO image named tc.iso for a system with machine type 8843 that includes the UpdateXpress System Pack Installer. The updates and files are acquired from the c:\workingdir directory on the local system. The tc.iso file is created in the c:\workingdir directory.

   ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi -m 8843 --iso=tc.iso -l workingdir –-no-acquire

   ./ibm_utl_bomc_9.63_sles10_i386.bin --function=uxspi -m 8843 --iso=tc.iso -l workingdir –-no-acquire

10. Create a bootable diagnostics CD using an HTTP proxy

    This example illustrates how to create a bootable diagnostics CD. The Dynamic System Analysis tool and bootable files are acquired from an HTTP proxy server with IP address hkce01.hk.ibm.com using port 80.

    Note: The HTTP proxy server must support SSL.

    ibm_utl_bomc_9.63_windows_i386.exe --function=dsa --cd=E: -l workingdir --proxy-address=hkce01.hk.ibm.com --proxy-port=80 --autorun=none

    ./ibm_utl_bomc_9.63_sles10_i386.bin --function=dsa --cd=/dev/hda -l workingdir --proxy-address=hkce01.hk.ibm.com --proxy-port=80 --autorun=none

11. Create a bootable diagnostics USB flash drive

    This example illustrates how to create a bootable diagnostic USB flash drive. For the Windows example, the USB flash drive uses the F: drive. For the SLES10 example, the USB flash drive uses the /dev/sdb4 device.

    ibm_utl_bomc_9.63_windows_i386.exe --function=dsa --usbkey=F: -l c:\working_dir --autorun=none

    ./ibm_utl_bomc_9.63_sles10_i386.bin --function=dsa --usbkeykey=/dev/sdb4 -l working_dir --autorun=none

12. Create an IBM ServerGuide Setup and Installation CD

    This example illustrates how to create a bootable IBM ServerGuide Setup and Installation CD.

    ibm_utl_bomc_9.63_windows_i386.exe --function=uxspi,serverguide -m 8843 -l=c:\workingdir --cd=E: --arch=x86 --no-firmware