How to create bootable media using the CLI - lnvgyutl_lxce_bomcv.r.m_distribution

Description​

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

While BoMC 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 two 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. For more information about the supported operating systems, see Supported operating systems.

Operating system	Command name
Microsoft Windows	lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe
Red Hat Enterprise Linux 7.X AMD64/EM64T and above	lnvgy_utl_lxce_bomcxxx_{ version }_rhel_indiv.bin
SUSE Linux Enterprise Server 12.X AMD64/EM64T and above	lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin

where v.r.m is the version, release and modification of BoMC (for example, 10.3.0).

--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

Automatically update the firmware when the system boots from the created bootable media. Users can check the update result of the server in update GUI after the update process is completed. The option is not supported in all-in-one media creation.

--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 BoMC, and downloads the earlier version, if available, to the directory in which this command is running.

Notes

• BoMC is ready to run after being 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=update, full

Specifies the function to be put into the bootable media. The update parameter is only used in firmware update. The full parameter is used in all functions supported by BoMC, including firmware update, VPD update, inventory and FFDC collection, advanced system configuration, FoD Keys management, and diagnostics.

-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, which is grub.cfg. For example, for 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. It will set one NIC to the specified address. To ensure the success of NIC firmware updates, 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 (for 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.

  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 it 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. It will set one NIC to the specified address. To ensure the success of NIC firmware updates, 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.

  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 Lenovo Web site and places the files in the working directory specified by the --local option. If not specified, this command acquires complete UpdateXpress System Packs.

Notes

• Lenovo XClarity Essentials 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).

It is the directory contains the files for creating the bootable media. It is also the default directory creating the bootable ISO image and the PXE files 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 for creating 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). Only Full function supports all. If you specify all, this command creates bootable media that supports all Lenovo ThinkSystem, System x, and BladeCenter machine types.

Notes

• From BoMC V9.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 wild cards are not allowed.
• Spaces are not allowed in a comma-separated list.
• You can find a list of valid machine types from the BoMC graphical user interface.

--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 Web site.

--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.

--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 option, 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 option, 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 option, 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 grub.cfg, img3a, img2a, pxelinux.0, LiveOS/squashfs.img, and tc.zip.

--legacy-boot

Creates bootable Preboot Execution Environment (PXE) files in legacy mode.

--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 Web site.

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
• sftp

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

The address of the server.

directory

The name of the directory.

--password=password

Set the password for the unattended mode. This option will be encrypted. Under the security mode, the unattended mode only supports the sftp/ftp/smb parameter.

--update-supportlist

Get the latest systems supported by BoMC.

Note

You can use the --update-supportlist (CLI) or the Update List button (GUI) to update the support list from the Web site.

--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 options.
• 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 Bootable Media Creator.

--vlan-id

Allows you to set the vlan-id.

--vlan-ip

Allows you to set the vlan-ip address.

-g [ --generate-raid-config-sample ]

Generate the RAID configuration sample in the working directory.

--noreboot

Do not restart BMC after updating BMC firmware automatically.

--noshutdowm

Do not power off after firmware update.

--rebootos

Restart OS after firmware update.

--copytoramdisk

Copy boot environment to system memory.

Exit status​

The following table contains the return codes of the above commands.

Examples​

1. Check for a new version of BoMC

   This example illustrates how to check for and download a new version of BoMC on a Linux environment.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --check-update

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --check-update

2. Create a bootable CD using an HTTP proxy

   This example illustrates how to create a bootable CD for a system with machine type 7x21.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.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --cd=E: -l workingdir --proxy-address=xxx.xx.xxx.com --proxy-port=80

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --cd=/dev/hda -l workingdir --proxy-address=xxx.xx.xxx.com --proxy-port=80

3. Create a bootable ISO image

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

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --iso=tc.iso -l c:\workingdir --autorun=update

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --iso=tc.iso -l workingdir --autorun=update

4. Create bootable USB flash drive

   This example illustrates how to create a bootable USB flash drive for a system with machine type 7x21 that includes the LXCE UpdateXpress. The updates and files are acquired from the IBM Web site. 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.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --usbkey=F: -l c:\working_dir

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --usbkeykey=/dev/sdb4 -l working_dir

5. Create bootable PXE files

   This example illustrates how to create bootable PXE files in the c:\workingdir\pxedir directory for a system with machine type 7x21 that includes the LXCE UpdateXpress. The updates and files are from acquired the IBM Web site. LXCE UpdateXpress runs automatically when the bootable media boots.

   Note

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

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --pxe=pxedir -l workingdir --tftp-pxe-address=192.168.1.6 --autorun=update

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --pxe=pxedir -l workingdir --tftp-pxe-address=192.168.1.6 --autorun=update

6. 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.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --configfile=c:\config.txt

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --configfile=/root/config.txt

7. 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 LXCE UpdateXpress tool and bootable environment are acquired from the IBM Web site by default.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update --no-acquire --iso=bios.iso -l c:\working_dir

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update --no-acquire --iso=bios.iso -l working_dir

8. 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 7x21 that includes the LXCE UpdateXpress. 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.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --iso=tc.iso -l workingdir -no-acquire

   ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --iso=tc.iso -l workingdir -no-acquire

9. Create a bootable media supporting to upload logs in the security mode

   This example illustrates how to create a bootable ISO image bootable.iso booted in the unattended mode. The logs will be uploaded to the sftp server: 10.23.34.34.

   lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=update -m 7x21 --iso=bootable. iso -l workingdir -no-acquire –unattended sftp://root@10.23.34.34/home --password 123456

   lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=update -m 7x21 --iso=bootable.iso -l workingdir -no-acquire –unattended sftp://root@10.23.34.34/home --password 123456

10. Create an all-in-one bootable ISO image

    This example illustrates how to create a bootable ISO image bootable.iso for a system. BoMC will download LXCE UpdateXpress, DSA, and ASU for managing firmware, VPD, advanced system, FFDC logs, inventory, FoD Keys, and BoMC logs based on your server (machine type: 7x21 and 1909).downloaded.

    lnvgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=full -m 7x21,1909 --iso=bootable. iso -l workingdir

    ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=funll -m 7x21,1909 --iso=bootable.iso -l workingdir

11. Create an all-in-one bootable ISO image on the local system

    This example illustrates how to create a bootable ISO image bootable.iso for a system. This bootable image is in LXCE UpdateXpress, DSA, and ASU of your server (machine type: 7x21 and 1909). The tools and packages can be acquired from the c:\workingdir directory on the local system. The bootable.iso file is created in the c:\workingdir directory.

    Invgy_utl_lxce_bomcxxx_{ version }_windows_indiv.exe --function=full -m 7x21,1909 --iso=bootable. iso -l workingdir -no-acquire

    ./lnvgy_utl_lxce_bomcxxx_{ version }_sles_indiv.bin --function=funll -m 7x21,1909 --iso=bootable.iso -l workingdir