-
Notifications
You must be signed in to change notification settings - Fork 0
/
NetXMS Calltips.xml
1047 lines (846 loc) · 28 KB
/
NetXMS Calltips.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="Windows-1252" ?>
<NotepadPlus>
<AutoComplete language="NXSL">
<Environment ignoreCase="no" startFunc="(" stopFunc=")" paramSeparator="," terminal=";" />
<KeyWord name="abs" func="yes">
<Overload retVal="" descr="
Description
Returns the absolute value of number.
Returns
Absolute value of number.">
<Param name="number" />
</Overload>
</KeyWord>
<KeyWord name="AddrInRange" func="yes">
<Overload retVal="" descr="
Description
Checks if given IP address is within given range (including both bounding addresses).
All IP addresses should be specified as strings.
Returns
TRUE if address is within given range, FALSE otherwise.">
<Param name="address, start, end" />
</Overload>
</KeyWord>
<KeyWord name="AddrInSubnet" func="yes">
<Overload retVal="" descr="
Description
Checks if given IP address is within given subnet (including subnet and broadcast addresses).
Returns
TRUE if address is within given subnet, FALSE otherwise.">
<Param name="address, subnet, mask" />
</Overload>
</KeyWord>
<KeyWord name="AgentReadList" func="yes">
</KeyWord>
<KeyWord name="AgentReadParameter" func="yes">
<Overload retVal="" descr="
Description
Read parameter's value directly from agent on given node.
Returns
Value of given parameter on success and NULL on failure.">
<Param name="node, name" />
</Overload>
</KeyWord>
<KeyWord name="AgentReadTable" func="yes">
</KeyWord>
<KeyWord name="BindObject" func="yes">
<Overload retVal="" descr="
Description
Bind all NetXMS objects that can be bound from console (nodes, subnets, clusters, and another containers) to container objects.
Returns
Nothing.">
<Param name="parent, child" />
</Overload>
</KeyWord>
<KeyWord name="ceil" func="yes">
<Overload retVal="" descr="
Description
Round up value.
Returns
The smallest integral value that is not less than x.">
<Param name="x" />
</Overload>
</KeyWord>
<KeyWord name="chr" func="yes">
<Overload retVal="" descr="
Description
Return a character from it's UNICODE value.
Returns
A character.">
<Param name="integer" />
</Overload>
</KeyWord>
<KeyWord name="classof" func="yes">
<Overload retVal="" descr="
Description
Returns the class name for given object.
Returns
Object's class name. If parameter passed to this function is not an object, runtime error will be generated.">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="CreateContainer" func="yes">
<Overload retVal="" descr="
Description
Create container object.
Returns
Reference to newly created object.">
<Param name="parent, name" />
</Overload>
</KeyWord>
<KeyWord name="CreateDCI" func="yes">
<Overload retVal="" descr="
Description
Create new DCI.
Returns
DCI object on success or NULL on failure.">
<Param name="node, source, name, description, dataType, pollingInterval, retentionTime" />
</Overload>
</KeyWord>
<KeyWord name="CreateNode" func="yes">
<Overload retVal="" descr="
Description
Create a node object.
Returns
Reference to newly created object or NULL on failure.">
<Param name="parent, name, primaryHostName" />
</Overload>
</KeyWord>
<KeyWord name="CreateSNMPTransport" func="yes">
<Overload retVal="" descr="
Description
Create new SNMP transport object for specific node. The node must support SNMP.
Returns
Object of class SNMP_Transport or NULL on failure.">
<Param name="node" />
</Overload>
</KeyWord>
<KeyWord name="DeleteCustomAttribute" func="yes">
<Overload retVal="" descr="
Description
Delete node's custom attribute.
Returns
Nothing.">
<Param name="node, attributeName" />
</Overload>
</KeyWord>
<KeyWord name="DeleteObject" func="yes">
<Overload retVal="" descr="
Description
Delete object.
Returns
Nothing.">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="d2x" func="yes">
<Overload retVal="" descr="
Description
Returns the hexidecimal value of a decimal.
Returns
Hexadecimal value of number.">
<Param name="number [,padding]" />
</Overload>
</KeyWord>
<KeyWord name="exit" func="yes">
<Overload retVal="" descr="
Description
Exit from script.
Returns
Nothing.">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="_exit" func="yes">
</KeyWord>
<KeyWord name="exp" func="yes">
<Overload retVal="" descr="
Description
Returns e (the base of natural logarithms) raised to a power.
Returns
e^power expressed as a real number.">
<Param name="power" />
</Overload>
</KeyWord>
<KeyWord name="FindAllDCIs" func="yes">
</KeyWord>
<KeyWord name="FindAlarmById" func="yes">
<Overload retVal="" descr="
Description
Find active (non-terminated) alarm by alarm ID.
Returns
Alarm object or null if no such alarm exist.">
<Param name="id" />
</Overload>
</KeyWord>
<KeyWord name="FindAlarmByKey" func="yes">
<Overload retVal="" descr="
Description
Find active (non-terminated) alarm by alarm key.
Returns
Alarm object or null if no such alarm exist.">
<Param name="key" />
</Overload>
</KeyWord>
<KeyWord name="FindDCIByDescription" func="yes">
<Overload retVal="" descr="
Description
Find DCI by description (search is case-insensetive).
Returns
DCI ID on success or 0 if DCI with matching description was not found.">
<Param name="node, description" />
</Overload>
</KeyWord>
<KeyWord name="FindDCIByName" func="yes">
<Overload retVal="" descr="
Description
Find DCI by name (search is case-insensetive).
Returns
DCI ID on success or 0 if DCI with matching name was not found.">
<Param name="node, description" />
</Overload>
</KeyWord>
<KeyWord name="FindNodeObject" func="yes">
<Overload retVal="" descr="
Description
Find node object by node id or node name.
Returns
Node object with given id or name on success or NULL on failure (either because node with given name/id does not exist, or access to it was denied).">
<Param name="node, id" />
</Overload>
</KeyWord>
<KeyWord name="FindObject" func="yes">
<Overload retVal="" descr="
Description
Find NetXMS object by object id or name.
Returns
Node object with given id or name on success or NULL on failure (either because object with given name/id does not exist, or access to it was denied).">
<Param name="id, node" />
</Overload>
</KeyWord>
<KeyWord name="FindSituation" func="yes">
<Overload retVal="" descr="
Description
Find situation instance either by situation object name and instance name or by situation object ID and instance name (name search is case-insensetive).
Returns
Situation object with given ID or name on success or NULL on failure.">
<Param name="id, instance" />
</Overload>
</KeyWord>
<KeyWord name="floor" func="yes">
<Overload retVal="" descr="
Description
Round down value.
Returns
The largest integral value not greater than x.">
<Param name="x" />
</Overload>
</KeyWord>
<KeyWord name="format" func="yes">
<Overload retVal="" descr="
Description
Formats a numeric value.
Returns
Formatted numeric value.">
<Param name="number, width, precision" />
</Overload>
</KeyWord>
<KeyWord name="GetAvgDCIValue" func="yes">
<Overload retVal="" descr="
Description
Get the average value of the DCI for the given period. The DCI value must be of numeric type.
Returns
Average value or NULL on failure.">
<Param name="node, dciId, from, to" />
</Overload>
</KeyWord>
<KeyWord name="GetConfigurationVariable" func="yes">
<Overload retVal="" descr="
Description
Get value of server's configuration variable.
Returns
Value of requested variable or specified default value if given variable is not set.">
<Param name="variableName, [defaultValue]" />
</Overload>
</KeyWord>
<KeyWord name="GetCustomAttribute" func="yes">
<Overload retVal="" descr="
Description
Get value of node's custom attribute.
If attribute name conforms to NXSL identifier naming conventions, it can be accessed directly as node object attribute.
For example "GetCustomAttribute($node, "my_attribute")" can be changed to "$node->my_attribute".
Returns
String value of requested custom attribute or NULL if attribute is missing.">
<Param name="node, attributeName" />
</Overload>
</KeyWord>
<KeyWord name="GetDCIObject" func="yes">
<Overload retVal="" descr="
Description
Get DCI object with given ID.
Returns
DCI object with given id on success or NULL on failure (if object with given id does not exist, or access to it was denied).">
<Param name="node, id" />
</Overload>
</KeyWord>
<KeyWord name="GetDCIRawValue" func="yes">
<Overload retVal="" descr="
Description
Get last raw value (before transformation) of DCI with given ID on given node.
Returns
Last raw value (before transformation) for given DCI or NULL if DCI with given ID does not exist or has no collected values.">
<Param name="node, id" />
</Overload>
</KeyWord>
<KeyWord name="GetDCIValue" func="yes">
<Overload retVal="" descr="
Description
Get last value of DCI with given ID on given node.
Returns
Last value for given DCI or NULL if DCI with given ID does not exist or has no collected values.">
<Param name="node, id" />
</Overload>
</KeyWord>
<KeyWord name="GetDCIValues" func="yes">
</KeyWord>
<KeyWord name="GetDCIValueByDescription" func="yes">
<Overload retVal="" descr="
Description
Get last value of DCI with given description on given node.
Returns
Last value for given DCI or NULL if DCI with given description does not exist or has no collected values.">
<Param name="node, description" />
</Overload>
</KeyWord>
<KeyWord name="GetDCIValueByName" func="yes">
<Overload retVal="" descr="
Description
Get last value of DCI with given name on given node.
Returns
Last value for given DCI or NULL if DCI with given name does not exist or has no collected values.">
<Param name="node, name" />
</Overload>
</KeyWord>
<KeyWord name="GetEventParameter" func="yes">
<Overload retVal="" descr="
Description
Get value of event's named parameter.
Returns
String value of requested parameter or NULL if no such parameter exist.">
<Param name="event, parameterName" />
</Overload>
</KeyWord>
<KeyWord name="gethostbyaddr" func="yes">
</KeyWord>
<KeyWord name="gethostbyname" func="yes">
</KeyWord>
<KeyWord name="GetInterfaceName" func="yes">
<Overload retVal="" descr="
Description
Get interface name by index.
Returns
Name of the requested interface or null if not found.">
<Param name="obj, index" />
</Overload>
</KeyWord>
<KeyWord name="GetInterfaceObject" func="yes">
<Overload retVal="" descr="
Description
Get interface object by index.
Returns
An interface object, or null if not found.">
<Param name="obj, index" />
</Overload>
</KeyWord>
<KeyWord name="GetMaxDCIValue" func="yes">
<Overload retVal="" descr="
Description
Get the maximum value of the DCI for the given period. The DCI value must be of numeric type.
Returns
Maximum value or NULL on failure.">
<Param name="node, dciId, from, to" />
</Overload>
</KeyWord>
<KeyWord name="GetMinDCIValue" func="yes">
<Overload retVal="" descr="
Description
Get the minimum value of the DCI for the given period. The DCI value must be of numeric type.
Returns
Minimum value or NULL on failure.">
<Param name="node, dciId, from, to" />
</Overload>
</KeyWord>
<KeyWord name="GetNodeInterfaces" func="yes">
<Overload retVal="" descr="
Description
Get all interfaces for given node.
Returns
Array of objects of class Interface, with first object placed at index 0. End of list indicated by array element with NULL value.">
<Param name="node" />
</Overload>
</KeyWord>
<KeyWord name="GetNodeParents" func="yes">
<Overload retVal="" descr="
Description
Get accessible parent objects for given node.
Returns
Array of objects of class NetObj (generic NetXMS object), with first object placed at index 0.
End of list indicated by array element with NULL value.
This function will never return template or policy objects applied to node.
Return value also affected by trusted nodes settings (see "Security Issues" on wiki for more information).">
<Param name="node" />
</Overload>
</KeyWord>
<KeyWord name="GetNodeTemplates" func="yes">
<Overload retVal="" descr="
Description
Get accessible template objects for given node.
Returns
Array of objects, with first object placed at index 0.
End of list indicated by array element with null value.
Return value also affected by trusted nodes settings (see "Security Issues" on wiki for more information).">
<Param name="node" />
</Overload>
</KeyWord>
<KeyWord name="GetObjectChildren" func="yes">
<Overload retVal="" descr="
Description
Get accessible child objects for given object.
Returns
Array of objects of class Node, Interface, or NetObj, with first object placed at index 0.
End of list indicated by array element with NULL value.
Return value also affected by trusted nodes settings (see "Security Issues" on wiki for more information).">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="GetObjectParents" func="yes">
<Overload retVal="" descr="
Description
Get accessible parent objects for given object.
Returns
Array of objects of class NetObj (generic NetXMS object), with first object placed at index 0.
End of list indicated by array element with NULL value.
This function will never return template or policy objects applied to node.
Return value also affected by trusted nodes settings (see "Security Issues" on wiki for more information).">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="GetSumDCIValue" func="yes">
<Overload retVal="" descr="
Description
Get the sum value of the DCI for the given period. The DCI value must be of numeric type.
Returns
Sum value or NULL on failure.">
<Param name="node, dciId, from, to" />
</Overload>
</KeyWord>
<KeyWord name="GetSituationAttribute" func="yes">
</KeyWord>
<KeyWord name="gmtime" func="yes">
<Overload retVal="" descr="
Description
Converts time in UNIX format (number of seconds since epoch) to calendar date and time broken down into its components, expressed as UTC (or GMT timezone).
Function uses either time given in time argument or current time if time is omitted.
Returns
Object of class TIME.">
<Param name="time" />
</Overload>
</KeyWord>
<KeyWord name="index" func="yes">
<Overload retVal="" descr="
Description
Returns the position of the first occurrence of substring in string at or after position if specifed.
All index values are 1-based (i.e. the first character has index 1, not 0).
Returns
Integer value of the position substring was found at, will return 0 if not found.">
<Param name="string, substring [,position]" />
</Overload>
</KeyWord>
<KeyWord name="inList" func="yes">
<Overload retVal="" descr="
Description
Check if given value is an element of given list.
Returns
TRUE if given value is an element of given list, FALSE otherwise.">
<Param name="string, separator, value" />
</Overload>
</KeyWord>
<KeyWord name="left" func="yes">
<Overload retVal="" descr="
Description
Returns the string of length characters of string, optionally padded with pad character instead of a space.
Returns
String of the left length characters.">
<Param name="string, length [,pad]" />
</Overload>
</KeyWord>
<KeyWord name="length" func="yes">
<Overload retVal="" descr="
Description
Returns the length of string.
Returns
Integer length of the string passed to the function.">
<Param name="string" />
</Overload>
</KeyWord>
<KeyWord name="localtime" func="yes">
<Overload retVal="" descr="
Description
Converts time in UNIX format (number of seconds since epoch) to calendar date and time broken down into its components. Function uses either time given in time argument or current time if time is omitted.
Returns
Object of class TIME.">
<Param name="time" />
</Overload>
</KeyWord>
<KeyWord name="log" func="yes">
<Overload retVal="" descr="
Description
Calculates natural logarithm of given value.
Returns
Natural logarithm of x.">
<Param name="x" />
</Overload>
</KeyWord>
<KeyWord name="log10" func="yes">
<Overload retVal="" descr="
Description
Calculates logarithm of given value to base 10.
Returns
Logarithm of x to base 10.">
<Param name="x" />
</Overload>
</KeyWord>
<KeyWord name="lower" func="yes">
<Overload retVal="" descr="
Description
Converts string to lowercase.
Returns
Source string converted to lowercase.">
<Param name="string" />
</Overload>
</KeyWord>
<KeyWord name="ltrim" func="yes">
<Overload retVal="" descr="
Description
Removes blanks (space and tab characters) from the left side of specified string.
Returns
Source string with blanks at the left side removed.">
<Param name="string" />
</Overload>
</KeyWord>
<KeyWord name="ManageObject" func="yes">
<Overload retVal="" descr="
Description
Set object into managed state. Has no effect if object is already in managed state.
Returns
Nothing.">
<Param name="object" />
</Overload>
</KeyWord>
<KeyWord name="map" func="yes">
<Overload retVal="" descr="
Description
Returns the value which corresponds to a specified key from specified Mapping Table.
Returns
Value corresponding for a keyName from tableName.">
<Param name="tableName, keyName" />
</Overload>
</KeyWord>
<KeyWord name="mapList" func="yes">
</KeyWord>
<KeyWord name="max" func="yes">
<Overload retVal="" descr="
Description
Returns maximal value from a list of values.
Returns
Maximal value of numbers.">
<Param name="number1 [,number2] [,number n]" />
</Overload>
</KeyWord>
<KeyWord name="md5" func="yes">
</KeyWord>
<KeyWord name="min" func="yes">
<Overload retVal="" descr="
Description
Returns minimal value from a list of values.
Returns
Minimal value of numbers.">
<Param name="number1 [,number2] [,number n]" />
</Overload>
</KeyWord>
<KeyWord name="ord" func="yes">
<Overload retVal="" descr="
Description
Convert a character into it's ASCII/Unicode value.
Only processes one character.
Returns
An ASCII/Unicode value.">
<Param name="character" />
</Overload>
</KeyWord>
<KeyWord name="PostEvent" func="yes">
<Overload retVal="" descr="
Description
Post event on behalf of given node.
"..." - 0 or more event-specific parameters.
Returns
TRUE if event was posted successfully or FALSE if not.">
<Param name="node, event, tag, ..." />
</Overload>
</KeyWord>
<KeyWord name="pow" func="yes">
<Overload retVal="" descr="
Description
Calculates x raised to the power of y.
Returns
x raised to the power of y.">
<Param name="x, y" />
</Overload>
</KeyWord>
<KeyWord name="PushDCIData" func="yes">
<Overload retVal="" descr="
Description
Push new DCI value from script.
Returns
No return value.">
<Param name="node, dciId, value" />
</Overload>
</KeyWord>
<KeyWord name="random" func="yes">
<Overload retVal="" descr="
Description
Generate pseudo random number in given range. Uses c/c++ rand() function.
Returns
Random value in range minValue..maxValue.">
<Param name="minValue, maxValue" />
</Overload>
</KeyWord>
<KeyWord name="RenameObject" func="yes">
<Overload retVal="" descr="
Description
Rename object.
Returns
Nothing.">
<Param name="object, name" />
</Overload>
</KeyWord>
<KeyWord name="right" func="yes">
<Overload retVal="" descr="
Description
Returns the string of length characters of string, optionally padded with pad character instead of blank (space) starting from the right. Padding occurs on the left portion of the string.
Returns
String of the right length characters.">
<Param name="string, length [,pad]" />
</Overload>
</KeyWord>
<KeyWord name="rindex" func="yes">
<Overload retVal="" descr="
Description
Returns the position of the last occurrence of substring in string up to or before position if specifed.
Returns
Integer value of the position substring was found at, will return 0 if not found.">
<Param name="string, substring [,position]" />
</Overload>
</KeyWord>
<KeyWord name="round" func="yes">
<Overload retVal="" descr="
Description
Round floating point value to the nearest integral value or floating point value with given precision.
[precision] - optional number of decimal places to be left. If omited or set to 0, x will be rounded to integral value.
Returns
The integral value that is closest to x if precision is omited or set to 0, or floating point value rounded to have given number of decimal places.">
<Param name="x [, precision]" />
</Overload>
</KeyWord>
<KeyWord name="rtrim" func="yes">
<Overload retVal="" descr="
Description
Removes blanks (space and tab characters) from the right side of specified string.
Returns
Source string with blanks at the right side removed.">
<Param name="string" />
</Overload>
</KeyWord>
<KeyWord name="sleep" func="yes">
<Overload retVal="" descr="
Description
Suspend script execution for given number of milliseconds.
Returns
Nothing.">
<Param name="milliseconds" />
</Overload>
</KeyWord>
<KeyWord name="SecondsToUptime" func="yes">
<Overload retVal="" descr="
Description
Format system uptime in seconds as string in format "n days, hh:mm".
Returns
System uptime in format "n days, hh:mm".">
<Param name="seconds" />
</Overload>
</KeyWord>
<KeyWord name="SetCustomAttribute" func="yes">
<Overload retVal="" descr="
Description
Set value of node's custom attribute. If attribute was not defined, it will be created.
Returns
Previous value of requested custom attribute or NULL if attribute was not defined before.">
<Param name="node, attributeName, value" />
</Overload>
</KeyWord>
<KeyWord name="SetEventParameter" func="yes">
<Overload retVal="" descr="
Description
Set value of event's named parameter.
Returns
Nothing.">
<Param name="event, parameterName, value" />
</Overload>
</KeyWord>
<KeyWord name="SetInterfaceExpectedState" func="yes">
<Overload retVal="" descr="
Description
Set expected state for given interface.
Returns
Nothing.">
<Param name="interface, state" />
</Overload>
</KeyWord>
<KeyWord name="sha1" func="yes">
</KeyWord>
<KeyWord name="sha256" func="yes">
</KeyWord>
<KeyWord name="SNMPGet" func="yes">
<Overload retVal="" descr="
Description
Get the object value from specific node with SNMP GET request.
The node and all SNMP communication details defined by SNMP transport.
Returns
Object of class SNMP_VarBind or NULL on failure.">
<Param name="transport,oid" />
</Overload>
</KeyWord>
<KeyWord name="SNMPGetValue" func="yes">
<Overload retVal="" descr="
Description
Get the object value from specific node with SNMP GET request.
The node and all SNMP communication details defined by SNMP transport.
This function is similar to SNMPGet but returns string instead of an SNMP_VarBind object.
Returns
String with the value requested or NULL on failure.">
<Param name="transport,oid" />
</Overload>
</KeyWord>
<KeyWord name="SNMPSet" func="yes">
<Overload retVal="" descr="
Description
Assign a specific value to the given SNMP object for the node.
The node and all SNMP communication details defined by SNMP transport.
Returns
TRUE on success, FALSE in case of failure.">
<Param name="transport,oid,value,[data type]" />
</Overload>
</KeyWord>
<KeyWord name="SNMPWalk" func="yes">
<Overload retVal="" descr="
Description
Get an array of the object values from specific node with SNMP WALK request.
The node and all SNMP communication details defined by SNMP transport.
Returns
Array of SNMP_VarBind objects or NULL on failure.">
<Param name="transport,oid" />
</Overload>
</KeyWord>
<KeyWord name="strftime" func="yes">
</KeyWord>
<KeyWord name="substr" func="yes">
<Overload retVal="" descr="
Description
Extracts the substring from string that begins at the nth character and is of length len.
Returns
Extracted substring.">
<Param name="string, n[, len]" />
</Overload>
</KeyWord>
<KeyWord name="time" func="yes">
<Overload retVal="" descr="
Description
Gets the system time.
Returns
System time as number of seconds elapsed since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock (also known as UNIX time).">
<Param name="" />
</Overload>
</KeyWord>
<KeyWord name="trace" func="yes">
<Overload retVal="" descr="
Description
Writes message to netxms main log at given debug level.
Returns
Nothing.">
<Param name="debugLevel, message" />
</Overload>
</KeyWord>
<KeyWord name="trim" func="yes">
<Overload retVal="" descr="
Description
Removes blanks (space and tab characters) from both sides of specified string.
Returns
Source string with blanks at both sides removed.">
<Param name="string" />
</Overload>
</KeyWord>
<KeyWord name="typeof" func="yes">
<Overload retVal="" descr="
Description
Returns the data type for given value.
Returns
data type for given value. Type is returned as lowercase string. The following type names can be returned:
NULL
object
string
real
int32
int64
uint32
uint64">
<Param name="value" />
</Overload>
</KeyWord>