[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

ResourceQuery

Object used to lookup resources with various filtering criteria


Properties

array of string as uuid
adapterInstanceId Optional

Array of uuids that identify adapter instances


array of string
adapterKind Optional

Array of Adapter Kind keys


array of integer as int32
collectorId Optional

Array of Collector Identifiers


array of string
collectorName Optional

Array of Collector names


array of string as uuid
credentialId Optional

Array of CredentialIDs


string
includeRelated Optional

None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.

Possible values are: PARENTCHILD


array of string as uuid
maintenanceScheduleId Optional

Array of {@link UUID} that identify Maintenance Schedules. Since vROps 6.1.0 release onwards, we don’t support search and look up of Resources using Maintenance Schedules’ identifiers.


array of string
name Optional

Array of resource names to query for. NOTE: Currently, only single element supported


array of string as uuid
parentId Optional

Array of UUID of object that are the parent resource in a parent child relationship


propertyConditions Optional

Property conditions query to be used for filtering. NOTE: If this filter is specified only the resources that have resource status ‘DATA_RECEIVING’ will be returned.


string
propertyName Optional

Name of property. Query only supports filtering for a single property.


string
propertyValue Optional

Value of property. Omitting the property value will check for existence of the property name on the resource. NOTE: Use ‘propertyConditions’ to specify lookup of Resource using multiple properties.


integer as int64
recentlyAdded Optional

Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.


array of string
regex Optional

Array of resource names in java regex format. NOTE: regex and name are mutually exclusive. If both are specified, name is given preference.


array of string
resourceHealth Optional

Array of resource health

Possible values are: GREENYELLOWORANGEREDGREY


array of string as uuid
resourceId Optional

Array of Resource Identifiers


array of string
resourceKind Optional

Array of Resource Kind keys


array of string
resourceState Optional

Array of resource states

Possible values are: STOPPEDSTARTINGSTARTEDSTOPPINGUPDATINGFAILEDMAINTAINEDMAINTAINED_MANUALREMOVINGNOT_EXISTINGNONEUNKNOWN


array of string
resourceStatus Optional

Array of resource data collection stats

Possible values are: NONEERRORUNKNOWNDOWNDATA_RECEIVINGOLD_DATA_RECEIVINGNO_DATA_RECEIVINGNO_PARENT_MONITORINGCOLLECTOR_DOWN


array of ResourceTag
resourceTag Optional

Property used for tag filtering. NOTE: If specified, only the resources with the tags will be returned.


statConditions Optional

Stat conditions query to be used for filtering. NOTE: If this filter is specified only the resources that have resource status ‘DATA_RECEIVING’ will be returned.


string
statKey Optional

Name of resource StatKey to validate value is within a range. Use with statKeyLowerBound, statKeyUpperBound and statKeyInclusive to create comparison conditions NOTE: Use ‘statConditions’ to specify lookup of Resource using multiple stat keys.


boolean
statKeyInclusive Optional

Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true


number as double
statKeyLowerBound Optional

StatKey value matching range lower bound


number as double
statKeyUpperBound Optional

StatKey value matching range upper bound

JSON Example

{
	"adapterInstanceId": [
		"string"
	],
	"adapterKind": [
		"string"
	],
	"collectorId": [
		0
	],
	"collectorName": [
		"string"
	],
	"credentialId": [
		"string"
	],
	"includeRelated": "PARENT",
	"maintenanceScheduleId": [
		"string"
	],
	"name": [
		"string"
	],
	"parentId": [
		"string"
	],
	"propertyConditions": {
		"conditions": [
			{
				"doubleValue": 0,
				"key": "string",
				"operator": "EQ",
				"stringValue": "string"
			}
		],
		"conjunctionOperator": "AND"
	},
	"propertyName": "string",
	"propertyValue": "string",
	"recentlyAdded": 0,
	"regex": [
		"string"
	],
	"resourceHealth": [
		"GREEN"
	],
	"resourceId": [
		"string"
	],
	"resourceKind": [
		"string"
	],
	"resourceState": [
		"STOPPED"
	],
	"resourceStatus": [
		"NONE"
	],
	"resourceTag": [
		{
			"category": "string",
			"name": "string"
		}
	],
	"statConditions": {
		"conditions": [
			{
				"doubleValue": 0,
				"key": "string",
				"operator": "EQ",
				"stringValue": "string"
			}
		],
		"conjunctionOperator": "AND"
	},
	"statKey": "string",
	"statKeyInclusive": false,
	"statKeyLowerBound": 0,
	"statKeyUpperBound": 0
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Property Of

AlertQuery
ResourceRelationshipsQuery
SymptomQuery
Parameter To

Get Matching Resources

Feedback

Was this page helpful?