neutron-debug command-line clientThe 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-debugCOMMANDneutron-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> ...
Subcommandsprobe-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 an all-in-one command to ping all fixed IPs in a specified network.
neutron-debug optional arguments--versionShow version number and exit.-v, --verbose, --debugIncrease verbosity of output and show tracebacks on
errors. Can be repeated.-q, --quietSuppress output except warnings and errors-h, --helpShow 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]--insecureExplicitly 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_FILEConfig file for interface driver (You may also use
l3_agent.ini)neutron-debug probe-create commandusage: neutron-debug probe-create NETCreate probe port - create port and interface, then
place it into the created network namespace.Positional argumentsNET IDID of the network in which the probe will be
created.neutron-debug probe-list commandusage: neutron-debug probe-listList probes.neutron-debug probe-clear commandusage: neutron-debug probe-clearClear all probes.neutron-debug probe-delete commandusage: neutron-debug probe-delete <port-id>
Remove a probe.
Positional arguments<port-id>ID of the probe to delete.neutron-debug probe-exec commandusage: neutron-debug probe-exec <port-id> <command>Execute commands in the namespace of the probeneutron-debug ping-all commandusage: neutron-debug ping-all <port-id> --timeout <numberAll-in-one command to ping all fixed IPs
in a specified network. A probe creation is not needed
for this command. A new probe is created automatically. It will,
however, need to be deleted manually when it is no longer needed.
When there are multiple networks, the newly created probe will be
attached to a random network and thus the ping will take
place from within that random network.Positional arguments<port-id>ID of the port to use.Optional arguments--timeout <timeout in
seconds>Optional ping timeout.neutron-debug exampleusage: neutron-debug create-probe < NET_ID>Create a probe namespace within the network identified
by NET_ID. The namespace will have the name of qprobe-<UUID
of the probe port>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>"SSH to an instance within the network.usage: neutron-debug ping-all <network ID>"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>"Ping the DHCP server for this network using dhcping to
verify it is working.