OS Manuals

/opt/chainguard/openstack-nova-2025.2/bin/nova-spicehtml5proxy

OpenStack Compute (Nova) — 2025.2 Flamingo

From openstack-nova-2025.2 32.2.0_git20261104-r4 (enterprise-packages), captured 2026-11-08 by running nova-spicehtml5proxy --help (exit 0). permalink

usage: nova-spicehtml5proxy [-h] [--cert CERT] [--config-dir DIR] [--config-file PATH] [--daemon]
                            [--debug] [--key KEY] [--log-config-append PATH]
                            [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH]
                            [--nodaemon] [--nodebug] [--nosource_is_ipv6] [--nossl_only]
                            [--nouse-journal] [--nouse-json] [--nouse-syslog] [--nowatch-log-file]
                            [--record RECORD] [--shell_completion SHELL_COMPLETION]
                            [--source_is_ipv6] [--ssl_only]
                            [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
                            [--use-json] [--use-syslog] [--version] [--watch-log-file] [--web WEB]
                            [--spice-html5proxy_host SPICE_HTML5PROXY_HOST]
                            [--spice-html5proxy_port SPICE_HTML5PROXY_PORT]

options:
  -h, --help            show this help message and exit
  --cert CERT           Path to SSL certificate file. Related options: * key * ssl_only *
                        [console] ssl_ciphers * [console] ssl_minimum_version
  --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. This option
                        must be set from the command-line.
  --daemon              Run as a background process.
  --debug, -d           If set to true, the logging level will be set to DEBUG instead of the
                        default INFO level.
  --key KEY             SSL key file (if separate from cert). Related options: * cert
  --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. Note
                        that 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).
  --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.
  --nodaemon            The inverse of --daemon
  --nodebug             The inverse of --debug
  --nosource_is_ipv6    The inverse of --source_is_ipv6
  --nossl_only          The inverse of --ssl_only
  --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
  --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.
  --shell_completion SHELL_COMPLETION
                        Display a shell completion script Allowed values: bash, zsh
  --source_is_ipv6      Set to True if source host is addressed with IPv6.
  --ssl_only            Disallow non-encrypted connections. Related options: * cert * key
  --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
  --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.
  --web WEB             Path to directory with content which will be served by a web server.

SPICE console features:
  SPICE console feature allows you to connect to a guest virtual machine. SPICE is a replacement
  for fairly limited VNC protocol. Following requirements must be met in order to use SPICE: *
  Virtualization driver must be libvirt * spice.enabled set to True * vnc.enabled set to False *
  update html5proxy_base_url * update server_proxyclient_address

  --spice-html5proxy_host SPICE_HTML5PROXY_HOST
                        IP address or a hostname on which the ``nova-spicehtml5proxy`` service
                        listens for incoming requests. Related options: * This option depends on
                        the ``html5proxy_base_url`` option. The ``nova-spicehtml5proxy`` service
                        must be listening on a host that is accessible from the HTML5 client.
  --spice-html5proxy_port SPICE_HTML5PROXY_PORT
                        Port on which the ``nova-spicehtml5proxy`` service listens for incoming
                        requests. Related options: * This option depends on the
                        ``html5proxy_base_url`` option. The ``nova-spicehtml5proxy`` service must
                        be listening on a port that is accessible from the HTML5 client.
Options (29)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--cert CERTPath to SSL certificate file.help
--config-dir DIRPath to a config directory to pull `*.conf` files from.help
--config-file PATHPath to a config file to use.help
--daemonRun as a background process.help
--debug, -dIf set to true, the logging level will be set to DEBUG instead of the default INFO level.help
--key KEYSSL key file (if separate from cert).help
--log-date-format DATE_FORMATDefines the format string for %(asctime)s in log records.help
--nodaemonThe inverse of --daemonhelp
--nodebugThe inverse of --debughelp
--nosource_is_ipv6The inverse of --source_is_ipv6help
--nossl_onlyThe inverse of --ssl_onlyhelp
--nouse-journalThe inverse of --use-journalhelp
--nouse-jsonThe inverse of --use-jsonhelp
--nouse-syslogThe inverse of --use-sysloghelp
--nowatch-log-fileThe inverse of --watch-log-filehelp
--record RECORDFilename that will be used for storing websocket frames received and sent by a proxy service (like VNC, spice, serial) running on this host.help
--shell_completion SHELL_COMPLETIONDisplay a shell completion script Allowed values: bash, zshhelp
--source_is_ipv6Set to True if source host is addressed with IPv6.help
--ssl_onlyDisallow non-encrypted connections.help
--syslog-log-facility SYSLOG_LOG_FACILITYSyslog facility to receive log lines.help
--use-journalEnable journald for logging.help
--use-jsonUse JSON formatting for logging.help
--use-syslogUse syslog for logging.help
--versionshow program's version number and exithelp
--watch-log-fileUses logging handler designed to watch file system.help
--web WEBPath to directory with content which will be served by a web server.help
--spice-html5proxy_host SPICE_HTML5PROXY_HOSTIP address or a hostname on which the ``nova-spicehtml5proxy`` service listens for incoming requests.help
--spice-html5proxy_port SPICE_HTML5PROXY_PORTPort on which the ``nova-spicehtml5proxy`` service listens for incoming requests.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.