OS Manuals

/usr/bin/neutron-sanity-check

OpenStack Networking (Neutron) — 2026.1 Gazpacho

From openstack-neutron-2026.1 28.0.2_git20261109-r0 (enterprise-packages), captured 2026-11-09 by running neutron-sanity-check --help (exit 0). permalink

2026-11-09 15:12:47.895 2 INFO neutron.common.config [-] Logging enabled!
2026-11-09 15:12:47.897 2 INFO neutron.common.config [-] /usr/bin/neutron-sanity-check version 28.0.3.dev44
usage: neutron-sanity-check [-h] [--arp_header_match] [--arp_responder] [--bridge_firewalling]
                            [--check_min_tx_rate_support] [--config-dir DIR] [--config-file PATH]
                            [--conntrack_installed] [--debug] [--dhcp_release6]
                            [--dnsmasq_local_service_supported] [--dnsmasq_version]
                            [--ebtables_installed] [--gre_conntrack] [--icmpv6_header_match]
                            [--ip6tables_installed] [--ip_nonlocal_bind] [--iproute2_vxlan]
                            [--ipset_installed] [--keepalived_garp_on_sighup_support]
                            [--keepalived_ipv6_support] [--log-config-append PATH]
                            [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH]
                            [--noarp_header_match] [--noarp_responder] [--nobridge_firewalling]
                            [--nocheck_min_tx_rate_support] [--noconntrack_installed] [--nodebug]
                            [--nodhcp_release6] [--nodnsmasq_local_service_supported]
                            [--nodnsmasq_version] [--noebtables_installed] [--nogre_conntrack]
                            [--noicmpv6_header_match] [--noip6tables_installed]
                            [--noip_nonlocal_bind] [--noiproute2_vxlan] [--noipset_installed]
                            [--nokeepalived_garp_on_sighup_support] [--nokeepalived_ipv6_support]
                            [--noovn_localnet_learn_fdb_support]
                            [--noovn_nb_db_schema_port_group_support]
                            [--noovn_nb_db_schema_stateless_nat_support]
                            [--noovn_sb_db_schema_chassis_private_support]
                            [--noovn_sb_db_schema_virtual_port_support] [--noovs_conntrack]
                            [--noovs_geneve] [--noovs_patch] [--noovs_qos_direct_port_supported]
                            [--noovs_vxlan] [--noovsdb_native] [--noread_netns] [--nouse-journal]
                            [--nouse-json] [--nouse-syslog] [--ovn_localnet_learn_fdb_support]
                            [--ovn_nb_db_schema_port_group_support]
                            [--ovn_nb_db_schema_stateless_nat_support]
                            [--ovn_sb_db_schema_chassis_private_support]
                            [--ovn_sb_db_schema_virtual_port_support] [--ovs_conntrack]
                            [--ovs_geneve] [--ovs_patch] [--ovs_qos_direct_port_supported]
                            [--ovs_vxlan] [--ovsdb_native] [--read_netns]
                            [--shell_completion SHELL_COMPLETION] [--state_path STATE_PATH]
                            [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
                            [--use-json] [--use-syslog] [--version]

options:
  -h, --help            show this help message and exit
  --arp_header_match    Check for ARP header match support
  --arp_responder       Check for ARP responder support
  --bridge_firewalling  Check bridge firewalling
  --check_min_tx_rate_support
                        Check if the configured SR-IOV NICs support the "ip-link vf min_tx_rate"
                        parameter.
  --config-dir DIR      Path to a config directory to pull `*.conf` files from. This file set is
                        sorted, so as to provide a predictable parse order if individual options
                        are over-ridden. The set is parsed after the file(s) specified via
                        previous --config-file, arguments hence over-ridden options in the
                        directory take precedence. This option must be set from the command-line.
  --config-file PATH    Path to a config file to use. Multiple config files can be specified, with
                        values in later files taking precedence. Defaults to None. This option
                        must be set from the command-line.
  --conntrack_installed
                        Check conntrack installation
  --debug, -d           If set to true, the logging level will be set to DEBUG instead of the
                        default INFO level.
  --dhcp_release6       Check dhcp_release6 installation
  --dnsmasq_local_service_supported
                        Check for local-service support in dnsmasq
  --dnsmasq_version     Check minimal dnsmasq version
  --ebtables_installed  Check ebtables installation
  --gre_conntrack       Check if conntrack for gre tunnels traffic is supported
  --icmpv6_header_match
                        Check for ICMPv6 header match support
  --ip6tables_installed
                        Check ip6tables installation
  --ip_nonlocal_bind    Check ip_nonlocal_bind kernel option works with network namespaces.
  --iproute2_vxlan      Check for iproute2 vxlan support
  --ipset_installed     Check ipset installation
  --keepalived_garp_on_sighup_support
                        Check keepalived support sending garp on SIGHUP.
  --keepalived_ipv6_support
                        Check keepalived IPv6 support
  --log-config-append, --log-config, --log_config PATH
                        The name of a logging configuration file. This file is appended to any
                        existing logging configuration files. For details about logging
                        configuration files, see the Python logging module documentation. Note
                        that when logging configuration files are used then all logging
                        configuration is set in the configuration file and other logging
                        configuration options are ignored (for example, log-date-format).
  --log-date-format DATE_FORMAT
                        Defines the format string for %(asctime)s in log records. Default: None .
                        This option is ignored if log_config_append is set.
  --log-dir, --logdir LOG_DIR
                        (Optional) The base directory used for relative log_file paths. This
                        option is ignored if log_config_append is set.
  --log-file, --logfile PATH
                        (Optional) Name of log file to send logging output to. If no default is
                        set, logging will go to stderr as defined by use_stderr. This option is
                        ignored if log_config_append is set.
  --noarp_header_match  The inverse of --arp_header_match
  --noarp_responder     The inverse of --arp_responder
  --nobridge_firewalling
                        The inverse of --bridge_firewalling
  --nocheck_min_tx_rate_support
                        The inverse of --check_min_tx_rate_support
  --noconntrack_installed
                        The inverse of --conntrack_installed
  --nodebug             The inverse of --debug
  --nodhcp_release6     The inverse of --dhcp_release6
  --nodnsmasq_local_service_supported
                        The inverse of --dnsmasq_local_service_supported
  --nodnsmasq_version   The inverse of --dnsmasq_version
  --noebtables_installed
                        The inverse of --ebtables_installed
  --nogre_conntrack     The inverse of --gre_conntrack
  --noicmpv6_header_match
                        The inverse of --icmpv6_header_match
  --noip6tables_installed
                        The inverse of --ip6tables_installed
  --noip_nonlocal_bind  The inverse of --ip_nonlocal_bind
  --noiproute2_vxlan    The inverse of --iproute2_vxlan
  --noipset_installed   The inverse of --ipset_installed
  --nokeepalived_garp_on_sighup_support
                        The inverse of --keepalived_garp_on_sighup_support
  --nokeepalived_ipv6_support
                        The inverse of --keepalived_ipv6_support
  --noovn_localnet_learn_fdb_support
                        The inverse of --ovn_localnet_learn_fdb_support
  --noovn_nb_db_schema_port_group_support
                        The inverse of --ovn_nb_db_schema_port_group_support
  --noovn_nb_db_schema_stateless_nat_support
                        The inverse of --ovn_nb_db_schema_stateless_nat_support
  --noovn_sb_db_schema_chassis_private_support
                        The inverse of --ovn_sb_db_schema_chassis_private_support
  --noovn_sb_db_schema_virtual_port_support
                        The inverse of --ovn_sb_db_schema_virtual_port_support
  --noovs_conntrack     The inverse of --ovs_conntrack
  --noovs_geneve        The inverse of --ovs_geneve
  --noovs_patch         The inverse of --ovs_patch
  --noovs_qos_direct_port_supported
                        The inverse of --ovs_qos_direct_port_supported
  --noovs_vxlan         The inverse of --ovs_vxlan
  --noovsdb_native      The inverse of --ovsdb_native
  --noread_netns        The inverse of --read_netns
  --nouse-journal       The inverse of --use-journal
  --nouse-json          The inverse of --use-json
  --nouse-syslog        The inverse of --use-syslog
  --ovn_localnet_learn_fdb_support
                        Check OVN supports localnet_learn_fdb option
  --ovn_nb_db_schema_port_group_support
                        Check OVN NB DB schema support Port_Group
  --ovn_nb_db_schema_stateless_nat_support
                        Check OVN NB DB schema support stateless NAT
  --ovn_sb_db_schema_chassis_private_support
                        Check OVN SB DB schema supports Chassis_Private
  --ovn_sb_db_schema_virtual_port_support
                        Check OVN SB DB schema support virtual ports
  --ovs_conntrack       Check ovs conntrack support
  --ovs_geneve          Check for OVS Geneve support
  --ovs_patch           Check for patch port support
  --ovs_qos_direct_port_supported
                        Check if the ovs supports QoS for direct ports
  --ovs_vxlan           Check for OVS vxlan support
  --ovsdb_native        Check ovsdb native interface support
  --read_netns          Check netns permission settings
  --shell_completion SHELL_COMPLETION
                        Display a shell completion script Allowed values: bash, zsh
  --state_path STATE_PATH
                        Where to store Neutron state files. This directory must be writable by the
                        agent.
  --syslog-log-facility SYSLOG_LOG_FACILITY
                        Syslog facility to receive log lines. This option is ignored if
                        log_config_append is set.
  --use-journal         Enable journald for logging. If running in a systemd environment you may
                        wish to enable journal support. Doing so will use the journal native
                        protocol which includes structured metadata in addition to log
                        messages.This option is ignored if log_config_append is set.
  --use-json            Use JSON formatting for logging. This option is ignored if
                        log_config_append is set.
  --use-syslog          Use syslog for logging. Existing syslog format is DEPRECATED and will be
                        changed later to honor RFC5424. This option is ignored if
                        log_config_append is set.
  --version             show program's version number and exit
Options (77)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--arp_header_matchCheck for ARP header match supporthelp
--arp_responderCheck for ARP responder supporthelp
--bridge_firewallingCheck bridge firewallinghelp
--check_min_tx_rate_supportCheck if the configured SR-IOV NICs support the "ip-link vf min_tx_rate" parameter.help
--config-dir DIRPath to a config directory to pull `*.conf` files from.help
--config-file PATHPath to a config file to use.help
--conntrack_installedCheck conntrack installationhelp
--debug, -dIf set to true, the logging level will be set to DEBUG instead of the default INFO level.help
--dhcp_release6Check dhcp_release6 installationhelp
--dnsmasq_local_service_supportedCheck for local-service support in dnsmasqhelp
--dnsmasq_versionCheck minimal dnsmasq versionhelp
--ebtables_installedCheck ebtables installationhelp
--gre_conntrackCheck if conntrack for gre tunnels traffic is supportedhelp
--icmpv6_header_matchCheck for ICMPv6 header match supporthelp
--ip6tables_installedCheck ip6tables installationhelp
--ip_nonlocal_bindCheck ip_nonlocal_bind kernel option works with network namespaces.help
--iproute2_vxlanCheck for iproute2 vxlan supporthelp
--ipset_installedCheck ipset installationhelp
--keepalived_garp_on_sighup_supportCheck keepalived support sending garp on SIGHUP.help
--keepalived_ipv6_supportCheck keepalived IPv6 supporthelp
--log-config-append, --log-config, --log_config PATHThe name of a logging configuration file.help
--log-date-format DATE_FORMATDefines the format string for %(asctime)s in log records.help
--log-dir, --logdir LOG_DIR(Optional) The base directory used for relative log_file paths.help
--log-file, --logfile PATH(Optional) Name of log file to send logging output to.help
--noarp_header_matchThe inverse of --arp_header_matchhelp
--noarp_responderThe inverse of --arp_responderhelp
--nobridge_firewallingThe inverse of --bridge_firewallinghelp
--nocheck_min_tx_rate_supportThe inverse of --check_min_tx_rate_supporthelp
--noconntrack_installedThe inverse of --conntrack_installedhelp
--nodebugThe inverse of --debughelp
--nodhcp_release6The inverse of --dhcp_release6help
--nodnsmasq_local_service_supportedThe inverse of --dnsmasq_local_service_supportedhelp
--nodnsmasq_versionThe inverse of --dnsmasq_versionhelp
--noebtables_installedThe inverse of --ebtables_installedhelp
--nogre_conntrackThe inverse of --gre_conntrackhelp
--noicmpv6_header_matchThe inverse of --icmpv6_header_matchhelp
--noip6tables_installedThe inverse of --ip6tables_installedhelp
--noip_nonlocal_bindThe inverse of --ip_nonlocal_bindhelp
--noiproute2_vxlanThe inverse of --iproute2_vxlanhelp
--noipset_installedThe inverse of --ipset_installedhelp
--nokeepalived_garp_on_sighup_supportThe inverse of --keepalived_garp_on_sighup_supporthelp
--nokeepalived_ipv6_supportThe inverse of --keepalived_ipv6_supporthelp
--noovn_localnet_learn_fdb_supportThe inverse of --ovn_localnet_learn_fdb_supporthelp
--noovn_nb_db_schema_port_group_supportThe inverse of --ovn_nb_db_schema_port_group_supporthelp
--noovn_nb_db_schema_stateless_nat_supportThe inverse of --ovn_nb_db_schema_stateless_nat_supporthelp
--noovn_sb_db_schema_chassis_private_supportThe inverse of --ovn_sb_db_schema_chassis_private_supporthelp
--noovn_sb_db_schema_virtual_port_supportThe inverse of --ovn_sb_db_schema_virtual_port_supporthelp
--noovs_conntrackThe inverse of --ovs_conntrackhelp
--noovs_geneveThe inverse of --ovs_genevehelp
--noovs_patchThe inverse of --ovs_patchhelp
--noovs_qos_direct_port_supportedThe inverse of --ovs_qos_direct_port_supportedhelp
--noovs_vxlanThe inverse of --ovs_vxlanhelp
--noovsdb_nativeThe inverse of --ovsdb_nativehelp
--noread_netnsThe inverse of --read_netnshelp
--nouse-journalThe inverse of --use-journalhelp
--nouse-jsonThe inverse of --use-jsonhelp
--nouse-syslogThe inverse of --use-sysloghelp
--ovn_localnet_learn_fdb_supportCheck OVN supports localnet_learn_fdb optionhelp
--ovn_nb_db_schema_port_group_supportCheck OVN NB DB schema support Port_Grouphelp
--ovn_nb_db_schema_stateless_nat_supportCheck OVN NB DB schema support stateless NAThelp
--ovn_sb_db_schema_chassis_private_supportCheck OVN SB DB schema supports Chassis_Privatehelp
--ovn_sb_db_schema_virtual_port_supportCheck OVN SB DB schema support virtual portshelp
--ovs_conntrackCheck ovs conntrack supporthelp
--ovs_geneveCheck for OVS Geneve supporthelp
--ovs_patchCheck for patch port supporthelp
--ovs_qos_direct_port_supportedCheck if the ovs supports QoS for direct portshelp
--ovs_vxlanCheck for OVS vxlan supporthelp
--ovsdb_nativeCheck ovsdb native interface supporthelp
--read_netnsCheck netns permission settingshelp
--shell_completion SHELL_COMPLETIONDisplay a shell completion script Allowed values: bash, zshhelp
--state_path STATE_PATHWhere to store Neutron state files.help
--syslog-log-facility SYSLOG_LOG_FACILITYSyslog facility to receive log lines.help
--use-journalEnable journald for logging.help
--use-jsonUse JSON formatting for logging.help
--use-syslogUse syslog for logging.help
--versionshow program's version number and exithelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.