Configuration Options Reference

This page lists every per-switch ngs_ option, generated directly from the option definitions in the source code. Each option is set in a [genericswitch:<switch name>] section of the switch configuration file.

For usage guidance, examples and vendor-specific notes, see Configuration.

Common options

These options apply to all device drivers.

ngs_mac_address

MAC address of the switch. Used to correlate LLDP data reported by ironic-python-agent with this device.

Type:

string

Default:

not set

ngs_trunk_ports

Comma-separated list of names of interfaces to be added as trunk ports to each network configured on this switch.

Type:

list

Default:

not set

ngs_port_default_vlan

Default VLAN to configure on a port when it is unplugged from a network.

Type:

string

Default:

not set

ngs_physical_networks

Comma-separated list of physical networks to which this switch is mapped.

Type:

list

Default:

not set

ngs_ssh_disabled_algorithms

Comma-separated list of entries formatted as “<type>:<algorithm>”, specifying SSH algorithms to disable.

Type:

list

Default:

not set

ngs_ssh_connect_timeout

Timeout in seconds for establishing an SSH connection to the switch.

Type:

integer

Default:

60

ngs_ssh_connect_interval

Interval in seconds between SSH connection attempts.

Type:

integer

Default:

10

ngs_ssh_reuse_connection

If True, reuse SSH connections to the switch across operations rather than reconnecting each time.

Type:

boolean

Default:

False

ngs_max_connections

Maximum number of concurrent connections to the switch.

Type:

integer

Default:

1

ngs_switchport_mode

Switchport mode to configure on ports plugged into a network.

Type:

string

Default:

access

ngs_disable_inactive_ports

If True, disable switch ports that are not in use.

Type:

boolean

Default:

False

ngs_network_name_format

String format for the network name to configure on switches. Accepts {network_id} and {segmentation_id} formatting options.

Type:

string

Default:

{network_id}

ngs_manage_vlans

If False, ngs will not add and delete VLANs from switches.

Type:

boolean

Default:

True

ngs_save_configuration

If False, ngs will skip saving configuration on devices.

Type:

boolean

Default:

True

ngs_batch_requests

If True, try to batch up in-flight switch requests.

Type:

boolean

Default:

False

ngs_fake_sleep_min_s

Fake device driver: minimum time in seconds to sleep per operation.

Type:

floating point

Default:

not set

ngs_fake_sleep_max_s

Fake device driver: maximum time in seconds to sleep per operation.

Type:

floating point

Default:

not set

ngs_fake_failure_prob

Fake device driver: probability (0.0-1.0) that an operation fails.

Type:

floating point

Default:

not set

ngs_allowed_vlans

Allow list of VLANs for this switch. Defaults to open; setting an empty string blocks all VLANs.

Type:

list

Default:

not set

ngs_allowed_ports

Allow list of ports for this switch. Defaults to open; setting an empty string blocks all ports.

Type:

list

Default:

not set

ngs_security_groups_enabled

Require security groups to be enabled on a per-device basis.

Type:

boolean

Default:

False

ngs_netconf_target

Force the NETCONF datastore target (‘candidate’ or ‘running’). Unset (default) auto-detects from server capabilities.

Type:

string

Default:

not set

ngs_netconf_save_config

XML config payload sent via edit-config to the running datastore to persist configuration.

Type:

string

Default:

not set

ngs_openconfig_network_instance

OpenConfig: L2/L3 forwarding instance for VLANs.

Type:

string

Default:

default

ngs_port_id_re_sub

JSON dict {“pattern”: “…”, “repl”: “…”} for regex substitution on port IDs from LLDP.

Type:

string

Default:

not set

ngs_openconfig_disabled_properties

OpenConfig: comma-separated list of disabled properties (e.g. “port_mtu”).

Type:

list

Default:

not set

ngs_netconf_confirmed_commit

Whether to use confirmed commit when the switch advertises it.

Type:

boolean

Default:

True

ngs_netconf_confirmed_commit_timeout

Rollback timeout in seconds for the tentative confirmed commit.

Type:

integer

Default:

5

ngs_manage_mtu

Master toggle for MTU management. Must be True for any MTU configuration to take effect. Default False preserves the pre-existing behavior of never touching port MTU.

Type:

boolean

Default:

False

ngs_port_default_mtu

Default MTU for access/bound ports. Used as a fallback when the network MTU is missing/zero and as the reset value on port unbind. Neutron ML2 networks always have an MTU (DB enforces non-null), but the fallback supports standalone usage and direct driver invocation.

Type:

integer

Default:

not set

ngs_trunk_port_mtu

MTU to apply on trunk (uplink) ports. Also serves as the upper bound for access port MTU validation.

Type:

integer

Default:

not set

ngs_bounce_ports_on_plug

If True, bounce (shutdown then no shutdown) ports during bind to trigger a carrier drop/raise, signalling the host to re-run DHCP. Ports remain UP when not bound, preserving LLDP.

Type:

boolean

Default:

False

ngs_port_stp_edge

If True, configure ports as STP edge (portfast) during bind to skip STP convergence delay.

Type:

boolean

Default:

False

ngs_port_bpdu_guard

If True, enable BPDU guard on ports during bind to protect against spanning tree loops.

Type:

boolean

Default:

False

ngs_verify_tls

TLS certificate verification for HTTP-based transports.

Type:

boolean

Default:

True

ngs_restconf_scheme

URI scheme to use for the RESTCONF transport.

Type:

string

Default:

https

ngs_restconf_content_type

Content-Type header sent with RESTCONF requests.

Type:

string

Default:

application/yang-data+json

ngs_restconf_base_path

Base path for the RESTCONF data resource.

Type:

string

Default:

/restconf/data

VXLAN L2VNI (EVPN/multicast) options

These options configure VXLAN L2VNI overlays and are honoured by the VXLAN-capable device drivers (e.g. Juniper, Arista, SONiC, Cumulus and Cisco NX-OS). Some options apply only to a specific vendor, as noted in each option’s description.

ngs_evpn_vni_config

Enable EVPN VNI control-plane configuration for VXLAN L2VNI. Requires ngs_bgp_asn to be set.

Type:

boolean

Default:

False

ngs_bgp_asn

BGP autonomous system number used for EVPN VXLAN L2VNI configuration. Required when ngs_evpn_vni_config is enabled, and for L2VNI on some drivers.

Type:

integer

Default:

not set

ngs_bum_replication_mode

BUM (broadcast, unknown-unicast, multicast) traffic replication mode for VXLAN L2VNI. One of “ingress-replication” or “multicast”.

Type:

string

Default:

ingress-replication

ngs_mcast_group_base

Base multicast group IPv4 address used to automatically derive per-VNI multicast groups when ngs_bum_replication_mode is “multicast” (e.g. 239.1.1.0).

Type:

string

Default:

not set

ngs_mcast_group_increment

Method used to derive per-VNI multicast group addresses from ngs_mcast_group_base.

Type:

string

Default:

vni_last_octet

ngs_mcast_group_map

Explicit VNI-to-multicast-group mappings as a comma-separated list of “<vni>:<group>” entries (e.g. “1001:239.1.1.1,1002:239.1.1.2”). Takes precedence over automatic derivation.

Type:

string

Default:

not set

ngs_vxlan_interface

Arista EOS: name of the VXLAN source interface used for L2VNI. Replaces the deprecated vxlan_interface option.

Type:

string

Default:

Vxlan1

ngs_evpn_route_target

Arista EOS: EVPN route target for L2VNI. Use “auto” (the default) to derive it automatically from the VNI.

Type:

string

Default:

auto

ngs_her_flood_list

Cumulus Linux: global head-end replication (HER) flood list, a comma-separated list of remote VTEP IPs used to flood BUM traffic.

Type:

list

Default:

not set

ngs_physnet_her_flood

Cumulus Linux: per-physical-network head-end replication (HER) flood lists, formatted as “<physnet>:<ip>,<ip>;<physnet>:<ip>,<ip>”. Takes precedence over ngs_her_flood_list for a given physical network.

Type:

string

Default:

not set

ngs_vtep_name

SONiC: name of the VTEP used for VXLAN L2VNI. Replaces the deprecated vtep_name option.

Type:

string

Default:

not set

ngs_nve_interface

Cisco NX-OS: name of the NVE (network virtualization edge) interface used for VXLAN L2VNI.

Type:

string

Default:

nve1

Juniper (Netmiko) options

Additional options accepted by the netmiko_juniper device type.

ngs_commit_timeout

Timeout in seconds for committing configuration changes.

Type:

integer

Default:

60

ngs_commit_interval

Interval in seconds between attempts to commit configuration changes.

Type:

integer

Default:

5

Open vSwitch options

Additional options accepted by the netmiko_ovs_linux device type.

ngs_ovs_bridge

OVS bridge name to use for VNI mapping storage.

Type:

string

Default:

genericswitch