salt.modules.zoneadm

Module for Solaris 10's zoneadm

maintainer:Jorge Schrauwen <sjorge@blackdot.be>
maturity:new
platform:OmniOS,OpenIndiana,SmartOS,OpenSolaris,Solaris 10

New in version 2017.7.0.

Warning

Oracle Solaris 11's zoneadm is not supported by this module!

salt.modules.zoneadm.attach(zone, force=False, brand_opts=None)

Attach the specified zone.

zone
: string
name of the zone
force
: boolean
force the zone into the "installed" state with no validation
brand_opts
: string
brand specific options to pass

CLI Example:

salt '*' zoneadm.attach lawrence
salt '*' zoneadm.attach lawrence True
salt.modules.zoneadm.boot(zone, single=False, altinit=None, smf_options=None)

Boot (or activate) the specified zone.

zone
: string
name or uuid of the zone
single
: boolean
boots only to milestone svc:/milestone/single-user:default.
altinit
: string
valid path to an alternative executable to be the primordial process.
smf_options
: string
include two categories of options to control booting behavior of the service management facility: recovery options and messages options.

CLI Example:

salt '*' zoneadm.boot clementine
salt '*' zoneadm.boot maeve single=True
salt '*' zoneadm.boot teddy single=True smf_options=verbose
salt.modules.zoneadm.clone(zone, source, snapshot=None)

Install a zone by copying an existing installed zone.

zone
: string
name of the zone
source
: string
zone to clone from
snapshot
: string
optional name of snapshot to use as source

CLI Example:

salt '*' zoneadm.clone clementine dolores
salt.modules.zoneadm.detach(zone)

Detach the specified zone.

zone
: string
name or uuid of the zone

CLI Example:

salt '*' zoneadm.detach kissy
salt.modules.zoneadm.halt(zone)

Halt the specified zone.

zone
: string
name or uuid of the zone

Note

To cleanly shutdown the zone use the shutdown function.

CLI Example:

salt '*' zoneadm.halt hector
salt.modules.zoneadm.install(zone, nodataset=False, brand_opts=None)

Install the specified zone from the system.

zone
: string
name of the zone
nodataset
: boolean
do not create a ZFS file system
brand_opts
: string
brand specific options to pass

CLI Example:

salt '*' zoneadm.install dolores
salt '*' zoneadm.install teddy True
salt.modules.zoneadm.list(verbose=True, installed=False, configured=False, hide_global=True)

List all zones

verbose
: boolean
display additional zone information
installed
: boolean
include installed zones in output
configured
: boolean
include configured zones in output
hide_global
: boolean
do not include global zone

CLI Example:

salt '*' zoneadm.list
salt.modules.zoneadm.move(zone, zonepath)

Move zone to new zonepath.

zone
: string
name or uuid of the zone
zonepath
: string
new zonepath

CLI Example:

salt '*' zoneadm.move meave /sweetwater/meave
salt.modules.zoneadm.ready(zone)

Prepares a zone for running applications.

zone
: string
name or uuid of the zone

CLI Example:

salt '*' zoneadm.ready clementine
salt.modules.zoneadm.reboot(zone, single=False, altinit=None, smf_options=None)

Restart the zone. This is equivalent to a halt boot sequence.

zone
: string
name or uuid of the zone
single
: boolean
boots only to milestone svc:/milestone/single-user:default.
altinit
: string
valid path to an alternative executable to be the primordial process.
smf_options
: string
include two categories of options to control booting behavior of the service management facility: recovery options and messages options.

CLI Example:

salt '*' zoneadm.reboot dolores
salt '*' zoneadm.reboot teddy single=True
salt.modules.zoneadm.shutdown(zone, reboot=False, single=False, altinit=None, smf_options=None)

Gracefully shutdown the specified zone.

zone
: string
name or uuid of the zone
reboot
: boolean
reboot zone after shutdown (equivalent of shutdown -i6 -g0 -y)
single
: boolean
boots only to milestone svc:/milestone/single-user:default.
altinit
: string
valid path to an alternative executable to be the primordial process.
smf_options
: string
include two categories of options to control booting behavior of the service management facility: recovery options and messages options.

CLI Example:

salt '*' zoneadm.shutdown peter
salt '*' zoneadm.shutdown armistice reboot=True
salt.modules.zoneadm.uninstall(zone)

Uninstall the specified zone from the system.

zone
: string
name or uuid of the zone

Warning

The -F flag is always used to avoid the prompts when uninstalling.

CLI Example:

salt '*' zoneadm.uninstall teddy
salt.modules.zoneadm.verify(zone)

Check to make sure the configuration of the specified zone can safely be installed on the machine.

zone
: string
name of the zone

CLI Example:

salt '*' zoneadm.verify dolores