Skip to content

Latest commit

 

History

History
412 lines (316 loc) · 12.6 KB

zadm.pod

File metadata and controls

412 lines (316 loc) · 12.6 KB
Raw

NAME

zadm - Manage OmniOS zones.

SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install [-f] <zone_name>
uninstall [-f] <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
reset <zone_name>
login <zone_name>
console [extra_args] <zone_name>
log <zone_name>
fw [-r] [-d] [-t] [-m] [-e ipf|ipf6|ipnat] <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

BHYVE BRAND SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> [-i <image_uuid|image_path_or_uri>] [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install [-i <image_uuid|image_path_or_uri>] [-f] <zone_name>
uninstall [-f] <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-m|--bootmenu] [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
reset <zone_name>
efireset <zone_name>
nmi <zone_name>
console [extra_args] <zone_name>
vnc [-w] [<[bind_addr:]port>] <zone_name>
webvnc [<[bind_addr:]port>] <zone_name>
log <zone_name>
fw [-r] [-d] [-t] [-m] [-e ipf|ipf6|ipnat] <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

EMU BRAND SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> [-i <image_uuid|image_path_or_uri>] [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install [-i <image_uuid|image_path_or_uri>] [-f] <zone_name>
uninstall [-f] <zone_name>
updateres -i <image_uuid> <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
reset <zone_name>
console [extra_args] <zone_name>
monitor <zone_name>
vnc [-w] [<[bind_addr:]port>] <zone_name>
webvnc [<[bind_addr:]port>] <zone_name>
log <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

ILLUMOS BRAND SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> -i <image_uuid|image_path_or_uri> [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install -i <image_uuid|image_path_or_uri> [-f] <zone_name>
uninstall [-f] <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
login <zone_name>
console [extra_args] <zone_name>
log <zone_name>
fw [-r] [-d] [-t] [-m] [-e ipf|ipf6|ipnat] <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

KVM BRAND SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> [-i <image_uuid|image_path_or_uri>] [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install [-i <image_uuid|image_path_or_uri>] [-f] <zone_name>
uninstall [-f] <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
reset <zone_name>
console [extra_args] <zone_name>
monitor <zone_name>
vnc [-w] [<[bind_addr:]port>] <zone_name>
webvnc [<[bind_addr:]port>] <zone_name>
log <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

LX BRAND SYNOPSIS

zadm command [options...]

where 'command' is one of the following:

create -b <brand> -i <image_uuid|image_path_or_uri> [-t <template_path>] <zone_name>
delete [-f] <zone_name>
edit <zone_name>
set <zone_name> <property=value>
install -i <image_uuid|image_path_or_uri> [-f] <zone_name>
uninstall [-f] <zone_name>
show [zone_name [property[,property]...]]
list [-H] [-F <format>] [-b <brand>] [-s <state>] [zone_name]
memstat
list-images [--refresh] [--verbose] [-b <brand>] [-p <provider>]
pull <image_uuid>
vacuum [-d <days>]
brands
start [-c [extra_args]] <zone_name>
stop [-c [extra_args]] <zone_name>
restart [-c [extra_args]] <zone_name>
poweroff <zone_name>
reset <zone_name>
login <zone_name>
console [extra_args] <zone_name>
log <zone_name>
fw [-r] [-d] [-t] [-m] [-e ipf|ipf6|ipnat] <zone_name>
snapshot [-d] <zone_name> [<snapname>]
rollback [-r] <zone_name> <snapname>
help [-b <brand>]
doc [-b <brand>] [-a <attribute>]
man
version

DESCRIPTION

Use zadm to create, edit or manage your zones.

create

creates a new zone with the name zone_name.

zadm will open an editor showing a suitable default configuration for the selected brand which can be modified as required. Once the configuration is saved and the editor is closed, the zone will be created and installed. Any required VNICs, ZFS datasets or volumes will be automatically set up based on the configuration.

The zadm configuration format is JSON. Standard zone properties from the zonecfg(1M) man page are supported via simple "property" : "value" pairs, single resources as "resource" : { } hash structure, and multiple resources as "resource" : [ { }, ... ] array of hash structures. For more information on the available attributes for a particular zone brand, issue zadm doc -b <brand>.

delete

deletes zone zone_name. You can use the -f flag to force the action.

edit

modify the configuration of a zone. See the descriptions in the create function for details.

set

modify the configuration of a zone, changing a single attribute. See the description in the create function for details. Set only supports simple "property" : "value" pairs.

install

installs a zone. If the zone is already installed then the -f option must be provided in order to first uninstall the zone.

uninstall

uninstalls a zone. You can use the -f flag to force the action.

show

shows the configuration for all zones in JSON format, or for a single zone if a zone_name is provided.

list

prints the status of all existing zones or zone_name if given. Available options are:

-F <format>                 Specify an alternative output format.
                            The value of format can be json, yaml or toml.
-H                          Omit the headers from the listing.
-b|--brand <brand>          List status of zones with brand <brand>.
-s|--state <state>          List status of zones in state <state>.

memstat

prints memory usage/caps for running zones.

list-images

list all available images ready for download and install.

pull

downloads the image with ID image_uuid and caches this without creating a zone with it.

vacuum

removes images from the local cache which have not been accessed in the last 30 days or the days specified with the -d option.

brands

list all available and installed zone brands

start

starts the zone zone_name. Attaches to the console if -c is given. Any extra_args will be passed to zlogin(1).

stop

stops the zone zone_name. Attaches to the console if -c is given. Any extra_args will be passed to zlogin(1).

restart

restarts the zone zone_name. Attaches to the console if -c is given. Any extra_args will be passed to zlogin(1).

poweroff

forcefully stops the zone zone_name (i.e. "unplug")

reset

forcefully stops the zone zone_name (i.e. "unplug"); then boots the zone.

login

log into zone_name.

console

attaches to the zone_name zone console. Any extra_args will be passed to zlogin(1).

log

displays the boot log for zone_name.

fw

manages the zone firewall. With no arguments, show the currently loaded firewall and NAT rules for the zone.

-r|--reload                 Reload and enable the zone firewall
-m|--monitor                Monitor zone firewall activity in real-time to stdout
-t|--top                    Show active zone firewall state in a top-like view
-e|--edit <ipf|ipf6|ipnat>  Open a zone firewall configuration file in an editor.
-d|--disable                Disable the zone firewall. It will be re-enabled
                            on zone reboot or with -r|--reload

snapshot

Manages snapshots for a zone. A snapshot is a point-in-time copy that can be easily restored in the future using the rollback command. This command is not available for zones that use boot environments, such as lipkg zones; for these zones, use the beadm create beName@snapshot and beadm rollback beName@snapshot commands from inside the zone to achieve the same result.

With no arguments, snapshot displays a list of current snapshots for the zone. If called with a snapshot name argument, a new snapshot is taken. For bhyve or KVM zones, this snapshot encompasses the boot disk and for other zones it includes the datasets that make up the zone root. To delete a snapshot use the optional -d flag before the zone name.

-d|--destroy                Remove the named snapshot.

rollback

Rolls back a zone to a previously taken snapshot. See the snapshot command for more details.

-r                          Destroy any snapshots and bookmarks more recent
                            than the one specified.

doc

displays information on the available attributes for a particular zone brand. If the optional -a <attribute> argument is provided then only that attribute is shown.

COPYRIGHT

Copyright 2022 OmniOS Community Edition (OmniOSce) Association.

LICENSE

This program 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.

This program 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 this program. If not, see http://www.gnu.org/licenses/.

AUTHOR

Andy Fiddaman <[email protected]> Dominik Hassler <[email protected]> Tobias Oetiker <[email protected]>

HISTORY

2020-04-12 had Initial Version