ResourceQuery
Object used to lookup resources with various filtering criteria
Properties
Array of uuids that identify adapter instances
Array of Adapter Kind keys
Array of Collector Identifiers
Array of Collector names
Array of CredentialIDs
None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.
Possible values are: PARENT , CHILD
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 resource names to query for. NOTE: Currently, only single element supported
Array of UUID of object that are the parent resource in a parent child relationship
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.
Name of property. Query only supports filtering for a single property.
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.
Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT.
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 resource health
Possible values are: GREEN , YELLOW , ORANGE , RED , GREY
Array of Resource Identifiers
Array of Resource Kind keys
Array of resource states
Possible values are: STOPPED , STARTING , STARTED , STOPPING , UPDATING , FAILED , MAINTAINED , MAINTAINED_MANUAL , REMOVING , NOT_EXISTING , NONE , UNKNOWN
Array of resource data collection stats
Possible values are: NONE , ERROR , UNKNOWN , DOWN , DATA_RECEIVING , OLD_DATA_RECEIVING , NO_DATA_RECEIVING , NO_PARENT_MONITORING , COLLECTOR_DOWN
Property used for tag filtering. NOTE: If specified, only the resources with the tags will be returned.
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.
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.
Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true
StatKey value matching range lower bound
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
}
Property Of
AlertQuery
ResourceRelationshipsQuery
SymptomQuery
Parameter To
Get Matching Resources
