OS Manuals

/usr/bin/nova-novncproxy

Nova noVNC console proxy (Kolla nova-novncproxy image)

From openstack-nova-2025.1-novncproxy 31.3.0_git20260717-r22 (enterprise-packages), captured 2026-11-08 by running nova-novncproxy --help (exit 0). permalink

Also provided by 2 other package versions
usage: nova-novncproxy [-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]
                       [--vnc-auth_schemes VNC_AUTH_SCHEMES]
                       [--vnc-novncproxy_host VNC_NOVNCPROXY_HOST]
                       [--vnc-novncproxy_port VNC_NOVNCPROXY_PORT]
                       [--vnc-vencrypt_ca_certs VNC_VENCRYPT_CA_CERTS]
                       [--vnc-vencrypt_client_cert VNC_VENCRYPT_CLIENT_CERT]
                       [--vnc-vencrypt_client_key VNC_VENCRYPT_CLIENT_KEY]
                       [--remote_debug-host REMOTE_DEBUG_HOST]
                       [--remote_debug-port REMOTE_DEBUG_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.

VNC options:
  Virtual Network Computer (VNC) can be used to provide remote desktop console access to
  instances for tenants and/or administrators.

  --vnc-auth_schemes VNC_AUTH_SCHEMES
                        The authentication schemes to use with the compute node. Control what RFB
                        authentication schemes are permitted for connections between the proxy and
                        the compute host. If multiple schemes are enabled, the first matching
                        scheme will be used, thus the strongest schemes should be listed first.
                        Related options: * ``[vnc]vencrypt_client_key``,
                        ``[vnc]vencrypt_client_cert``: must also be set
  --vnc-novncproxy_host VNC_NOVNCPROXY_HOST
                        IP address that the noVNC console proxy should bind to. The VNC proxy is
                        an OpenStack component that enables compute service users to access their
                        instances through VNC clients. noVNC provides VNC support through a
                        websocket-based client. This option sets the private address to which the
                        noVNC console proxy service should bind to. Related options: *
                        novncproxy_port * novncproxy_base_url
  --vnc-novncproxy_port VNC_NOVNCPROXY_PORT
                        Port that the noVNC console proxy should bind to. The VNC proxy is an
                        OpenStack component that enables compute service users to access their
                        instances through VNC clients. noVNC provides VNC support through a
                        websocket-based client. This option sets the private port to which the
                        noVNC console proxy service should bind to. Related options: *
                        novncproxy_host * novncproxy_base_url
  --vnc-vencrypt_ca_certs VNC_VENCRYPT_CA_CERTS
                        The path to the CA certificate PEM file The fully qualified path to a PEM
                        file containing one or more x509 certificates for the certificate
                        authorities used by the compute node VNC server. Related options: *
                        ``vnc.auth_schemes``: must include ``vencrypt``
  --vnc-vencrypt_client_cert VNC_VENCRYPT_CLIENT_CERT
                        The path to the client key file (for x509) The fully qualified path to a
                        PEM file containing the x509 certificate which the VNC proxy server
                        presents to the compute node during VNC authentication. Related options: *
                        ``vnc.auth_schemes``: must include ``vencrypt`` *
                        ``vnc.vencrypt_client_key``: must also be set
  --vnc-vencrypt_client_key VNC_VENCRYPT_CLIENT_KEY
                        The path to the client certificate PEM file (for x509) The fully qualified
                        path to a PEM file containing the private key which the VNC proxy server
                        presents to the compute node during VNC authentication. Related options: *
                        ``vnc.auth_schemes``: must include ``vencrypt`` *
                        ``vnc.vencrypt_client_cert``: must also be set

debugger options:
  --remote_debug-host REMOTE_DEBUG_HOST
                        Debug host (IP or name) to connect to. This command line parameter is used
                        when you want to connect to a nova service via a debugger running on a
                        different host. Note that using the remote debug option changes how nova
                        uses the eventlet library to support async IO. This could result in
                        failures that do not occur under normal operation. Use at your own risk.
                        Possible Values: * IP address of a remote host as a command line parameter
                        to a nova service. For example:: nova-compute --config-file
                        /etc/nova/nova.conf --remote_debug-host <IP address of the debugger>
  --remote_debug-port REMOTE_DEBUG_PORT
                        Debug port to connect to. This command line parameter allows you to
                        specify the port you want to use to connect to a nova service via a
                        debugger running on different host. Note that using the remote debug
                        option changes how nova uses the eventlet library to support async IO.
                        This could result in failures that do not occur under normal operation.
                        Use at your own risk. Possible Values: * Port number you want to use as a
                        command line parameter to a nova service. For example:: nova-compute
                        --config-file /etc/nova/nova.conf --remote_debug-host <IP address of the
                        debugger> --remote_debug-port <port debugger is listening on>.
Options (35)
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
--vnc-auth_schemes VNC_AUTH_SCHEMESThe authentication schemes to use with the compute node.help
--vnc-novncproxy_host VNC_NOVNCPROXY_HOSTIP address that the noVNC console proxy should bind to.help
--vnc-novncproxy_port VNC_NOVNCPROXY_PORTPort that the noVNC console proxy should bind to.help
--vnc-vencrypt_ca_certs VNC_VENCRYPT_CA_CERTSThe path to the CA certificate PEM file The fully qualified path to a PEM file containing one or more x509 certificates for the certificate authorities used by the compute node VNC server.help
--vnc-vencrypt_client_cert VNC_VENCRYPT_CLIENT_CERTThe path to the client key file (for x509) The fully qualified path to a PEM file containing the x509 certificate which the VNC proxy server presents to the compute node during VNC authentication.help
--vnc-vencrypt_client_key VNC_VENCRYPT_CLIENT_KEYThe path to the client certificate PEM file (for x509) The fully qualified path to a PEM file containing the private key which the VNC proxy server presents to the compute node during VNC…help
--remote_debug-host REMOTE_DEBUG_HOSTDebug host (IP or name) to connect to.help
--remote_debug-port REMOTE_DEBUG_PORTDebug port to connect to.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.