System image managementΒΆ

The CLI provides commands to manage system images:

  • Display installed images:

    router{}show system-image
    

    One image is displayed per lines in the following format:

    <product name> - <version>[ - <image name>] [(default)] [(current)] [(next)]
    
    product name

    6WIND product name.

    version

    6WIND product version.

    image name

    Name used to identify the image. If not set, the version is used.

    (default)

    Set if it is the default boot image.

    (current)

    Set if it is the image on which the system is booted.

    (next)

    Set if the image will be used for the next boot.

    Example

    router{}show system-image
    Turbo IPsec Embedded Edition (EE) - 1.4.0 - my-current-img (default) (current)
    router{}
    
  • Download and install a new image:

    router{}system-image add NAME URL
    
    NAME

    Name of the new image.

    URL

    URL link to an update image to download. TFTP. FTP, SCP, HTTP or HTTPS protocols can be used.

    Example

    router{}system-image add my-next-img http://1.0.0.1:8000/6wind-turbo-ipsec-ee-x86_64-1.6.0.update
    Importing file http://1.0.0.1:8000/6wind-turbo-ipsec-ee-x86_64-1.6.0.update
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100  240M  100  240M    0     0   140M      0  0:00:01  0:00:01 --:--:--  140M
    router{}show system-image
    Turbo IPsec Embedded Edition (EE) - 1.5.0 - my-current-img (default) (current)
    Turbo IPsec Embedded Edition (EE) - 1.6.0 - my-next-img (next)
    router{}
    

    Note

    The newly installed image becomes the next boot image, but does not automatically become the default boot image.

    This enables to test the installed image at next reboot. In case of problem, resetting the system will boot the default image.

    Of course, you can explicitly set the newly installed image as the default image whenever you wish.

  • Change the default boot image:

    router{}system-image set-default current|NAME
    
    current

    Set the default boot image to the current one.

    NAME

    Name of the image to set as default boot.

    Example

    router{}system-image set-default my-next-img
    router{}show system-image
    Turbo IPsec Embedded Edition (EE) - 1.4.0 - my-current-img (current)
    Turbo IPsec Embedded Edition (EE) - 1.5.0 - my-next-img (default) (next)
    router{}
    
  • Rename an image:

    router{}system-image rename NAME NEW_NAME
    
    NAME

    Current name of the image to rename.

    NEW_NAME

    New name of the image.

    Example

    router{}system-image rename my-next-img my-default-img
    router{}show system-image
    Turbo IPsec Embedded Edition (EE) - 1.4.0 - my-current-img (current)
    Turbo IPsec Embedded Edition (EE) - 1.5.0 - my-default-img (default) (next)
    router{}
    
  • Remove an image:

    router{}delete system-image NAME
    
    NAME

    Name of the image to remove.

    Example

    router{}delete system-image my-default-img
    WARNING: This is the default boot image!
    WARNING: Are you sure to remove this image (y/n)? [n]: y
    WARNING: This image will be booted at next start!
    WARNING: Are you sure to remove this image (y/n)? [n]: y
    router{}show system-image
    Turbo IPsec Embedded Edition (EE) - 1.4.0 - my-current-img (default) (current)
    router{}
    

    Note

    If the default boot image is deleted, the current image automatically becomes the default.