From nobody Mon Sep 16 18:59:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=none dis=none) header.from=riseup.net ARC-Seal: i=1; a=rsa-sha256; t=1693756235; cv=none; d=zohomail.com; s=zohoarc; b=jE+G8Xx+W/CAT8i6KhvhgIorJeuIRtyrWVq+QH9zWE+MaXJixaXjCR6Px7aRpp4AacaOBylYw10YidTLO/KYjhFhK71n2ek1noPC5qGG/V9NtR2ECpKesPnSL8LETFZWuYV5G6c9J5YeX8287ZD6pGWzGst3Ec9BI2s2r06OYwE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1693756235; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=6bTztl8Ghr2oKlYH63oZtB26lf0OgW/fqtMNg7uTLo8=; b=HE0Bu1JT1OX9vqKuxC7nRDfSXccsEybjLlPZVYmWPjik7eomHaIuNpSCQRFGUm2JbwB/guYntceKfpGoLpmUtGQfEKqriTduVhdvWHnCiiA01RyeoJ3+7MhHkdJM8PMcx/P49B4h3pYUwlPFV79M+GFxkIXLVci8rLFXQmW9vJE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1693756235308244.21293480823124; Sun, 3 Sep 2023 08:50:35 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-554-AjHiDxOHN-Wk6ioXEOTfKA-1; Sun, 03 Sep 2023 11:50:31 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2E37E38149A1; Sun, 3 Sep 2023 15:50:29 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1897E40C6CCC; Sun, 3 Sep 2023 15:50:29 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id EB31819465B7; Sun, 3 Sep 2023 15:50:28 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 8A6F71946588 for ; Sun, 3 Sep 2023 15:50:27 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 7D225525720; Sun, 3 Sep 2023 15:50:27 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast04.extmail.prod.ext.rdu2.redhat.com [10.11.55.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 751EE493114 for ; Sun, 3 Sep 2023 15:50:27 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-inbound-delivery-1.mimecast.com [207.211.31.81]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 56EBD101A54E for ; Sun, 3 Sep 2023 15:50:27 +0000 (UTC) Received: from mx1.riseup.net (mx1.riseup.net [198.252.153.129]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-411-YmjlQRR1MVeeLpvLMeEUGg-1; Sun, 03 Sep 2023 11:50:25 -0400 Received: from fews02-sea.riseup.net (fews02-sea-pn.riseup.net [10.0.1.112]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx1.riseup.net (Postfix) with ESMTPS id 4Rdx741vBfzDrDX for ; Sun, 3 Sep 2023 15:50:24 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by fews02-sea.riseup.net (Postfix) with ESMTPSA id 4Rdx730sFSzFpfK; Sun, 3 Sep 2023 15:50:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1693756234; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=6bTztl8Ghr2oKlYH63oZtB26lf0OgW/fqtMNg7uTLo8=; b=Mcr2bj2ecU/E+7kCwBEMsnHExQaB0GER9rBE6TaRzg1FgFghUWeMd6+9Lvoq1NT0W3ZmHw AzKZyciHMjuEOyAt4H0KD456H9rah/lLJY/aTl6Oj/t6zARzrfGyOAsWNT6zUOybpqxR+A HSinFD3GazildJJ+lQakRjMLIbt/MnY= X-MC-Unique: AjHiDxOHN-Wk6ioXEOTfKA-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: YmjlQRR1MVeeLpvLMeEUGg-1 X-Riseup-User-ID: 335B7ADAA91855B4938D08911B8642A1C08ECA4B52C71A3FFE8AAE7AB9DAC64B From: K Shiva Kiran To: libvir-list@redhat.com Subject: [PATCH 12/16] docs: Document nwfilter metadata related commands Date: Sun, 3 Sep 2023 21:19:13 +0530 Message-ID: <20230903155034.211476-13-shiva_kr@riseup.net> In-Reply-To: <20230903155034.211476-1-shiva_kr@riseup.net> References: <20230903155034.211476-1-shiva_kr@riseup.net> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: K Shiva Kiran Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: riseup.net Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1693756237547100009 Content-Type: text/plain; charset="utf-8"; x-default="true" Documents the commands `nwfilter-desc`, `nwfilter-metadata` and the new `--title` option of `nwfilter-list`. Signed-off-by: K Shiva Kiran --- 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 =20 :: =20 - nwfilter-list + nwfilter-list [--title] =20 List all of the available network filters. =20 +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 m= etadata.) + +- *--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* opt= ion. + +- *--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 descrip= tion +is displayed instead of being modified. + =20 nwfilter-dumpxml ---------------- @@ -8133,6 +8176,59 @@ The editor used can be supplied by the ``$VISUAL`` o= r ``$EDITOR`` environment variables, and defaults to ``vi``. =20 =20 +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* arg= ument + 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 correspo= nding +to the *uri* namespace is displayed instead of being modified. + +- *--remove* + + Specifies that the metadata element specified by the *--uri* argument sh= ould + be removed rather than updated. + + + NWFILTER BINDING COMMANDS =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D =20 --=20 2.42.0