db162cf2b1
New tables have been included in the config ref and existing *aas options have been moved to the same file for consistency. Change-Id: I7836b7d1358ada1b1392a96581a92551df4cf7b3 Closes-Bug: #1460851 Closes-Bug: #1439648 Partial-Bug: #1452738 Closes-Bug: #1455237 Closes-Bug: #1469932 Closes-Bug: #1470371
247 lines
12 KiB
XML
247 lines
12 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_neutron_nsx">
|
|
<caption>Description of VMware NSX 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>conn_idle_timeout</option> = <replaceable>900</replaceable></td>
|
|
<td>(IntOpt) Reconnect connection to nsx if not used within this amount of time.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>default_service_cluster_uuid</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Unique identifier of the Service Cluster which will be used by logical services like dhcp and metadata</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>default_tz_uuid</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) This is uuid of the default NSX Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NSX before starting Neutron with the nsx plugin.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>http_timeout</option> = <replaceable>75</replaceable></td>
|
|
<td>(IntOpt) Time before aborting a request</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_controllers</option> = <replaceable>None</replaceable></td>
|
|
<td>(ListOpt) Lists the NSX controllers in this cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_password</option> = <replaceable>admin</replaceable></td>
|
|
<td>(StrOpt) Password for NSX controllers in this cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_user</option> = <replaceable>admin</replaceable></td>
|
|
<td>(StrOpt) User name for NSX controllers in this cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>redirects</option> = <replaceable>2</replaceable></td>
|
|
<td>(IntOpt) Number of times a redirect should be followed</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>retries</option> = <replaceable>2</replaceable></td>
|
|
<td>(IntOpt) Number of time a request should be retried</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[NSX]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>agent_mode</option> = <replaceable>agent</replaceable></td>
|
|
<td>(StrOpt) The mode used to implement DHCP/metadata services.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>concurrent_connections</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Maximum concurrent connections to each NSX controller.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>default_transport_type</option> = <replaceable>stt</replaceable></td>
|
|
<td>(StrOpt) The default network tranport type to use (stt, gre, bridge, ipsec_gre, or ipsec_stt)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_lp_per_bridged_ls</option> = <replaceable>5000</replaceable></td>
|
|
<td>(IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 5000)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_lp_per_overlay_ls</option> = <replaceable>256</replaceable></td>
|
|
<td>(IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 256)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>metadata_mode</option> = <replaceable>access_network</replaceable></td>
|
|
<td>(StrOpt) If set to access_network this enables a dedicated connection to the metadata proxy for metadata server access via Neutron router. If set to dhcp_host_route this enables host route injection via the dhcp agent. This option is only useful if running on a host that does not support namespaces otherwise access_network should be used.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_gen_timeout</option> = <replaceable>-1</replaceable></td>
|
|
<td>(IntOpt) Number of seconds a generation id should be valid for (default -1 meaning do not time out)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>replication_mode</option> = <replaceable>service</replaceable></td>
|
|
<td>(StrOpt) The default option leverages service nodes to perform packet replication though one could set to this to 'source' to perform replication locally. This is useful if one does not want to deploy a service node(s). It must be set to 'service' for leveraging distributed routers.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[NSX_SYNC]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>always_read_status</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Always read operational status from backend on show operations. Enabling this option might slow down the system.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_random_sync_delay</option> = <replaceable>0</replaceable></td>
|
|
<td>(IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>min_chunk_size</option> = <replaceable>500</replaceable></td>
|
|
<td>(IntOpt) Minimum number of resources to be retrieved from NSX during state synchronization</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>min_sync_req_delay</option> = <replaceable>1</replaceable></td>
|
|
<td>(IntOpt) Minimum delay, in seconds, between two state synchronization queries to NSX. It must not exceed state_sync_interval</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>state_sync_interval</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[nsx_v3]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>default_edge_cluster_uuid</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Default edge cluster identifier</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_password</option> = <replaceable>default</replaceable></td>
|
|
<td>(StrOpt) Password for NSX controllers in this cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nsx_user</option> = <replaceable>admin</replaceable></td>
|
|
<td>(StrOpt) User name for NSX controllers in this cluster</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[nsxv]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>backup_edge_pool</option> = <replaceable>service:large:4:10, service:compact:4:10, vdr:large:4:10</replaceable></td>
|
|
<td>(ListOpt) Defines edge pool using the format: <edge_type>:[edge_size]:<min_edges>:<max_edges>.edge_type: service,vdr. edge_size: compact, large, xlarge, quadlarge and default is large.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>cluster_moid</option> = <replaceable></replaceable></td>
|
|
<td>(ListOpt) Parameter listing the IDs of the clusters which are used by OpenStack.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>datacenter_moid</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>datastore_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>deployment_container_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>dhcp_lease_time</option> = <replaceable>86400</replaceable></td>
|
|
<td>(IntOpt) DHCP default lease time.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>dvs_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) DVS ID for VLANs</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>edge_appliance_password</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Password to configure for Edge appliance login</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>edge_appliance_user</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Username to configure for Edge appliance login</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>external_network</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Network ID for physical network connectivity</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>locking_coordinator_url</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) A URL to a locking mechanism coordinator</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>manager_uri</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) uri for vsm</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>maximum_tunnels_per_vnic</option> = <replaceable>20</replaceable></td>
|
|
<td>(IntOpt) Maximum number of sub interfaces supported per vnic in edge. The value should be in 1-110.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>metadata_shared_secret</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Shared secret to sign metadata requests</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mgt_net_default_gateway</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Management network default gateway for metadata proxy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mgt_net_moid</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Network ID for management network connectivity</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mgt_net_proxy_ips</option> = <replaceable>None</replaceable></td>
|
|
<td>(ListOpt) Management network IP address for metadata proxy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mgt_net_proxy_netmask</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Management network netmask for metadata proxy</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nova_metadata_ips</option> = <replaceable>None</replaceable></td>
|
|
<td>(ListOpt) IP addresses used by Nova metadata service</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>nova_metadata_port</option> = <replaceable>8775</replaceable></td>
|
|
<td>(IntOpt) TCP Port used by Nova metadata server</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>password</option> = <replaceable>default</replaceable></td>
|
|
<td>(StrOpt) Password for vsm</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>resource_pool_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>retries</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Maximum number of API retries on endpoint.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>spoofguard_enabled</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) If True then plugin will use NSXV spoofguard component for port-security feature.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>task_status_check_interval</option> = <replaceable>2000</replaceable></td>
|
|
<td>(IntOpt) Task status check interval</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>tenant_router_types</option> = <replaceable>shared, distributed, exclusive</replaceable></td>
|
|
<td>(ListOpt) Ordered list of router_types to allocate as tenant routers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>user</option> = <replaceable>admin</replaceable></td>
|
|
<td>(StrOpt) User name for vsm</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>vdn_scope_id</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) Network scope ID for VXLAN virtual wires</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|