Difference between revisions of "NXSL:CreateDCI"

From NetXMS Wiki
Jump to navigation Jump to search
Line 53: Line 53:
== Return Value ==
== Return Value ==


[[NXSL:DCI|DCI]] object on success or null on failure.
[[NXSL:DCI|DCI]] object on success or '''null''' on failure.


== Examples ==
== Examples ==

Revision as of 11:17, 22 October 2014

Create new DCI.

Since: 1.2.6

Syntax

CreateDCI(node, source, name, description, dataType, pollingInterval, retentionTime);


Parameters

node Node object to create DCI on.
source Data collection source. Should be on of:
"agent" source is NetXMS agent.
"internal" source is server's internal data.
"push" source is push agent.
"snmp" source is SNMP agent.
name Metric name (parameter for agent and internal DCIs, OID for SNMP).
description Textual description of the DCI.
dataType DCI data type. Should be one of:
"int32" signed 32-bit integer.
"uint32" unsigned 32-bit integer.
"int64" signed 64-bit integer.
"uint64" unsigned 64-bit integer.
"float" floating point number.
"string" text string.
pollingInterval Interval in seconds between polls.
retentionTime DCI retention time in days.

Return Value

DCI object on success or null on failure.

Examples

// Create DCI to collect agent's version every 300 seconds and
// keep history for 370 days on node named "SERVER"
node = FindNodeObject(null, "SERVER");
if (node != null)
{
	dci = CreateDCI(node, "agent", "Agent.Version", "Version of NetXMS agent", "string", 300, 370);
	println (dci != null) ? "DCI created" : "DCI creation failed";
}
else
{
	println "Cannot find node object";
}