brand.dtd.1 revision c5cd6260c3d6c06a9359df595ad9dddbfd00a80e
c793af95640863cd29868fc7c419c5d2496b207bsangeeta CDDL HEADER START
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The contents of this file are subject to the terms of the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Common Development and Distribution License (the "License").
c793af95640863cd29868fc7c419c5d2496b207bsangeeta You may not use this file except in compliance with the License.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
c793af95640863cd29868fc7c419c5d2496b207bsangeeta See the License for the specific language governing permissions
c793af95640863cd29868fc7c419c5d2496b207bsangeeta and limitations under the License.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta When distributing Covered Code, include this CDDL HEADER in each
c793af95640863cd29868fc7c419c5d2496b207bsangeeta file and include the License file at usr/src/OPENSOLARIS.LICENSE.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If applicable, add the following below this CDDL HEADER, with the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta fields enclosed by brackets "[]" replaced with your own identifying
c793af95640863cd29868fc7c419c5d2496b207bsangeeta information: Portions Copyright [yyyy] [name of copyright owner]
c793af95640863cd29868fc7c419c5d2496b207bsangeeta CDDL HEADER END
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Copyright 2008 Sun Microsystems, Inc. All rights reserved.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Use is subject to license terms.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta DO NOT EDIT THIS FILE.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the program to be invoked by zonecfg to verify that the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta zone's configuration is legal, and that all the configured devices,
c793af95640863cd29868fc7c419c5d2496b207bsangeeta attributes, etc. are legal for this brand.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The program is called with a single argument: the path to a file
c793af95640863cd29868fc7c419c5d2496b207bsangeeta containing a temporary config.xml file the zone. It should return 0
c793af95640863cd29868fc7c419c5d2496b207bsangeeta on success and non-0 on failure. Any detailed error messages should be
c793af95640863cd29868fc7c419c5d2496b207bsangeeta displayed to stderr.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the program invoked by zoneadm to perform brand-specific
c793af95640863cd29868fc7c419c5d2496b207bsangeeta checks as to the viability of a zone on this specific machine.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
edd26dc5eeb3b093945c371e4b6dd8286348d53fdr Additional arguments, if any, are appended.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The program should return 0 on success and non-0 on failure. Any
c793af95640863cd29868fc7c419c5d2496b207bsangeeta detailed error messages should be displayed to stderr.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the program to invoke when installing a zone. The following
c793af95640863cd29868fc7c419c5d2496b207bsangeeta replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Additional arguments, if any, are appended.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh installopts
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Identifies the command-line options supported by the brand's
c793af95640863cd29868fc7c419c5d2496b207bsangeeta installation program, allowing zoneadm to parse the install line
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark This is a program which gets run by zoneadmd when a zone is booted.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The program will be invoked as the last step in the zone booting
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark process before the the first process is spawned inside the zone.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this programs succeeds it should not generate any output.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this program returns an error, any output generated by the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta program will be sent to the zoneadmd message log.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Additional arguments, if any, are appended.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta This is a program which gets run by zoneadmd when a zone is being
c793af95640863cd29868fc7c419c5d2496b207bsangeeta halted. This callback is provided to allow a brand to cleanup any
c793af95640863cd29868fc7c419c5d2496b207bsangeeta special configuration that was setup during boot.
188e166434dcdde5356d87fb06c169f15dc4dca9Erik Nordmark This program will also be invoked by zoneadmd if any part of the zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta booting process fail, even if the booting process failed before the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta brand boot program was invoked. It is also possible that if the zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta fails to halt after invoking this program, future attempts to halt the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta zone will invoke this program again. So this program should be
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark designed to clean up any resources allocated to a zone but it should
c793af95640863cd29868fc7c419c5d2496b207bsangeeta also be able to gracefully handle the case where resources that it
c793af95640863cd29868fc7c419c5d2496b207bsangeeta expects to release are not actually allocated (or have been already
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this programs succeeds it should not generate any output. If this
c793af95640863cd29868fc7c419c5d2496b207bsangeeta program returns an error, any output generated by the program will be
c793af95640863cd29868fc7c419c5d2496b207bsangeeta sent to the zoneadmd message log.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Additional arguments, if any, are appended.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Path to the kernel module that implements the kernel-level
c793af95640863cd29868fc7c419c5d2496b207bsangeeta functionality of the brand.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to the initial executable that should be launched when booting a
c793af95640863cd29868fc7c419c5d2496b207bsangeeta branded zone.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to the initial login binary that should be executed when
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark attempting to zlogin into a branded zone.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %Z Name of the current zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %u User login name
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng It has no attributes.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng Path to the binary that will translate a user name to a passwd(4) entry.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %u User login name
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes. The passwd(4) entry is used to determine $LOGNAME,
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark $HOME, and $SHELL for non-interactive "zlogin -l <user> <cmd>".
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary processing on
c793af95640863cd29868fc7c419c5d2496b207bsangeeta a zone to allow it to be attached. The zone will be in the "configured"
c793af95640863cd29868fc7c419c5d2496b207bsangeeta state when this hook is run. This hook is never called when the zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta is "force attached" (-F).
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this hook exits with a non-zero exit status, the attach operation
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If no hook is provided, the internal zoneadm attach code will be used.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary post-processing on
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng a zone after it has been attached. The zone will be in the "installed"
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark state when this hook is run. This hook is never called when the zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark is "force attached" (-F).
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng If this hook exits with a non-zero exit status, the attach operation
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng will fail and the zone state will be reset to "configured".
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng The following replacements are performed:
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary post-processing on
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a zone after it has been cloned. The zone will be in the "incomplete"
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark state when this hook is run.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If this hook exits with a non-zero exit status, the clone operation
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark will fail and the zone will be left in the "incomplete" state,
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark otherwise the state will be changed to the "installed" state.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng %z Name of zone
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a script that will perform any necessary post-processing on
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a zone after it has been freshly installed. This hook will run after the
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark install hook completes and the zone is in the installed state. The
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark additional arguments are the same as what is passed to the install hook.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary pre-processing on
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a zone before it is detached. The zone will be in the "installed"
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark state when this hook is run.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It is possible that if the zone fails to detach after invoking this
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark hook, future attempts to detach the zone will invoke this hook again.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark So this hook should be designed to gracefully handle the case where
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark it is run multiple times on the same zone. If this hook exits with
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a non-zero exit status, the detach operation will fail.
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng This hook is most commonly used when there is pre-processing for detaching
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a zone but the built-in detach support will be used for the actual
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark detach. Otherwise, if a detach hook is provided, then it can be used
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark to do both preprocessing as well as the actual detach.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary processing on
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng a zone to allow it to be detached. The zone will be in the "installed"
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark state when this hook is run.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It is possible that if the zone fails to detach while running this
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark hook, future attempts to detach the zone will invoke this hook again.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark So this hook should be designed to gracefully handle the case where
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark it is run multiple times on the same zone. If this hook exits with
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a non-zero exit status, the detach operation will fail and the zone will
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark be left in the "installed" state, otherwise the state will be changed
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark to "configured".
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If no hook is provided, the internal zoneadm detach code will be used.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a hook that will perform any necessary processing on a zone to
9e3469d3db608feb0e43d9955cbf406c22025463Erik Nordmark allow it to be installed via cloning. Cloning is an alternative to
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark installing so this hook should result in the same effect for the zone.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The zone will be in the "incomplete" state when this hook is run.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If this hook exits with a non-zero exit status, the clone operation
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark will fail and the zone will be left in the "incomplete" state, otherwise
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng the state will be changed to "installed".
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark 1st arg name of source zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If no hook is provided, the internal zoneadm cloning code will be used.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Path to a script that will perform any necessary pre-processing on
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark a zone before it is uninstalled. The zone will be in the "installed"
da14cebe459d3275048785f25bd869cb09b5307fEric Cheng state when this hook is run.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It is possible that if the zone fails to uninstall after invoking this
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark hook, future attempts to uninstall the zone will invoke this hook
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark again. So this hook should be designed to gracefully handle the case
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark where it is run multiple times on the same zone. If this hook exits
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark with a non-zero exit status, the uninstall operation will fail.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark The following replacements are performed:
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
188e166434dcdde5356d87fb06c169f15dc4dca9Erik Nordmark Additional arguments, if any, are appended.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark It has no attributes.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the hook to invoke when uninstalling a zone. The zone will
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh be in the "incomplete" state when this hook is run.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this hook exits with a non-zero exit status, the uninstall operation
c793af95640863cd29868fc7c419c5d2496b207bsangeeta will fail and the zone will be left in the "incomplete" state, otherwise
c793af95640863cd29868fc7c419c5d2496b207bsangeeta the state will be changed to "configured".
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Additional arguments, if any, are appended.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If no hook is provided, the internal zoneadm uninstall code will be used.
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh Identifies the hook to invoke before snapshotting a zone using the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta built-in ZFS clone support.
188e166434dcdde5356d87fb06c169f15dc4dca9Erik Nordmark If this hook exits with a non-zero exit status, the snapshot operation
c793af95640863cd29868fc7c419c5d2496b207bsangeeta will fail and the zfs clone operation will fail.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
188e166434dcdde5356d87fb06c169f15dc4dca9Erik Nordmark %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the hook to invoke after snapshotting a zone using the
29bc4795a563df76952f94da2aa3b7daa8abf972sangeeta built-in ZFS clone support.
29bc4795a563df76952f94da2aa3b7daa8abf972sangeeta If this hook exits with a non-zero exit status, the zfs clone operation
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta validatesnap
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh Identifies the hook to invoke to validate a snapshot of a zone using the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta built-in ZFS clone support. This will validate a snapshot that was
c793af95640863cd29868fc7c419c5d2496b207bsangeeta explicitly specified to the clone command when the user wants to
c793af95640863cd29868fc7c419c5d2496b207bsangeeta re-use a snapshot from an earlier clone operation.
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh If this hook exits with a non-zero exit status, the snapshot validation
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh operation will fail, meaning the zfs snapshot cannot be used to install
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 1st arg snapshot name
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark 2nd arg snapshot path
c793af95640863cd29868fc7c419c5d2496b207bsangeeta prestatechange
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies the hook to invoke before zoneadmd makes a state change.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta If this hook exits with a non-zero exit status, the action failed
c793af95640863cd29868fc7c419c5d2496b207bsangeeta and no further state change activity will take place.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 1st arg integer representing current state of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 2 - installed
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 4 - running
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 5 - shutting down
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 7 - mounted
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh 2nd arg integer representing transition command
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh poststatechange
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh Identifies the hook to invoke after zoneadmd makes a successful state
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh change. If this hook exits with a non-zero exit status, the action failed
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh and zoneadmd treats the overall state change as failed, although
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh all of the actions up to running the hook will have taken place.
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark See prestatechange comment for 1st and 2nd argument values.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Identifies a hook which can be called to get brand-specific information
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh about the zone. There is no specific place in zones where this is called,
c793af95640863cd29868fc7c419c5d2496b207bsangeeta calls within the zone infrastructure can be added as needed.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta One example of the use of this hook is to query the implicit ZFS datasets
c793af95640863cd29868fc7c419c5d2496b207bsangeeta supported by the brand.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark If this hook exits with a non-zero exit status, the query failed,
c793af95640863cd29868fc7c419c5d2496b207bsangeeta although in general, this hook shouldn't return non-zero.
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh The following replacements are performed:
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %z Name of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta %R Zonepath of zone
c793af95640863cd29868fc7c419c5d2496b207bsangeeta 1st arg Arbitrary string which the hook can use to determine what
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark data to return. Brands implementing this hook should be
c793af95640863cd29868fc7c419c5d2496b207bsangeeta tolerant of arguments they don't support and simply do
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark Add a privilege to the default, prohibited, or required set for all
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark zones of this brand with ip-type matched. If a privilege is added
9e3469d3db608feb0e43d9955cbf406c22025463Erik Nordmark to the default set all zones of this brand with ip-type matched on
9e3469d3db608feb0e43d9955cbf406c22025463Erik Nordmark the system will inherit this privilege unless the privilege is
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark removed via limitpriv in zonecfg(1m). If a privilege is added to
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark the prohibited set it can not be added to any zones with ip-type
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark matched via limitpriv in zonecfg(1m). If a privilege is added to
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark the required set then all zones of this brand with ip-type matched
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark on the system will inherit this privilege and it can't be removed via
c793af95640863cd29868fc7c419c5d2496b207bsangeeta limitpriv in zonecfg(1m).
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Its attributes are
c793af95640863cd29868fc7c419c5d2496b207bsangeeta set The name of the set the privilege should go into.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta name The name of the privilege.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta ip-type Optional, indicates that adding of the privilege to the
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark set only applies to certain IP types. Can be "shared" or
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark "exclusive". If it is not specified, the default value
c793af95640863cd29868fc7c419c5d2496b207bsangeeta "all" will be used, which means it is applicable regardless
edd26dc5eeb3b093945c371e4b6dd8286348d53fdr the IP type.
edd26dc5eeb3b093945c371e4b6dd8286348d53fdr<!ATTLIST privilege set ( default | prohibited | required ) #REQUIRED
c793af95640863cd29868fc7c419c5d2496b207bsangeeta The toplevel container for a brand configuration.
c793af95640863cd29868fc7c419c5d2496b207bsangeeta Its attributes are
c793af95640863cd29868fc7c419c5d2496b207bsangeeta name The name of the brand. This must match the name of the
c793af95640863cd29868fc7c419c5d2496b207bsangeeta directory in which the configuration file is stored.
bd670b35a010421b6e1a5536c34453a827007c81Erik Nordmark<!ELEMENT brand (modname?, initname, login_cmd, user_cmd, install,
c793af95640863cd29868fc7c419c5d2496b207bsangeeta installopts?, boot?, halt?, verify_cfg?, verify_adm?,
f4b3ec61df05330d25f55a36b975b4d7519fdeb1dh privilege+)>