resource-query

resource-query
resource-query

Object used to lookup resources with various filtering criteria

JSON Example
{
    "name": [
        "string"
    ],
    "regex": [
        "string"
    ],
    "adapterKind": [
        "string"
    ],
    "resourceKind": [
        "string"
    ],
    "collectorName": [
        "string"
    ],
    "collectorId": [
        0
    ],
    "maintenanceScheduleId": [
        "string"
    ],
    "adapterInstanceId": [
        "string"
    ],
    "recentlyAdded": 0,
    "resourceState": [
        "string"
    ],
    "resourceStatus": [
        "string"
    ],
    "resourceHealth": [
        "string"
    ],
    "parentId": [
        "string"
    ],
    "credentialId": [
        "string"
    ],
    "resourceId": [
        "string"
    ],
    "propertyName": "string",
    "propertyValue": "string",
    "statKey": "string",
    "statKeyLowerBound": "number",
    "statKeyUpperBound": "number",
    "statKeyInclusive": false,
    "propertyConditions": {
        "conjunctionOperator": "string",
        "conditions": [
            {
                "key": "string",
                "operator": "string",
                "stringValue": "string",
                "doubleValue": "number"
            }
        ]
    },
    "statConditions": {
        "conjunctionOperator": "string",
        "conditions": [
            {
                "key": "string",
                "operator": "string",
                "stringValue": "string",
                "doubleValue": "number"
            }
        ]
    },
    "includeRelated": "string",
    "resourceTag": [
        {
            "category": "string",
            "name": "string"
        }
    ]
}
array of string
name
Optional

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

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
adapterKind
Optional

Array of Adapter Kind keys

array of string
resourceKind
Optional

Array of Resource Kind keys

array of string
collectorName
Optional

Array of Collector names

array of integer
collectorId
Optional

Array of Collector Identifiers

array of string
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
adapterInstanceId
Optional

Array of uuids that identify adapter instances

integer As int64 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 resource-state
resourceState
Optional

Array of resource states. NOTE, the following states are applicable only for adapter instances: STOPPED, STARTING, STOPPING, UPDATING, FAILED, REMOVING

array of resource-data-collection-status
resourceStatus
Optional

Array of resource data collection statuses. NOTE, the following statuses are applicable only for adapter instances: ERROR, DOWN, COLLECTOR_DOWN. The statuses OLD_DATA_RECEIVING, NO_PARENT_MONITORING and UNKNOWN are deprecated.

array of resource-health
resourceHealth
Optional

Array of resource health

array of string
parentId
Optional

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

array of string
credentialId
Optional

Array of CredentialIDs

array of string
resourceId
Optional

Array of Resource Identifiers

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.

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.

number As double As double
statKeyLowerBound
Optional

StatKey value matching range lower bound

number As double As double
statKeyUpperBound
Optional

StatKey value matching range upper bound

boolean
statKeyInclusive
Optional

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

stat-or-property-condition-query
propertyConditions
Optional

Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator

stat-or-property-condition-query
statConditions
Optional

Object used to define filtering criteria based on multiple stats/properties with possibility to specify the conjunction operator

string
includeRelated
Optional

Relationship Types between resources. All relationships are many-to-many.
Representation names are plural.

Possible values are : PARENT, CHILD,
array of resourceTag
resourceTag
Optional

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

Property Of
Parameter To