A.112 getEventListByQuery

Lists the events for an object using a query to narrow results.

Syntax

getEventListByQuery [ [ objType=value ] [ objIds=value ] ] [ severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL } ] severityEqualityType= { LT | LTE | GT | GTE | EQ | NE } [ eventTypes= value ] eventEqualityType= { LIKE | NOT_LIKE } [ acknowledged= { Yes | No } ] [ userAckable= { Yes | No } ] [ startTime=value ] [ endTime=value ] [ maxResults=value ]

Description

This command lists the events for an object using a query to narrow results. To acknowledge an event, use the ackEvent command.

Options

The following table shows the available options for this command.

Option

Description

objType=value

The object type for which to list the events. The value of objType is an object such as FileServer, Repository, or Server. To get a list of all object types, use the showobjtypes. The value for objType is case insensitive.

This is an optional parameter and must be used with the objIds option.

objIds=value

The ID of the objects for which events should be listed. To enter one or more objects, use a comma separated list.

This is an optional parameter and must be used with the objType option.

severity= { UNKNOWN | CRITICAL | WARNING | INFORMATIONAL }

The severity of the event to list. Use this in combination with the equalityType option. The events are ranked in the order from low to high:

  • UNKNOWN: The event does not have a specific severity.

  • INFORMATIONAL: An event which is used to convey information about the system.

  • WARNING: An event which is only likely to have a minor impact to system functionality.

  • CRITICAL: An event which could cause a critical loss of functionality which requires immediate attention.

When you use this in conjunction with the severityEqualityType option, the comparison is performed using this ranking. For example, if you use:

severity=WARNING severityEqualityType=GTE

All events greater than or equal to WARNING are returned. This means all WARNING and all CRITICAL events are returned.

This is an optional parameter.

severityEqualityType= { LT | LTE | GT | GTE | EQ | NE }

The equality type for the severity comparison. Use this in combination with the severity option. The parameters are:

  • LT: Less than (<).

  • LTE: Less than or equal to (<=).

  • GT: Greater than (>).

  • GTE: Greater than or equal to (>=).

  • EQ: Equal to (=).

  • NE: Not equal to (<>, or !=).

eventTypes=value

The event type. Use this to filter the results to a specific event or events. For example:

eventTypes=server.maintenance.mode.

Note the period (.) at the end of the event type. This is important. You cannot truncate the event type; it must be in full. No wild cards are allowed. For a list of the available options, see Table A.1, “eventTypes Values”.

For the most up-to-date list of event types, see the Oracle VM Manager Web Services API 3.4 documentation at:

http://hostname/WSAPI/doc/api/webservices_s/com/oracle/ovm/mgr/ws/model/Event.html

This documentation is available on the Oracle VM Manager ISO/CD. You should deploy it to a web server to access the content.

eventEqualityType= { LIKE | NOT_LIKE }

The event equality type for the event types comparison. Use this in combination with the eventTypes option. The parameters are:

  • LIKE: Is like the value of eventTypes.

  • NOT_LIKE: Is not like the value of eventTypes.

acknowledged= { Yes | No }

Whether to include acknowledged events in the listing. The default is No, so all events that have been acknowledged are not displayed.

This is an optional parameter.

userAckable= { Yes | No }

Whether to include events that can be acknowledged by a user in the listing. The default is No, so all events that cannot be acknowledged by a user are removed from the results.

This is an optional parameter.

startTime=value

The start date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss".

This is an optional parameter.

endTime=value

The end date and time from which to list events. The format to use is "MM-dd-yyyy HH:mm:ss".

This is an optional parameter.

maxResults=value

The maximum number of events to list.

This is an optional parameter.

eventTypes Values

This table shows the available options for the eventTypes option of this command.

Table A.1 eventTypes Values

eventType Value

Event Severity

Description

Lifecycle Events
lifecycle.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all lifecycle eventTypes.
lifecycle.create.INFORMATIONALObject has been created.
lifecycle.modify.INFORMATIONALObject has been modified.
lifecycle.delete.INFORMATIONALObject has been deleted.
Runstate Events
runstate.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all runstate eventTypes.
runstate.starting.INFORMATIONALObject is in the process of starting.
runstate.running.INFORMATIONALObject is running.
runstate.stopping.INFORMATIONALObject is in the process of stopping.
runstate.stopped.INFORMATIONALObject is stopped.
runstate.suspended.INFORMATIONALObject is suspended.
Discover Events
discover.failure.INFORMATIONALThere was a failure during server discovery.
Virtual machine Events
vm.api.incomming.INFORMATIONALVirtual machine incoming message.
vm.api.outgoing.INFORMATIONALVirtual machine outgoing message.
vm.error.CRITICALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all vm.error eventTypes.
vm.error.disconnected.CRITICALVirtual machine has disconnected.
vm.error.migration.CRITICALVirtual machine migration failed.
vm.warn.migration.WARNINGThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all vm.warn.migration eventTypes.
vm.warn.migration.src.WARNINGVirtual machine migration warning from the server that holds the source (from) the virtual machine.
vm.warn.migration.tgt.WARNINGVirtual machine migration warning from the server that is the target (to) for the virtual machine.
vm.domain.mismatch.INFORMATIONALVirtual machine domain type mismatch.
vm.migrating.INFORMATIONALVirtual machine is migrating.
vm.misplaced.INFORMATIONALVirtual machine has been found on an incompatible server.
vm.os.mismatch.INFORMATIONALVirtual machine operating system type mismatch.
vm.disk.missing.CRITICALVirtual machine is missing a virtual disk.
vm.error.offline.CRITICALVirtual machine is offline.
Server Events
server.failure.CRITICALServer has experienced a failure.
server.discovery.failed.CRITICALServer discovery has failed.
server.discovery.started.INFORMATIONALServer discovery is in progress.
server.repository.error.CRITICALThe server repository has experienced an error.
server.cluster.failure.CRITICALThe server cluster has experienced a failure.
server.cluster.state.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all server.cluster.state eventTypes.
server.cluster.state.downINFORMATIONALThe server's cluster is down.
server.cluster.state.upINFORMATIONALThe server's cluster is up.
server.disconnected.CRITICALThe server has disconnected.
server.authentication.error.CRITICALThere was a server authentication error.
server.disk.reserved.INFORMATIONALThe server disk is reserved.
server.disk.unreserved.INFORMATIONALThe server disk is unreserved.
server.kernel.invalid.CRITICALThe server kernel is invalid.
server.maintenance.mode.INFORMATIONALThe server is in maintenance mode.
server.out.of.date.INFORMATIONALThe server software is out of date with regards to that found in the update repository.
server.pool.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all server.pool eventTypes.
server.pool.failure.CRITICALThere has been a failure with the server pool.
server.pool.file.system.missing.CRITICALThe server pool file system is missing.
server.pool.master.missing.CRITICALServer pool is missing the master.
server.pool.vip.unavailable.WARNINGServer pool virtual IP address is unavailable.
server.evacuate.failed.WARNINGServer failed to evacuate.
server.mount.missing.WARNINGServer mount is missing.
server.network.operation.failed.WARNINGServer network operation failed.
server.offline.CRITICALServer is offline.
server.ownership.mismatch.WARNINGServer is owned by another Oracle VM Manager.
server.version.mismatch.WARNINGThere is an API version mismatch with the server.
server.update.repository.mismatch.INFORMATIONALThe repository information on the server is not the same as configured in Oracle VM Manager. This will trigger an update process so the information on the server is reconfigured.
server.update.repository.check.INFORMATIONALServer is being checked if its software update repository is up to date.
server.update.repository.check.failed.INFORMATIONALThere was a failure during the update repository configuration.
server.update.repository.config.failed.INFORMATIONALThere was a failure during the repository configuration update check.
server.duplicate.storage.initiator.WARNINGServer has a duplicate storage initiator.
server.network.mismatch.WARNINGA networking device was found during discovery on this server with a network definition that includes the Virtual Machine role. This network already exists in Oracle VM Manager without the Virtual Machine role. This role will not be automatically added to the network and the server's view of the network is out of sync with Oracle VM Manager. If the Virtual Machine role is needed on this network, it will need to be added manually.
server.upgrade.in.progress.INFORMATIONALServer upgrade in progress.
server.upgrade.config.in.progress.INFORMATIONALA configuration of the server upgrade repositories is in progress.
File Server Events
fileserver.error.CRITICALA critical fileserver error.
fileserver.invalid.exports.CRITICALInvalid exports exist.
File System Events
filesystem.missing.WARNINGFile system is missing.
filesystem.size.mismatch.CRITICALFile system is larger than its underlying storage device.
Repository Events
repository.empty.CRITICALRepository is empty.
repository.error.CRITICALThere is a repository error.
repository.missing.WARNINGRepository is missing.
repository.unmounted.CRITICALRepository is unmounted
Storage Device Events
storage.device.INFORMATIONAL

storage.device.offline.WARNINGStorage device is offline.
storage.device.online.INFORMATIONALStorage device is online.
storage.device.off.path.WARNINGAt least one path is missing for storage element
Manager Events
mgr.db.scan.error.CRITICALDatabase scan error.
mgr.db.scan.ok.INFORMATIONALDatabase scan succeeded.
mgr.db.backup.fail.WARNINGDatabase backup failed.
mgr.db.timeshift.WARNINGSystem time has gone backwards.
Port Events
port.status.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all port.status eventTypes.
port.status.down.INFORMATIONALEthernet port is down.
port.status.up.INFORMATIONALEthernet port is up.
Path Events
path.status.INFORMATIONALThis eventType is not used directly. However, you can use this when retrieving Events by type to retrieve all path.status eventTypes.
path.status.down.INFORMATIONALStorage path status is down.
path.status.up.INFORMATIONALStorage path status is up.
path.missing.storage.device.WARNINGStorage path is missing a storage device.
Volume Events
volume.group.missing.CRITICALA volume group is missing.
Object Events
object.needs.refresh.INFORMATIONALObject needs to be refreshed to obtain valid object information.

Examples

Example A.140 Listing all events

OVM> getEventListByQuery

Example A.141 Listing all events for specified Oracle VM Servers

OVM> getEventListByQuery objType=Server objIds=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d, \
  00:e0:81:4d:41:59:00:e0:81:4d:41:2c:00:e0:81:4d

Example A.142 Listing events types for Oracle VM Servers

OVM> getEventListByQuery eventEqualityType=LIKE eventTypes=server.disconnected.

Example A.143 Listing high priority events for Oracle VM Servers

OVM> getEventListByQuery severity=WARNING severityEqualityType=GTE \
  eventTypes=server.disconnected. eventEqualityType=LIKE

See Also