OmniCube Reference Manual

37 pages in 5 sections

User CommandsSection 1

activate_zone_vnc.sh(1)publish a bhyve or kvm zone VNC console over TCP
generate_mac_address_vm(1)generate a random VM MAC address in the MA-M block
sshpass(1)run ssh non-interactively by supplying its password

Library FunctionsSection 3

oc_console(3)stop a zone's VNC console relay before its pool is exported
oc_lock(3)acquire a single-instance OmniCube lock and maintain the shared lock directory
oc_log(3)log OmniCube messages to syslog and send throttled alert mail
oc_policy(3)resolve an OmniCube snapshot policy file and validate the remote privilege prefix
oc_runlevel(3)stop OmniCube jobs when the host is not in a normal multi-user state
oc_ssh(3)pre-flight check that a remote OmniCube host is usable over ssh
oc_validate(3)validate OmniCube identifiers and test list and snapshot membership
omnicube_utils(3)shared shell function library for OmniCube commands
21 other names documented in section 3
_bkp_priv(3)resolve an OmniCube snapshot policy file and validate the remote privilege prefix
_current_runlevel(3)stop OmniCube jobs when the host is not in a normal multi-user state
_ensure_shared_dir(3)acquire a single-instance OmniCube lock and maintain the shared lock directory
_send_mail(3)log OmniCube messages to syslog and send throttled alert mail
_should_send_mail(3)log OmniCube messages to syslog and send throttled alert mail
_zone_console_pids(3)stop a zone's VNC console relay before its pool is exported
abort_if_shutting_down(3)stop OmniCube jobs when the host is not in a normal multi-user state
acquire_lock_or_exit(3)acquire a single-instance OmniCube lock and maintain the shared lock directory
error(3)log OmniCube messages to syslog and send throttled alert mail
get_snap_policy_path(3)resolve an OmniCube snapshot policy file and validate the remote privilege prefix
info(3)log OmniCube messages to syslog and send throttled alert mail
is_in_exact_list(3)validate OmniCube identifiers and test list and snapshot membership
is_shutting_down(3)stop OmniCube jobs when the host is not in a normal multi-user state
is_snapexists(3)validate OmniCube identifiers and test list and snapshot membership
kill_zone_console(3)stop a zone's VNC console relay before its pool is exported
require_ssh(3)pre-flight check that a remote OmniCube host is usable over ssh
ssh_probe_reset(3)pre-flight check that a remote OmniCube host is usable over ssh
ssh_reachable(3)pre-flight check that a remote OmniCube host is usable over ssh
validate_dataset(3)validate OmniCube identifiers and test list and snapshot membership
validate_name(3)validate OmniCube identifiers and test list and snapshot membership
warning(3)log OmniCube messages to syslog and send throttled alert mail

File FormatsSection 5

default.conf(5)OmniCube snapshot retention policy file
vm_tpl.cfg(5)OmniCube VM zone template configuration file
3 other names documented in section 5
policies(5)OmniCube snapshot retention policy file
vm_tpl_bhyve.cfg(5)OmniCube VM zone template configuration file
vm_tpl_kvm.cfg(5)OmniCube VM zone template configuration file

Standards, Environments, and MacrosSection 7

omnicube(7)OmniCube clustered zone and VM management suite

System Administration CommandsSection 8

autocleansnap(8)expire ZFS snapshots according to the retention policies
autosnap(8)create policy-driven ZFS snapshots of flagged datasets
autosync(8)replicate flagged ZFS snapshots to the backup host
create_iscsi_lun.sh(8)create and export the main and SLOG iSCSI LUNs of a zone
create_zone_config.sh(8)create the mirrored zpool and datasets of a zone
create_zone_pool.sh(8)create the zpool and datasets of a SYNC or ASYNC zone
get_vm_disk_info.sh(8)report record size and virtual/current size of a VM disk
init_backup_zfs.sh(8)create and NFS-share the per-pool backup datasets
isolate_node.sh(8)place an OmniCube node in isolation mode, or take it back out
logadm(8)rotate OmniCube and system logs, wrapping the system logadm
manage_zone.sh(8)manage the configuration and lifecycle of zones and VMs
monitor_nvme.sh(8)check NVMe health log pages and device wear level
pool_monitor.sh(8)monitor and repair iSCSI sessions, bridges and ZFS pools
qemu(8)monitor-command - send QEMU guest-agent commands to a zone-hosted VM
restart_windows_server(8)reboot a Windows guest through its SAC console
restrict(8)shell-cmd - privileged helper granting a user their own zone console
restrict(8)shell - login shell giving a user the console of their own zone only
shutdown_windows_server(8)shut down a Windows guest through its SAC console
sync_pool.sh(8)replicate asynchronous zone pools to the peer cluster nodes
sys_monitor(8)monitor zpool capacity, stale pool locks and host time sync
zone_monitor.sh(8)boot OmniCube zones that are installed but not running
zone_save.sh(8)save the configuration of every local zone into its zonepath
zones_srv_monitor.sh(8)clear failed services inside OmniCube lipkg and LX zones

37 pagesgenerated 2026-09-02 05:17 CEST