Chapter 10. neutron-debug command-line client


The neutron-debug client is an extension to the neutron command-line interface (CLI) for the OpenStack neutron-debug tool. This chapter documents neutron-debug version 2.3.0.
For help on a specific neutron-debug command, enter:
$ neutron-debug help COMMAND
Copy to Clipboard Toggle word wrap

10.1. neutron-debug usage

 [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ... 
Copy to Clipboard Toggle word wrap

Subcommands

probe-create
Create probe port - create port and interface within a network namespace.
probe-list
List all probes.
probe-clear
Clear all probes.
probe-delete
Delete probe - delete port then delete the namespace.
probe-exec
Execute commands in the namespace of the probe.
ping-all
ping-all is all-in-one command to ping all fixed IP's in a specified network.

10.2. neutron-debug optional arguments

--version
Show version number and exit.
-v, --verbose, --debug
Increase verbosity of output and show tracebacks on errors. Can be repeated.
-q, --quiet
Suppress output except warnings and errors
-h, --help
Show this help message and exit
--os-auth-strategy <auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication
--os-auth-url <auth-url>
Authentication URL (Env: OS_AUTH_URL)
--os-tenant-name <auth-tenant-name>
Authentication tenant name (Env: OS_TENANT_NAME)
--os-tenant-id <auth-tenant-id>
Authentication tenant name (Env: OS_TENANT_ID)
--os-username <auth-username>
Authentication username (Env: OS_USERNAME)
--os-password <auth-password>
Authentication password (Env: OS_PASSWORD)
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-token <token>
Defaults to env[OS_TOKEN]
--endpoint-type <endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or public URL.
--os-url <url>
Defaults to env[OS_URL]
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]
--insecure
Explicitly allow neutron-debug to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--config-file CONFIG_FILE
Config file for interface driver (You may also use l3_agent.ini)

10.3. neutron-debug probe-create command

usage: neutron-debug probe-create NET
Copy to Clipboard Toggle word wrap
Create probe port - create port and interface, then place it into the created network namespace.

Positional arguments

NET ID
ID of the network in which the probe will be created.

10.4. neutron-debug probe-list command

usage: neutron-debug probe-list
Copy to Clipboard Toggle word wrap
List probes.

10.5. neutron-debug probe-clear command

usage: neutron-debug probe-clear
Copy to Clipboard Toggle word wrap
Clear all probes.

10.6. neutron-debug probe-delete command

usage: neutron-debug probe-delete <port-id>
Copy to Clipboard Toggle word wrap
Remove a probe.

Positional arguments

<port-id>
ID of the probe to delete.

10.7. neutron-debug probe-exec command

usage: neutron-debug probe-exec <port-id> <command>
Copy to Clipboard Toggle word wrap
Execute commands in the namespace of the probe

10.8. neutron-debug ping-all command

usage: neutron-debug ping-all <port-id> --timeout <number
Copy to Clipboard Toggle word wrap
All-in-one command to ping all fixed IP's in a specified network.

Positional arguments

<port-id>
ID of the port to use.

Optional arguments

--timeout <timeout in seconds>
Optional ping timeout.

10.9. neutron-debug example

usage: neutron-debug create-probe < NET_ID>
Copy to Clipboard Toggle word wrap
Create a probe namespace within the network identified by NET_ID. The namespace will have the name of qprobe-<UUID of the probe port>
Note
For the following examples to function, the security group rules may need to be modified to allow the SSH (TCP port 22) or ping (ICMP) traffic into network.
usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>"
Copy to Clipboard Toggle word wrap
SSH to an instance within the network.
usage: neutron-debug ping-all <network ID>"
Copy to Clipboard Toggle word wrap
Ping all instances on this network to verify they are responding.
usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>"
Copy to Clipboard Toggle word wrap
Ping the DHCP server for this network using dhcping to verify it is working.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat