Appendix E. Search Parameters

This appendix describes in detail how Search works in Red Hat Enterprise Virtualization.

E.1. Searching for Resources

This section specifies, for each resource, the resource’s unique set of properties as well as the set of associated resource types.

E.1.1. Searching for Data Centers

The following table describes all search options for Data Centers.

Table E.1. Searching for Data Centers

Property (of resource or resource-type) Type Description (Reference)
Clusters.clusters-prop See property types in Section E.1.2, “Searching for Clusters” The property of the clusters associated with the data center.
name String The name of the data center.
description String A description of the data center.
type String The type of data center.
status List The availability of the data center.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Datacenter: type = nfs and status != up
returns a list of data centers with:
  • A storage type of NFS and status other than up

E.1.2. Searching for Clusters

The following table describes all search options for clusters.

Table E.2. Searching Clusters

Property (of resource or resource-type) Type Description (Reference)
Datacenter.datacenter-prop See property types in Section E.1.1, “Searching for Data Centers” The property of the data center associated with the cluster.
Datacenter String The data center to which the cluster belongs.
name String The unique name that identifies the clusters on the network.
description String The description of the cluster.
initialized String True or False indicating the status of the cluster.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Clusters: initialized = true or name = Default
returns a list of clusters which are:
  • initialized; or
  • named Default

E.1.3. Searching for Hosts

The following table describes all search options for hosts.

Table E.3. Searching for Hosts

Property (of resource or resource-type) Type Description (Reference)
Vms.Vms-prop See property types in Section E.1.5, “Searching for Virtual Machines” The property of the Vms associated with the host.
Templates.templates-prop See property types in Section E.1.7, “Searching for Templates” The property of the templates associated with the host.
Events.events-prop See property types in Section E.1.9, “Searching for Events” The property of the Events associated with the host.
Users.users-prop See property types in Section E.1.8, “Searching for Users” The property of the Users associated with the host.
name String The name of the host.
status List The availability of the host.
cluster String The cluster to which the host belongs.
address String The unique name that identifies the host on the network.
cpu_usage Integer The percent of processing power used.
mem_usage Integer The percentage of memory used.
network_usage Integer The percentage of network usage.
load Integer Jobs waiting to be executed in the run-queue per processor, in a given time slice.
version Integer The version number of the operating system.
cpus Integer The number of CPUs on the host.
memory Integer The amount of memory available.
cpu_speed Integer The processing speed of the CPU.
cpu_model String The type of CPU.
active_vms Integer The number of Vms currently running.
migrating_vms Integer The number of Vms currently being migrated.
committed_mem Integer The percentage of committed memory.
tag String The tag assigned to the host.
type String The type of host.
datacenter String The data center to which the host belongs.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Hosts: cluster = Default and Vms.os = windows7
returns a list of hosts which:
  • Are part of the Default cluster and host virtual machines running the Windows 7 operating system.

E.1.4. Searching for Storage

The following table describes all search options for storage.

Table E.4. Searching for Storage

Property (of resource or resource-type) Type Description (Reference)
name String The unique name that identifies the storage on the network.
status String The status of the storage domain.
datacenter String The data center to which the storage belongs.
type String The type of the storage.
size Integer The size of the storage.
used Integer The amount of the storage that is used.
committed Integer The amount of the storage that is committed.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Storage: size > 200 or used < 50
returns a list of storage with:
  • total storage space greater than 200 GB; or
  • used storage space less than 50 GB.

E.1.5. Searching for Virtual Machines

The following table describes all search options for virtual machines (Vms). Vms can be either virtual servers or virtual desktops.

Table E.5. Searching for Virtual Machines

Property (of resource or resource-type) Type Description (Reference)
Hosts.hosts prop See property types in Section E.1.3, “Searching for Hosts” The property of the hosts associated with the virtual machine.
Templates.templates-prop Property types in the bottom portion of this table as well as custom tags The property of the templates associated with the virtual machine.
Events.events-prop See property types in Section E.1.9, “Searching for Events” The property of the events associated with the virtual machine.
Users.users-prop See property types in Section E.1.8, “Searching for Users” The property of the users associated with the virtual machine.
name String The name of the virtual machine.
status List The availability of the virtual machine.
ip Integer The IP address of the virtual machine.
uptime Integer The number of minutes that the virtual machine has been running.
domain String The domain (usually Active Directory domain) that groups these machines.
os String The operating system on which the virtual machine was created.
creationdate Date The date on which the virtual machine was created.
address String The unique name that identifies the virtual machine on the network.
cpu_usage Integer The percent of processing power used.
mem_usage Integer The percentage of memory used.
network_usage Integer The percentage of network used.
memory Integer The maximum memory defined.
apps String The applications currently installed on the virtual machine.
cluster List The cluster to which the virtual machine belongs.
pool List The virtual machine pool to which the virtual machine belongs.
loggedinuser String The name of the user currently logged in to the virtual machine.
tag List The tags to which the virtual machine belongs.
datacenter String The data center to which the virtual machine belongs.
type List The virtual machine type (server or desktop).
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Vms: template.name = Win* and user.name = ""
Returns a list of VMs, where:
  • The template on which the virtual machine is based begins with Win and the virtual machine is assigned to any user.
Example
Vms: cluster = Default and os = windowsxp
Returns a list of VMs, where:
  • The cluster to which the virtual machine belongs is named Default and the virtual machine is running the Windows XP operating system.

E.1.6. Searching for Pools

The following table describes all search options for Pools.

Table E.6. Searching for Pools

Property (of resource or resource-type) Type Description (Reference)
name String The name of the pool.
description String The description of the pool.
type String The type of pool.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Pools: type = automatic
returns a list of pools with:
  • Type of automatic

E.1.7. Searching for Templates

The following table describes all search options for templates. Options are offered by Auto-Completion when typing where appropriate.

Table E.7. Searching for Templates

Property (of resource or resource-type) Type Description (Reference)
Vms.Vms-prop See property types in Section E.1.5, “Searching for Virtual Machines” The property of the VMs associated with the template.
Hosts.hosts-prop See property types in Section E.1.3, “Searching for Hosts” The property of the hosts associated with the template.
Events.events-prop See property types in Section E.1.9, “Searching for Events” The property of the events associated with the template.
Users.users-prop See property types in Section E.1.8, “Searching for Users” The property of the users associated with the template.
name String The name of the template.
domain String The domain of the template.
os String The type of operating system.
creationdate Integer
The date on which the template was created.
Date format is mm/dd/yy.
childcount Integer The number of Vms created from the template.
mem Integer Defined memory.
description String The description of the template.
status String The status of the template.
cluster String The cluster associated with the template.
datacenter String The data center associated with the template.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Template: Events.severity >= normal and Vms.uptime > 0
Returns a list of templates, where:
  • Events of normal or greater severity have occurred on VMs derived from the template, and the VMs are still running.
Sample Template Search

Figure E.1. Sample Template Search


E.1.8. Searching for Users

The following table describes all search options for users.

Table E.8. Searching for Users

Property (of resource or resource-type) Type Description (Reference)
Vms.Vms-prop See property types in Section E.1.5, “Searching for Virtual Machines” The property of the VMs associated with the user.
Hosts.hosts- prop See property types in Section E.1.3, “Searching for Hosts” The property of the hosts associated with the user.
Templates.templates-prop See property types in Section E.1.7, “Searching for Templates” The property of the templates associated with the user.
Events.events-prop See property types in Section E.1.9, “Searching for Events” The property of the events associated with the user.
name String The name of the user.
lastname String The last name of the user.
usrname String The unique name of the user.
department String The department to which the user belongs.
group String The group to which the user belongs.
title String The title of the user.
status String The status of the user.
role String The role of the user.
tag String The tag to which the user belongs.
pool String The pool to which the user belongs.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Users: Events.severity > normal and Vms.status = up or Vms.status = pause
Returns a list of users where:
  • Events of greater than normal severity have occurred on their Vms AND the Vms are still running; or
  • The users’ VMs are paused.

E.1.9. Searching for Events

The following table describes all search options you can use to search for events. Auto-completion is offered for many options as appropriate.

Table E.9. Searching for Events

Property (of resource or resource-type) Type Description (Reference)
Vms.Vms-prop See property types in Section E.1.5, “Searching for Virtual Machines” The property of the Vms associated with the event.
Hosts.hosts-prop See property types in Section E.1.3, “Searching for Hosts” The property of the hosts associated with the event.
Templates.templates-prop See property types in Section E.1.7, “Searching for Templates” The property of the templates associated with the event.
Users.users-prop See property types in Section E.1.8, “Searching for Users” The property of the users associated with the event.
type List Type of the event.
severity List The severity of the Event: Warning/Error/Normal.
message String Description of the event type.
time Integer Time at which the event occurred.
usrname usrname The username associated with the event.
event_host String The host associated with the event.
event_vm String The virtual machine associated with the event.
event_template String The template associated with the event.
event_storage String The storage associated with the event.
event_datacenter String The data center associated with the event.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.

Example
Events: Vms.name = testdesktop and Hosts.name = gonzo.example.com
Returns a list of events, where:
  • The event occurred on the virtual machine named testdesktop while it was running on the host gonzo.example.com.