181cb4fab2ff421a034410d6a9022eb421e979d2
[openstack-build/neutron-build.git] / neutron / debug / README
1 Debug Helper Script for Neutron
2
3 - Configure
4 export NEUTRON_TEST_CONFIG_FILE=/etc/neutron/debug.ini
5 or
6 export NEUTRON_TEST_CONFIG_FILE=/etc/neutron/l3_agent.ini
7
8 you can also specify config file by --config-file option
9
10 - Usage
11 neutron-debug commands
12
13 probe-create <net-id>
14   Create probe port - create port and interface, then plug it in.
15   This commands returns a port id of a probe port. A probe port is a port which is used to test.
16   The port id is probe id.
17   We can have multiple probe probes in a network, in order to check connectivity between ports.
18
19   neutron-debug probe-exec probe_id_1 'nc -l 192.168.100.3 22'
20   neutron-debug probe-exec probe_id_2 'nc -vz 192.168.100.4 22'
21
22   Note: You should use a user and a tenant who has permission to
23    modify network and subnet if you want to probe. For example, you need to be admin user if you
24    want to probe external network.
25
26 probe-delete <port-id>  Delete probe - delete port then uplug
27 probe-exec <port-id> 'command'    Exec commands on the namespace of the probe
28 `probe-exec <port-id>` 'interactive command' Exec interactive command (eg, ssh)
29
30 probe-list     List probes
31 probe-clear    Clear All probes
32
33 ping-all --id <network_id> --timeout 1 (optional)
34          ping-all is all-in-one command to ping all fixed ip's in all network or a specified network.
35          In the command probe is automatically created if needed.
36
37 neutron-debug extends the shell of neutronclient,  so you can use all the commands of neutron
38