Configuration option=Default value | -(Type) Description | -
---|---|
debug=False | -(BoolOpt) Prints debugging output. | -
verbose=False | -(BoolOpt) Prints more verbose output. - | -
Configuration option=Default value | -(Type) Description | -
---|---|
log_config= | -(StrOpt) The logging configuration file. - Overrides any other logging options - specified. See the Python logging module - documentation for details on logging - configuration files. | -
log_format=%(asctime)s %(levelname)8s - [%(name)s] %(message)s | -(StrOpt) A logging.Formatter log message - format string that can use any of the - available logging.LogRecord attributes. - | -
log_date_format=%Y-%m-%d %H:%M:%S | -(StrOpt) Format string for %(asctime)s in - log records. | -
log_file= | -(StrOpt) (Optional) Name of log file to - output to. If not set, logging goes to - stdout. | -
log_dir= | -(StrOpt) (Optional) The directory to keep - log files in (will be prepended to - --logfile). | -
use_syslog=False | -(BoolOpt) Uses syslog for logging. | -
syslog_log_facility=LOG_USER | -(StrOpt) The syslog facility to receive - log lines. | -
Configuration option=Default value | -(Type) Description | -
---|---|
auth_host = 127.0.0.1 | -(StrOpt) Authentication listening - host. | -
auth_port = 35357 | -(IntOpt) Authentication listening - port. | -
auth_protocol = http | -(StrOpt) Authentication protocol. | -
admin_tenant_name = | -(StrOpt) The administrative tenant - name. | -
admin_user = | -(StrOpt) The administrative user - name. | -
admin_password = | -(StrOpt) The password for the - administrative user. | -
signing_dir = /var/lib/neutron/keystone-signing | -(StrOpt) The signing directory. | -
Configuration option=Default value | -(Type) Description | -
---|---|
bind_host=0.0.0.0 | -(StrOpt) Server listening IP. | -
bind_port=9696 | -(IntOpt) Server listening port. | -
api_paste_config=api-paste.ini | -(StrOpt) The paste configuration file, - which configures the WSGI application. - | -
api_extensions_path= | -(StrOpt) Enables custom addition to be - made to the above configuration. | -
policy_file=policy.json | -(StrOpt) JSON file representing policies - to access and view data. The usage and - format is discussed in more detail in the - Authentication and Authorization section. - | -
auth_strategy=keystone | -(StrOpt) The strategy used for - authentication. The supported values are - ‘keystone’ and ‘noauth’. | -
core_plugin=neutron.plugins.sample.SamplePlugin.FakePlugin | -(StrOpt) The plugin to be loaded by the - service. | -
pagination_max_limit=-1 | -(StrOpt) The maximum number of items - returned in a single response. A value of - 'infinite', or a negative integer means no - limit. | -
Configuration option=Default value | -(Type) Description | -
---|---|
base_mac=fa:16:3e:00:00:00 | -(StrOpt) MAC addresses for a port are - generated. The first 3 octets will remain - unchanged. If the 4h octet is not 00, it - will also used. The others will be - randomly generated. | -
mac_generation_retries=16 | -(IntOpt) The number of times the plugin - attempts to generate a unique MAC address. - | -
allow_bulk=True | -(BoolOpt) Enables or disables bulk - create/update/delete operations. | -
allow_overlapping_ips=False | -|
allow_pagination=False | -|
allow_sorting=False | -|
force_gateway_on_subnet = False | -|
max_dns_nameservers=5 | -(IntOpt) The maximum amount of DNS - nameservers that can be configured per - subnet. | -
max_subnet_host_routes=20 | -(IntOpt) The maximum amount of host routes - that can be configured per subnet. | -
state_path=. | -(StrOpt) Top level directory for - configuration files. | -
dhcp_lease_duration=120 | -(IntOpt) The default expiration time, in - seconds, for a DHCP address. | -
Configuration option=Default value | -(Type) Description | -
---|---|
control_exchange=neutron | -(StrOpt) AMQP exchange to connect to if - using RabbitMQ or QPID. | -
rpc_backend=neutron.openstack.common.rpc.impl_kombu | -(StrOpt) The messaging module to use, defaults to kombu. For qpid, make - use of neutron.openstack.common.rpc.impl_qpid. | -
rpc_thread_pool_size=64 | -(IntOpt) Size of RPC thread pool. | -
rpc_conn_pool_size=30 | -(IntOpt) Size of RPC connection pool. - | -
rpc_response_timeout=60 | -(IntOpt) Seconds to wait for a response - from call or multi call. | -
allowed_rpc_exception_modules='neutron.openstack.common.exception', - 'nova.exception' | -(ListOpt) Modules of exceptions that are - permitted to be recreated upon receiving - exception data from an rpc call. | -
fake_rabbit=False | -(BoolOpt) If passed, use a fake RabbitMQ - provider. | -
Configuration option=Default value | -(Type) Description | -
---|---|
kombu_ssl_version= | -(StrOpt) SSL version to use (valid only if - SSL enabled). | -
kombu_ssl_keyfile= | -(StrOpt) SSL key file (valid only if SSL - enabled). | -
kombu_ssl_certfile= | -(StrOpt) SSL cert file (valid only if SSL - enabled). | -
kombu_ssl_ca_certs= | -(StrOpt) SSL certification authority file - (valid only if SSL enabled). | -
rabbit_host=localhost | -(StrOpt) IP address of the RabbitMQ - installation. | -
rabbit_password=guest | -Password of the RabbitMQ server. | -
rabbit_port=5672 | -(IntOpt) Port where RabbitMQ server is - running/listening. | -
rabbit_userid=guest | -(StrOpt) User ID used for RabbitMQ - connections. | -
rabbit_virtual_host=/ | -(StrOpt) Location of a virtual RabbitMQ - installation. | -
rabbit_max_retries=0 | -(IntOpt) Maximum retries with trying to - connect to RabbitMQ. The default of 0 - implies an infinite retry count. | -
rabbit_retry_interval=1 | -(IntOpt) RabbitMQ connection retry - interval. | -
Configuration option=Default value | -(Type) Description | -
---|---|
qpid_hostname=localhost | -(StrOpt) Qpid broker hostname. | -
qpid_port=5672 | -(IntOpt) Qpid broker port. | -
qpid_username= | -(StrOpt) Username for qpid connection. - | -
qpid_password= | -(StrOpt) Password for qpid connection. - | -
qpid_sasl_mechanisms= | -(StrOpt) Space separated list of SASL - mechanisms to use for auth. | -
qpid_reconnect=True | -(BoolOpt) Automatically reconnect. | -
qpid_reconnect_timeout=0 | -(IntOpt) The number of seconds to wait - before deciding that a reconnect attempt - has failed. | -
qpid_reconnect_limit=0 | -(IntOpt) The limit for the number of times - to reconnect before considering the - connection to be failed. | -
qpid_reconnect_interval_min=0 | -(IntOpt) Minimum seconds between - reconnection attempts. | -
qpid_reconnect_interval_max=0 | -(IntOpt) Maximum seconds between - reconnection attempts. | -
qpid_reconnect_interval=0 | -(IntOpt) Equivalent to setting max and min - to the same value. | -
qpid_heartbeat=60 | -(IntOpt) Seconds between connection - keepalive heartbeats. | -
qpid_protocol=tcp | -(StrOpt) Transport to use, either 'tcp' or - 'ssl.' | -
qpid_tcp_nodelay=True | -(BoolOpt) Disable Nagle algorithm. | -
Configuration option=Default value | -(Type) Description | -
---|---|
notification_driver=neutron.openstack.common.notifier.list_notifier | -(MultiStrOpt) Driver or drivers to handle - sending notifications. The default is set - as notifier as the DHCP agent makes use of - the notifications. | -
default_notification_level=INFO | -(StrOpt) Default notification level for - outgoing notifications. | -
default_publisher_id=$host | -(StrOpt) Default publisher_id for outgoing - notifications. | -
- list_notifier_drivers='neutron.openstack.common.notifier.no_op_notifier' | -(MultiStrOpt) List of drivers to send - notifications. | -
notification_topics='notifications' | -(ListOpt) AMQP topic used for openstack - notifications. | -
Configuration option=Default value | -(Type) Description | -
---|---|
quota_driver=neutron.quota.ConfDriver | -(StrOpt) Default driver to use for quota checks. If the default driver
- is used then the configuration values below are in effect. To limit
- quotas per tenant then use:
- |
-
quota_items=network,subnet,port | -(ListOpt) Resource names that are - supported by the Quotas feature. | -
default_quota=-1 | -(IntOpt) Default number of resources - allowed per tenant, minus for unlimited. - | -
quota_network=10 | -(IntOpt) Number of networks allowed per - tenant, and minus means unlimited. | -
quota_subnet=10 | -(IntOpt) Number of subnets allowed per - tenant, and minus means unlimited. | -
quota_port=50 | -(IntOpt) Number of ports allowed per - tenant, and minus means unlimited. | -
Configuration option=Default value | -(Type) Description | -
---|---|
sql_connection=sqlite:// | -|
sql_max_retries=10 | -(IntOpt) The number of database - re-connection retry times. Used if - connectivity is lost with the database. -1 - implies an infinite retry count. | -
reconnect_interval=2 | -(IntOpt) The database reconnection - interval in seconds. Used if connectivity - is lost. | -
Configuration option=Default value | -(Type) Description | -
---|---|
network_vlan_ranges=default:2000:3999 | -(ListOpt) Comma-separated list of - <physical_network>:<vlan_min>:<vlan_max> - tuples enumerating ranges of VLAN IDs on - named physical networks that are available - for allocation. | -
tunnel_id_ranges= | -(ListOpt) Comma-separated list of - <tun_min>:<tun_max> tuples - enumerating ranges of GRE tunnel IDs that - are available for allocation. | -
integration_bridge=br-int | -(StrOpt) The name of the OVS integration - bridge. There is one per hypervisor. The - integration bridge acts as a virtual - "patch port". All VM VIFs are attached to - this bridge and then "patched" according - to their network connectivity. Do not - change this parameter unless you have a - good reason to. | -
tunnel_bridge=br-tun | -(StrOpt) The name of the OVS tunnel bridge - used by the agent for GRE tunnels. Only - used if tunnel_id_ranges is not empty. - | -
bridge_mappings=default:br-eth1 | -(ListOpt) Comma-separated list of - <physical_network>:<bridge> - tuples mapping physical network names to - agent's node-specific OVS bridge names. - Each bridge must exist, and should have - physical network # interface configured as - a port. | -
local_ip=10.0.0.3 | -(StrOpt) The local IP address of this - hypervisor. Used only when - tunnel_id_ranges are used. | -
enable_tunneling=False | -(BoolOpt) A flag indicating if tunneling - is supported. Not all systems that support - Open vSwitch support its GRE tunneling - feature, that is, it is not supported in - the Linux kernel source tree. This applies - to both the server and agent. | -
Configuration option=Default value | -(Type) Description | -
---|---|
rpc=True | -(BoolOpt) If |
-
polling_interval=2 | -(IntOpt) Agent's polling interval in - seconds. | -
root_helper=sudo | -(StrOpt) Limits the commands that can be - run. See the rootwrap section for more - details. | -
Configuration option=Default - value | -(Type) Description | -
---|---|
sql_connection=sqlite:// | -|
sql_max_retries=10 | -(IntOpt) Database re-connection retry - times. Used if connectivity is lost - with the database. -1 implies an - infinite retry count. | -
reconnect_interval=2 | -(IntOpt) Database reconnection - interval in seconds. Used if - connectivity is lost. | -
Configuration option=Default - value | -(Type) Description | -
---|---|
network_vlan_ranges=default:1000:2999 | -(ListOpt) Comma-separated list of - <physical_network>:<vlan_min>:<vlan_max> - tuples enumerating ranges of VLAN IDs - on named physical networks that are - available for allocation. | -
Configuration option=Default - value | -(Type) Description | -
---|---|
physical_interface_mappings=default:eth1 | -(ListOpt) Comma-separated list of - <physical_network>:<physical_interface> - tuples mapping physical network names - to agent's node-specific physical - network interfaces. Server uses - physical network names for validation - but ignores interfaces. | -
Configuration option=Default - value | -(Type) Description | -
---|---|
rpc=True | -(BoolOpt) If |
-
polling_interval=2 | -(IntOpt) Agent's polling interval in - seconds. | -
root_helper=sudo | -(StrOpt) Limits the commands that can - be run. See the rootwrap section for - more details. | -
Configuration option=Default - value | -(Type) Description | -
---|---|
root_helper=sudo | -(StrOpt) Limits the commands that can - be run. See the rootwrap section for - more details. | -
dhcp_driver=neutron.agent.linux.dhcp.Dnsmasq | -(StrOpt) The driver used to manage the - DHCP server. | -
- dhcp_lease_relay_socket=$state_path/dhcp/lease_relay | -(StrOpt) Location to DHCP lease relay - UNIX domain socket. | -
use_namespaces=True | -
Configuration option=Default - value | -(Type) Description | -
---|---|
dhcp_confs=$state_path/dhcp | -(StrOpt) Location to store DHCP server - config files. | -
dhcp_lease_time=120 | -(IntOpt) Lifetime of a DHCP lease in - seconds. | -
dhcp_domain=openstacklocal | -(StrOpt) Domain to use for building - the host names. | -
dnsmasq_config_file= | -(StrOpt) Overrides the default dnsmasq - settings with this file. | -
dnsmasq_dns_server= | -(StrOpt) Specifies whether to use
- another DNS server before any in
- |
-
Configuration option=Default - value | -(Type) Description | -
---|---|
root_helper=sudo | -(StrOpt) Limits the commands that can - be run. See the rootwrap section for - more details. | -
external_network_bridge=br-ex | -(StrOpt) Name of bridge used for - external network traffic. | -
use_namespaces=True | -|
polling_interval=3 | -(IntOpt) The time, in seconds, between - state poll requests. | -
metadata_port=9697 | -(IntOpt) TCP Port used by metadata namespace proxy. | -
router_id= | -(StrOpt) If namespaces is disabled, - the l3 agent can only configure a - router whose ID matches this - parameter. | -
handle_internal_only_routers=True | -(BoolOpt) Agent should implement - routers with no gateway. | -
gateway_external_network_id= | -(StrOpt) UUID of external network for - routers implemented by the agents. - | -
Configuration option=Default value | -(Type) Description | -
---|---|
nova_metadata_ip=127.0.0.1 | -(StrOpt) The IP address of the Nova metadata service. | -
nova_metadata_port=8775 | -(IntOpt) The TCP port of the Nova metadata service. | -
metadata_proxy_shared_secret= | -(StrOpt) When proxying metadata requests, Neutron signs the Instance-ID - header with a shared secret to prevent spoofing. You may select any - string for a secret, but it must match here and in the configuration - used by the Nova Metadata Server. NOTE: Nova uses a different key: - neutron_metadata_proxy_shared_secret | -
admin_user= | -(StrOpt) The administrative user name for OpenStack Networking, which is - defined in OpenStack Identity - (keystone). | -
admin_password= | -(StrOpt) The password for the administrative user. | -
admin_tenant_name= | -(StrOpt) The administrative user's tenant name. | -
auth_url= | -(StrOpt) The URL used to validate tokens. For example,
- `auth_protocol`://`auth_host`:`auth_port`/v2.0 . |
-
auth_region= | -(StrOpt) The authentication region. | -
Configuration option=Default value | -(Type) Description | -
---|---|
interface_driver= | -(StrOpt) The driver used to manage the - virtual interface. | -
ovs_use_veth=False | -(BoolOpt) Specifies whether to use veth
- for an interface. Set to
- |
-
admin_user= | -(StrOpt) The administrative user name for - OpenStack Networking, which is defined in - OpenStack Identity (keystone). - Only relevant if using MetaPlugin. | -
admin_password= | -(StrOpt) The password for the - administrative user. Only relevant if - using MetaPlugin. | -
admin_tenant_name= | -(StrOpt) The administrative user's tenant - name. Only relevant if using - MetaPlugin. | -
auth_url= | -(StrOpt) The URL used to validate tokens.
- For example,
- `auth_protocol`://`auth_host`:`auth_port`/v2.0 .
- Only relevant if using MetaPlugin. |
-
auth_strategy=keystone | -(StrOpt) The strategy to use for - authentication. Supports noauth or - keystone. Only relevant if using - MetaPlugin. | -
auth_region= | -(StrOpt) The authentication region. Only - relevant if using MetaPlugin. | -
ovs_integration_bridge=br-int | -(StrOpt) Name of Open vSwitch bridge to - use. Only relevant if using Open vSwitch. - | -
network_device_mtu= | -(StrOpt) MTU setting for device. Only - relevant if using Open vSwitch. | -
meta_flavor_driver_mappings= | -(StrOpt). Mappings between flavors and - drivers. Only relevant if using - MetaPlugin. | -
resync_interval=30 | -(IntOpt) If an exception occurs on the neutron-server service, the DHCP
- agent ensures that it syncs with the |
-
Plugin | -Support Native Pagination | -Support Native Sorting | -
---|---|---|
Open vSwitch | -True | -True | -
LinuxBridge | -True | -True | -
extension:provider_network:set
action. The default OpenStack Networking API policy
configuration authorizes both actions for users with
- the admin role. See - | Libvirt (KVM/QEMU) | -XenServer | -VMware | -Hyper-V | -Bare-metal | -PowerVM | -
---|---|---|---|---|---|---|
Bigswitch / Floodlight | -Yes | -- | - | - | - | - |
Brocade | -Yes | -- | - | - | - | - |
Cisco | -Yes | -- | - | - | - | - |
Cloudbase Hyper-V | -- | - | - | Yes | -- | - |
Linux Bridge | -Yes | -- | - | - | - | - |
Mellanox | -Yes | -- | - | - | - | - |
Midonet | -Yes | -- | - | - | - | - |
NEC OpenFlow | -Yes | -- | - | - | - | - |
Nicira NVP | -Yes | -Yes | -Yes | -- | - | - |
Open vSwitch | -Yes | -- | - | - | - | - |
Plumgrid | -Yes | -- | Yes | -- | - | - |
Ryu | -Yes | -- | - | - | - | - |
Attribute | -Type | -Default value | -Description | -
---|---|---|---|
bool | -True | -Administrative state of the network. If specified as - False (down), this network does not forward - packets. - | -|
uuid-str | -Generated | -UUID for this network. | -|
string | -None | -Human-readable name for this network; is not required - to be unique. - | -|
bool | -False | -Specifies whether this network resource can - be accessed by any tenant. The default policy setting restricts - usage of this attribute to administrative users only. - | -|
string | -N/A | -Indicates whether this network is - currently operational. | -|
list(uuid-str) | -Empty list | -List of subnets associated with this network. - | -|
uuid-str | -N/A | -Tenant owner of the network. Only administrative users - can set the tenant identifier; this cannot be changed - using authorization policies. - | -
Attribute | -Type | -Default Value | -Description | -
---|---|---|---|
list(dict) | -Every address in |
- ||
string | -N/A | -IP range for this subnet, based on the IP version. | -|
list(string) | -Empty list | -List of DNS name servers used by hosts in this subnet. | -|
bool | -True | -Specifies whether DHCP is enabled for this subnet. | -|
string | -First address in |
- Default gateway used by devices in this subnet. | -|
list(dict) | -Empty list | -Routes that should be used by devices with - IPs from this subnet (not including local - subnet route). | -|
uuid-string | -Generated | -UUID representing this subnet. | -|
int | -4 | -IP version. | -|
string | -None | -Human-readable name for this subnet (might - not be unique). - | -|
uuid-string | -N/A | -Network with which this subnet is associated. | -|
uuid-string | -N/A | -Owner of network. Only administrative users - can set the tenant identifier; this cannot be changed - using authorization policies. - | -
Attribute | -Type | -Default Value | -Description | -
---|---|---|---|
bool | -true | -Administrative state of this port. If specified as False - (down), this port does not forward packets. - | -|
string | -None | -Identifies the device using this port (for example, a - virtual server's ID). - | -|
string | -None | -Identifies the entity using this port (for example, a - dhcp agent). | -|
list(dict) | -Automatically allocated from pool | -Specifies IP addresses for this port; associates - the port with the subnets containing the listed IP - addresses. - | -|
uuid-string | -Generated | -UUID for this port. | -|
string | -Generated | -Mac address to use on this port. | -|
string | -None | -Human-readable name for this port (might - not be unique). - | -|
uuid-string | -N/A | -Network with which this port is associated. - | -|
string | -N/A | -Indicates whether the network is currently - operational. - | -|
uuid-string | -N/A | -Owner of the network. Only administrative users - can set the tenant identifier; this cannot be changed - using authorization policies. - | -
Action | -Command | -
---|---|
Create a network. | -|
Create a subnet associated with net1. | -|
List ports on a tenant. | -|
List ports on a tenant, and display the |
- |
Display details of a particular port. | -
Action | -Command | -
---|---|
Create a "shared" network (that is, a network that can be used by all tenants). | -|
Create a subnet that has a specific gateway IP address. | -|
Create a subnet that has no gateway IP address. | -|
Create a subnet in which DHCP is disabled. | -|
Create subnet with a specific set of host routes. | -|
Create subnet with a specific set of dns nameservers. | -|
Display all ports/IPs allocated on a network. | -
Action | -Command | -
---|---|
Check available networks. | -|
Boot a VM with a single NIC on a selected OpenStack Networking network. | -|
Search for all ports with a |
- |
Search for ports, but limit display to only the port's |
- |
Temporarily disable a port from sending traffic. | -|
Delete a VM. | -
Action | -Command | -
---|---|
Boot a VM with multiple NICs. | -|
Boot a VM with a specific IP address: first create an OpenStack
- Networking port with a specific IP address, then boot
- a VM specifying a |
- |
Boot a VM that connects to all networks that are accessible to
- the tenant who submits the request (without the
- |
-