NetXMS Wiki

Difference between revisions of "NXSL Function Reference"

NXSL Function Reference (view source)

Revision as of 16:13, 13 September 2022

2,503 bytes removed ,  16:13, 13 September 2022
m
Text replacement - "^" to "{{deprecated}}"
(Added missing functions "FindAllDCIs" and "GetDCIValues")
m (Text replacement - "^" to "{{deprecated}}")
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{deprecated}}
{| style="border-spacing: 20px; border: 20px solid red;"
|
'''WARNING''': This page is no longer updated. Please visit '''[https://www.netxms.org/documentation/nxsl-latest/#_function_reference NXSL Function Reference] for current version of the documentation.
|}
= Function tables =
= Function tables =
{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
{| {border="1" cellpadding="4" cellspacing="2" style="border:\#c9c9c9 1px solid; margin: 1em 1em 1em 0; border-collapse: collapse;"}
Line 9: Line 18:
| align="center" style="background:#f0f0f0;"|'''Network'''
| align="center" style="background:#f0f0f0;"|'''Network'''
|-
|-
| [[NXSL:classof|classof]]||[[NXSL:abs|abs]]||[[NXSL:chr|chr]]||[[NXSL:CreateDCI|CreateDCI]]||[[NXSL:FindNodeObject|FindNodeObject]]||[[NXSL:BindObject|BindObject]]||[[NXSL:AddrInRange|AddrInRange]]
| [[NXSL:CountScheduledTasksByKey|CountScheduledTasksByKey]]||[[NXSL:abs|abs]]||[[NXSL:ArrayToString|ArrayToString]]||[[NXSL:CreateDCI|CreateDCI]]||[[NXSL:FindNodeObject|FindNodeObject]]||[[NXSL:BindObject|BindObject]]||[[NXSL:AddrInRange|AddrInRange]]
|-
|-
| [[NXSL:d2x|d2x]]||[[NXSL:ceil|ceil]]||[[NXSL:format|format]]||[[NXSL:FindAllDCIs|FindAllDCIs]]||[[NXSL:FindObject|FindObject]]||[[NXSL:CreateContainer|CreateContainer]]||[[NXSL:AddrInSubnet|AddrInSubnet]]
| [[NXSL:classof|classof]]||[[NXSL:ceil|ceil]]||[[NXSL:chr|chr]]||[[NXSL:FindAllDCIs|FindAllDCIs]]||[[NXSL:FindObject|FindObject]]||[[NXSL:CreateContainer|CreateContainer]]||[[NXSL:AddrInSubnet|AddrInSubnet]]
|-
|-
| [[NXSL:exit|exit]]||[[NXSL:exp|exp]]||[[NXSL:index|index]]||[[NXSL:FindDCIByDescription|FindDCIByDescription]]||[[NXSL:GetInterfaceName|GetInterfaceName]]||[[NXSL:CreateNode|CreateNode]]||[[NXSL:gethostbyaddr|gethostbyaddr]]
| [[NXSL:d2x|d2x]]||[[NXSL:exp|exp]]||[[NXSL:format|format]]||[[NXSL:FindDCIByDescription|FindDCIByDescription]]||[[NXSL:GetInterfaceName|GetInterfaceName]]||[[NXSL:CreateNode|CreateNode]]||[[NXSL:gethostbyaddr|gethostbyaddr]]
|-
|-
| [[NXSL:GetConfigurationVariable|GetConfigurationVariable]]||[[NXSL:floor|floor]]||[[NXSL:left|left]]||[[NXSL:FindDCIByName|FindDCIByName]]||[[NXSL:GetInterfaceObject|GetInterfaceObject]]||[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]||[[NXSL:gethostbyname|gethostbyname]]
| [[NXSL:exit|exit]]||[[NXSL:floor|floor]]||[[NXSL:index|index]]||[[NXSL:FindDCIByName|FindDCIByName]]||[[NXSL:GetInterfaceObject|GetInterfaceObject]]||[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]||[[NXSL:gethostbyname|gethostbyname]]
|-
|-
| [[NXSL:inList|inList]]||[[NXSL:log|log]]||[[NXSL:length|length]]||[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]||[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]||[[NXSL:DeleteObject|DeleteObject]]||
| [[NXSL:GetConfigurationVariable|GetConfigurationVariable]]||[[NXSL:log|log]]||[[NXSL:left|left]]||[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]||[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]||[[NXSL:DeleteObject|DeleteObject]]||
|-
|-
| [[NXSL:map|map]]||[[NXSL:log10|log10]]||[[NXSL:lower|lower]]||[[NXSL:GetDCIObject|GetDCIObject]]||[[NXSL:GetNodeParents|GetNodeParents]]||[[NXSL:GetCustomAttribute|GetCustomAttribute]]||
| [[NXSL:inList|inList]]||[[NXSL:log10|log10]]||[[NXSL:length|length]]||[[NXSL:GetDCIObject|GetDCIObject]]||[[NXSL:GetNodeParents|GetNodeParents]]||[[NXSL:EnterMaintenance|EnterMaintenance]]||
|-
|-
| [[NXSL:mapList|mapList]]||[[NXSL:pow|pow]]||[[NXSL:ltrim|ltrim]]||[[NXSL:GetDCIRawValue|GetDCIRawValue]]||[[NXSL:GetNodeTemplates|GetNodeTemplates]]||[[NXSL:ManageObject|ManageObject]]||
| [[NXSL:map|map]]||[[NXSL:pow|pow]]||[[NXSL:lower|lower]]||[[NXSL:GetDCIRawValue|GetDCIRawValue]]||[[NXSL:GetNodeTemplates|GetNodeTemplates]]||[[NXSL:GetCustomAttribute|GetCustomAttribute]]||
|-
|-
| [[NXSL:max|max]]||[[NXSL:round|round]]||[[NXSL:ord|ord]]||[[NXSL:GetDCIValue|GetDCIValue]]||[[NXSL:GetObjectChildren|GetObjectChildren]]||[[NXSL:RenameObject|RenameObject]]||
| [[NXSL:mapList|mapList]]||[[NXSL:round|round]]||[[NXSL:ltrim|ltrim]]||[[NXSL:GetDCIValue|GetDCIValue]]||[[NXSL:GetObjectChildren|GetObjectChildren]]||[[NXSL:LeaveMaintenance|LeaveMaintenance]]||
|-
|-
| [[NXSL:min|min]]||||[[NXSL:right|right]]||[[NXSL:GetDCIValues|GetDCIValues]]||[[NXSL:GetObjectParents|GetObjectParents]]||[[NXSL:SetCustomAttribute|SetCustomAttribute]]||
| [[NXSL:max|max]]||||[[NXSL:ord|ord]]||[[NXSL:GetDCIValues|GetDCIValues]]||[[NXSL:GetObjectParents|GetObjectParents]]||[[NXSL:ManageObject|ManageObject]]||
|-
|-
| [[NXSL:random|random]]||||[[NXSL:rindex|rindex]]||[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]||||[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]||
| [[NXSL:min|min]]||||[[NXSL:right|right]]||[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]||[[NXSL:GetAllNodes|GetAllNodes]]||[[NXSL:RenameObject|RenameObject]]||
|-
|-
| [[NXSL:sleep|sleep]]||||[[NXSL:rtrim|rtrim]]||[[NXSL:GetDCIValueByName|GetDCIValueByName]]||||[[NXSL:UnbindObject|UnbindObject]]||
| [[NXSL:random|random]]||||[[NXSL:rindex|rindex]]||[[NXSL:GetDCIValueByName|GetDCIValueByName]]||||[[NXSL:SetCustomAttribute|SetCustomAttribute]]||
|-
|-
| [[NXSL:trace|trace]]||||[[NXSL:substr|substr]]||[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]||||[[NXSL:UnmanageObject|UnmanageObject]]||
| [[NXSL:sleep|sleep]]||||[[NXSL:rtrim|rtrim]]||[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]||||[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]||
|-
|-
| [[NXSL:typeof|typeof]]||||[[NXSL:trim|trim]]||[[NXSL:GetMinDCIValue|GetMinDCIValue]]||||||
| [[NXSL:trace|trace]]||||[[NXSL:SplitString|SplitString]]||[[NXSL:GetMinDCIValue|GetMinDCIValue]]||||[[NXSL:UnbindObject|UnbindObject]]||
|-
|-
| [[NXSL:x2d|x2d]]||||[[NXSL:upper|upper]]||[[NXSL:GetSumDCIValue|GetSumDCIValue]]||||||
| [[NXSL:typeof|typeof]]||||[[NXSL:substr|substr]]||[[NXSL:GetSumDCIValue|GetSumDCIValue]]||||[[NXSL:UnmanageObject|UnmanageObject]]||
|-
|-
| ||||||[[NXSL:PushDCIData|PushDCIData]]||||||
| [[NXSL:x2d|x2d]]||||[[NXSL:trim|trim]]||[[NXSL:PushDCIData|PushDCIData]]||||||
|-
|-
|  
| ||||[[NXSL:upper|upper]]||||||||
|}
|}
<hr>
<hr>
Line 49: Line 58:
| align="center" style="background:#f0f0f0;"|'''Agent'''
| align="center" style="background:#f0f0f0;"|'''Agent'''
| align="center" style="background:#f0f0f0;"|'''Event Processing'''
| align="center" style="background:#f0f0f0;"|'''Event Processing'''
| align="center" style="background:#f0f0f0;"|'''Situations'''
| align="center" style="background:#f0f0f0;"|'''Persistent Storage'''
| align="center" style="background:#f0f0f0;"|'''File I/O'''
|-
| [[NXSL:gmtime|gmtime]]||[[NXSL:md5|md5]]||[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]||[[NXSL:AgentReadList|AgentReadList]]||[[NXSL:FindAlarmById|FindAlarmById]]||[[NXSL:ReadPersistentStorage|ReadPersistentStorage]]||[[NXSL:CopyFile|CopyFile]]||
|-
|-
| [[NXSL:gmtime|gmtime]]||[[NXSL:md5|md5]]||[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]||[[NXSL:AgentReadList|AgentReadList]]||[[NXSL:FindAlarmById|FindAlarmById]]||[[NXSL:FindSituation|FindSituation]]
| [[NXSL:localtime|localtime]]||[[NXSL:sha1|sha1]]||[[NXSL:SNMPGet|SNMPGet]]||[[NXSL:AgentReadParameter|AgentReadParameter]]||[[NXSL:FindAlarmByKey|FindAlarmByKey]]||[[NXSL:WritePersistentStorage|WritePersistentStorage]]||[[NXSL:CreateDirectory|CreateDirectory]]||
|-
|-
| [[NXSL:localtime|localtime]]||[[NXSL:sha1|sha1]]||[[NXSL:SNMPGet|SNMPGet]]||[[NXSL:AgentReadParameter|AgentReadParameter]]||[[NXSL:FindAlarmByKey|FindAlarmByKey]]||[[NXSL:GetSituationAttribute|GetSituationAttribute]]
| [[NXSL:SecondsToUptime|SecondsToUptime]]||[[NXSL:sha256|sha256]]||[[NXSL:SNMPGetValue|SNMPGetValue]]||[[NXSL:AgentReadTable|AgentReadTable]]||[[NXSL:FindAlarmByKeyRegex|FindAlarmByKeyRegex]]||||[[NXSL:DeleteFile|DeleteFile]]||
|-
|-
| [[NXSL:SecondsToUptime|SecondsToUptime]]||[[NXSL:sha256|sha256]]||[[NXSL:SNMPGetValue|SNMPGetValue]]||[[NXSL:AgentReadTable|AgentReadTable]]||[[NXSL:GetEventParameter|GetEventParameter]]||
| [[NXSL:strftime|strftime]]||||[[NXSL:SNMPSet|SNMPSet]]||||[[NXSL:GetEventParameter|GetEventParameter]]||||[[NXSL:FileAccess|FileAccess]]
|-
|-
| [[NXSL:strftime|strftime]]||||[[NXSL:SNMPSet|SNMPSet]]||||[[NXSL:PostEvent|PostEvent]]||
| [[NXSL:time|time]]||||[[NXSL:SNMPWalk|SNMPWalk]]||||[[NXSL:PostEvent|PostEvent]]||||[[NXSL:OpenFile|OpenFile]]
|-
|-
| [[NXSL:time|time]]||||[[NXSL:SNMPWalk|SNMPWalk]]||||[[NXSL:SetEventParameter|SetEventParameter]]||
| [[NXSL:mktime|mktime]]||||||||[[NXSL:SetEventParameter|SetEventParameter]]||||[[NXSL:RemoveDirectory|RemoveDirectory]]||
|-
|-
|  
| ||||||||||||[[NXSL:RenameFile|RenameFile]]||
|}
|}
<hr>
Below is the old function organization.
= Generic Functions =
[[NXSL:abs|abs]]
[[NXSL:AddrInRange|AddrInRange]]
[[NXSL:AddrInSubnet|AddrInSubnet]]
[[NXSL:ceil|ceil]]
[[NXSL:chr|chr]]
[[NXSL:classof|classof]]
[[NXSL:d2x|d2x]]
[[NXSL:exit|exit]]
[[NXSL:exp|exp]]
[[NXSL:floor|floor]]
[[NXSL:format|format]]
[[NXSL:gmtime|gmtime]]
[[NXSL:gethostbyaddr|gethostbyaddr]]
[[NXSL:gethostbyname|gethostbyname]]
[[NXSL:index|index]]
[[NXSL:inList|inList]]
[[NXSL:left|left]]
[[NXSL:length|length]]
[[NXSL:localtime|localtime]]
[[NXSL:log|log]]
[[NXSL:log10|log10]]
[[NXSL:lower|lower]]
[[NXSL:ltrim|ltrim]]
[[NXSL:map|map]]
[[NXSL:mapList|mapList]]
[[NXSL:max|max]]
[[NXSL:min|min]]
[[NXSL:md5|md5]]
[[NXSL:ord|ord]]
[[NXSL:pow|pow]]
[[NXSL:random|random]]
[[NXSL:right|right]]
[[NXSL:rindex|rindex]]
[[NXSL:round|round]]
[[NXSL:rtrim|rtrim]]
[[NXSL:sleep|sleep]]
[[NXSL:SecondsToUptime|SecondsToUptime]]
[[NXSL:sha1|sha1]]
[[NXSL:sha256|sha256]]
[[NXSL:strftime|strftime]]
[[NXSL:substr|substr]]
[[NXSL:time|time]]
[[NXSL:trace|trace]]
[[NXSL:trim|trim]]
[[NXSL:typeof|typeof]]
[[NXSL:upper|upper]]
[[NXSL:x2d|x2d]]
= Data Collection =
[[NXSL:CreateDCI|CreateDCI]]
[[NXSL:FindAllDCIs|FindAllDCIs]]
[[NXSL:FindDCIByDescription|FindDCIByDescription]]
[[NXSL:FindDCIByName|FindDCIByName]]
[[NXSL:GetAvgDCIValue|GetAvgDCIValue]]
[[NXSL:GetDCIObject|GetDCIObject]]
[[NXSL:GetDCIRawValue|GetDCIRawValue]]
[[NXSL:GetDCIValue|GetDCIValue]]
[[NXSL:GetDCIValues|GetDCIValues]]
[[NXSL:GetDCIValueByDescription|GetDCIValueByDescription]]
[[NXSL:GetDCIValueByName|GetDCIValueByName]]
[[NXSL:GetMaxDCIValue|GetMaxDCIValue]]
[[NXSL:GetMinDCIValue|GetMinDCIValue]]
[[NXSL:GetSumDCIValue|GetSumDCIValue]]
[[NXSL:PushDCIData|PushDCIData]]
= Event Processing =
[[NXSL:FindAlarmById|FindAlarmById]]
[[NXSL:FindAlarmByKey|FindAlarmByKey]]
[[NXSL:GetEventParameter|GetEventParameter]]
[[NXSL:PostEvent|PostEvent]]
[[NXSL:SetEventParameter|SetEventParameter]]
= Object Management =
[[NXSL:BindObject|BindObject]]
[[NXSL:CreateContainer|CreateContainer]]
[[NXSL:CreateNode|CreateNode]]
[[NXSL:DeleteCustomAttribute|DeleteCustomAttribute]]
[[NXSL:DeleteObject|DeleteObject]]
[[NXSL:FindNodeObject|FindNodeObject]]
[[NXSL:FindObject|FindObject]]
[[NXSL:GetCustomAttribute|GetCustomAttribute]]
[[NXSL:GetInterfaceName|GetInterfaceName]]
[[NXSL:GetInterfaceObject|GetInterfaceObject]]
[[NXSL:GetNodeInterfaces|GetNodeInterfaces]]
[[NXSL:GetNodeParents|GetNodeParents]]
[[NXSL:GetNodeTemplates|GetNodeTemplates]]
[[NXSL:GetObjectChildren|GetObjectChildren]]
[[NXSL:GetObjectParents|GetObjectParents]]
[[NXSL:ManageObject|ManageObject]]
[[NXSL:RenameObject|RenameObject]]
[[NXSL:SetCustomAttribute|SetCustomAttribute]]
[[NXSL:SetInterfaceExpectedState|SetInterfaceExpectedState]]
[[NXSL:UnbindObject|UnbindObject]]
[[NXSL:UnmanageObject|UnmanageObject]]
= Server Configuration =
[[NXSL:GetConfigurationVariable|GetConfigurationVariable]]
= Situations =
[[NXSL:FindSituation|FindSituation]]
[[NXSL:GetSituationAttribute|GetSituationAttribute]]
= Agent Access =
[[NXSL:AgentReadList|AgentReadList]]
[[NXSL:AgentReadParameter|AgentReadParameter]]
[[NXSL:AgentReadTable|AgentReadTable]]
= SNMP =
[[NXSL:CreateSNMPTransport|CreateSNMPTransport]]
[[NXSL:SNMPGet|SNMPGet]]
[[NXSL:SNMPGetValue|SNMPGetValue]]
[[NXSL:SNMPSet|SNMPSet]]
[[NXSL:SNMPWalk|SNMPWalk]]
[[Category:Scripting Guide]]
Retrieved from "https://wiki.netxms.org/wiki/Special:MobileDiff/1436...1884"