CLI Reference¶
Every phenix command, generated from its source. Each top-level command has its own page, and the options of phenix itself are global flags that every command accepts.
phenix¶
A cli application for phēnix
Options¶
--base-dir.builder-templates string directory of the Builder template files phenix ui reads at start (default: <base-dir.phenix>/builder/templates)
--base-dir.injects string base directory for staged workflow injects (default: <base-dir.phenix>/injects; workflow apply uses the server's value unless this flag is given)
--base-dir.minimega string base minimega directory (default "/tmp/minimega")
--base-dir.phenix string base phenix directory (default "/phenix")
--base-dir.topologies string base directory for topology directories (default: <base-dir.phenix>/topologies)
--bridge-mode string bridge naming mode for experiments ('auto' uses experiment name for bridge; 'manual' uses user-specified bridge name, or 'phenix' if not specified; a phenix ui in 'auto' mode overrides it) (options: manual | auto) (default "manual")
--color string when to color the output: 'auto' colors only a terminal, and not when NO_COLOR is set or TERM is dumb. JSON and YAML output never have color (options: auto | on | off) (default "auto")
--deploy-mode string deploy mode for minimega VMs (options: all | no-headnode | only-headnode)
--experiment.disk-check string what a start does when a VM disk image or CD-ROM image is missing or its backing chain is broken ('error' refuses the start, 'warn' starts with a warning, 'off' does not check) (options: error | warn | off) (default "error")
-h, --help help for phenix
--hostname-suffixes string hostname suffixes to strip (default "-minimega,-phenix")
--log.console string output for console logs (text format) (stderr, stdout, or file path) (default "stderr")
--log.level string level to log messages at (default "info")
--log.system.max-age int maximum number of days to retain old log files (default 90)
--log.system.max-backups int maximum number of old log files to retain (default 3)
--log.system.max-size int maximum size in megabytes of the log file before it gets rotated (default 100)
--log.system.path string path to system log (JSON format) (default: /var/log/phenix/phenix.log as root, $HOME/phenix_logs/phenix.log otherwise)
--minimega.read-connections int most read-only commands sent to minimega at once, 3 to 64; 2 are kept for reads of the head node (default 16)
--mount-dir string base directory for VM filesystem mounts (default: <base-dir.phenix>/mounts)
--store.endpoint string BoltDB store endpoint (bolt://<path>) (default: bolt:///etc/phenix/store.bdb as root, bolt://$HOME/.phenix.bdb otherwise)
--unix-socket string phēnix unix socket to listen on (ui subcommand) or connect to (default "/tmp/phenix.sock")
--use-gre-mesh use GRE tunnels between mesh nodes for VLAN trunking
SEE ALSO¶
- phenix admin - Administration of users, roles and API tokens
- phenix completion - Generate completion script
- phenix config - Configuration file management
- phenix disk - Disk image file management
- phenix doctor - Check the phenix configuration without a running server
- phenix experiment - Experiment management
- phenix healthcheck - Check the health of the phenix UI server
- phenix host - Cluster host management
- phenix image - Virtual disk image management
- phenix job - Background job management
- phenix logs - Show the log entries of the phenix server
- phenix mm - Send commands, or attach, to minimega
- phenix settings - View, list, or edit phenix system settings
- phenix ui - Run the phenix UI
- phenix util - Utility commands
- phenix version - Print version information
- phenix vlan - Used to manage VLANs
- phenix vm - Virtual machine management
- phenix workflow - Workflow management