Data Object - AuditEventSummaryView

Class: VMware.Hv.AuditEventSummaryView
See also: ApplicationId, DesktopId, MachineId, PersistentDiskId, SessionId, UserOrGroupId
Since: Horizon 7.13

Data Object Description

The AuditEventSummaryView Object.

Queryable Data Object

This data object is queryable using QueryService.

Query definitions can specify the following member types:

eventId (QueryFilterEquals filter only)
eventType (QueryFilterEquals, QueryFilterContains, or QueryFilterStartsWith filter only)
severity (QueryFilterEquals filter only)
time (QueryFilterBetween filter only)
module (QueryFilterEquals filter only)
message (QueryFilterEquals, QueryFilterContains, or QueryFilterStartsWith filter only)
machineDnsName (QueryFilterEquals, QueryFilterContains, or QueryFilterStartsWith filter only)
userId (QueryFilterEquals filter only)
desktopId (QueryFilterEquals filter only)
applicationId (QueryFilterEquals filter only)
machineId (QueryFilterEquals filter only)
persistentDiskId (QueryFilterEquals filter only)

The following caveats apply:

This will consider the audit events summary from Event table only, and will not return events from historical database tables.
The first filter may be any of the above or an QueryFilterAnd or QueryFilterOr filter specifying any combination of the above.
If sortBy is not specified, resulting events will be sorted by time.
maxPageSize cannot exceed 1000.

Data Object Properties

Properties

Name

Type

Description

eventId

xsd:int

ID of the event in Event Database.

eventType

xsd:string

Event name that corresponds to an item in the message catalog. For example: BROKER_USERLOGGEDIN, AGENT_CONNECTED etc.

severity

xsd:string

Severity type of the event.

This property will be one of:

Value	Description
"INFO"	INFO type.
"WARNING"	WARNING type.
"ERROR"	ERROR type.
"AUDIT_SUCCESS"	AUDIT SUCCESS type.
"AUDIT_FAIL"	AUDIT FAILURE type.

module

xsd:string

Horizon View component that has logged this event.

This property will be one of:

Value	Description
"Admin"	Admin component.
"Broker"	Broker component.
"Client"	Client component.
"Agent"	Agent component.
"Vlsi"	Vlsi component.
"Framework"	Framework component.
"Tunnel"	Tunnel component.
"Endpoint"	Endpoint component.
"TransferServer"	TransferServer component.
"Rest"	Rest component.

time

xsd:dateTime

Time at which the event occurred, measured from the epoch (January 1, 1970).

machineDnsName

xsd:string

FQDN of the machine in the Pod that has logged this event.

This property need not be set.

userId

UserOrGroupId

User involved in this event. Will be unset if there is no user association for this event.

This property need not be set.

desktopId

DesktopId

Desktop pool associated with this event. Will be unset if there is no desktop association for this event.

This property need not be set.

applicationId

ApplicationId

Application associated with this event. Will be unset if there is no Application association for this event.

This property need not be set.

machineId

MachineId

Machine associated with this event. Will be unset if there is no machine association for this event.

This property need not be set.

sessionId

SessionId

Session associated with this event. Will be unset if there is no Session association for this event.

This property need not be set.

message

xsd:string

Event message. Language of this message will be dependent on the locale. Locale can be set at request or session level. Request level locale can be provided by adding X-VIEW-LOCALE request header and session level locale can be set by invoking AuthenticationManager_SetLocale method after login. Request level locale will be given priority over session level locale. If not set explicitly, locale will default to English language.

userDisplayName

xsd:string

Display name of the user associated with this event. Will be unset if there is no User association for this event.

This property need not be set.

persistentDiskId

PersistentDiskId

Deprecated. This is being deprecated since View Composer will no longer be supported from Horizon version 2012 onwards.

Persistent disk associated with this event. Will be unset if there is no Persistent disk association for this event.

This property need not be set.

userSid

xsd:string

Sid of the user associated with this event. Will be unset if there is no User association for this event.

This property need not be set.