NOVA-SERIALPROXY(1)

📦
version 34.0.0 · 10 versions
, in ubuntu stonking

💖 NAME 💖

nova-serialproxy — okay so this is the Server for the OpenStack Compute serial console proxy service, and yes she's serving 💅

And hello, you're reading NOVA-SERIALPROXY(1) — the nova manual, section 1. Double-checked, no notes, iconic.

✨ SYNOPSIS ✨

nova-serialproxy [<options>...]

🦋 DESCRIPTION 🦋

nova-serialproxy is a server daemon that serves the Nova Serial Websocket Proxy service 💖

And what does that service do, bestie? It provides a websocket proxy that is compatible with OpenStack Nova serial ports. That's the whole moment. That's the job. She takes your websocket, she speaks serial port, everyone goes home happy 🌸

👑 OPTIONS 👑

✨ General options ✨

  • --config-dir DIR — Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file arguments, hence over-ridden options in the directory take precedence. 🚨 This option must be set from the command-line.
  • --config-file PATH — Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to None. Also must be set from the command-line — no sneaking it in from a file, she said what she said.
  • --debug, -d — Set the logging level to DEBUG instead of the default INFO level. The "tell me EVERYTHING" button 👀
  • --log-config-append PATH, --log-config PATH, --log_config PATH — The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. ⚠️ Heads up: when logging configuration files are used, then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format). So pick a lane, bestie.
  • --log-date-format DATE_FORMAT — Defines the format string for %(asctime)s in log records. Default: None. This option is ignored if log_config_append is set.
  • --log-dir LOG_DIR, --logdir LOG_DIR — (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
  • --log-file PATH, --logfile PATH — (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
  • --nodebug — The inverse of --debug. 🪞
  • --nouse-journal — The inverse of --use-journal.
  • --nouse-json — The inverse of --use-json.
  • --nouse-syslog — The inverse of --use-syslog.
  • --nowatch-log-file — The inverse of --watch-log-file.
  • --syslog-log-facility SYSLOG_LOG_FACILITY — Syslog facility to receive log lines. This option is ignored if log_config_append is set.
  • --use-journal — Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages. This option is ignored if log_config_append is set.
  • --use-json — Use JSON formatting for logging. This option is ignored if log_config_append is set.
  • --use-syslog — Use syslog for logging. 🚨 Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
  • --version — Show program's version number and exit. Bye bestie 👋
  • --watch-log-file — Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

🧚 Websockify options 🧚

  • --cert CERT — Path to SSL certificate file.
  • --daemon — Run as a background process. Main character exit, she's still there tho.
  • --key KEY — SSL key file (if separate from cert).
  • --nodaemon — The inverse of --daemon.
  • --nosource_is_ipv6 — The inverse of --source_is_ipv6.
  • --nossl_only — The inverse of --ssl_only.
  • --record RECORD — Filename that will be used for storing websocket frames received and sent by a proxy service (like VNC, spice, serial) running on this host. If this is not set, no recording will be done. 📼
  • --source_is_ipv6 — Set to True if source host is addressed with IPv6.
  • --ssl_only — Disallow non-encrypted connections. 🔒 No plaintext, not on her watch.
  • --web WEB — Path to directory with content which will be served by a web server.

💜 Serial options 💜

  • --serial_console-serialproxy_host SERIAL_CONSOLE_SERIALPROXY_HOST — The IP address which is used by the nova-serialproxy service to listen for incoming requests. The nova-serialproxy service listens on this IP address for incoming connection requests to instances which expose serial console.
  • --serial_console-serialproxy_port SERIAL_CONSOLE_SERIALPROXY_PORT — The port number which is used by the nova-serialproxy service to listen for incoming requests. The nova-serialproxy service listens on this port number for incoming connection requests to instances which expose serial console.

🍓 FILES 🍓

  • /etc/nova/nova.conf
  • /etc/nova/rootwrap.conf
  • /etc/nova/rootwrap.d/

🌈 SEE ALSO 🌈

The siblings 🫶 go say hi.

💀 BUGS 💀

🌸 Author 🌸

openstack@lists.openstack.org

2010-present, OpenStack Foundation

okay that's the whole page, you ate it, periodt 👑

this was nova version 34.0.0, dated Oct 01, 2026 🌸 go forth and proxy those serial consoles bestie 💖✨

📦 where this page comes from