hostinfo-test/hostinfo-test.pl

   1 #!/usr/bin/perl -w
   2 # @configure_input@
   3 # virt-hostinfo
   4 # Copyright (C) 2009 Red Hat Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 use strict;
  21
  22 #use Sys::Virt;
  23
  24 =pod
  25
  26 =head1 NAME
  27
  28 hostinfo-test - make or test hostinfo requests from a virtual machine
  29
  30 =head1 SYNOPSIS
  31
  32  hostinfo-test [--options]
  33
  34 =head1 DESCRIPTION
  35
  36 I<Note:> It only makes sense to use this command from inside
  37 a guest (virtual machine).
  38
  39 This command is used to make/test hostinfo requests.  You can
  40 use this to test that the hostinfo system is working end-to-end.
  41
  42 On its own, the command will make a simple 'ping' request, just
  43 to check that the path from the guest to the C<hostinfod> (daemon)
  44 inside the host is working:
  45
  46  # hostinfo-test
  47
  48 or:
  49
  50  # hostinfo-test
  51  error: no response ping request
  52
  53 =cut
  54
  55
  56
  57
  58
  59 =head1 RETURN VALUE
  60
  61 This command returns 0 if the test succeeded, or 1 if the test failed
  62 or there was an error.
  63
  64 =head1 SEE ALSO
  65
  66 L<hostinfo(8)>,
  67 L<hostinfo-set(8)>,
  68 L<hostinfo-status(8)>,
  69 L<virt-install(1)>,
  70 L<virt-manager(1)>,
  71 L<http://fedoraproject.org/wiki/Features/Hostinfo>,
  72 L<http://libvirt.org/>.
  73
  74 =head1 AUTHORS
  75
  76 Richard W.M. Jones (C<rjones at redhat dot com>)
  77
  78 =head1 COPYRIGHT
  79
  80 Copyright (C) 2009 Red Hat Inc.
  81 L<http://fedoraproject.org/wiki/Features/Hostinfo>
  82
  83 This program is free software; you can redistribute it and/or modify
  84 it under the terms of the GNU General Public License as published by
  85 the Free Software Foundation; either version 2 of the License, or
  86 (at your option) any later version.
  87
  88 This program is distributed in the hope that it will be useful,
  89 but WITHOUT ANY WARRANTY; without even the implied warranty of
  90 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  91 GNU General Public License for more details.
  92
  93 You should have received a copy of the GNU General Public License
  94 along with this program; if not, write to the Free Software
  95 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.