Skip to content

Instantly share code, notes, and snippets.

@stellarpower
Last active March 16, 2021 21:22
Show Gist options
  • Save stellarpower/4f463f911ca8adf7d9fdbcdffa2ecc6c to your computer and use it in GitHub Desktop.
Save stellarpower/4f463f911ca8adf7d9fdbcdffa2ecc6c to your computer and use it in GitHub Desktop.
Nicely-printed output from `zadm doc`; saves browsing the schemata in the source
bhyve brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
vcpus: CPU
vnc: VNC
zonename: name of zone
zonepath: path to zone root
acpi (optional): generate ACPI tables for the guest
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
bootdisk (optional): resource containing the following attributes:
path: path of zvol
blocksize (optional): zvol block size
direct (optional): enable/disable syncing
nocache (optional): enable/disable caching
nodelete (optional): enable/disable TRIM
ro (optional): set disk read-only
sectorsize (optional): set logical/physical sector size
serial (optional): serial number of disk, upper-case alpha-numeric, up to 20 characters
size (optional): zvol disk size. according to zfs syntax
sparse (optional): sparse zvol
sync (optional): enable/disable syncing
bootorder (optional): boot order
bootrom (optional): boot ROM to use for starting the virtual machine
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cdrom (optional): array of path to iso file
console (optional): console
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
disk (optional): array of resource containing the following attributes:
path: path of zvol
blocksize (optional): zvol block size
direct (optional): enable/disable syncing
nocache (optional): enable/disable caching
nodelete (optional): enable/disable TRIM
ro (optional): set disk read-only
sectorsize (optional): set logical/physical sector size
serial (optional): serial number of disk, upper-case alpha-numeric, up to 20 characters
size (optional): zvol disk size. according to zfs syntax
sparse (optional): sparse zvol
sync (optional): enable/disable syncing
diskif (optional): disk type
extra (optional): extra parameters
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostbridge (optional): type of emulated system host bridge
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
feature_mask (optional): bhyve viona feature mask
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
netif (optional): network type
pool (optional): name of the resource pool this zone must be bound to
ppt (optional): array of PCI devices to pass-through
ram (optional): RAM
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
scheduling-class (optional): Specifies the scheduling class used for
processes running
type (optional): machine type
vga (optional): type of VGA emulation to use
xhci (optional): emulated USB tablet interface
kvm brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
vcpus: CPU
vnc: VNC
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
bootdisk (optional): resource containing the following attributes:
path: path of zvol
blocksize (optional): zvol block size
serial (optional): serial number of disk, upper-case alpha-numeric, up to 20 characters
size (optional): zvol disk size. according to zfs syntax
sparse (optional): sparse zvol
bootorder (optional): boot order
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cdrom (optional): array of path to iso file
console (optional): console
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
disk (optional): array of resource containing the following attributes:
path: path of zvol
blocksize (optional): zvol block size
serial (optional): serial number of disk, upper-case alpha-numeric, up to 20 characters
size (optional): zvol disk size. according to zfs syntax
sparse (optional): sparse zvol
diskif (optional): disk type
extra (optional): extra parameters
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
netif (optional): network type
pool (optional): name of the resource pool this zone must be bound to
ram (optional): RAM
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
scheduling-class (optional): Specifies the scheduling class used for
processes running
type (optional): machine type
lx brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
kernel-version: Kernel version
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
ipv6 (optional): enable/disable IPv6 within LX zone
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
gateway (optional): Gateway for LX zones
global-nic (optional): GZ network interface
ips (optional): array of IPs for LX zones
mac-addr (optional): MAC address of the interface
over (optional): global link
primary (optional): Primary Interface for LX zones
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
lipkg brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
ipkg brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
sparse brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
pkgsrc brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
illumos brand attributes
brand: the zone's brand type
ip-type: ip-type of zone. can either be "exclusive" or "shared"
limitpriv: the maximum set of privileges any process in this zone can
obtain
zonename: name of zone
zonepath: path to zone root
admin (optional): resource containing the following attributes:
auths: permissions set for user
user: username
attr (optional): array of resource containing the following attributes:
name: attribute name
type: attribute type
value: attribute value
autoboot (optional): boot zone automatically
bootargs (optional): boot arguments for zone
capped-cpu (optional): resource containing the following attributes:
ncpus: sets the limit on the amount of CPU time. value is the percentage of a single CPU
capped-memory (optional): resource containing the following attributes:
locked (optional): limits of locked memory. can be suffixed by (K, M, G, T)
physical (optional): limits of physical memory. can be suffixed by (K, M, G, T)
swap (optional): limits of swap memory. can be suffixed by (K, M, G, T)
cpu-shares (optional): the number of Fair Share Scheduler (FSS) shares
dataset (optional): array of resource containing the following
attributes:
name: the name of a ZFS dataset to be accessed from within the zone
dedicated-cpu (optional): resource containing the following attributes:
ncpus: the number of cpus that should be assigned for this zone's exclusive use
importance (optional): specifies the pset.importance value for use by poold
device (optional): array of resource containing the following
attributes:
match: device name to match
dns-domain (optional): DNS search domain
fs (optional): array of resource containing the following attributes:
dir: directory of the mounted filesystem
special: path of fs to be mounted
type: type of fs
options (optional): array of mounting options
raw (optional): path of raw disk
fs-allowed (optional): a comma-separated list of additional filesystems
that may be mounted
hostid (optional): emulated 32-bit host identifier
max-lwps (optional): the maximum number of LWPs simultaneously available
max-msg-ids (optional): the maximum number of message queue IDs allowed
max-processes (optional): the maximum number of processes simultaneously
available
max-sem-ids (optional): the maximum number of semaphore IDs allowed
max-shm-ids (optional): the maximum number of shared memory IDs allowed
max-shm-memory (optional): the maximum amount of shared memory allowed
net (optional): array of resource containing the following attributes:
physical: network interface
address (optional): IP address of network interface
allowed-address (optional): IP address of the zone
defrouter (optional): IP address of default router
global-nic (optional): GZ network interface
mac-addr (optional): MAC address of the interface
over (optional): global link
vlan-id (optional): vlan id
pool (optional): name of the resource pool this zone must be bound to
rctl (optional): array of resource containing the following attributes:
name (optional): resource name
value (optional): resource containing the following attributes:
action: <description missing>
limit: <description missing>
priv: <description missing>
resolvers (optional): array of DNS resolvers
scheduling-class (optional): Specifies the scheduling class used for
processes running
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment