dci.adoc

DCI

Represents Data Collection Item (DCI).

Instance attributes

activeThresholdSeverity ⇒ Integer

Severity of the active threshold. If there are no active thresholds, defaults to 0 (NORMAL).

comments ⇒ String

DCI Comments

dataType ⇒ Integer

Data type of the DCI.

description ⇒ String

Description

errorCount ⇒ Integer

Number of consecutive data collection errors

flags ⇒ Integer

DCI flags

hasActiveThreshold ⇒ Boolean

TRUE if DCI has active threshold

id ⇒ Integer

Unique DCI identifier

instance ⇒ String

DCI instance (only for single value DCIs): %{instance}

instanceName ⇒ String

DCI instance name (only for single value DCIs): %{instance-name}

lastPollTime ⇒ Integer64

Time of last DCI poll (either successful or not) as number of seconds since epoch (1 Jan 1970 00:00:00 UTC)

lastCollectionTime ⇒ Integer64

Time of last successful DCI poll as number of seconds since epoch (1 Jan 1970 00:00:00 UTC). Added in version 4.0.

name ⇒ String

Parameter’s name

origin ⇒ Integer

Data origin of the DCI.

pollingInterval ⇒ Integer

Current polling interval

pollingSchedules ⇒ Array

Array of custom schedules in cron format

pollingScheduleType ⇒ Integer

Collection schedule:

• 0 = Server default interval

• 1 = Custom interval

• 2 = Advanced schedule

relatedObject ⇒ [class-netobj]

Related object or null if there is no object

status ⇒ Integer

Data status of the DCI.

systemTag ⇒ String

System tag. Contains information about DCI Interpretation.

template ⇒ [class-template]

Template object if DCI came from Template or NULL.

templateId ⇒ Integer

Template id if DCI came from Template or 0.

templateItemId ⇒ Integer

DCI item id in template if DCI came from Template or 0.

transformedDataType ⇒ Integer

Tranformed data type.

type ⇒ Integer

DCI type:

• 1 = single value

• 2 = table

userTag ⇒ String

User tag. This attribute was added in version 5.2

Instance methods

forcePoll() ⇒ void

Start DCI force poll.