[libvirt] [PATCH] add nwfilter functions to virsh man page
Unfortunately after the 0.8.0 release, but here's a beginning of the documentation of the nwfilter functionality. Signed-off-by; Stefan Berger <stefanb@us.ibm.com> --- tools/virsh.pod | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) Index: libvirt-acl/tools/virsh.pod =================================================================== --- libvirt-acl.orig/tools/virsh.pod +++ libvirt-acl/tools/virsh.pod @@ -840,6 +840,59 @@ children of this snapshot. =back +=head1 NWFILTER COMMMANDS + +The following commands manipulate network filters. Network filters allow +to filter the network traffic comming from and going to virtual machines. +Individual network traffic filters are written in XML, may contain +references to other network filters, describe traffic filtering rules, +or contain both. Network filters are referenced by virtual machines +from within their interface description. A network filter may be referenced +by multiple virtual machines' interfaces. + +=over 4 + +=item B<nwfilter-define> I<xmlfile> + +Make a new network filter known to libvirt. If a network filter with +the same name already exists, it will be replaced with the new XML. +Any running virtual machine referencing this network filter will have +its network traffic rules adapted. If for any reason the network traffic +filtering rules cannot be instantiated by any of the running virtual +machines, then the new XML will be rejected. + +=item B<nwfilter-undefine> I<nwfilter-name> + +Delete a network filter. The deletion will fail if any running virtual +machine is currently using this network filter. + +=item B<nwfilter-list> + +List all of the available network filters. + +=item B<nwfilter-dumpxml> I<nwfilter-name> + +Output the network filter XML. + +=item B<nwfilter-edit> I<nwfilter-name> + +Edit the XML of a network filter. + +This is equivalent to: + + virsh nwfilter-dumpxml myfilter > myfilter.xml + edit myfilter.xml + virsh nwfilter-define myfilter.xml + +except that it does some error checking. +The new network filter may be rejected due to the same reason as +mention in I<nwfilter-define>. + +The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment +variables, and defaults to C<vi>. + +=back + =head1 ENVIRONMENT The following environment variables can be set to alter the behaviour
On 04/12/2010 12:47 PM, Stefan Berger wrote:
Unfortunately after the 0.8.0 release, but here's a beginning of the documentation of the nwfilter functionality.
+=head1 NWFILTER COMMMANDS + +The following commands manipulate network filters. Network filters allow +to filter the network traffic comming from and going to virtual machines.
s/allow to filter the/allow filtering of the/ s/comming/coming/
+Individual network traffic filters are written in XML, may contain
s/, may/, and may/
+references to other network filters, describe traffic filtering rules, +or contain both. Network filters are referenced by virtual machines +from within their interface description. A network filter may be referenced +by multiple virtual machines' interfaces. + +=over 4 + +=item B<nwfilter-define> I<xmlfile> + +Make a new network filter known to libvirt. If a network filter with +the same name already exists, it will be replaced with the new XML. +Any running virtual machine referencing this network filter will have +its network traffic rules adapted. If for any reason the network traffic +filtering rules cannot be instantiated by any of the running virtual +machines, then the new XML will be rejected. + +=item B<nwfilter-undefine> I<nwfilter-name> + +Delete a network filter. The deletion will fail if any running virtual +machine is currently using this network filter. + +=item B<nwfilter-list> + +List all of the available network filters. + +=item B<nwfilter-dumpxml> I<nwfilter-name> + +Output the network filter XML. + +=item B<nwfilter-edit> I<nwfilter-name> + +Edit the XML of a network filter. + +This is equivalent to: + + virsh nwfilter-dumpxml myfilter > myfilter.xml + edit myfilter.xml + virsh nwfilter-define myfilter.xml + +except that it does some error checking. +The new network filter may be rejected due to the same reason as +mention in I<nwfilter-define>.
s/mention/mentioned/
+ +The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment +variables, and defaults to C<vi>. + +=back + =head1 ENVIRONMENT
The following environment variables can be set to alter the behaviour
Another one of those spelling battles. Depends on who you ask: $ git grep behavior -- src tools | wc 7 78 567 $ git grep behaviour -- src tools | wc 13 91 1015 $ git grep behavior -- tools/virsh.pod | wc 2 27 157 $ git grep behaviour -- tools/virsh.pod | wc 1 11 86 but maybe we should go with the American 'behavior' (couldn't help myself on the pun). ACK, after fixing the nits. And I might as well submit a separate patch for behavio[u]r, given my previous patch for initiali[sz]e. -- Eric Blake eblake@redhat.com +1-801-349-2682 Libvirt virtualization library http://libvirt.org
participants (2)
-
Eric Blake -
Stefan Berger