Difference between revisions of "NXSL:GetAvgDCIValue"

Latest revision as of 18:13, 13 September 2022

This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

Get the average value of the DCI for the given period. The DCI value must be of numeric type.

Since: 1.2.1

Syntax

GetAvgDCIValue(node, dciId, from, to);

Parameters

node	Node object to calculate the average DCI value for.
dciId	DCI item id (integer).
from	Start of the period (as UNIX timestamp).
to	End of the period (as UNIX timestamp).

Return Value

Average value or null on failure.

Examples

sub main()
{
    value = GetAvgDCIValue(FindObject("MYWORKPC"), 18, 0, time()); // from the beginning till now
    trace(1, "Processor average load ". value . "%");
}

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{deprecated}}__NOTOC__
-Get the average value of the DCI item for the given period. The item value must be of either integer or double type.
+Get the average value of the DCI for the given period. The DCI value must be of numeric type.
 '''Since:''' 1.2.1
@@ Line 6: / Line 6: @@
 == Syntax ==
-GetAvgDCIValue(''node'',''dciitem'',''fromtime'',''totime'');
+GetAvgDCIValue(''node'', ''dciId'', ''from'', ''to'');
@@ Line 15: / Line 15: @@
 | ''node'' || [[NXSL:Node|Node]] object to calculate the average DCI value for.
 |-
-| ''dciitem'' || DCI item id (integer).
+| ''dciId'' || DCI item id (integer).
 |-
-| ''fromtime'' || Start of the peridod (timestamp).
+| ''from'' || Start of the period (as [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp]).
 |-
-| ''totime'' || End of the peridod (timestamp).
+| ''to'' || End of the period (as [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp]).
 |}