openstack/neutron
Code Issues Proposed changes
a8c6d84b69
neutron/doc/source/ovn/ml2ovn_trace.rst
Brian Haley 7d139a013b Add RST linting to neutron 
Start running the doc8 RST linter in the pep8 job. This
will catch obvious errors like line too long, etc. Tried
to fix most of the errors (there were a lot!), but added
some ignore directives so we can address some files later.

Did have to move a couple of files around as a double
include was causing some issues, but content is unchanged.

Change-Id: I336a9ee7729045da095be22ea0f58ee596967174
2024-10-01 11:18:46 -04:00

2.6 KiB
Raw Blame History

ml2ovn-trace

This is a simple wrapper around ovn-trace that will fill in datapath, inport, eth.src, ip.src, eth.dst, and ip.dst based on values pulled from openstack objects.

Usage

Usage: ml2ovn-trace [OPTIONS] [OVNTRACE_ARGS]...

Options:
  -c, --cloud TEXT                Cloud from clouds.yaml to connect to
  -n, --net TEXT                  Network to limit interfaces lookups to
  --from-net TEXT                 Network to limit src interface lookups to
  --to-net TEXT                   Network to limit dst interface lookups to
  -f, --from [server|router]=value
                                  Fill eth-src/ip-src from the same object,
                                  e.g. server=vm1

  --eth-src [mac|server|router]=value
                                  Object from which to fill eth.src
                                  [required]

  --ip-src [ip|server|router]=value
                                  Object from which to fill ip.src  [required]
  -t, --to [server|router]=value  Fill eth-dst/ip-dst from the same object,
                                  e.g. server=vm2

  -v, --eth-dst, --via [mac|server|router]=value
                                  Object from which to fill eth.dst
                                  [required]

  --ip-dst [ip|server|router]=value
                                  Object from which to fill ip.dst  [required]
  -m, --microflow TEXT            Additional microflow text to append to the
                                  one generated

  -v, --verbose                   Enables verbose mode
  --dry-run                       Print ovn-trace output, but don't run it
  --help                          Show this message and exit.

Examples

If vm1 and vm2 only have one network interface and you want to trace between them:

$ sudo ml2ovn-trace --from server=vm1 --to server=vm2

Or if you want to limit to a specific network:

$ sudo ml2ovn-trace --net net1 --from server=vm1 --to server=vm2

Or if you want to go from vm1 to the floating IP of vm2 via vm1's router:

$ sudo ml2ovn-trace --net net1 --from server=vm1 --to ip=172.18.1.7 --via router=net1-router

To add to the generated microflow, use -m. For example, for SSH:

$ sudo ml2ovn-trace --net net1 --from server=vm1 --to server=vm2 -m "tcp.dst==22"

To pass arbitrary (non microflow) arguments to ovn-trace, place them after '--':

$ sudo ml2ovn-trace --net net1 --from server=vm1 --to server=vm2 -- --summary