VIRT-WHO(8)						      System Manager's Manual						       VIRT-WHO(8)

NAME

       virt-who - Agent for reporting virtual guest IDs to Subscription Asset Manager.

SYNOPSIS

       virt-who [-d] [-i INTERVAL] [-b] [-o] [--sam|--satellite] [--libvirt|--vdsm|--esx|--rhevm|--hyperv]

OPTIONS

       -h, --help
	      show this help message and exit

       -d, --debug
	      Enable debugging output

       -b, --background
	      Run in the background and monitor virtual guests

       -o, --one-shot
	      Send the list of guest IDs and exit immediately

       -i INTERVAL, --interval=INTERVAL
	      Acquire and send list of virtual guest each N seconds

   Virtualization backend
	      Choose virtualization backend that should be used to gather host/guest associations

       --libvirt
	      Use libvirt to list virtual guests [default]

       --vdsm Use vdsm to list virtual guests

       --esx  Register ESX machines using vCenter

       --rhevm
	      Register guests using RHEV-M

       --hyperv
	      Register guests using Hyper-V

   Subscription manager
	      Choose where the host/guest associations should be reported

       --sam  Report host/guest associations to the Subscription Asset Manager [default]

       --satellite
	      Report host/guest associations to the Satellite

   vCenter/ESX options
	      Use this options with --esx

       --esx-owner=OWNER
	      Organization who has purchased subscriptions of the products

       --esx-env=ENV
	      Environment where the vCenter server belongs to

       --esx-server=SERVER
	      URL of the vCenter server to connect to

       --esx-username=USERNAME
	      Username for connecting to vCenter

       --esx-password=PASSWORD
	      Password for connecting to vCenter

   RHEV-M options
	      Use this options with --rhevm

       --rhevm-owner=OWNER
	      Organization who has purchased subscriptions of the products

       --rhevm-env=ENV
	      Environment where the RHEV-M belongs to

       --rhevm-server=SERVER
	      URL of the RHEV-M server to connect to

       --rhevm-username=USERNAME
	      Username for connecting to RHEV-M

       --rhevm-password=PASSWORD
	      Password for connecting to RHEV-M

   Hyper-V options
	      Use this options with --hyperv

       --hyperv-owner=OWNER
	      Organization who has purchased subscriptions of the products

       --hyperv-env=ENV
	      Environment where the Hyper-V belongs to

       --hyperv-server=SERVER
	      URL of the Hyper-V server to connect to

       --hyperv-username=USERNAME
	      Username for connecting to Hyper-V

       --hyperv-password=PASSWORD
	      Password for connecting to Hyper-V

   Satellite options:
	      Use this options with --satellite

       --satellite-server=SAT_SERVER
	      Satellite server URL

       --satellite-username=SAT_USERNAME
	      Username for connecting to Satellite server

       --satellite-password=SAT_PASSWORD
	      Password for connecting to Satellite server

ENVIRONMENT

       virt-who  also reads environmental variables. They have the same name as command line arguments but upper-cased, with underscore instead of
       dash and prefixed with VIRTWHO_ (e.g. VIRTWHO_ONE_SHOT). Empty variables are considered as disabled, non-empty as enabled

USAGE

   MODE
       virt-who has three modes how it can run:

       1. one-shot mode
	      # virt-who -o

	      In this mode virt-who just sends list of guest UUIDs to the server and exits.

       2. interval mode
	      # virt-who

	      This is default mode. virt-who will check and send list of guest UUIDs once per hour. This interval can be changed using "-i  INTER-
	      VAL" option where INTERVAL is number of seconds how often it should check and send the list.

       3. background mode
	      # virt-who -b

	      This  mode  is  similar  to interval mode but it monitors events from libvirt and update list of guest UUIDs as soon as possible. It
	      also does the interval check (interval can be altered by "-i INTERVAL" option).

	      NOTE: virt-who don't print anything to terminal in this mode

	      NOTE: monitoring for events requires libvirt backend, but this mode can be used with all backends.

   VIRTUALIZATION BACKEND
       virt-who can use couple of virtualization backends.

       1. libvirt
	      # virt-who

	      # virt-who --libvirt

	      Use libvirt as virtualization backend. This is default.

	      NOTE: virt-who can monitor for events only in this mode.

       2. vdsm
	      # virt-who --vdsm

	      Use vdsm as virtualization backend.

       3. ESX

	      #  virt-who  --esx  --esx-owner=ESX_OWNER    --esx-env=ESX_ENV   --esx-server=ESX_SERVER	 --esx-username=ESX_USERNAME   --esx-pass-
	      word=ESX_PASSWORD

	      Use ESX (vCenter) as virtualization backend and specify option required to connect to ESX server.

       4. RHEV-M

	      #  virt-who  --rhevm  --rhevm-owner=RHEVM_OWNER	--rhevm-env=RHEVM_ENV  --rhevm-server=RHEVM_SERVER --rhevm-username=RHEVM_USERNAME
	      --rhevm-password=RHEVM_PASSWORD

	      Use RHEV-M as virtualization backend and specify option required to connect to RHEV-M server.

       5. Hyper-V

	      #   virt-who   --hyperv	--hyperv-owner=HYPERV_OWNER	--hyperv-env=HYPERV_ENV    --hyperv-server=HYPERV_SERVER    --hyperv-user-
	      name=HYPERV_USERNAME --hyperv-password=HYPERV_PASSWORD

	      Use Hyper-V as virtualization backend and specify option required to connect to Hyper-V server.

   SUBSCRIPTION MANAGER
       virt-who can report host/guest associations either to Subscription Asset Manager (SAM) or to Satellite.

       1. Subscription Asset Manager
	      # virt-who

	      # virt-who --sam

	      System  must be registered using subscription-manager prior to using virt-who. Configuration for connecting to SAM is shared between
	      subscription-manager and virt-who. This is default.

       2. Satellite
	      # virt-who --satellite --satellite-server=SAT_SERVER --satellite-username=SAT_USERNAME --satellite-password=SAT_PASSWORD

	      This option can't be used for monitoring local guests, use rhn-virtualization-host instead.

LOGGING

       virt-who always writes error output to file /var/log/rhsm/rhsm.log. In all modes, excluding background ("-b"), it writes same  output  also
       to the standard error output.

       virt-who can be started with option "-d" in all modes and with all backends. This option will enable verbose output with more information.

AUTHOR

       Radek Novacek <rnovacek at redhat dot com>

virt-who							    August 2013 						       VIRT-WHO(8)