From nobody Mon Feb 9 14:00:01 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) client-ip=207.211.31.81; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 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=1595510566; cv=none; d=zohomail.com; s=zohoarc; b=hWzV9Voro5uAe8aU8ziKN9l/lqSPY/JfVuDvTHRbn0TTZOnbQVJW3BW6cKRCOQXbnMcAUbBkSYzod9IAGQJfJMOwEe5ZpyC9K7qUbS9kxl8h4Vr7g+FsFT3dbBk1bz17HH3Wj3Id85f8N+kKcDjJdTE2bWY5Qnvaz9BIyyMvPPI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1595510566; h=Content-Type:Content-Transfer-Encoding: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=P/YiUKUFComE+3GV6VWqhLGeYs/CdcIpEZpp1jbYCwU=; b=TRacLC7wkH3phkDSC8EN68EDmopE/waxN3aJLZnK402bxJFoU1Y4qiuM5WKj8q+RbFyWY+EXHcH1cF+rJHR3iS79ppB8WFSZR2kOOstnf6vak3K0bR5Jur5bUQM49mhleOgiM4Ksv8LWs9XEok19PZL2f22EHL9avc/Dn+feSN8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) by mx.zohomail.com with SMTPS id 1595510566657730.7402949608282; Thu, 23 Jul 2020 06:22:46 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-475-4Chp3YmFOhSNpkCDT2NxTA-1; Thu, 23 Jul 2020 09:22:43 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 52DC09127B; Thu, 23 Jul 2020 13:22:37 +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 1686571D25; Thu, 23 Jul 2020 13:22:36 +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 DC0B1A3596; Thu, 23 Jul 2020 13:22:35 +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 06NDMUav028693 for ; Thu, 23 Jul 2020 09:22:30 -0400 Received: by smtp.corp.redhat.com (Postfix) id 5242019D7C; Thu, 23 Jul 2020 13:22:30 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9CDB52DE9A for ; Thu, 23 Jul 2020 13:22:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1595510565; 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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=P/YiUKUFComE+3GV6VWqhLGeYs/CdcIpEZpp1jbYCwU=; b=UuWEbqHVpiDEBC/l5rubPSy0e18TBGrxKttwutbGYRUmLnoqhI5DzlcvVTqyADU6RjoyZM ZuTnHwEzQlUcR0vPXEqTkIDuEcjxtC6xewIzJ+kCm9Z0qNF9qhGOnIfzXkq86vaoDUyRvT t7BDeUhAKFRxhN7Sbn4r62KSFPHET+I= X-MC-Unique: 4Chp3YmFOhSNpkCDT2NxTA-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 23/32] docs: formatdomain-devices: Split out Date: Thu, 23 Jul 2020 15:21:28 +0200 Message-Id: In-Reply-To: References: 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.15 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa --- docs/formatdomain-devices-watchdog.rst | 63 +++++++++++++++++++++++++ docs/formatdomain-devices.rst | 65 +------------------------- docs/meson.build | 1 + 3 files changed, 65 insertions(+), 64 deletions(-) create mode 100644 docs/formatdomain-devices-watchdog.rst diff --git a/docs/formatdomain-devices-watchdog.rst b/docs/formatdomain-dev= ices-watchdog.rst new file mode 100644 index 0000000000..7a7ffaffce --- /dev/null +++ b/docs/formatdomain-devices-watchdog.rst @@ -0,0 +1,63 @@ +:anchor:`` + +Watchdog device +~~~~~~~~~~~~~~~ + +A virtual hardware watchdog device can be added to the guest via the +``watchdog`` element. :since:`Since 0.7.3, QEMU and KVM only` + +The watchdog device requires an additional driver and management daemon in= the +guest. Just enabling the watchdog in the libvirt configuration does not do +anything useful on its own. + +Currently libvirt does not support notification when the watchdog fires. T= his +feature is planned for a future version of libvirt. + +:: + + ... + + + + ... + +:: + + ... + + + + + +``model`` + The required ``model`` attribute specifies what real watchdog device is + emulated. Valid values are specific to the underlying hypervisor. + + QEMU and KVM support: + + - 'i6300esb' - the recommended device, emulating a PCI Intel 6300ESB + - 'ib700' - emulating an ISA iBase IB700 + - 'diag288' - emulating an S390 DIAG288 device :since:`Since 1.2.17` + +``action`` + The optional ``action`` attribute describes what action to take when the + watchdog expires. Valid values are specific to the underlying hyperviso= r. + + QEMU and KVM support: + + - 'reset' - default, forcefully reset the guest + - 'shutdown' - gracefully shutdown the guest (not recommended) + - 'poweroff' - forcefully power off the guest + - 'pause' - pause the guest + - 'none' - do nothing + - 'dump' - automatically dump the guest :since:`Since 0.8.7` + - 'inject-nmi' - inject a non-maskable interrupt into the guest + :since:`Since 1.2.17` + + Note 1: the 'shutdown' action requires that the guest is responsive to = ACPI + signals. In the sort of situations where the watchdog has expired, gues= ts are + usually unable to respond to ACPI signals. Therefore using 'shutdown' i= s not + recommended. + + Note 2: the directory to save dump files can be configured by + ``auto_dump_path`` in file /etc/libvirt/qemu.conf. diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index acf08e8d15..819c05e531 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -55,70 +55,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3= .9.0` .. include:: formatdomain-devices-video.rst .. include:: formatdomain-devices-chardev.rst .. include:: formatdomain-devices-sound.rst - -:anchor:`` - -Watchdog device -~~~~~~~~~~~~~~~ - -A virtual hardware watchdog device can be added to the guest via the -``watchdog`` element. :since:`Since 0.7.3, QEMU and KVM only` - -The watchdog device requires an additional driver and management daemon in= the -guest. Just enabling the watchdog in the libvirt configuration does not do -anything useful on its own. - -Currently libvirt does not support notification when the watchdog fires. T= his -feature is planned for a future version of libvirt. - -:: - - ... - - - - ... - -:: - - ... - - - - - -``model`` - The required ``model`` attribute specifies what real watchdog device is - emulated. Valid values are specific to the underlying hypervisor. - - QEMU and KVM support: - - - 'i6300esb' - the recommended device, emulating a PCI Intel 6300ESB - - 'ib700' - emulating an ISA iBase IB700 - - 'diag288' - emulating an S390 DIAG288 device :since:`Since 1.2.17` - -``action`` - The optional ``action`` attribute describes what action to take when the - watchdog expires. Valid values are specific to the underlying hyperviso= r. - - QEMU and KVM support: - - - 'reset' - default, forcefully reset the guest - - 'shutdown' - gracefully shutdown the guest (not recommended) - - 'poweroff' - forcefully power off the guest - - 'pause' - pause the guest - - 'none' - do nothing - - 'dump' - automatically dump the guest :since:`Since 0.8.7` - - 'inject-nmi' - inject a non-maskable interrupt into the guest - :since:`Since 1.2.17` - - Note 1: the 'shutdown' action requires that the guest is responsive to = ACPI - signals. In the sort of situations where the watchdog has expired, gues= ts are - usually unable to respond to ACPI signals. Therefore using 'shutdown' i= s not - recommended. - - Note 2: the directory to save dump files can be configured by - ``auto_dump_path`` in file /etc/libvirt/qemu.conf. +.. include:: formatdomain-devices-watchdog.rst :anchor:`` diff --git a/docs/meson.build b/docs/meson.build index c6efff8b80..21dcd589d7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -140,6 +140,7 @@ docs_rst_files =3D [ 'formatdomain-devices-video.rst', 'formatdomain-devices-chardev.rst', 'formatdomain-devices-sound.rst', + 'formatdomain-devices-watchdog.rst', ] }, { 'name': 'hacking' }, --=20 2.26.2