aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/tools/auvirt/auvirt.8
blob: 96123f456bfffe3813ea71cde27d4d848cd72a6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.TH AUVIRT 8 "Dec 2011" "IBM Corp" "System Administration Utilities"
.SH NAME
auvirt - a program that shows data related to virtual machines

.SH SYNOPSIS
.B auvirt
[ \fIOPTIONS\fP ]

.SH DESCRIPTION
\fBauvirt\fP shows a list of guest sessions found in the audit logs. If a guest
is specified, only the events related to that guest is considered. To specify a
guest, both UUID or VM name can be given.

For each guest session the tool prints a record with the domain name, the user
that started the guest, the time when the guest was started and the time when
the guest was stoped.

If the option "\-\-all\-events" is given a more detailed output is shown. In this
mode other records are shown for guest's stops, resource
assignments, host shutdowns and AVC and anomaly events. The first field
indicates the event type and can have the following values: start, stop,
res, avc, anom and down (for host shutdowns).

Resource assignments have the additional fields: resource type, reason and
resource. And AVC records have the following additional fields: operation,
result, command and target.

By default, auvirt reads records from the system audit log file. But
\fB--stdin\fP and \fB--file\fP options can be specified to change this
behavior.

.SH OPTIONS
.TP
\fB--all-events\fP
Show records for all virtualization related events.
.TP
\fB--debug\fP
Print debug messages to standard output.
.TP
\fB-f\fP, \fB--file\fP \fIfile\fP
Read records from the given \fIfile\fP instead from the system audit log file.
.TP
\fB-h\fP, \fB--help\fP
Print help message and exit.
.TP
\fB--proof\fP
Add after each event a line containing all the identifiers of the audit records
used to calculate the event. Each identifier consists of unix time,
milliseconds and serial number.
.TP
\fB--show-uuid\fP
Add the guest's UUID to each record.
.TP
\fB--stdin\fP
Read records from the standard input instead from the system audit log file.
This option cannot be specified with \fB--file\fP.
.TP
\fB--summary\fP
Print a summary with information about the events found. The summary contains
the considered range of time, the number of guest starts and stops, the number
of resource assignments, the number of AVC and anomaly events, the number of
host shutdowns and the number of failed operations.
.TP
.BR \-te ,\  \-\-end \ [\fIend-date\fP]\ [\fIend-time\fP]
Search for events with time stamps equal to or before the given end time. The
format of end time depends on your locale. If the date is omitted,
.B today
is assumed. If the time is omitted,
.B now
is assumed. Use 24 hour clock time rather than AM or PM to specify time.
An example date using the en_US.utf8 locale is 09/03/2009. An example of time
is 18:00:00. The date format accepted is influenced by the LC_TIME
environmental variable.

You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP,
\fByesterday\fP, \fBthis\-week\fP, \fBweek\-ago\fP, \fBthis\-month\fP,
\fBthis\-year\fP. \fBToday\fP means starting now. \fBRecent\fP is 10 minutes
ago. \fBYesterday\fP is 1 second after midnight the previous day.
\fBThis\-week\fP means starting 1 second after midnight on day 0 of the week
determined by your locale (see \fBlocaltime\fP). \fBThis\-month\fP means 1
second after midnight on day 1 of the month. \fBThis\-year\fP means the 1
second after midnight on the first day of the first month.
.TP
.BR \-ts ,\  \-\-start \ [\fIstart-date\fP]\ [\fIstart-time\fP]
Search for events with time stamps equal to or after the given end time. The
format of end time depends on your locale. If the date is omitted,
.B today
is assumed. If the time is omitted,
.B midnight
is assumed. Use 24 hour clock time rather than AM or PM to specify time. An
example date using the en_US.utf8 locale is 09/03/2009. An example of time is
18:00:00. The date format accepted is influenced by the LC_TIME environmental
variable.

You may also use the word: \fBnow\fP, \fBrecent\fP, \fBtoday\fP,
\fByesterday\fP, \fBthis\-week\fP, \fBthis\-month\fP, \fBthis\-year\fP.
\fBToday\fP means starting at 1 second after midnight. \fBRecent\fP is 10
minutes ago. \fBYesterday\fP is 1 second after midnight the previous day.
\fBThis\-week\fP means starting 1 second after midnight on day 0 of the week
determined by your locale (see \fBlocaltime\fP). \fBThis\-month\fP means 1
second after midnight on day 1 of the month. \fBThis\-year\fP means the 1
second after midnight on the first day of the first month.
.TP
\fB-u\fP, \fB--uuid\fP \ \fIUUID\fP
Only show events related to the guest with the given UUID.
.TP
\fB-v\fP, \fB--vm\fP \ \fIname\fP
Only show events related to the guest with the given name.

.SH EXAMPLES
To see all the records in this month for a guest

\fBauvirt \-\-start this\-month \-\-vm GuestVmName \-\-all\-events\fP

.SH SEE ALSO
.BR aulast (8),
.BR ausearch (8),
.BR aureport (8).

.SH AUTHOR
Marcelo Cerri