Neutron Api

Learn about configurations >

• action-managed-upgrade | boolean

  If True enables openstack upgrades for this charm via juju actions. You will still need to set openstack-origin to the new repository but instead of an upgrade running automatically across all units, it will wait for you to execute the openstack-upgrade action for this charm on each unit. If False it will revert to existing behavior of upgrading all units on config change.

• allow-automatic-dhcp-failover | boolean

  Default: True

  Automatically remove networks from offline DHCP agents and reschedule them to online DHCP agents. This option can be used in conjunction with dhcp-agents-per-network as a single network can be maintained by multiple dhcp agents. Practically, rescheduling involves creating a dhcp network namespace and starting a DHCP agent like the default dnsmasq one in that network namespace. If availability zone information is propagated to neutron-openvswitch and neutron-gateway units from the underlying Juju provider (e.g. MAAS), it may also affect rescheduling.

• allow-automatic-l3agent-failover | boolean

  Automatically reschedule routers from offline L3 agents to online L3 agents. Note that it is advised to set this to true even when Distributed Virtual routing is enabled, since SNAT for nodes without floating IPs is set up centrally on an L3 agent. For DVR the SNAT namespace will be rescheduled only to L3 agents running in the 'dvr_snat' mode, while l3 agents in the 'dvr' mode will only host qrouter and fip namespaces.

• audit-middleware | boolean

  Enable Keystone auditing middleware for logging API calls.

• calico-origin | string

  Repository from which to install Calico packages. If set, must be a PPA URL, of the form ppa:somecustom/ppa. Changing this value after installation will force an immediate software upgrade.

• config-flags | string

  Comma-separated list of key=value config flags. These values will be placed in the neutron.conf [DEFAULT] section. . WARNING: this is not the recommended way to configure the underlying services that this charm installs and is used at the user's own risk. This option is mainly provided as a stop-gap for users that either want to test the effect of modifying some config or who have found a critical bug in the way the charm has configured their services and need it fixed immediately. We ask that whenever this is used, that the user consider opening a bug on this charm at https://bugs.launchpad.net/charm-neutron-api providing an explanation of why the config was needed so that we may consider it for inclusion as a natively supported config in the charm.

• database | string

  Default: neutron

  Database name for Neutron (if enabled).

• database-user | string

  Default: neutron

  Username for Neutron database access (if enabled).

• debug | boolean

  Enable debug logging.

• default-tenant-network-type | string

  The default type for a tenant network e.g. vxlan, vlan, gre etc

• dhcp-agents-per-network | int

  Default: 1

  The number of dhcp agents to be deployed per network. Note that if the Calico plugin is being used, this option has no effect.

• dhcp-load-type | string

  Default: networks

  Sets the resource type used in weight calculations during AZ-aware scheduling (networks, subnets or ports).

• dns-domain | string

  Default: openstack.example.

  Specifies the dns domain name that should be used for building instance hostnames. An empty option or the value of 'openstacklocal' will cause the dhcp agents to broadcast the default domain of openstacklocal and will not enable internal cloud dns resolution. This value should end with a '.', e.g. 'cloud.example.org.'.

• dns-ha | boolean

  Use DNS HA with MAAS 2.0. Note if this is set do not set vip* settings.

• enable-dvr | boolean

  Enable Distributed Virtual Routing (juno and above).

• enable-firewall-group-logging | boolean

  Setting this to True will enable logging for FWaaSv2. (Available from Stein) WARNING: Enabling this may affect your disk I/O performance since this may log ALL traffic being passed via gateway. Logging configuration such as thresholds and a destination log file are available in the neutron-gateway charm. . NOTE: Neutron FWaaS has been deprecated as of the OpenStack Ussuri release and will be removed during the W cycle.

• enable-fwaas | boolean

  Default: True

  Setting this to True will enable FWaasS (FWaaSv2 from Stein onwards). This feature is disabled from Victoria onwards and will have no effect. . NOTE: Neutron FWaaS has been deprecated as of the OpenStack Ussuri release and will be removed during the W cycle.

• enable-hardware-offload | boolean

  Enable OVS hardware offload support across Neutron and Nova.

• enable-igmp-snooping | boolean

  If True, on Ussuri or later, igmp snooping will be set on OVS and OVN control plane will learn about multicast traffic going on in the cluster.

• enable-l3ha | boolean

  Enable L3 HA (juno and above).

• enable-ml2-dns | boolean

  Enables the Neutron DNS extension driver (>= mitaka). When enabled, ports attached to Nova instances will have DNS names assigned based on the instance name.

• enable-ml2-port-security | boolean

  Enable port security extension for ML2 plugin (>= kilo).

• enable-network-segment-range | boolean

  Setting this to True will enable network segment ranges (Stein and later).

• enable-port-forwarding | boolean

  Setting this to True will enable port forwarding (Rocky and later).

• enable-qos | boolean

  Enable QoS (assuming the plug-in or ml2 mechanism driver can support it)

• enable-security-group-logging | boolean

  Setting this to True will enable logging for Security Groups. (Available from Queens) WARNING: Enabling this may affect your disk I/O performance since this will log ALL traffic being passed via NSG. Logging configuration such as thresholds and a destination log file are available in the neutron-openvswitch charm. Also, an neutron-openvswitch charm config option "firewall-driver" should be explicitly set to "openvswitch", since security group logging works only with OVS firewall driver now.

• enable-sriov | boolean

  Enable SR-IOV networking support across Neutron and Nova.

• enable-vlan-trunking | boolean

  Enable VLAN trunking or a VLAN aware VM. Neutron extension to access lots of neutron networks over a single vNIC as tagged/encapsulated traffic.

• extra-key | string

  Optional key for archive containing additional packages.

• extra-source | string

  Optional source for archive containing additional packages.

• flat-network-providers | string

  Space-delimited list of Neutron flat network providers.

• global-physnet-mtu | int

  Default: 1500

  MTU of the underlying physical network. Neutron uses this value to calculate MTU for all virtual network components. For flat and VLAN networks, neutron uses this value without modification. For overlay networks such as VXLAN, neutron automatically subtracts the overlay protocol overhead from this value. . NOTE: This options is available starting from Mitaka release.

• ha-bindiface | string

  Default: eth0

  Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster.

• ha-mcastport | int

  Default: 5424

  Default multicast port number that will be used to communicate between HA Cluster nodes.

• haproxy-client-timeout | int

  Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.

• haproxy-connect-timeout | int

  Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.

• haproxy-queue-timeout | int

  Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.

• haproxy-server-timeout | int

  Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.

• harden | string

  Apply system hardening. Supports a space-delimited list of modules to run. Supported modules currently include os, ssh, apache and mysql.

• ipv4-ptr-zone-prefix-size | int

  Default: 24

  The size in bits of the prefix for the IPv4 reverse lookup (PTR) zones. Valid size has to be multiple of 8, with maximum value of 24 and minimum value of 8. . NOTE: Use only when "reverse-dns-lookup" option is set to "True".

• ipv6-ptr-zone-prefix-size | int

  Default: 64

  The size in bits of the prefix for the IPv6 reverse lookup (PTR) zones. Valid size has to be multiple of 4, with maximum value of 124 and minimum value of 4. . NOTE: Use only when "reverse-dns-lookup" option is set to "True".

• l2-population | boolean

  Default: True

  Populate the forwarding tables of virtual switches (LinuxBridge or OVS), to decrease broadcast traffics inside the physical networks fabric while using overlays networks (VXLan, GRE).

  WARNING: Care should be taken when changing this configuration at runtime as there will be a temporary data-plane outage while the network adapters are reconfigured.

• manage-neutron-plugin-legacy-mode | boolean

  If False plugin is chosen through the deployment of a subordinate charm and relating it to the neutron-api application.

  If True the network management plugin is chosen via the neutron-plugin configuration option.

  The default value for this configuration option for new deployments is False for OpenStack Ussuri (or newer), and True when deploying or upgrading from prior versions.

• max-l3-agents-per-router | int

  Default: 2

  Maximum number of l3 agents to host a router. Only used when enable-l3ha is True.

• mem-password | string

  The Midokura Enterprise MidoNet password credentials to access the repository.

• mem-username | string

  The Midokura Enterprise MidoNet username credentials to access the repository.

• midonet-origin | string

  Default: midonet-2015.06

  'mem-1.8', 'mem-1.9', 'midonet-2015.06' . NOTE: updating this setting to a source that is known to provide a later version of MidoNet (do not change between MEM and MidoNet) will trigger a software upgrade.

• min-l3-agents-per-router | int

  Default: 2

  Minimum number of l3 agents to host a router. Only used when enable-l3ha is True. . NOTE: This option was deprecated in Newton and removed in Ocata so will have no effect from then onwards.

• nagios_context | string

  Default: juju

  Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like 'juju-myservice-0'. If you are running multiple environments with the same services in them this allows you to differentiate between them.

• nagios_servicegroups | string

  A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup

• network-device-mtu | int

  The MTU size for interfaces managed by neutron. If unset or set to 0, no value will be applied. This value will be provided to neutron-plugin-api relations. . NOTE: This option is deprecated and will be removed in Newton. Please use the system-wide global-physnet-mtu setting which the agents will take into account when wiring VIFs.

• neutron-external-network | string

  Default: ext_net

  Name of the external network for floating IP addresses provided by Neutron.

• neutron-plugin | string

  Default: ovs

  Neutron plugin to use for network management; supports . ovs - OpenvSwitch Plugin vsp - Nuage Networks VSP nsx - VMWare NSX Calico - Project Calico Networking midonet - MidoNet plumgrid - PLUMgrid .

• neutron-security-groups | boolean

  Use Neutron for security group management.

• nsx-controllers | string

  Space delimited addresses of NSX controllers

• nsx-l3-uuid | string

  This is uuid of the default NSX L3 Gateway Service.

• nsx-password | string

  Default: admin

  Password to connect to NSX controllers with

• nsx-tz-uuid | string

  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.

• nsx-username | string

  Default: admin

  Username to connect to NSX controllers with

• nuage-packages | string

  Default: nuage-openstack-neutron nuagenetlib

  Its [nuage-openstack-neutron nuagenetlib] for Nuage VSP >=3.2R4 & KILO and [nuage-neutron python-nuagenetlib] of Nuage VSP <=3.0 & JUNO

• openstack-origin | string

  Default: yoga

  Repository from which to install. May be one of the following: distro (default), ppa:somecustom/ppa, a deb url sources entry, or a supported Ubuntu Cloud Archive e.g. . cloud:<series>-<openstack-release> cloud:<series>-<openstack-release>/updates cloud:<series>-<openstack-release>/staging cloud:<series>-<openstack-release>/proposed . See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which cloud archives are available and supported. . NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade unless action-managed-upgrade is set to True.

• os-admin-hostname | string

  The hostname or address of the admin endpoints created for neutron-api in the keystone identity provider. . This value will be used for admin endpoints. For example, an os-admin-hostname set to 'neutron-api.admin.example.com' with ssl enabled will create a internal endpoint for neutron-api: . https://neutron-api.admin.example.com:9696/

• os-admin-network | string

  The IP address and netmask of the OpenStack Admin network (e.g. 192.168.0.0/24) . This network will be used for admin endpoints.

• os-internal-hostname | string

  The hostname or address of the internal endpoints created for neutron-api in the keystone identity provider. . This value will be used for internal endpoints. For example, an os-internal-hostname set to 'neutron-api.internal.example.com' with ssl enabled will create a internal endpoint for neutron-api: . https://neutron-api.internal.example.com:9696/

• os-internal-network | string

  The IP address and netmask of the OpenStack Internal network (e.g. 192.168.0.0/24) . This network will be used for internal endpoints.

• os-public-hostname | string

  The hostname or address of the public endpoints created for neutron-api in the keystone identity provider. . This value will be used for public endpoints. For example, an os-public-hostname set to 'neutron-api.example.com' with ssl enabled will create the following endpoint for neutron-api: . https://neutron-api.example.com:9696/

• os-public-network | string

  The IP address and netmask of the OpenStack Public network (e.g. 192.168.0.0/24) . This network will be used for public endpoints.

• overlay-network-type | string

  Default: gre

  Overlay network types to use, valid options include: . gre vxlan . Multiple types can be provided - field is space delimited. To disable overlay networks set to the empty string ''

• path-mtu | int

  Maximum size of an IP packet (MTU) that can traverse the underlying physical network infrastructure without fragmentation when using an overlay/tunnel protocol. This option allows specifying a physical network MTU value that differs from the default global-physnet-mtu value.

• physical-network-mtus | string

  Space-delimited list of <physical_network>:<mtu> pairs specifying MTU for individual physical networks. . Use this if a subset of your flat or VLAN provider networks have a MTU that differ with what is set in global-physnet-mtu.

• plumgrid-password | string

  Default: plumgrid

  Password to access PLUMgrid Director

• plumgrid-username | string

  Default: plumgrid

  Username to access PLUMgrid Director

• plumgrid-virtual-ip | string

  IP address of PLUMgrid Director

• polling-interval | int

  Default: 2

  The number of seconds the agent will wait between polling for local device changes. Used by neutron l2 agents.

• prefer-ipv6 | boolean

  If True enables IPv6 support. The charm will expect network interfaces to be configured with an IPv6 address. If set to False (default) IPv4 is expected. . NOTE: these charms do not currently support IPv6 privacy extension. In order for this charm to function correctly, the privacy extension must be disabled and a non-temporary address must be configured/available on your network interface.

• quota-floatingip | int

  Default: 50

  Number of floating IPs allowed per tenant. A negative value means unlimited.

• quota-health-monitors | int

  Default: -1

  Number of health monitors allowed per tenant. A negative value means unlimited. The default is unlimited because a health monitor is not a real resource consumer on Openstack. However, on back-end, a member is a resource consumer and that is the reason why quota is possible.

• quota-member | int

  Default: -1

  Number of pool members allowed per tenant. A negative value means unlimited. The default is unlimited because a member is not a real resource consumer on Openstack. However, on back-end, a member is a resource consumer and that is the reason why quota is possible.

• quota-network | int

  Default: 10

  Number of networks allowed per tenant. A negative value means unlimited.

• quota-pool | int

  Default: 10

  Number of pools allowed per tenant. A negative value means unlimited.

• quota-port | int

  Default: 50

  Number of ports allowed per tenant. A negative value means unlimited.

• quota-router | int

  Default: 10

  Number of routers allowed per tenant. A negative value means unlimited.

• quota-security-group | int

  Default: 10

  Number of security groups allowed per tenant. A negative value means unlimited.

• quota-security-group-rule | int

  Default: 100

  Number of security group rules allowed per tenant. A negative value means unlimited

• quota-subnet | int

  Default: 10

  Number of subnets allowed per tenant. A negative value means unlimited.

• quota-vip | int

  Default: 10

  Number of vips allowed per tenant. A negative value means unlimited.

• rabbit-user | string

  Default: neutron

  Username used to access rabbitmq queue.

• rabbit-vhost | string

  Default: openstack

  Rabbitmq vhost name.

• region | string

  Default: RegionOne

  OpenStack region name.

• report-interval | int

  Default: 30

  Seconds between nodes reporting state to server; should be less than agent_down_time, best if it is half or less than agent_down_time. Used by all neutron agents (includes l2 agents and other types of agents).

• reverse-dns-lookup | boolean

  A boolean value specifying whether to enable or not the creation of reverse lookup (PTR) records. . NOTE: Use only when relating neutron-api charm to designate charm.

• router-scheduler-driver | string

  Default: neutron.scheduler.l3_agent_scheduler.AZLeastRoutersScheduler

  The driver to use for router scheduling. In case of distributed routers this will affect snat namespace scheduling.

• rpc-response-timeout | int

  Default: 60

  Seconds to wait for a response from a call. Used by all neutron agents (includes l2 agents and other types of agents).

• ssl_ca | string

  SSL CA to use with the certificate and key provided - this is only required if you are providing a privately signed ssl_cert and ssl_key.

• ssl_cert | string

  SSL certificate to install and use for API ports. Setting this value and ssl_key will enable reverse proxying, point Neutron's entry in the Keystone catalog to use https, and override any certificate and key issued by Keystone (if it is configured to do so).

• ssl_key | string

  SSL key to use with certificate specified as ssl_cert.

• supported-pci-vendor-devs | string

  NOTE: Required for OpenStack versions Kilo, Liberty and Mitaka. Ignored for OpenStack Newton and newer. . Space-delimited list of supported Vendor PCI Devices, in format vendor_id:product_id . Example: 15b3:1004 8086:10ca . This must be set to match available hardware on nova-compute units. Neutron will refuse to bind ports to hardware with Vendor PCI IDs not in this list. (Use lspci -nn to get IDs) . NOTE: The vendor_id:product_id of the PFs and VFs differ. Make sure to enter the correct one for your use case.

• uplink-status-propagation | boolean

  If True, on Stein or later attribute 'propagate_uplink_status' will be available to port. This attribute can be implemented for VF port to indicate if the VF link state should follow the state of the PF.

• use-internal-endpoints | boolean

  Openstack mostly defaults to using public endpoints for internal communication between services. If set to True this option will configure services to use internal endpoints where possible.

• use-policyd-override | boolean

  If True then use the resource file named 'policyd-override' to install override YAML files in the service's policy.d directory. The resource file should be a ZIP file containing at least one yaml file with a .yaml or .yml extension. If False then remove the overrides.

• use-syslog | boolean

  Setting this to True will allow supporting services to log to syslog.

• verbose | boolean

  Enable verbose logging.

• vip | string

  Virtual IP(s) to use to front API services in HA configuration. . If multiple networks are being used, a VIP should be provided for each network, separated by spaces.

• vip_cidr | int

  Default: 24

  Default CIDR netmask to use for HA vip when it cannot be automatically determined.

• vip_iface | string

  Default: eth0

  Default network interface to use for HA vip when it cannot be automatically determined.

• vlan-ranges | string

  Default: physnet1:1000:2000

  Space-delimited 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.

• vni-ranges | string

  Default: 1001:2000

  Space-delimited list of <vxlan_min>:<vxlan_max> for VXLAN provider.

• vsd-auth | string

  Default: csproot:csproot

  Username Password to connect to Nuage VSD Server

• vsd-auth-resource | string

  Default: /me

  Nuage VSD authentication resource

• vsd-auth-ssl | boolean

  Default: True

  SSL authentication of the Nuage VSD Server

• vsd-base-uri | string

  Default: /nuage/api/v3_0

  Nuage VSD API endpoint URI

• vsd-cms-id | string

  CMS ID is used as an authentication token from VSD to CMS. This value is being generated via nuage scripts and can be set pre/post deployment.

• vsd-cms-name | string

  This is required only for 3.2 R4 and above releases of Nuage and Kilo. Please give Maas env id so that it is unique per openstack cluster. This name is used to create th CMS ID on Nuage-VSD which should be unique per OSP cluster. Your Deployment will fail if this config is not provided.

• vsd-netpart-name | string

  Default: juju-enterprise

  Name of the Organization or Enterprise to create in Nuage VSD

• vsd-organization | string

  Default: csp

  Name of the organization in Nuage VSD

• vsd-server | string

  Nuage VSD Server

• worker-multiplier | float

  The CPU core multiplier to use when configuring worker processes for this service. By default, the number of workers for each daemon is set to twice the number of CPU cores a service unit has. This default value will be capped to 4 workers unless this configuration option is set.