Metrics Engine Documentation Index
Configuration Reference Home

System Info Monitor Provider

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.

The System Info Monitor Provider can be used to publish information about the system and virtual machine on which the Metrics Engine is running.

Parent Component
Properties
dsconfig Usage

Parent Component

The System Info Monitor Provider component inherits from the Monitor Provider

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled

Basic Properties

description

Description
A description for this Monitor Provider
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Monitor Provider is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Monitor Providers:

dsconfig list-monitor-providers
     [--property {propertyName}] ...

To view the configuration for an existing Monitor Provider:

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

To update the configuration for an existing Monitor Provider:

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

To create a new System Info Monitor Provider:

dsconfig create-monitor-provider
     --provider-name {name}
     --type system-info
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Monitor Provider:

dsconfig delete-monitor-provider
     --provider-name {name}