Hostinfo day 6: RPM packaging, initscripts, hostinfo-status, hostinfo-test.

[virt-hostinfo.git] / hostinfod / hostinfo.pod

diff --git a/hostinfod/hostinfo.pod b/hostinfod/hostinfo.pod
index be9c3f6..6ddfe57 100644 (file)
--- a/hostinfod/hostinfo.pod
+++ b/hostinfod/hostinfo.pod
@@ -220,18 +220,27 @@ C<[*]>.  A typical example would be:
 
  # Rule for specific qemu/KVM guest called 'guest1'.
  [qemu-guest1]
- interval 60
- physcpus off
+ interval       60
+ physcpus       off
  
  # Rule that covers all other qemu/KVM guests.
  [qemu-*]
- interval 60
+ interval       60
  
  # Catch-all default rule for guests.
  # This rule MUST be last in the file.
  [*]
- interval 1
- physcpus on
+ interval       1
+ availcpus      on
+ corespersocket on
+ memory         on
+ mhz            on
+ model          on
+ nodes          on
+ physcpus       on
+ ping           on
+ socketspernode on
+ threadspercore on
  #etc.
 
 In the section header, C<[hypervisor-guestname]>, the C<guestname>
@@ -266,21 +275,19 @@ available to it, every N seconds, which means in total there could up
 to M requests every N seconds per guest.
 
 If a guest exceeds the rate at which it is allowed to make requests,
-then the daemon sleeps before replying (just for that guest).
+then the daemon will after some number of violations stop talking to
+the guest.  The only way to restore service to the guest will be to
+reboot the guest or restart the daemon.
 
 Setting this to C<any> means there is no limit.  Guests can flood the
 host with requests.
 
-=item B<physcpus BOOL>
-
-Enable or disable requesting the number of physical CPUs available in
-the host.
-
-
-
-
+=item B<I<command> BOOL>
 
+Enable or disable the command named I<command>.
 
+The default for every command is disabled.  You have to enable
+each one that you want to allow.
 
 =back
 
@@ -380,8 +387,29 @@ Is the guest using the correct serial port?
 
 Use the L<hostinfo-test(8)> program in the guest to test this.
 
+=item 8.
+
+(Linux/Unix guests) Is getty attached to the serial port?
+
+On some operating systems, system daemons will attach themselves to
+serial ports.  Under Linux you can use the lsof command to check:
+
+ /usr/sbin/lsof | grep ttyS
+
+=item 9.
+
+(Linux/Unix guests) Is serial device not in raw mode?
+
+Client software should set the serial device to raw mode and
+disable echoing.  The usual way to do this is:
+
+ stty raw -echo < /dev/ttyS1
+
 =back
 
+Note that serial port settings like speed, parity etc. make no
+difference for these emulated serial ports, so that won't be a factor.
+
 =head1 FILES
 
 =over 4
@@ -398,9 +426,10 @@ Use the L<hostinfo-test(8)> program in the guest to test this.
 
 L<hostinfo-set(8)>,
 L<hostinfo-status(8)>,
-L<hostinfo-test(8)>,
+L<hostinfo-test(1)>,
 L<virt-install(1)>,
 L<virt-manager(1)>,
+L<hostinfo-protocol(5)>,
 L<http://fedoraproject.org/wiki/Features/Hostinfo>,
 L<http://libvirt.org/>.