Bug 1027154

Summary: qemu-guest-agent missing documentation
Product: Red Hat Enterprise Linux 7 Reporter: Karel Volný <kvolny>
Component: qemu-kvmAssignee: Ademar Reis <areis>
Status: CLOSED WONTFIX QA Contact: Virtualization Bugs <virt-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 7.0CC: acathrow, hhuang, juzhang, knoel, mrezanin, sluo, virt-maint
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-09-03 08:06:30 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Karel Volný 2013-11-06 09:56:19 UTC
Description of problem:
In today's updates, I have noticed a package "qemu-guest-agent". As I had no clue what this is for, I tried to read the docs, but I have found them missing and lacking - no clue what does this application do.

Version-Release number of selected component (if applicable):
qemu-guest-agent-1.5.3-13.el7

How reproducible:
always

Steps to Reproduce:
1. man qemu-ga
2. qemu-ga --help

Actual results:
1. No manual entry for qemu-ga
2.
Usage: qemu-ga [-m <method> -p <path>] [<options>]
QEMU Guest Agent 1.5.3

 -m, --method     transport method: one of unix-listen, virtio-serial, or
...

Expected results:
1. (manpage is shown)
2.
Usage: qemu-ga [-m <method> -p <path>] [<options>]
QEMU Guest Agent 1.5.3

A daemon program running inside the domain which is supposed to help management applications with executing functions which need assistance of the guest OS. 

Options:
 -m, --method     transport method: one of unix-listen, virtio-serial, or
...


Additional info:
Sample text taken from http://wiki.libvirt.org/page/Qemu_guest_agent ... I don't say that it is perfect (well, to me, the exact purpose of this would be still a puzzle if I had read only this one sentence).

Comment 2 Miroslav Rezanina 2014-09-03 08:06:30 UTC
User should never execute qemu-ga directly. It's handle through provided systemd unit.

Proper usage is documented in Virtualization Deployment Guide.