Documents the commands `nwfilter-desc`, `nwfilter-metadata` and the new `--title` option of `nwfilter-list`. Signed-off-by: K Shiva Kiran <shiva_kr@xxxxxxxxxx> --- docs/manpages/virsh.rst | 98 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 97 insertions(+), 1 deletion(-) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index 91e1d5de37..c81927d290 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -8082,10 +8082,53 @@ nwfilter-list :: - nwfilter-list + nwfilter-list [--title] List all of the available network filters. +If *--title* is specified, then the short network filter description +(title) is printed in an extra column. + + +nwfilter-desc +------------- + +**Syntax:** + +:: + + nwfilter-desc [--nwfilter] nwfilter-name + [--title] [--edit] [--remove] + [--new-desc new-value] + +Show or modify description and title of a network filter. + +These values are user fields that allow storing arbitrary textual data to +allow easy identification of network filters. +Title should be short, although it's not enforced. +(See also ``nwfilter-metadata`` that works with XML based network filter metadata.) + +- *--title* + + Specifies to operate on the title field instead of description. + +- *--edit* + + Opens an editor with the current title or description. + Modifications to the contents will be saved back. + Alternatively, the new contents can be provided via the *--new-desc* option. + +- *--remove* + + Removes the title or description field. + +- *--new-desc* + + Stores the provided title/description string. + +If neither of *--edit* or *--new-desc* are specified, the title or description +is displayed instead of being modified. + nwfilter-dumpxml ---------------- @@ -8133,6 +8176,59 @@ The editor used can be supplied by the ``$VISUAL`` or ``$EDITOR`` environment variables, and defaults to ``vi``. +nwfilter-metadata +----------------- + +**Syntax:** + +:: + + nwfilter-metadata [--nwfilter] nwfilter-name [--uri] uri + [--edit] [[--key] nskey] [--set new-metadata-xml] + [--remove] + +Show or modify custom XML metadata of a network filter. + +The metadata is a user defined XML that allows storing arbitrary XML data +in the network filter definition. +Multiple separate custom metadata pieces can be stored in the +network filter XML. The pieces are identified by a private XML namespace +provided via the *uri* argument. +(See also ``nwfilter-desc`` that works with textual metadata of +a network filter, such as title and description.) + +- *--uri* + + Specifies the URI for the private namespace. + +- *--edit* + + Opens an editor with the metadata identified by the *uri* argument. + Modifications to the contents will be saved back. + Alternatively, the new contents can be provided via the *--set* argument. + +- *--key* + + Specifies the namespace key to be used. + +- *--set* + + Validates and stores the provided metadata string. + + **Note:** When setting metadata via *--edit* or *--set* the *--key* argument + must be specified and is used to prefix the custom elements to bind them + to the private namespace. + +If neither of *--edit* and *--set* are specified the XML metadata corresponding +to the *uri* namespace is displayed instead of being modified. + +- *--remove* + + Specifies that the metadata element specified by the *--uri* argument should + be removed rather than updated. + + + NWFILTER BINDING COMMANDS ========================= -- 2.42.0
