diff --git a/doc/common/tables/neutron-agent.xml b/doc/common/tables/neutron-agent.xml index 1964d11663..42ab110180 100644 --- a/doc/common/tables/neutron-agent.xml +++ b/doc/common/tables/neutron-agent.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-api.xml b/doc/common/tables/neutron-api.xml index f312699d73..99aa02184a 100644 --- a/doc/common/tables/neutron-api.xml +++ b/doc/common/tables/neutron-api.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-bigswitch.xml b/doc/common/tables/neutron-bigswitch.xml index 63dd1a7fa3..abe3ae5ddc 100644 --- a/doc/common/tables/neutron-bigswitch.xml +++ b/doc/common/tables/neutron-bigswitch.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -24,7 +24,7 @@ (IntOpt) Maximum number of router rules - neutron_id=neutron-docwork + neutron_id=neutron-autodoc (StrOpt) User defined identifier for this Neutron deployment diff --git a/doc/common/tables/neutron-brocade.xml b/doc/common/tables/neutron-brocade.xml index 8a58a7387e..84ea96ee4c 100644 --- a/doc/common/tables/neutron-brocade.xml +++ b/doc/common/tables/neutron-brocade.xml @@ -11,50 +11,30 @@ Configuration option=Default value - (Type) Description + Description address= - (StrOpt) No help text available for this option + (StrOpt) The address of the host to SSH to ostype=NOS - (StrOpt) No help text available for this option + (StrOpt) Currently unused password=None - (StrOpt) Password for Redis server. (optional) - - - password=passw0rd - (StrOpt) MidoNet admin password. - - - password= - (StrOpt) No help text available for this option - - - password=password - (StrOpt) PLUMgrid Director admin password + (StrOpt) HTTP password for authentication physical_interface=eth0 - (StrOpt) No help text available for this option + (StrOpt) The network interface to use when creatinga port - username=admin - (StrOpt) MidoNet admin username. - - - username= - (StrOpt) No help text available for this option - - - username=username - (StrOpt) PLUMgrid Director admin username + username=None + (StrOpt) HTTP username for authentication - \ No newline at end of file + diff --git a/doc/common/tables/neutron-cisco.xml b/doc/common/tables/neutron-cisco.xml index 0d6c37d8c2..0c46ad8e50 100644 --- a/doc/common/tables/neutron-cisco.xml +++ b/doc/common/tables/neutron-cisco.xml @@ -11,26 +11,30 @@ Configuration option=Default value - (Type) Description + Description - host=docwork + default_network_profile=default_network_profile + (StrOpt) N1K default network profile + + + default_policy_profile=service_profile + (StrOpt) N1K default policy profile + + + host=autodoc (StrOpt) The hostname Neutron is running on - - host=127.0.0.1 - (StrOpt) Host to locate redis - - - host=127.0.0.1 - (StrOpt) Host to connect to - model_class=neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2 (StrOpt) Model Class + + network_node_policy_profile=dhcp_pp + (StrOpt) N1K policy profile for network node + nexus_driver=neutron.plugins.cisco.test.nexus.fake_nexus_driver.CiscoNEXUSFakeDriver (StrOpt) Nexus Driver Name @@ -39,6 +43,10 @@ nexus_plugin=neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin (StrOpt) Nexus Switch to use + + poll_duration=10 + (StrOpt) N1K Policy profile polling duration in seconds + provider_vlan_auto_create=True (BoolOpt) Provider VLANs are automatically created as needed on the Nexus switch @@ -55,6 +63,14 @@ svi_round_robin=False (BoolOpt) Distribute SVI interfaces over all switches + + svi_round_robin=False + (BoolOpt) Distribute SVI interfaces over all switches + + + vlan_name_prefix=q- + (StrOpt) VLAN Name prefix + vlan_name_prefix=q- (StrOpt) VLAN Name prefix @@ -63,6 +79,10 @@ vswitch_plugin=neutron.plugins.openvswitch.ovs_neutron_plugin.OVSNeutronPluginV2 (StrOpt) Virtual Switch to use + + vxlan_id_ranges=5000:10000 + (StrOpt) N1K VXLAN ID Ranges + - \ No newline at end of file + diff --git a/doc/common/tables/neutron-common.xml b/doc/common/tables/neutron-common.xml index f582019ddb..ea11c9ea0f 100644 --- a/doc/common/tables/neutron-common.xml +++ b/doc/common/tables/neutron-common.xml @@ -11,13 +11,13 @@ Configuration option=Default value - (Type) Description + Description admin_password=None - (StrOpt) Admin password + (StrOpt) ESM admin password. admin_tenant_name=None @@ -39,10 +39,6 @@ auth_strategy=keystone (StrOpt) The type of authentication to use - - auth_strategy=keystone - (StrOpt) The type of authentication to use - auth_url=None (StrOpt) Authentication URL @@ -68,7 +64,7 @@ (BoolOpt) Allow sending resource operation notification to DHCP agent - dhcp_lease_duration=120 + dhcp_lease_duration=86400 (IntOpt) DHCP lease duration @@ -80,17 +76,9 @@ (BoolOpt) Ensure that configured gateway is on subnet - host=docwork + host=autodoc (StrOpt) The hostname Neutron is running on - - host=127.0.0.1 - (StrOpt) Host to locate redis - - - host=127.0.0.1 - (StrOpt) Host to connect to - lock_path=None (StrOpt) Directory to use for lock files. Default to a temp directory @@ -111,6 +99,14 @@ max_subnet_host_routes=20 (IntOpt) Maximum number of host routes per subnet + + meta_flavor_driver_mappings=None + (StrOpt) Mapping between flavor and LinuxInterfaceDriver + + + network_device_mtu=None + (IntOpt) MTU setting for device. + network_vlan_ranges= (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> @@ -123,6 +119,10 @@ network_vlan_ranges=d,,,e,,,f,,,a,,,u,,,l,,,t,,,:,,,1,,,:,,,1,,,0,,,0,,,0 (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> + + network_vlan_ranges=vlan:1:4095 + (StrOpt) N1K Network VLAN Ranges + network_vlan_ranges= (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> @@ -131,9 +131,17 @@ network_vlan_ranges= (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. + + ovs_integration_bridge=br-int + (StrOpt) Name of Open vSwitch bridge to use + + + ovs_use_veth=False + (BoolOpt) Uses veth for an interface or not + periodic_fuzzy_delay=5 - (IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) periodic_interval=40 @@ -153,4 +161,4 @@ - \ No newline at end of file + diff --git a/doc/common/tables/neutron-db.xml b/doc/common/tables/neutron-db.xml index 482d8b8ce3..b04b1e9941 100644 --- a/doc/common/tables/neutron-db.xml +++ b/doc/common/tables/neutron-db.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-embrane.xml b/doc/common/tables/neutron-embrane.xml new file mode 100644 index 0000000000..0d790dab34 --- /dev/null +++ b/doc/common/tables/neutron-embrane.xml @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for embrane
Configuration option=Default valueDescription
admin_username=admin(StrOpt) ESM admin username.
async_requests=True(BoolOpt) Define if the requests have run asynchronously or not
dummy_utif_id=None(StrOpt) Dummy user traffic Security Zone id
esm_mgmt=None(StrOpt) ESM management root address
inband_id=None(StrOpt) In band Security Zone id
mgmt_id=None(StrOpt) Management Security Zone id
oob_id=None(StrOpt) Out of band Security Zone id
resource_pool_id=None(StrOpt) Optional parameter identifying the ID of resource to deploy NSX Edges
resource_pool_id=default(StrOpt) Shared resource pool id
router_image=None(StrOpt) Router image id (Embrane FW/VPN)
+ \ No newline at end of file diff --git a/doc/common/tables/neutron-fwaas.xml b/doc/common/tables/neutron-fwaas.xml new file mode 100644 index 0000000000..a8fdc0c9fd --- /dev/null +++ b/doc/common/tables/neutron-fwaas.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + +
Description of configuration options for fwaas
Configuration option=Default valueDescription
enabled=False(BoolOpt) Enable FWaaS
+ \ No newline at end of file diff --git a/doc/common/tables/neutron-hyperv.xml b/doc/common/tables/neutron-hyperv.xml index b6a28c08f6..019d8aa115 100644 --- a/doc/common/tables/neutron-hyperv.xml +++ b/doc/common/tables/neutron-hyperv.xml @@ -11,10 +11,18 @@ Configuration option=Default value - (Type) Description + Description + + enable_metrics_collection=False + (BoolOpt) Enables metrics collections for switch ports by using Hyper-V's metric APIs. Collected data can by retrieved by other apps and services, e.g.: Ceilometer. Requires Hyper-V / Windows Server 2012 and above + + + force_hyperv_utils_v1=False + (BoolOpt) Force V1 WMI utility classes + local_network_vswitch=private (StrOpt) Private vswitch name used for local networks @@ -23,22 +31,6 @@ network_vlan_ranges= (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - - network_vlan_ranges=default:1:1000 - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. - physical_network_vswitch_mappings= (ListOpt) List of <physical_network>:<vswitch> where the physical networks can be expressed with wildcards, e.g.: ."*:external" @@ -53,7 +45,7 @@ tenant_network_type=local - (StrOpt) Network type for tenant networks (local, vlan, or none) + (StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) tenant_network_type=vlan @@ -61,8 +53,12 @@ tenant_network_type=local - (StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) + (StrOpt) N1K Tenant Network Type + + + tenant_network_type=local + (StrOpt) Network type for tenant networks (local, vlan, or none) - \ No newline at end of file + diff --git a/doc/common/tables/neutron-kombu.xml b/doc/common/tables/neutron-kombu.xml index eead0d23b0..27f139bef5 100644 --- a/doc/common/tables/neutron-kombu.xml +++ b/doc/common/tables/neutron-kombu.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-lbaas.xml b/doc/common/tables/neutron-lbaas.xml index 53f7fcdfa5..0c9a09b6bf 100644 --- a/doc/common/tables/neutron-lbaas.xml +++ b/doc/common/tables/neutron-lbaas.xml @@ -11,14 +11,10 @@ Configuration option=Default value - (Type) Description + Description - - driver_fqn=neutron.services.loadbalancer.drivers.haproxy.plugin_driver.HaproxyOnHostPluginDriver - (StrOpt) LBaaS driver Fully Qualified Name - loadbalancer_pool_scheduler_driver=neutron.services.loadbalancer.agent_scheduler.ChanceScheduler (StrOpt) Driver to use for scheduling pool to a default loadbalancer agent diff --git a/doc/common/tables/neutron-linuxbridge.xml b/doc/common/tables/neutron-linuxbridge.xml index cc89c069ae..6f74015f04 100644 --- a/doc/common/tables/neutron-linuxbridge.xml +++ b/doc/common/tables/neutron-linuxbridge.xml @@ -11,10 +11,18 @@ Configuration option=Default value - (Type) Description + Description + + enable_vxlan=False + (BoolOpt) Enable VXLAN on the agent. Can be enabled when agent is managed by ml2 plugin using linuxbridge mechanism driver + + + l2_population=False + (BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability + physical_interface_mappings= (ListOpt) List of <physical_network>:<physical_interface> @@ -29,7 +37,7 @@ tenant_network_type=local - (StrOpt) Network type for tenant networks (local, vlan, or none) + (StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) tenant_network_type=vlan @@ -37,8 +45,24 @@ tenant_network_type=local - (StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) + (StrOpt) N1K Tenant Network Type + + + tenant_network_type=local + (StrOpt) Network type for tenant networks (local, vlan, or none) + + + tos=None + (IntOpt) TOS for vxlan interface protocol packets. + + + ttl=None + (IntOpt) TTL for vxlan interface protocol packets. + + + vxlan_group=224.0.0.1 + (StrOpt) Multicast group for vxlan interface. - \ No newline at end of file + diff --git a/doc/common/tables/neutron-logging.xml b/doc/common/tables/neutron-logging.xml index 471747843c..a9886e66d4 100644 --- a/doc/common/tables/neutron-logging.xml +++ b/doc/common/tables/neutron-logging.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-meta.xml b/doc/common/tables/neutron-meta.xml index b281cdeb44..68008440d4 100644 --- a/doc/common/tables/neutron-meta.xml +++ b/doc/common/tables/neutron-meta.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-metadata.xml b/doc/common/tables/neutron-metadata.xml index 63c04da710..ea628ad4de 100644 --- a/doc/common/tables/neutron-metadata.xml +++ b/doc/common/tables/neutron-metadata.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -23,14 +23,6 @@ auth_strategy=keystone (StrOpt) The type of authentication to use - - metadata_proxy_socket=$state_path/metadata_proxy - (StrOpt) Location of Metadata Proxy UNIX domain socket - - - metadata_router_id=None - (StrOpt) Virtual metadata router ID. - \ No newline at end of file diff --git a/doc/common/tables/neutron-midonet.xml b/doc/common/tables/neutron-midonet.xml index f55cd43fce..d792df997c 100644 --- a/doc/common/tables/neutron-midonet.xml +++ b/doc/common/tables/neutron-midonet.xml @@ -11,10 +11,14 @@ Configuration option=Default value - (Type) Description + Description + + midonet_host_uuid_path=/etc/midolman/host_uuid.properties + (StrOpt) Path to midonet host uuid file + midonet_uri=http://localhost:8080/midonet-api (StrOpt) MidoNet API server URI. @@ -23,22 +27,10 @@ mode=dev (StrOpt) Operational mode. Internal dev use only. - - password=None - (StrOpt) Password for Redis server. (optional) - password=passw0rd (StrOpt) MidoNet admin password. - - password= - (StrOpt) No help text available for this option - - - password=password - (StrOpt) PLUMgrid Director admin password - project_id=77777777-7777-7777-7777-777777777777 (StrOpt) ID of the project that MidoNet admin userbelongs to. @@ -51,14 +43,6 @@ username=admin (StrOpt) MidoNet admin username. - - username= - (StrOpt) No help text available for this option - - - username=username - (StrOpt) PLUMgrid Director admin username - - \ No newline at end of file + diff --git a/doc/common/tables/neutron-ml2.xml b/doc/common/tables/neutron-ml2.xml index 6d5baf50b4..1bb4a161da 100644 --- a/doc/common/tables/neutron-ml2.xml +++ b/doc/common/tables/neutron-ml2.xml @@ -11,10 +11,26 @@ Configuration option=Default value - (Type) Description + Description + + agent_boot_time=180 + (IntOpt) Delay within which agent is expected to update existing ports whent it restarts + + + eapi_host= + (StrOpt) Arista EOS IP address. This is required field.If not set, all communications to Arista EOSwill fail + + + eapi_password= + (StrOpt) Password for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail + + + eapi_username= + (StrOpt) Username for Arista EOS. This is required field.if not set, all communications to Arista EOSwill fail + flat_networks= (ListOpt) List of physical_network names with which flat networks can be created. Use * to allow flat networks with arbitrary physical_network names. @@ -23,22 +39,46 @@ mechanism_drivers= (ListOpt) An ordered list of networking mechanism driver entrypoints to be loaded from the neutron.ml2.mechanism_drivers namespace. + + region_name=RegionOne + (StrOpt) Defines Region Name that is assigned to this OpenStackController. This is useful when multipleOpenStack/Neutron controllers are managing the sameArista HW clusters. Note that this name must match withthe region name registered (or known) to keystoneservice. Authentication with Keysotne is performed byEOS. This is optional. If not set, a value of"RegionOne" is assumed + req_timeout=30 (IntOpt) Total time limit for a cluster request + + sync_interval=180 + (IntOpt) Sync interval in seconds between Neutron plugin andEOS. This interval defines how often thesynchronization is performed. This is an optionalfield. If not set, a value of 180 seconds is assumed + tenant_network_types=local (ListOpt) Ordered list of network_types to allocate as tenant networks. + + timeout=10 + (IntOpt) HTTP timeout in seconds. + type_drivers=local,flat,vlan,gre,vxlan (ListOpt) List of network type driver entrypoints to be loaded from the neutron.ml2.type_drivers namespace. + + url=None + (StrOpt) HTTP URL of Tail-f NCS REST interface. + + + use_fqdn=True + (BoolOpt) Defines if hostnames are sent to Arista EOS as FQDNs("node1.domain.com") or as short names ("node1").This is optional. If not set, a value of "True"is assumed. + vni_ranges= (ListOpt) Comma-separated list of <vni_min>:<vni_max> tuples enumerating ranges of VXLAN VNI IDs that are available for tenant network allocation + + vxlan_group=224.0.0.1 + (StrOpt) Multicast group for vxlan interface. + - \ No newline at end of file + diff --git a/doc/common/tables/neutron-mlnx.xml b/doc/common/tables/neutron-mlnx.xml index 7656db22f1..4101af50cb 100644 --- a/doc/common/tables/neutron-mlnx.xml +++ b/doc/common/tables/neutron-mlnx.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -24,8 +24,8 @@ (IntOpt) The number of milliseconds the agent will wait for response on request to daemon. - vnic_type=direct - (StrOpt) type of VM network interface: direct or hosdev + vnic_type=mlnx_direct + (StrOpt) Type of VM network interface: mlnx_direct or hostdev diff --git a/doc/common/tables/neutron-nec.xml b/doc/common/tables/neutron-nec.xml index 4ff54c365d..1d42926c64 100644 --- a/doc/common/tables/neutron-nec.xml +++ b/doc/common/tables/neutron-nec.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -19,6 +19,10 @@ cert_file=None (StrOpt) Certificate file + + default_router_provider=l3-agent + (StrOpt) Default router provider to use. + driver=trema (StrOpt) Driver to use @@ -28,28 +32,16 @@ (BoolOpt) Enable packet filter - host=docwork + host=autodoc (StrOpt) The hostname Neutron is running on - - host=127.0.0.1 - (StrOpt) Host to locate redis - - - host=127.0.0.1 - (StrOpt) Host to connect to - - - port=6379 - (IntOpt) Use this port to connect to redis host. - port=8888 (StrOpt) Port to connect to - use_ssl=False - (BoolOpt) Enable SSL on the API server + router_providers=l3-agent,openflow + (ListOpt) List of enabled router providers. use_ssl=False @@ -57,4 +49,4 @@ - \ No newline at end of file + diff --git a/doc/common/tables/neutron-nicira.xml b/doc/common/tables/neutron-nicira.xml index d9e2cdc153..1b3cfdab7b 100644 --- a/doc/common/tables/neutron-nicira.xml +++ b/doc/common/tables/neutron-nicira.xml @@ -11,14 +11,26 @@ Configuration option=Default value - (Type) Description + Description + + agent_mode=agent + (StrOpt) The mode used to implement DHCP/metadata services. + concurrent_connections=5 (IntOpt) Maximum concurrent connections + + datacenter_moid=None + (StrOpt) Optional parameter identifying the ID of datacenter to deploy NSX Edges + + + datastore_id=None + (StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges + default_interface_name=breth0 (StrOpt) Name of the interface on a L2 Gateway transport nodewhich should be used by default when setting up a network connection @@ -40,13 +52,21 @@ (StrOpt) This is uuid of the default NVP Transport zone that will be used for creating tunneled isolated "Neutron" networks. It needs to be created in NVP before starting Neutron with the nvp plugin. - enable_metadata_access_network=True - (BoolOpt) Enables dedicated connection to the metadata proxy for metadata server access via Neutron router + deployment_container_id=None + (StrOpt) Optional parameter identifying the ID of datastore to deploy NSX Edges + + + external_network=None + (StrOpt) Network ID for physical network connectivity http_timeout=10 (IntOpt) Time before aborting a request + + manager_uri=None + (StrOpt) uri for vsm + max_lp_per_bridged_ls=64 (IntOpt) Maximum number of ports of a logical switch on a bridged transport zone (default 64) @@ -55,10 +75,22 @@ max_lp_per_overlay_ls=256 (IntOpt) Maximum number of ports of a logical switch on an overlay transport zone (default 64) + + max_random_sync_delay=0 + (IntOpt) Maximum value for the additional random delay in seconds between runs of the state synchronization task + metadata_mode=access_network (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. + + min_chunk_size=500 + (IntOpt) Minimum number of resources to be retrieved from NVP during state synchronization + + + min_sync_req_delay=10 + (IntOpt) Minimum delay, in seconds, between two state synchronization queries to NVP. It must not exceed state_sync_interval + nvp_cluster_uuid=None (StrOpt) Optional paramter identifying the UUID of the cluster in NVP. This can be retrieved from NVP management console "admin" section. @@ -83,10 +115,26 @@ redirects=2 (IntOpt) Number of times a redirect should be followed + + resource_pool_id=default + (StrOpt) Shared resource pool id + retries=2 (IntOpt) Number of time a request should be retried + + state_sync_interval=120 + (IntOpt) Interval in seconds between runs of the state synchronization task. Set it to 0 to disable it + + + task_status_check_interval=2000 + (IntOpt) Task status check interval + + + user=admin + (StrOpt) User name for vsm + - \ No newline at end of file + diff --git a/doc/common/tables/neutron-notifier.xml b/doc/common/tables/neutron-notifier.xml index 4c3cbeca10..e5faed42bb 100644 --- a/doc/common/tables/neutron-notifier.xml +++ b/doc/common/tables/neutron-notifier.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-openvswitch.xml b/doc/common/tables/neutron-openvswitch.xml index d343085147..527d5204fc 100644 --- a/doc/common/tables/neutron-openvswitch.xml +++ b/doc/common/tables/neutron-openvswitch.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -19,6 +19,10 @@ bridge_mappings= (ListOpt) List of <physical_network>:<bridge> + + bridge_mappings= + (StrOpt) N1K Bridge Mappings + enable_tunneling=False (BoolOpt) Enable tunneling support @@ -31,42 +35,26 @@ integration_bridge=br-int (StrOpt) Integration bridge to use + + integration_bridge=br-int + (StrOpt) N1K Integration Bridge + + + l2_population=False + (BoolOpt) Use ml2 l2population mechanism driver to learn remote mac and IPs and improve tunnel scalability + local_ip= (StrOpt) Local IP address of GRE tunnel endpoints. - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> + local_ip= + (StrOpt) Local IP address of the VXLAN endpoints. network_vlan_ranges= (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - network_vlan_ranges=d,e,f,a,u,l,t,:,1,:,1,0,0,0 - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> - - - network_vlan_ranges= - (ListOpt) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network> specifying physical_network names usable for VLAN provider and tenant networks, as well as ranges of VLAN tags on each available for allocation to tenant networks. - - - tenant_network_type=local - (StrOpt) Network type for tenant networks (local, flat, vlan or none) - - - tenant_network_type=local - (StrOpt) Network type for tenant networks (local, vlan, or none) - - - tenant_network_type=vlan - (StrOpt) Network type for tenant networks (local, ib, vlan, or none) - tenant_network_type=local (StrOpt) Network type for tenant networks (local, vlan, gre, vxlan, or none) @@ -79,26 +67,18 @@ tunnel_bridge=br-tun (StrOpt) Tunnel bridge to use - - tunnel_id_ranges= - (ListOpt) List of <tun_min>:<tun_max> - tunnel_id_ranges= (ListOpt) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges of GRE tunnel IDs that are available for tenant network allocation - - tunnel_type= - (StrOpt) The type of tunnels to use when utilizing tunnels, either 'gre' or 'vxlan' - - - tunnel_types= - (ListOpt) Network types supported by the agent (gre and/or vxlan) - veth_mtu=None (IntOpt) MTU size of veth interfaces + + vxlan_udp_port=4789 + (IntOpt) The UDP port to use for VXLAN tunnels. + - \ No newline at end of file + diff --git a/doc/common/tables/neutron-plumgrid.xml b/doc/common/tables/neutron-plumgrid.xml index 7ba330a93b..8ce418abc2 100644 --- a/doc/common/tables/neutron-plumgrid.xml +++ b/doc/common/tables/neutron-plumgrid.xml @@ -11,10 +11,18 @@ Configuration option=Default value - (Type) Description + Description + + director=localhost + (StrOpt) vArmour director ip + + + director_port=443 + (StrOpt) vArmour director port + director_server=localhost (StrOpt) PLUMgrid Director server to connect to @@ -24,16 +32,12 @@ (StrOpt) PLUMgrid Director server port to connect to - password=None - (StrOpt) Password for Redis server. (optional) - - - password=passw0rd - (StrOpt) MidoNet admin password. + password=varmour + (StrOpt) vArmour director password password= - (StrOpt) No help text available for this option + (StrOpt) The SSH password to use password=password @@ -43,18 +47,10 @@ servertimeout=5 (IntOpt) PLUMgrid Director server timeout - - username=admin - (StrOpt) MidoNet admin username. - - - username= - (StrOpt) No help text available for this option - username=username (StrOpt) PLUMgrid Director admin username - \ No newline at end of file + diff --git a/doc/common/tables/neutron-policy.xml b/doc/common/tables/neutron-policy.xml index fd547dc846..1b870b479c 100644 --- a/doc/common/tables/neutron-policy.xml +++ b/doc/common/tables/neutron-policy.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-qpid.xml b/doc/common/tables/neutron-qpid.xml index bca635171c..59599afdd6 100644 --- a/doc/common/tables/neutron-qpid.xml +++ b/doc/common/tables/neutron-qpid.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -47,6 +47,10 @@ qpid_tcp_nodelay=True (BoolOpt) Disable Nagle algorithm + + qpid_topology_version=1 + (IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. + qpid_username= (StrOpt) Username for qpid connection diff --git a/doc/common/tables/neutron-quotas.xml b/doc/common/tables/neutron-quotas.xml index dec72dffe4..cdd99e3817 100644 --- a/doc/common/tables/neutron-quotas.xml +++ b/doc/common/tables/neutron-quotas.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -53,7 +53,7 @@ quota_network_gateway=5 - (IntOpt) number of network gateways allowed per tenant, -1 for unlimited + (IntOpt) Number of network gateways allowed per tenant, -1 for unlimited quota_packet_filter=100 @@ -61,7 +61,7 @@ quota_port=50 - (IntOpt) number of ports allowed per tenant, minus for unlimited + (IntOpt) Number of ports allowed per tenant, minus for unlimited quota_router=10 diff --git a/doc/common/tables/neutron-rabbitmq.xml b/doc/common/tables/neutron-rabbitmq.xml index fb3f80d08d..c283793ebb 100644 --- a/doc/common/tables/neutron-rabbitmq.xml +++ b/doc/common/tables/neutron-rabbitmq.xml @@ -11,14 +11,10 @@ Configuration option=Default value - (Type) Description + Description - - rabbit_durable_queues=False - (BoolOpt) use durable queues in RabbitMQ - rabbit_ha_queues=False (BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option. diff --git a/doc/common/tables/neutron-rpc.xml b/doc/common/tables/neutron-rpc.xml index 77f7a988db..42e7f30f43 100644 --- a/doc/common/tables/neutron-rpc.xml +++ b/doc/common/tables/neutron-rpc.xml @@ -11,26 +11,26 @@ Configuration option=Default value - (Type) Description + Description + + amqp_auto_delete=False + (BoolOpt) Auto-delete queues in amqp. + + + amqp_durable_queues=False + (BoolOpt) Use durable queues in amqp. + control_exchange=neutron (StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid - host=docwork + host=autodoc (StrOpt) The hostname Neutron is running on - - host=127.0.0.1 - (StrOpt) Host to locate redis - - - host=127.0.0.1 - (StrOpt) Host to connect to - matchmaker_heartbeat_freq=300 (IntOpt) Heartbeat frequency @@ -39,25 +39,9 @@ matchmaker_heartbeat_ttl=600 (IntOpt) Heartbeat time-to-live. - - password=None - (StrOpt) Password for Redis server. (optional) - - - password=passw0rd - (StrOpt) MidoNet admin password. - password= - (StrOpt) No help text available for this option - - - password=password - (StrOpt) PLUMgrid Director admin password - - - port=6379 - (IntOpt) Use this port to connect to redis host. + (StrOpt) The SSH password to use port=8888 @@ -97,4 +81,4 @@ - \ No newline at end of file + diff --git a/doc/common/tables/neutron-ryu.xml b/doc/common/tables/neutron-ryu.xml index 5aa30e4d85..6d085c2d3a 100644 --- a/doc/common/tables/neutron-ryu.xml +++ b/doc/common/tables/neutron-ryu.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-scheduler.xml b/doc/common/tables/neutron-scheduler.xml index ecc4fe58a5..e1cbeb15bf 100644 --- a/doc/common/tables/neutron-scheduler.xml +++ b/doc/common/tables/neutron-scheduler.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -25,7 +25,7 @@ router_auto_schedule=True - (BoolOpt) Allow auto scheduling routers to L3 agent. + (BoolOpt) Allow auto scheduling of routers to L3 agent. router_scheduler_driver=neutron.scheduler.l3_agent_scheduler.ChanceScheduler diff --git a/doc/common/tables/neutron-securitygroups.xml b/doc/common/tables/neutron-securitygroups.xml index 7b0bca102a..f57fe82da6 100644 --- a/doc/common/tables/neutron-securitygroups.xml +++ b/doc/common/tables/neutron-securitygroups.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-ssl.xml b/doc/common/tables/neutron-ssl.xml index de928c3ba6..1602dc2b2a 100644 --- a/doc/common/tables/neutron-ssl.xml +++ b/doc/common/tables/neutron-ssl.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-testing.xml b/doc/common/tables/neutron-testing.xml index 14d744aaa5..41443cc367 100644 --- a/doc/common/tables/neutron-testing.xml +++ b/doc/common/tables/neutron-testing.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-vpn.xml b/doc/common/tables/neutron-vpn.xml new file mode 100644 index 0000000000..120e048863 --- /dev/null +++ b/doc/common/tables/neutron-vpn.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for vpn
Configuration option=Default valueDescription
config_base_dir=$state_path/ipsec(StrOpt) Location to store ipsec server config files
ipsec_config_template=/usr/lib/python2.7/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.conf.template(StrOpt) Template file for ipsec configuration
ipsec_secret_template=/usr/lib/python2.7/site-packages/neutron/services/vpn/device_drivers/template/openswan/ipsec.secret.template(StrOpt) Template file for ipsec secret configuration
ipsec_status_check_interval=60(IntOpt) Interval for checking ipsec status
vpn_device_driver=['neutron.services.vpn.device_drivers.ipsec.OpenSwanDriver'](MultiStrOpt) The vpn device drivers Neutron will use
+ \ No newline at end of file diff --git a/doc/common/tables/neutron-wsgi.xml b/doc/common/tables/neutron-wsgi.xml index d7156d5018..65edbc7532 100644 --- a/doc/common/tables/neutron-wsgi.xml +++ b/doc/common/tables/neutron-wsgi.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description diff --git a/doc/common/tables/neutron-zeromq.xml b/doc/common/tables/neutron-zeromq.xml index 4d8110aacd..44777874d5 100644 --- a/doc/common/tables/neutron-zeromq.xml +++ b/doc/common/tables/neutron-zeromq.xml @@ -11,7 +11,7 @@ Configuration option=Default value - (Type) Description + Description @@ -24,7 +24,7 @@ (IntOpt) Number of ZeroMQ contexts, defaults to 1 - rpc_zmq_host=docwork + rpc_zmq_host=autodoc (StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. diff --git a/tools/autogenerate-config-docs/flagmappings/neutron.flagmappings b/tools/autogenerate-config-docs/flagmappings/neutron.flagmappings index e6dacc818d..b944956d5a 100644 --- a/tools/autogenerate-config-docs/flagmappings/neutron.flagmappings +++ b/tools/autogenerate-config-docs/flagmappings/neutron.flagmappings @@ -3,14 +3,20 @@ address brocade admin_password common admin_tenant_name common admin_user common +admin_username embrane +agent_boot_time ml2 agent_down_time agent +agent_mode nicira allow_bulk api allow_overlapping_ips policy allow_pagination api allow_sorting api allowed_rpc_exception_modules common +amqp_auto_delete rpc +amqp_durable_queues rpc api_extensions_path api api_paste_config api +async_requests embrane auth_region common auth_strategy common auth_strategy metadata @@ -24,12 +30,15 @@ bind_port common bridge_mappings openvswitch cert_file nec concurrent_connections nicira +config_base_dir vpn connection db connection_debug db connection_trace db control_exchange rpc core_plugin common daemon_endpoint mlnx +datacenter_moid nicira +datastore_id nicira debug logging default_flavor meta default_interface_name nicira @@ -37,44 +46,64 @@ default_l2_gw_service_uuid nicira default_l3_flavor meta default_l3_gw_service_uuid nicira default_log_levels logging +default_network_profile cisco default_notification_level notifier +default_policy_profile cisco default_publisher_id notifier default_quota quotas +default_router_provider nec default_transport_type nicira default_tz_uuid nicira +deployment_container_id nicira dhcp_agent_notification common dhcp_agents_per_network db dhcp_lease_duration common +director plumgrid +director_port plumgrid director_server plumgrid director_server_port plumgrid disable_process_locking common driver nec -driver_fqn lbaas -enable_metadata_access_network nicira +dummy_utif_id embrane +eapi_host ml2 +eapi_password ml2 +eapi_username ml2 +enable_metrics_collection hyperv enable_packet_filter nec enable_tunneling openvswitch +enable_vxlan linuxbridge +enabled fwaas +esm_mgmt embrane extension_map meta +external_network nicira external_pids agent fake_rabbit testing fatal_deprecations logging firewall_driver securitygroups flat_networks ml2 force_gateway_on_subnet common +force_hyperv_utils_v1 hyperv host cisco host common host nec host rpc http_timeout nicira idle_timeout db +inband_id embrane instance_format logging instance_uuid_format logging int_peer_patch_port openvswitch integration_bridge openvswitch +ipsec_config_template vpn +ipsec_secret_template vpn +ipsec_status_check_interval vpn key_file ssl kombu_ssl_ca_certs kombu kombu_ssl_certfile kombu kombu_ssl_keyfile kombu kombu_ssl_version kombu +l2_population linuxbridge +l2_population openvswitch l3_plugin_list meta loadbalancer_pool_scheduler_driver lbaas local_ip openvswitch @@ -90,6 +119,7 @@ logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging mac_generation_retries common +manager_uri nicira matchmaker_heartbeat_freq rpc matchmaker_heartbeat_ttl rpc max_dns_nameservers common @@ -98,19 +128,26 @@ max_lp_per_bridged_ls nicira max_lp_per_overlay_ls nicira max_overflow db max_pool_size db +max_random_sync_delay nicira max_retries db max_router_rules bigswitch max_routes quotas max_subnet_host_routes common mechanism_drivers ml2 +meta_flavor_driver_mappings common metadata_mode nicira metadata_proxy_socket metadata -metadata_router_id metadata +mgmt_id embrane +midonet_host_uuid_path midonet midonet_uri midonet +min_chunk_size nicira min_pool_size db +min_sync_req_delay nicira mode midonet model_class cisco network_auto_schedule scheduler +network_device_mtu common +network_node_policy_profile cisco network_scheduler_driver scheduler network_vlan_ranges common network_vlan_ranges hyperv @@ -134,8 +171,11 @@ nvp_controllers nicira nvp_gen_timeout nicira nvp_password nicira nvp_user nicira +oob_id embrane openflow_rest_api ryu ostype brocade +ovs_integration_bridge common +ovs_use_veth common ovsdb_interface ryu ovsdb_ip ryu ovsdb_port ryu @@ -151,6 +191,7 @@ physical_interface_mappings linuxbridge physical_network_vswitch_mappings hyperv plugin_list meta policy_file policy +poll_duration cisco polling_interval hyperv pool_timeout db port nec @@ -169,6 +210,7 @@ qpid_port qpid qpid_protocol qpid qpid_sasl_mechanisms qpid qpid_tcp_nodelay qpid +qpid_topology_version qpid qpid_username qpid quota_driver quotas quota_firewall quotas @@ -184,7 +226,6 @@ quota_router quotas quota_security_group quotas quota_security_group_rule quotas quota_subnet quotas -rabbit_durable_queues rabbitmq rabbit_ha_queues rabbitmq rabbit_host rabbitmq rabbit_hosts rabbitmq @@ -197,15 +238,20 @@ rabbit_use_ssl rabbitmq rabbit_userid rabbitmq rabbit_virtual_host rabbitmq redirects nicira +region_name ml2 report_interval agent req_timeout ml2 request_timeout mlnx +resource_pool_id embrane +resource_pool_id nicira retries nicira retry_interval db retry_until_window wsgi ringfile rpc root_helper common router_auto_schedule scheduler +router_image embrane +router_providers nec router_scheduler_driver scheduler rpc_backend rpc rpc_cast_timeout rpc @@ -235,17 +281,23 @@ ssl_ca_file ssl ssl_cert_file ssl ssl_key_file ssl state_path common +state_sync_interval nicira supported_extension_aliases meta svi_round_robin cisco sync_data bigswitch +sync_interval ml2 syslog_log_facility logging +task_status_check_interval nicira tcp_keepidle wsgi tenant_default_router_rule bigswitch tenant_network_type hyperv tenant_network_type linuxbridge tenant_network_type openvswitch tenant_network_types ml2 +timeout ml2 topics rpc +tos linuxbridge +ttl linuxbridge tun_peer_patch_port openvswitch tunnel_bridge openvswitch tunnel_id_ranges openvswitch @@ -256,11 +308,14 @@ tunnel_key_min ryu tunnel_type openvswitch tunnel_types openvswitch type_drivers ml2 +url ml2 +use_fqdn ml2 use_ssl nec use_ssl ssl use_stderr logging use_syslog logging use_tpool db +user nicira username brocade username midonet username plumgrid @@ -271,4 +326,9 @@ vif_types bigswitch vlan_name_prefix cisco vni_ranges ml2 vnic_type mlnx +vpn_device_driver vpn vswitch_plugin cisco +vxlan_group linuxbridge +vxlan_group ml2 +vxlan_id_ranges cisco +vxlan_udp_port openvswitch