diff --git a/op-mode-definitions/system-image.xml.in b/op-mode-definitions/system-image.xml.in
index c131087be..13bc408de 100644
--- a/op-mode-definitions/system-image.xml.in
+++ b/op-mode-definitions/system-image.xml.in
@@ -1,201 +1,210 @@
<?xml version="1.0" encoding="UTF-8"?>
<interfaceDefinition>
<node name="add">
<properties>
<help>Add an object</help>
</properties>
<children>
<node name="system">
<properties>
<help>Add item to a system facility</help>
</properties>
<children>
<tagNode name="image">
<properties>
<help>Add a new image to the system</help>
<completionHelp>
<list>/path/to/vyos-image.iso "http://example.com/vyos-image.iso"</list>
</completionHelp>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_installer.py --action add --image-path "${4}"</command>
<children>
<tagNode name="vrf">
<properties>
<help>Download image via specified VRF</help>
<completionHelp>
<path>vrf name</path>
</completionHelp>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_installer.py --action add --image-path "${4}" --vrf "${6}"</command>
<children>
<tagNode name="username">
<properties>
<help>Username for authentication</help>
</properties>
<children>
<tagNode name="password">
<properties>
<help>Password to use with authentication</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_installer.py --action add --image-path "${4}" --vrf "${6}" --username "${8}" --password "${10}"</command>
</tagNode>
</children>
</tagNode>
</children>
</tagNode>
<tagNode name="username">
<properties>
<help>Username for authentication</help>
</properties>
<children>
<tagNode name="password">
<properties>
<help>Password to use with authentication</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_installer.py --action add --image-path "${4}" --username "${6}" --password "${8}"</command>
</tagNode>
</children>
</tagNode>
</children>
</tagNode>
</children>
</node>
</children>
</node>
<node name="set">
<properties>
<help>Install a new system</help>
</properties>
<children>
<node name="system">
<properties>
<help>Set system operational parameters</help>
</properties>
<children>
+ <tagNode name="boot-console">
+ <properties>
+ <help>Set system console type at boot</help>
+ <completionHelp>
+ <script>sudo ${vyos_op_scripts_dir}/image_manager.py --action list_console_types</script>
+ </completionHelp>
+ </properties>
+ <command>sudo ${vyos_op_scripts_dir}/image_manager.py --action set_console_type --console-type "${4}"</command>
+ </tagNode>
<node name="image">
<properties>
<help>Set system image parameters</help>
</properties>
<children>
<node name="default-boot">
<properties>
<help>Set default image to boot.</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_manager.py --action set</command>
</node>
<tagNode name="default-boot">
<properties>
<help>Set default image to boot.</help>
<completionHelp>
<script>sudo ${vyos_op_scripts_dir}/image_manager.py --action list</script>
</completionHelp>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_manager.py --action set --image-name "${5}"</command>
</tagNode>
</children>
</node>
</children>
</node>
</children>
</node>
<node name="install">
<properties>
<help>Install a new system</help>
</properties>
<children>
<node name="image">
<properties>
<help>Install new system image to hard drive</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_installer.py --action install</command>
</node>
</children>
</node>
<node name="delete">
<properties>
<help>Delete an object</help>
</properties>
<children>
<node name="system">
<properties>
<help>Delete system objects</help>
</properties>
<children>
<node name="image">
<properties>
<help>Remove an installed image from the system</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_manager.py --action delete</command>
</node>
<tagNode name="image">
<properties>
<help>Remove an installed image from the system</help>
<completionHelp>
<script>sudo ${vyos_op_scripts_dir}/image_manager.py --action list</script>
</completionHelp>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_manager.py --action delete --image-name "${4}"</command>
</tagNode>
</children>
</node>
</children>
</node>
<node name="rename">
<properties>
<help>Rename an object</help>
</properties>
<children>
<node name="system">
<properties>
<help>Rename a system object</help>
</properties>
<children>
<tagNode name="image">
<properties>
<help>System image to rename</help>
<completionHelp>
<script>sudo ${vyos_op_scripts_dir}/image_manager.py --action list</script>
</completionHelp>
</properties>
<children>
<tagNode name="to">
<properties>
<help>A new name for an image</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_manager.py --action rename --image-name "${4}" --image-new-name "${6}"</command>
</tagNode>
</children>
</tagNode>
</children>
</node>
</children>
</node>
<node name="show">
<properties>
<help>Rename an object</help>
</properties>
<children>
<node name="system">
<properties>
<help>Show system information</help>
</properties>
<children>
<node name="image">
<properties>
<help>Show installed VyOS images</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_info.py show_images_summary</command>
<children>
<node name="details">
<properties>
<help>Show details about installed VyOS images</help>
</properties>
<command>sudo ${vyos_op_scripts_dir}/image_info.py show_images_details</command>
</node>
</children>
</node>
</children>
</node>
</children>
</node>
</interfaceDefinition>
diff --git a/src/op_mode/image_manager.py b/src/op_mode/image_manager.py
index 51b95e4d5..05d3b0048 100755
--- a/src/op_mode/image_manager.py
+++ b/src/op_mode/image_manager.py
@@ -1,239 +1,263 @@
#!/usr/bin/env python3
#
# Copyright 2023 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This file is part of VyOS.
#
# VyOS is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# VyOS is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# VyOS. If not, see <https://www.gnu.org/licenses/>.
from argparse import ArgumentParser, Namespace
from pathlib import Path
from shutil import rmtree
from sys import exit
-from typing import Optional
+from typing import Optional, Literal, TypeAlias, get_args
from vyos.system import disk, grub, image, compat
from vyos.utils.io import ask_yes_no, select_entry
SET_IMAGE_LIST_MSG: str = 'The following images are available:'
SET_IMAGE_PROMPT_MSG: str = 'Select an image to set as default:'
DELETE_IMAGE_LIST_MSG: str = 'The following images are installed:'
DELETE_IMAGE_PROMPT_MSG: str = 'Select an image to delete:'
MSG_DELETE_IMAGE_RUNNING: str = 'Currently running image cannot be deleted; reboot into another image first'
MSG_DELETE_IMAGE_DEFAULT: str = 'Default image cannot be deleted; set another image as default first'
+ConsoleType: TypeAlias = Literal['tty', 'ttyS']
+
def annotate_list(images_list: list[str]) -> list[str]:
"""Annotate list of images with additional info
Args:
images_list (list[str]): a list of image names
Returns:
dict[str, str]: a dict of annotations indexed by image name
"""
running = image.get_running_image()
default = image.get_default_image()
annotated = {}
for image_name in images_list:
annotated[image_name] = f'{image_name}'
if running in images_list:
annotated[running] = annotated[running] + ' (running)'
if default in images_list:
annotated[default] = annotated[default] + ' (default boot)'
return annotated
def define_format(images):
annotated = annotate_list(images)
def format_selection(image_name):
return annotated[image_name]
return format_selection
@compat.grub_cfg_update
def delete_image(image_name: Optional[str] = None,
no_prompt: bool = False) -> None:
"""Remove installed image files and boot entry
Args:
image_name (str): a name of image to delete
"""
available_images: list[str] = grub.version_list()
format_selection = define_format(available_images)
if image_name is None:
if no_prompt:
exit('An image name is required for delete action')
else:
image_name = select_entry(available_images,
DELETE_IMAGE_LIST_MSG,
DELETE_IMAGE_PROMPT_MSG,
format_selection)
if image_name == image.get_running_image():
exit(MSG_DELETE_IMAGE_RUNNING)
if image_name == image.get_default_image():
exit(MSG_DELETE_IMAGE_DEFAULT)
if image_name not in available_images:
exit(f'The image "{image_name}" cannot be found')
persistence_storage: str = disk.find_persistence()
if not persistence_storage:
exit('Persistence storage cannot be found')
if (not no_prompt and
not ask_yes_no(f'Do you really want to delete the image {image_name}?',
default=False)):
exit()
# remove files and menu entry
version_path: Path = Path(f'{persistence_storage}/boot/{image_name}')
try:
rmtree(version_path)
grub.version_del(image_name, persistence_storage)
print(f'The image "{image_name}" was successfully deleted')
except Exception as err:
exit(f'Unable to remove the image "{image_name}": {err}')
@compat.grub_cfg_update
def set_image(image_name: Optional[str] = None,
prompt: bool = True) -> None:
"""Set default boot image
Args:
image_name (str): an image name
"""
available_images: list[str] = grub.version_list()
format_selection = define_format(available_images)
if image_name is None:
if not prompt:
exit('An image name is required for set action')
else:
image_name = select_entry(available_images,
SET_IMAGE_LIST_MSG,
SET_IMAGE_PROMPT_MSG,
format_selection)
if image_name == image.get_default_image():
exit(f'The image "{image_name}" already configured as default')
if image_name not in available_images:
exit(f'The image "{image_name}" cannot be found')
persistence_storage: str = disk.find_persistence()
if not persistence_storage:
exit('Persistence storage cannot be found')
# set default boot image
try:
grub.set_default(image_name, persistence_storage)
print(f'The image "{image_name}" is now default boot image')
except Exception as err:
exit(f'Unable to set default image "{image_name}": {err}')
@compat.grub_cfg_update
def rename_image(name_old: str, name_new: str) -> None:
"""Rename installed image
Args:
name_old (str): old name
name_new (str): new name
"""
if name_old == image.get_running_image():
exit('Currently running image cannot be renamed')
available_images: list[str] = grub.version_list()
if name_old not in available_images:
exit(f'The image "{name_old}" cannot be found')
if name_new in available_images:
exit(f'The image "{name_new}" already exists')
if not image.validate_name(name_new):
exit(f'The image name "{name_new}" is not allowed')
persistence_storage: str = disk.find_persistence()
if not persistence_storage:
exit('Persistence storage cannot be found')
if not ask_yes_no(
f'Do you really want to rename the image {name_old} '
f'to the {name_new}?',
default=False):
exit()
try:
# replace default boot item
if name_old == image.get_default_image():
grub.set_default(name_new, persistence_storage)
# rename files and dirs
old_path: Path = Path(f'{persistence_storage}/boot/{name_old}')
new_path: Path = Path(f'{persistence_storage}/boot/{name_new}')
old_path.rename(new_path)
# replace boot item
grub.version_del(name_old, persistence_storage)
grub.version_add(name_new, persistence_storage)
print(f'The image "{name_old}" was renamed to "{name_new}"')
except Exception as err:
exit(f'Unable to rename image "{name_old}" to "{name_new}": {err}')
+@compat.grub_cfg_update
+def set_console_type(console_type: ConsoleType) -> None:
+ console_choice = get_args(ConsoleType)
+ if console_type not in console_choice:
+ exit(f'console type \'{console_type}\' not available')
+
+ grub.set_console_type(console_type)
+
+
def list_images() -> None:
"""Print list of available images for CLI hints"""
images_list: list[str] = grub.version_list()
for image_name in images_list:
print(image_name)
+def list_console_types() -> None:
+ """Print list of console types for CLI hints"""
+ console_types: list[str] = list(get_args(ConsoleType))
+ for console_type in console_types:
+ print(console_type)
+
+
def parse_arguments() -> Namespace:
"""Parse arguments
Returns:
Namespace: a namespace with parsed arguments
"""
parser: ArgumentParser = ArgumentParser(description='Manage system images')
parser.add_argument('--action',
- choices=['delete', 'set', 'rename', 'list'],
+ choices=['delete', 'set', 'set_console_type',
+ 'rename', 'list', 'list_console_types'],
required=True,
help='action to perform with an image')
parser.add_argument('--no-prompt', action='store_true',
help='perform action non-interactively')
parser.add_argument(
'--image-name',
help=
'a name of an image to add, delete, install, rename, or set as default')
parser.add_argument('--image-new-name', help='a new name for image')
+ parser.add_argument('--console-type', help='console type for boot')
args: Namespace = parser.parse_args()
# Validate arguments
if args.action == 'rename' and (not args.image_name or
not args.image_new_name):
exit('Both old and new image names are required for rename action')
return args
if __name__ == '__main__':
try:
args: Namespace = parse_arguments()
if args.action == 'delete':
delete_image(args.image_name, args.no_prompt)
if args.action == 'set':
set_image(args.image_name)
+ if args.action == 'set_console_type':
+ set_console_type(args.console_type)
if args.action == 'rename':
rename_image(args.image_name, args.image_new_name)
if args.action == 'list':
list_images()
+ if args.action == 'list_console_types':
+ list_console_types()
exit()
except KeyboardInterrupt:
print('Stopped by Ctrl+C')
exit()
except Exception as err:
exit(f'{err}')