Metrics Engine Documentation Index
Configuration Reference Home

Server Query

The Server Query is used to select a set of monitored servers based on server name, type or location.

The configuration of a Server Query allows it to return a static list of servers or a list of servers that may change with each invocation of the query.

↓Relations From this Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct aggregation relation to Server Queries:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ query-name  None
↓ description
↓ server-instance-type
↓ server-instance-location
↓ server-instance-name

Basic Properties

query-name (Read-Only)

Description
Specifies the name of the Server Query.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

description

Description
Description of the Server Query.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-instance-type

Description
Query will return only servers of the specified types. Each Server Query will return a set of servers that match this type constraint.
Default Value
None
Allowed Values
directory - Return Identity Data Store instances.

metrics-engine - Return Metrics Engine instances.

proxy - Return Identity Proxy instances.

sync - Return Identity Data Sync Server instances.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

server-instance-location

Description
Query will return only servers from the specified location. Each Server Query will include the set of servers configured to be in this location. The value of location comes from the server's location property in the global configuration entry.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-instance-name

Description
Query will return only servers of the specified types. Each Server Query will include the set of servers defined in this attribute. The name of a server comes from the cn property of the corresponding External Server entry.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Server Queries:

dsconfig list-server-queries
     [--property {propertyName}] ...

To view the configuration for an existing Server Query:

dsconfig get-server-query-prop
     --query-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Server Query:

dsconfig set-server-query-prop
     --query-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Server Query:

dsconfig create-server-query
     --query-name {name}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Server Query:

dsconfig delete-server-query
     --query-name {name}