C.2. Searching for Resources

This section specifies the unique set of properties for each resource and the set of associated resource types.

C.2.1. Searching for Clusters

The following table describes all search options for clusters.
Property (of resource or resource-type) Type Description (Reference)
name String The unique name that identifies the clusters on the network.
description String The description of the cluster.
initialized String A Boolean 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

This above query returns a list of clusters that are:
  • Initialized; or
  • Named Default

C.2.2. Searching for Hosts

The following table describes all search options for hosts.
Property (of resource or resource-type) Type Description (Reference)
Events.events-prop See property types in Section C.2.5, “Searching for Events” The property of the events associated with the host.
Users.users-prop See property types in Section C.2.4, “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 usage.
mem_usage Integer The percentage of memory usage.
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.
committed_mem Integer The percentage of committed memory.
tag String The tag assigned to the host.
type String The type of host.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.
Example

Host: cluster = Default

The above query returns a list of hosts that:
  • Are part of the Default cluster.

C.2.3. Searching for Volumes

The following table describes all search options for volumes.
Property (of resource or resource-type) Type Description (Reference)
Clusters.clusters prop See property types in Section C.2.1, “Searching for Clusters” The property of the clusters associated with the volume.
name String The name of the volume.
status List The availability of the volume.
type List The type of the volume.
transport_type List The transport type of the volume.
replica_count Integer The replicate count of the volume.
sortby List Sorts the returned results by one of the resource properties.
page Integer The page number of results to display.
Example

Volumes: Cluster.name = Default and Status = Up

The above query returns a list of volumes that:
  • Belong to the Default cluster and the status of the volume is Up.

C.2.4. Searching for Users

The following table describes all search options for users.
Property (of resource or resource-type) Type Description (Reference)
Hosts.hosts- prop See property types in Section C.2.2, “Searching for Hosts” The property of the hosts associated with the user.
Events.events-prop See property types in Section C.2.5, “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 Hosts.name = Server name

The above query returns a list of users for which:
  • Events of a severity greater than Normal have occurred on their hosts.

C.2.5. 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.
Property (of resource or resource-type) Type Description (Reference)
Hosts.hosts-prop See property types in Section C.2.2, “Searching for Hosts” The property of the hosts associated with the event.
Users.users-prop See property types in Section C.2.4, “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 user name associated with the event.
event_host String The host 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: event_host = gonzo.example.com

The above query returns a list of events for which:
  • The event occurred on the server named gonzo.example.com.