tools/auvirt/auvirt.8

   1 .TH AUVIRT 8 "Dec 2011" "IBM Corp" "System Administration Utilities"
   2 .SH NAME
   3 auvirt - a program that shows data related to virtual machines
   4
   5 .SH SYNOPSIS
   6 .B auvirt
   7 [ \fIOPTIONS\fP ]
   8
   9 .SH DESCRIPTION
  10 \fBauvirt\fP shows a list of guest sessions found in the audit logs. If a guest
  11 is specified, only the events related to that guest is considered. To specify a
  12 guest, both UUID or VM name can be given.
  13
  14 For each guest session the tool prints a record with the domain name, the user
  15 that started the guest, the time when the guest was started and the time when
  16 the guest was stoped.
  17
  18 If the option "\-\-all\-events" is given a more detailed output is shown. In this
  19 mode other records are shown for guest's stops, resource
  20 assignments, host shutdowns and AVC and anomaly events. The first field
  21 indicates the event type and can have the following values: start, stop,
  22 res, avc, anom and down (for host shutdowns).
  23
  24 Resource assignments have the additional fields: resource type, reason and
  25 resource. And AVC records have the following additional fields: operation,
  26 result, command and target.
  27
  28 By default, auvirt reads records from the system audit log file. But
  29 \fB--stdin\fP and \fB--file\fP options can be specified to change this
  30 behavior.
  31
  32 .SH OPTIONS
  33 .TP
  34 \fB--all-events\fP
  35 Show records for all virtualization related events.
  36 .TP
  37 \fB--debug\fP
  38 Print debug messages to standard output.
  39 .TP
  40 \fB-f\fP, \fB--file\fP \fIfile\fP
  41 Read records from the given \fIfile\fP instead from the system audit log file.
  42 .TP
  43 \fB-h\fP, \fB--help\fP
  44 Print help message and exit.
  45 .TP
  46 \fB--proof\fP
  47 Add after each event a line containing all the identifiers of the audit records
  48 used to calculate the event. Each identifier consists of unix time,
  49 milliseconds and serial number.
  50 .TP
  51 \fB--show-uuid\fP
  52 Add the guest's UUID to each record.
  53 .TP
  54 \fB--stdin\fP
  55 Read records from the standard input instead from the system audit log file.
  56 This option cannot be specified with \fB--file\fP.
  57 .TP
  58 \fB--summary\fP
  59 Print a summary with information about the events found. The summary contains
  60 the considered range of time, the number of guest starts and stops, the number
  61 of resource assignments, the number of AVC and anomaly events, the number of
  62 host shutdowns and the number of failed operations.
  63 .TP
  64 .BR \-te ,\  \-\-end \ [\fIend-date\fP]\ [\fIend-time\fP]
  65 Search for events with time stamps equal to or before the given end time. The
  66 format of end time depends on your locale. If the date is omitted,
  67 .B today
  68 is assumed. If the time is omitted,
  69 .B now
  70 is assumed. Use 24 hour clock time rather than AM or PM to specify time.
  71 An example date using the en_US.utf8 locale is 09/03/2009. An example of time
  72 is 18:00:00. The date format accepted is influenced by the LC_TIME
  73 environmental variable.
  74
  75 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP,
  76 \fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP,
  77 \fBthis\-year\fP. \fBToday\fP means starting now. \fBRecent\fP is 10 minutes
  78 ago. \fBYesterday\fP is 1 second after midnight the previous day.
  79 \fBThis\-week\fP means starting 1 second after midnight on day 0 of the week
  80 determined by your locale (see \fBlocaltime\fP). \fBThis\-month\fP means 1
  81 second after midnight on day 1 of the month. \fBThis\-year\fP means the 1
  82 second after midnight on the first day of the first month.
  83 .TP
  84 .BR \-ts ,\  \-\-start \ [\fIstart-date\fP]\ [\fIstart-time\fP]
  85 Search for events with time stamps equal to or after the given end time. The
  86 format of end time depends on your locale. If the date is omitted,
  87 .B today
  88 is assumed. If the time is omitted,
  89 .B midnight
  90 is assumed. Use 24 hour clock time rather than AM or PM to specify time. An
  91 example date using the en_US.utf8 locale is 09/03/2009. An example of time is
  92 18:00:00. The date format accepted is influenced by the LC_TIME environmental
  93 variable.
  94
  95 You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP,
  96 \fByesterday\fP, \fBthis\-week\fP, \fBthis\-month\fP, \fBthis\-year\fP.
  97 \fBToday\fP means starting at 1 second after midnight. \fBRecent\fP is 10
  98 minutes ago. \fBYesterday\fP is 1 second after midnight the previous day.
  99 \fBThis\-week\fP means starting 1 second after midnight on day 0 of the week
 100 determined by your locale (see \fBlocaltime\fP). \fBThis\-month\fP means 1
 101 second after midnight on day 1 of the month. \fBThis\-year\fP means the 1
 102 second after midnight on the first day of the first month.
 103 .TP
 104 \fB-u\fP, \fB--uuid\fP \ \fIUUID\fP
 105 Only show events related to the guest with the given UUID.
 106 .TP
 107 \fB-v\fP, \fB--vm\fP \ \fIname\fP
 108 Only show events related to the guest with the given name.
 109
 110 .SH EXAMPLES
 111 To see all the records in this month for a guest
 112
 113 \fBauvirt \-\-start this\-month \-\-vm GuestVmName \-\-all\-events\fP
 114
 115 .SH SEE ALSO
 116 .BR aulast (8),
 117 .BR ausearch (8),
 118 .BR aureport (8).
 119
 120 .SH AUTHOR
 121 Marcelo Cerri