sys software image¶

sys software image(1) BIG-IP TMSH Manual sys software image(1)

NAME
image - Manages F5 Networks software images.

MODULE
sys software

SYNTAX
Install, display information about, or delete a software image using the syntax in the following sections.

INSTALL
install
options:
create-volume
image [name]
reboot
volume [name]

DISPLAY
list image
list image [ [ [ name [/slot_id] ] | [glob] | [regex] ] ... ]
options:
build
build-date
checksum
file-size
last-modified
one-line
product
verified
version

DELETE
delete image [ [ [name] ... ] | [all] ]

DESCRIPTION
You can use the image component to install images onto a volume, view information about available images, or delete
unwanted images.

INSTALLING A SOFTWARE IMAGE
Before you begin installing an image, you must download the image file into the /shared/images directory. You can find new
software images at http://downloads.f5.com. We recommend downloading both the .iso file and the .md5 file. Download the
file (or files) to your local machine, then transfer it to the /shared/images directory on the BIG-IP(r). Use the Manager
(GUI) interface to make this transfer, or quit tmsh to the Unix command line and use scp or a similar Unix command.

If you downloaded the .md5 file, you can use the Unix md5sum command to check the MD5 hash of the .iso file, and you can
compare it to the contents of the .md5 file. They should match. If they do not, retry the download and/or transfer of the
.iso file.

From tmsh, you can use show sys software status to see all of the available disk volumes where you can install the .iso
file. You can install the .iso file in any volume that is not active.

Then use the install command with this component to install the .iso file to an unused volume. You can use the create-
volume option if you want to create a new volume. The installation takes some time; you can use show sys software status
repetitively to watch the progress of the installation. To put the .iso file into active service, use the reboot option in
the install command, or use the reboot volume vol-name command after the install command completes.

Note: You use the slot_id option only for chassis systems and only when displaying the values for the options of a specific
image. You do not use the slot_id option when installing or deleting an image, because these commands operate on all blades
or the entire system.

CONFIRMING AN IMAGE INSTALLATION
You can use show sys version to confirm that the system is running the new software version. If this is a new module for
the current system, you may need to use show sys license and/or install sys license to update your license. For a new
module, you may also need to provision CPU, memory, and disk space for the module with the sys provision component.

EXAMPLES
install image BIGIP-10.0.0.5376.0.iso volume HD1.1 reboot

Attempts to install the specified image, BIGIP-10.0.0.5376.0.iso, onto HD1.1. Note: If the installation is successful and
the version is permitted, the machine reboots into the newly installed image. If the version is not permitted, add forced
to the command to force the reboot.

list image BIGIP-10.0.0.5376.0.iso

Displays information about the specified image, build 5376.0 of BIG-IP version 10.0.0.

list image */1

Displays information about all of the images located on the first slot.

OPTIONS
build
Displays the build number of the image.

build-date
Displays the date on which the image was built.

checksum
Displays the checksum of the image. You can use this option to verify the integrity of the image.

create-volume
Creates a new volume using the name specified with the volume option. Mirrored volume names must begin with the prefix
MD1.. Mirrored volumes are available only on systems that support RAID, see sys raid.

file-size
Displays the size of the image file in megabytes.

glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.

last-modified
Displays the date the file was last modified.

name Specifies the name of the image that you want to install or delete.

product
Displays the F5 Networks product the image contains.

reboot
Specifies that the system reboots immediately after a successful installation.

forced
Forces a reboot if the version is not permitted by the license.

regex
Displays the items that match the regular expression. The regular expression must be preceded by an at sign (@[regular
expression]) to indicate that the identifier is a regular expression. See help regex for a description of regular
expression syntax.

verified
When set to yes, indicates that the image is authentic.

version
Displays the version number of the product this image contains.

volume
Specifies the name of the volume on which you want to install the image, or from which you want to delete the image.

Note: You cannot install software on the active volume.

SEE ALSO
delete, glob, install, list, reboot, regex, sys software hotfix, tmsh, show, sys software status, sys version, sys license,
sys provision

COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.

BIG-IP 2019-05-02 sys software image(1)