From nobody Mon Apr 29 09:40:52 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=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1642605548; cv=none; d=zohomail.com; s=zohoarc; b=N7AG62GEk5uOto/pIMwMB4rNjMsUMdvo3SdzAfdU6kJ+xl+SYDJLbGMzL9V41uXwX2SPqarJ6eiluRmXEIul99WXHf009scVQKlmlEm0/2aYgDh+mY5SyYbt7J8IGei1G/QDg1HuIdh+UL2WT0NSU7nLCavmGLs6dlS1j/7ENuc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1642605548; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=bfFXuDVYA1/DFdFO7+8jPG2YDX6OJI8w7+aDaXWaAQI=; b=OGCqjcaSlHz21JHa98vyh6pKBy19cokkiAN6j2nEieJdgmmgdAbgS+fRFgv2bYJ624fSTwUby44ZdPSMhmCTsmQtXw5XhLRLgNgiNuBbjgBUDfgLNsxXUMtdmx3Nl4qpa+iqmHA5jN7iUoSP2OgRTohUupg9WkjyG+Pvb9NcS40= 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=pass 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 1642605548232716.1557664822102; Wed, 19 Jan 2022 07:19:08 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-490--rCGMkkyMe62cTQMBF4jXw-1; Wed, 19 Jan 2022 10:19:03 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3DC8718B9F2C; Wed, 19 Jan 2022 15:18:58 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 15EFF7B6C3; Wed, 19 Jan 2022 15:18:58 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id D8D7C4A705; Wed, 19 Jan 2022 15:18:57 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 20JF6tZu022807 for ; Wed, 19 Jan 2022 10:06:55 -0500 Received: by smtp.corp.redhat.com (Postfix) id B0A982B451; Wed, 19 Jan 2022 15:06:55 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.7]) by smtp.corp.redhat.com (Postfix) with ESMTP id 171C02B45F for ; Wed, 19 Jan 2022 15:06:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1642605547; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=bfFXuDVYA1/DFdFO7+8jPG2YDX6OJI8w7+aDaXWaAQI=; b=JKAyR/sJd3+CbsqRAIAa1udEF5yNurUaKsamoBPY4OIkByOTOJqmX8UY/59L5mQka+0Xj6 gAobSEVV1eR3+GvTjKsuRyVtM/JO339P5WdeOSGh0Mb/TM16P9otpYWy2kzV3uYuVJSY05 B4EozqjhAhPjg96CvXpHLjhZQahE67U= X-MC-Unique: -rCGMkkyMe62cTQMBF4jXw-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH] docs: man: virsh: Document more carefully that 'guestinfo' can return nothing Date: Wed, 19 Jan 2022 16:06:44 +0100 Message-Id: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1642605548737100001 Content-Type: text/plain; charset="utf-8" When invoking 'virsh guestinfo $VM' without explicitly specifying a group of information to return, virsh always reports success even when the guest agent doesn't report any information in the current state. This is desired in situations when you are okay with stats being missing and avoids spurious errors being reported. Clarify that this is really desired in the man page. Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=3D2041665 Signed-off-by: Peter Krempa --- docs/manpages/virsh.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index dd534c10cb..19fb8cd0e4 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -2768,11 +2768,14 @@ Note that this command requires a guest agent to be= configured and running in the domain's guest OS. When run without any arguments, this command prints all information types = that -are supported by the guest agent. You can limit the types of information t= hat -are returned by specifying one or more flags. If a requested information -type is not supported, the processes will provide an exit code of 1. -Available information types flags are *--user*, *--os*, +are supported by the guest agent at that point, omitting unavailable ones. +Success is always reported in this mode. + +You can limit the types of information that are returned by specifying one= or +more flags. Available information types flags are *--user*, *--os*, *--timezone*, *--hostname*, *--filesystem*, *--disk* and *--interface*. +If an explicitly requested information type is not supported by the guest = agent +at that point, the processes will provide an exit code of 1. Note that depending on the hypervisor type and the version of the guest ag= ent running within the domain, not all of the following information may be --=20 2.34.1