openstack-manuals/doc/common/tables/nova-vnc.xml
Gauvain Pocentek cdebb041d5 [config-ref] Nova option tables update
Partial-Bug: #1472417
Closes-Bug: #1465841
Partial-Bug: #1461459
Partial-Bug: #1454356
Closes-Bug: #1450002

Change-Id: I1ce5933ce20d2021f4286ca965823483940157fe
2015-07-19 17:01:07 +02:00

93 lines
3.6 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_vnc">
<caption>Description of VNC configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>daemon</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Become a daemon (background process)</td>
</tr>
<tr>
<td><option>key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) SSL key file (if separate from cert)</td>
</tr>
<tr>
<td><option>novncproxy_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Host on which to listen for incoming requests</td>
</tr>
<tr>
<td><option>novncproxy_port</option> = <replaceable>6080</replaceable></td>
<td>(IntOpt) Port on which to listen for incoming requests</td>
</tr>
<tr>
<td><option>record</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Record sessions to FILE.[session_number]</td>
</tr>
<tr>
<td><option>source_is_ipv6</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Source is ipv6</td>
</tr>
<tr>
<td><option>ssl_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disallow non-encrypted connections</td>
</tr>
<tr>
<td><option>web</option> = <replaceable>/usr/share/spice-html5</replaceable></td>
<td>(StrOpt) Run webserver on same port. Serve files from DIR.</td>
</tr>
<tr>
<th colspan="2">[vmware]</th>
</tr>
<tr>
<td><option>vnc_port</option> = <replaceable>5900</replaceable></td>
<td>(IntOpt) VNC starting port</td>
</tr>
<tr>
<td><option>vnc_port_total</option> = <replaceable>10000</replaceable></td>
<td>(IntOpt) Total number of VNC ports</td>
</tr>
<tr>
<th colspan="2">[vnc]</th>
</tr>
<tr>
<td><option>enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable VNC related features</td>
</tr>
<tr>
<td><option>keymap</option> = <replaceable>en-us</replaceable></td>
<td>(StrOpt) Keymap for VNC</td>
</tr>
<tr>
<td><option>novncproxy_base_url</option> = <replaceable>http://127.0.0.1:6080/vnc_auto.html</replaceable></td>
<td>(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"</td>
</tr>
<tr>
<td><option>vncserver_listen</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) IP address on which instance vncservers should listen</td>
</tr>
<tr>
<td><option>vncserver_proxyclient_address</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect</td>
</tr>
<tr>
<td><option>xvpvncproxy_base_url</option> = <replaceable>http://127.0.0.1:6081/console</replaceable></td>
<td>(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"</td>
</tr>
</tbody>
</table>
</para>