diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml
index 411b332afe..c2c32d5dfb 100644
--- a/doc/cli-reference/bk-cli-reference.xml
+++ b/doc/cli-reference/bk-cli-reference.xml
@@ -9,7 +9,7 @@
OpenStack Command-Line Interface Reference
-CLI Reference
+ CLI Reference
@@ -35,7 +35,7 @@
- This guide documents the OpenStack command-line clients.
+ This guide documents the OpenStack command-line clients.
@@ -52,6 +52,16 @@
+
+ 2014-03-14
+
+
+
+ Added documentation for the neutron-debug command.
+
+
+
+
@@ -62,6 +72,7 @@
+
diff --git a/doc/cli-reference/ch_cli_neutron-debug_commands.xml b/doc/cli-reference/ch_cli_neutron-debug_commands.xml
new file mode 100644
index 0000000000..b9dc5633b8
--- /dev/null
+++ b/doc/cli-reference/ch_cli_neutron-debug_commands.xml
@@ -0,0 +1,313 @@
+
+
+
+
+
+
+
+ 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 COMMAND
+
+
+ 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> ...
+
+
+ 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.
+
+
+
+
+
+
+ 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)
+
+
+
+
+
+ neutron-debug probe-create command
+ usage: neutron-debug probe-create NET
+
+ 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.
+
+
+
+
+
+ neutron-debug probe-list command
+ usage: neutron-debug probe-list
+
+ List probes.
+
+
+ neutron-debug probe-clear command
+ usage: neutron-debug probe-clear
+
+ Clear all probes.
+
+
+ neutron-debug probe-delete command
+ usage: neutron-debug probe-delete <port-id>
+
+
+Remove a probe.
+
+ Positional arguments
+
+ <port-id>
+
+ ID of the probe to delete.
+
+
+
+
+
+ neutron-debug probe-exec command
+ usage: neutron-debug probe-exec <port-id> <command>
+
+ Execute commands in the namespace of the probe
+
+
+ neutron-debug ping-all command
+ usage: neutron-debug ping-all <port-id> --timeout <number
+
+ 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.
+
+
+
+
+
+ neutron-debug example
+ usage: 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.
+
+