NAME

       system-image-cli - Ubuntu System Image Upgrader command line script

SYNOPSIS

       system-image-cli [options]

DESCRIPTION

       This script upgrades the system to the latest available image (i.e. build number).  With no options, this
       script  checks  the latest version available on the server and calculates an upgrade path to that version
       from the system's current version.  If an upgrade path is found, the relevant files  are  downloaded  and
       the upgrade is applied by rebooting the system into recovery mode.

OPTIONS

       -h, --help
              Show the program's message and exit.

       --version
              Show the program's version number and exit.

       -b NUMBER, --build NUMBER
              Override  the  device's current build number just this once.  NUMBER must be an integer.  Use -b 0
              for force an upgrade.

       -c CHANNEL, --channel CHANNEL
              Override the device's upgrade channel just this once.  Use in combination with --build 0 to switch
              channels.

       --switch CHANNEL
              This is a convenience alias for the combination of -b 0 -c CHANNEL.  It is an easier way to switch
              channels.  If -switch is given with -b and/or -c, the latter take precedence.

       --list-channels
              Lists the available channels, including aliases, and exits.

       -d DEVICE, --device DEVICE
              Override the device name just this once.

       -f FILTER, --filter FILTER
              Filter the candidate upgrade paths to only contain full or delta updates.  FILTER must  be  either
              full or delta.

       -m IMAGENO, --maximage IMAGENO
              Cap a winning upgrade path to image number IMAGENO.  All images with a version number greater than
              IMAGENO  will be ignored.  For example, if the winning upgrade path is 200:204:304 and you give -m
              205, the upgrade will not include image number 304.  Note that  this  capping  happens  after  the
              winning upgrade path is selected.

       -i, --info
              Show  some  information about the current device, including the current build number, device name,
              and channel, then exit.

       -n, --dry-run
              Calculate and print the upgrade path, but do not download or apply it.  New in system-image 2.5.1:
              output displays the target phase percentage

       -p VALUE, --percentage VALUE
              For testing purposes, force a device specific phase percentage.  The  value  must  be  an  integer
              between 0 and 100.  New in system-image 2.5.1

       -g, --no-apply
              Downloads  all  files  and prepares for, but does not actually apply the update.  On devices which
              require a reboot to apply the update, no reboot is performed.

       -v, --verbose
              Increase the logging verbosity.  With one -v, logging goes to the console in addition to  the  log
              file, and logging at INFO level is enabled.  With two -v (or -vv), logging both to the console and
              to the log file are output at DEBUG level.

       -C DIR, --config DIR
              Use  the  given  configuration directory, otherwise use the system default.  The program will read
              all the files in this directory that begin with a number, followed by an underscore, and ending in
              .ini (e.g. 03_myconfig.ini).  The files are read in sorted  numerical  order  from  lowest  prefix
              number to highest, with later configuration files able to override any variable in any section.

       --factory-reset
              Wipes  the  data  partition and issues a reboot into recovery.  This effectively performs a device
              factory reset.

       --show-settings
              Show all the key/value pairs in the settings database.

       --progress [dots|logfile|json]
              Report progress in various ways.  dots prints some dots every once in  a  while  to  stderr;  this
              mimic  what  was  available  in  system-image  2.5.  logfile prints messages at debug level to the
              system-image log file, and is also available in 2.5 (via the --verbose flag).   json  prints  JSON
              records to stdout.  New in system-image 3.0

       --get KEY
              Print  the  value  for  the  given key in the settings database.  If the key is missing, a default
              value is printed.  May be given multiple times.

       --set KEY=VALUE
              Set the value for the given key in the settings database.  If the key is missing it is added.  May
              be given multiple times.

       --del KEY
              Deletes the given key from the settings database.  If the key does not exist,  this  is  a  no-op.
              May be given multiple times.

       --override-gsm
              Allows  an  update to proceed while the device is on GSM and currently set to only use wifi.  This
              is only effective when using ubuntu-download-manager.  New in system-image 3.1.

FILES

       /etc/system-image/[0-9]+*.ini
              Default configuration files.

SEE ALSO

       system-image.ini(5), system-image-dbus(8)

AUTHOR

       Barry Warsaw <barry@ubuntu.com>

COPYRIGHT

       2013-2016 Canonical Ltd.

3.1                                                2016-02-25                                SYSTEM-IMAGE-CLI(1)