A.122 getStatListByQuery

Lists statistic types for an object using a query to narrow results.

Syntax

getStatListByQuery objType= { Server | Vm | FileSystem } objIds=value statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL } equalityType= { LT | LTE | GT | GTE | EQ | NE } statValue=value [ startTime=value ] [ endTime=value ] [ maxResults=value ]

Description

This command lists statistics for an object using a query to refine results.

Options

The following table shows the available options for this command.

Option

Description

objType= { Server | Vm | FileSystem }

The object type for which to list the statistics. The value of objType may be Server, Vm, or FileSystem. The value for objType is case insensitive.

objIds=value

The name or ID of the objects for which statistics should be listed. This must be the ID of a Server, Vm, or FileSystem object. To enter one or more objects, use a comma separated list, for example:

objIds=UUID1,UUID2,UUID3

statType= { CPU_UTILIZATION | CPU_COUNT | MEMORY_USED | FREE_MEMORY | MEMORY_UTILIZATION | FILE_SYSTEM_SPACE_FREE | FILE_SYSTEM_SPACE_UTILIZATION | FILE_SYSTEM_SPACE_TOTAL }

The type of statistic to list:

  • CPU_UTILIZATION: The percentage of the total CPU power being used by the object

  • CPU_COUNT: The number of CPUs.

  • MEMORY_USED: The amount of memory, in MBs, used by the object.

  • FREE_MEMORY: The amount of memory, in MBs, available on the server.

  • MEMORY_UTILIZATION: The percentage of the total memory being used by the object.

  • FILE_SYSTEM_SPACE_FREE: The amount of file system space, in GiB, that is not currently used.

  • FILE_SYSTEM_SPACE_UTILIZATION: The percentage of the total file system space currently in use.

  • FILE_SYSTEM_SPACE_TOTAL: The total size of the file system, in GiB.

The FILE_SYSTEM_SPACE_FREE, FILE_SYSTEM_SPACE_UTILIZATION, FILE_SYSTEM_SPACE_TOTAL parameters are supported for the FileSystem object type only.

The CPU_COUNT parameter is not supported by the Server object type.

An error is returned when an incompatible object type and parameter are requested.

A value of 0 may be returned for any parameter if there are no statistics available for the object on Oracle VM Manager in the time frame when the statistics were requested.

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

The equality type for the statistics. Use this in combination with the value 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 !=).

statValue=value

The value to use with the equalityType option. Use this option to search and filter the results. For example, when you want to find when a server is under 20% CPU utilization, use:

equalityType=LT statValue=20

Another example might be for querying when a virtual machine is using more than two CPUs. In this case you might use:

equalityType=GT statValue=2

Note that when entering non-integer values for values such as the number of GiB in a file system, the value may lose precision due to internal conversion algorithms. Be careful when working with equality for non-integer values as the results may not match the values that you expect.

startTime=value

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

This is an optional parameter.

The value must not be later than the current time or after the value of endTime.

endTime=value

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

This is an optional parameter.

maxResults=value

The maximum number of statistics to list.

This is an optional parameter.

Examples

Example A.156 Listing statistics for an Oracle VM Server using a query to filter results

OVM> getStatListByQuery objType=Server objIds=00:e0:81:4d:41:05:00:e0:81:4d:40:de:00:e0:81:4d \
  statType=CPU_UTILIZATION equalityType=GT statValue=80

Example A.157 Listing statistics during a date range

OVM> getStatListByQuery objType=Server objIds=00:e0:81:4d:5f:2f:00:e0:81:4d:29:ee:00:e0:81:4d \
  statType=CPU_UTILIZATION equalityType=GT statValue=80 startTime="02-01-2015 00:00:00" \
  endTime="02-09-2015 23:59:00" maxResults=10

Example A.158 Listing statistics for a virtual machine using a query to filter results

OVM> getStatListByQuery objtype=Vm objIds=0004fb000006000044f5ee8585b1d59c statType=MEMORY_USED \
  equalityType=GT statValue=2048

See Also