Bootenv

activate has one required property, id. Use query to find the boot environment id.

activate returns true when successful. query returns active values of N (now) for the current boot environment and R (reboot) for the pending one. Enter system reboot to reboot the system and activate the pending boot environment.

From the CLI prompt, enter:

system bootenv activate id="TEST"

Where TEST is the id of the boot environment to activate.

Press Enter.

system bootenv activate id="TEST"
true

create has one required property, name, and one optional property, source.

The boot environment name may include only alphanumeric characters, dashes (-), underscores (_), or periods (.).

If source is defined, the new boot environment is created as a clone of an existing boot environment. Use query to find the id of an existing boot environment.

create returns a blank line when successful. Use query to confirm.

From the CLI prompt, enter:

system bootenv create name="TEST2" source="TEST"

Where TEST2 is a name for the new boot environment and TEST is the id of an existing boot environment to clone, if needed.

Press Enter.

system bootenv create name="TEST2" source="TEST"

delete has one required property, id. Use query to find the boot environment id.

You cannot delete the default or any active entries. To delete the active boot environment, first activate another entry and then delete the environment you want to remove.

delete returns the task progress as a percentage.

From the CLI prompt, enter:

system bootenv delete id="TEST"

Where TEST is the id of an existing boot environment.

Press Enter.

system bootenv delete id="TEST"
[0%] ...
[100%] ...

get_instance has one required property, id. Use query to find the boot environment id.

get_instance returns a table containing boot environment information.

From the CLI prompt, enter:

system bootenv get_instance id="TEST"

Where TEST is the id of an existing boot environment.

Press Enter.

system bootenv get_instance id="TEST"
+--------------+---------------------------+
|           id | TEST                      |
|     realname | TEST                      |
|         name | TEST                      |
|       active |                           |
|    activated | false                     |
| can_activate | true                      |
|   mountpoint | -                         |
|        space | 8.0K                      |
|      created | 2023-09-22T11:56:00+00:00 |
|         keep | false                     |
|     rawspace | 8192                      |
+--------------+---------------------------+

query does not require entering properties or arguments. Enter the command, then press Enter.

query returns a table containing information about all stored boot environments on the system. The active boot environment is identified with N (now) under active and R (reboot). If a boot environment activate is pending, the current environment is identified with N and the pending environment with R.

From the CLI prompt, enter:

system reboot query

Press Enter.

system bootenv query
+------------------------------+------------------------------+------------------------------+--------+-----------+--------------+------------+-------+---------------------------+-------+------------+
| id                           | realname                     | name                         | active | activated | can_activate | mountpoint | space | created                   | keep  | rawspace   |
+------------------------------+------------------------------+------------------------------+--------+-----------+--------------+------------+-------+---------------------------+-------+------------+
| 23.10-RC.1-INTERNAL.9        | 23.10-RC.1-INTERNAL.9        | 23.10-RC.1-INTERNAL.9        |        | false     | true         | -          | 2.35G | 2023-09-15T09:04:00+00:00 | false | 2527326208 |
| 23.10-MASTER-20230922-042925 | 23.10-MASTER-20230922-042925 | 23.10-MASTER-20230922-042925 | NR     | true      | true         | legacy     | 2.33G | 2023-09-22T11:26:00+00:00 | false | 2497949696 |
| Initial-Install              | Initial-Install              | Initial-Install              |        | false     | true         | -          | 7.1M  | 2023-08-31T09:02:00+00:00 | true  | 7442432    |
| 23.10-BETA.1                 | 23.10-BETA.1                 | 23.10-BETA.1                 |        | false     | true         | -          | 2.31G | 2023-08-31T08:47:00+00:00 | false | 2484695040 |
+------------------------------+------------------------------+------------------------------+--------+-----------+--------------+------------+-------+---------------------------+-------+------------+

set_attribute has one required property, id, one optional property, attributes. Currently, keep is the only available attribute. Use query to find the boot environment id.

set_attribute returns true when successful.

From the CLI prompt, enter:

system bootenv set_attribute id="TEST" attributes={“keep”:true}

Where TEST is the boot environment id and true is a boolean value.

Press Enter.

system bootenv set_attribute id="23.10-BETA.1" attributes={"keep":true}
true

update has two required properties, id and name. Use query to find the boot environment id.

The new boot environment name may include only alphanumeric characters, dashes (-), underscores (_), or periods (.).

update returns a blank line when successful. Use query to confirm.

From the CLI prompt, enter:

system bootenv update id="TEST" name="RETEST"

Where TEST is the boot environment id to update and RETEST is the new name.

Press Enter.

system bootenv update id="TEST" name="RETEST"