index-alphabetical.adoc

This appendix provides a quick alphabetical reference to all NXSL functions and classes.

Tip	Use your browser’s search (Ctrl+F / Cmd+F) to quickly find what you’re looking for.

Functions

Function	Category
_exit()	Utility
assert()	Utility
Base64::Decode()	Base64 Package
Base64::Encode()	Base64 Package
CalculateDowntime()	Data Collection
CancelScheduledTasksByKey()	Utility
chr()	String Operations
classof()	Utility
CountryAlphaCode()	Utility
CountryName()	Utility
CountScheduledTasksByKey()	Utility
CreateDCI()	Data Collection
CreateUserAgentNotification()	Utility
Crypto::MD5()	Cryptography Package
Crypto::SHA1()	Cryptography Package
Crypto::SHA256()	Cryptography Package
CurrencyAlphaCode()	Utility
CurrencyExponent()	Utility
CurrencyName()	Utility
d2x()	String Operations
DetectAnomalies()	Data Collection
FindAlarmById()	Events and Alarms
FindAlarmByKey()	Events and Alarms
FindAlarmByKeyRegex()	Events and Alarms
FindAccessPointByMACAddress()	Object Navigation
FindAllDCIs()	Data Collection
FindDCIByDescription()	Data Collection
FindDCIByName()	Data Collection
FindDCIByTag()	Data Collection
FindDCIByTagPattern()	Data Collection
FindNodeByAgentId()	Object Navigation
FindNodeByIPAddress()	Object Navigation
FindNodeByMACAddress()	Object Navigation
FindNodeBySysName()	Object Navigation
FindNodeObject()	Object Navigation
FindObject()	Object Navigation
FindObjectByGUID()	Object Navigation
FindVendorByMACAddress()	Utility
FormatMetricPrefix()	String Operations
FormatNumber()	String Operations
GetAllNodes()	Object Navigation
GetAvailablePackages()	Utility
GetAvgDCIValue()	Data Collection
GetConfigurationVariable()	Utility
GetCurrentTime()	Time and Date
GetCurrentTimeMs()	Time and Date
GetDCIObject()	Data Collection
GetDCIRawValue()	Data Collection
GetDCIValue()	Data Collection
GetDCIValueByDescription()	Data Collection
GetDCIValueByName()	Data Collection
GetDCIValueByTag()	Data Collection
GetDCIValueByTagPattern()	Data Collection
GetDCIValues()	Data Collection
GetDCIValuesEx()	Data Collection
GetMappingTableKeys()	Utility
GetMaxDCIValue()	Data Collection
GetMinDCIValue()	Data Collection
GetMonotonicClockTime()	Time and Date
GetServerNode()	Object Navigation
GetServerNodeId()	Object Navigation
GetServerQueueNames()	Utility
GetSumDCIValue()	Data Collection
GetSyslogRuleCheckCount()	Utility
GetSyslogRuleMatchCount()	Utility
GetThreadPoolNames()	Utility
IO::CopyFile()	File I/O Package
IO::CreateDirectory()	File I/O Package
IO::DeleteFile()	File I/O Package
IO::FileAccess()	File I/O Package
IO::OpenFile()	File I/O Package
IO::RemoveDirectory()	File I/O Package
IO::RenameFile()	File I/O Package
IsMarkdownComment()	Utility
JsonParse()	Utility
LevenshteinDistance()	String Operations
LoadEvent()	Events and Alarms
map()	Utility
mapList()	Utility
Math::Abs()	Math Package
Math::Acos()	Math Package
Math::Asin()	Math Package
Math::Atan()	Math Package
Math::Atan2()	Math Package
Math::Atanh()	Math Package
Math::Average()	Math Package
Math::Ceil()	Math Package
Math::Cos()	Math Package
Math::Cosh()	Math Package
Math::Exp()	Math Package
Math::Floor()	Math Package
Math::Log()	Math Package
Math::Log10()	Math Package
Math::Max()	Math Package
Math::MeanAbsoluteDeviation()	Math Package
Math::Min()	Math Package
Math::Pow()	Math Package
Math::Pow10()	Math Package
Math::Random()	Math Package
Math::Round()	Math Package
Math::Sin()	Math Package
Math::Sinh()	Math Package
Math::Sqrt()	Math Package
Math::StandardDeviation()	Math Package
Math::Sum()	Math Package
Math::Tan()	Math Package
Math::Tanh()	Math Package
Math::Weierstrass()	Math Package
Net::GetLocalHostName()	Network Package
Net::ResolveAddress()	Network Package
Net::ResolveHostname()	Network Package
ord()	String Operations
PollerTrace()	Utility
PostEvent()	Events and Alarms
PostEventEx()	Events and Alarms
print()	Utility
println()	Utility
PushDCIData()	Data Collection
QueryAIAssistant()	Utility
range()	Utility
ReadPersistentStorage()	Utility
RegisterAITask()	Utility
SecondsToUptime()	Time and Date
SendMail()	Utility
SendNotification()	Utility
SimilarityScore()	String Operations
sleep()	Utility
time()	Time and Date
trace()	Utility
typeof()	Utility
WritePersistentStorage()	Utility
x2d()	String Operations

Deprecated Functions

These functions are deprecated and should not be used in new scripts. See Deprecated Functions for replacement recommendations.

Function	Replacement
abs()	Math::Abs()
AddrInRange()	InetAddress::inRange()
AddrInSubnet()	InetAddress::sameSubnet()
AgentExecuteCommand()	Node method
AgentExecuteCommandWithOutput()	Node method
AgentReadList()	Node::readAgentList()
AgentReadParameter()	Node::readAgentParameter()
AgentReadTable()	Node::readAgentTable()
ArrayToString()	Array::join()
Base64Decode()	Base64::Decode()
Base64Encode()	Base64::Encode()
BindObject()	NetObj::bind()
ceil()	Math::Ceil()
cos()	Math::Cos()
CreateContainer()	Container/ServiceRoot method
CreateNode()	Container/ServiceRoot method
CreateSNMPTransport()	Node method
DeleteCustomAttribute()	NetObj::deleteCustomAttribute()
DeleteObject()	NetObj::delete()
DriverReadParameter()	Node::readDriverParameter()
EnterMaintenance()	NetObj::enterMaintenance()
EventCodeFromName()	Event attribute
EventNameFromCode()	Event attribute
ExpandString()	String method
floor()	Math::Floor()
format()	FormatNumber()
GetCustomAttribute()	NetObj::getCustomAttribute()
GetEventParameter()	Event attribute
GetInterfaceName()	Interface attribute
GetInterfaceObject()	Node::getInterface()
GetNodeInterfaces()	Node attribute
GetNodeParents()	NetObj attribute
GetNodeTemplates()	Node attribute
GetObjectChildren()	NetObj attribute
GetObjectParents()	NetObj attribute
gmtime()	DateTime class
index()	String::indexOf()
inList()	Array method
Instance()	classof()
LeaveMaintenance()	NetObj::leaveMaintenance()
left()	String::left()
length()	String::length
localtime()	DateTime class
lower()	String::toLowerCase()
ltrim()	String::trimLeft()
ManageObject()	NetObj method
max()	Math::Max()
min()	Math::Min()
mktime()	DateTime class
pow()	Math::Pow()
random()	Math::Random()
RenameObject()	NetObj attribute
replace()	String::replace()
right()	String::right()
rindex()	String::lastIndexOf()
round()	Math::Round()
rtrim()	String::trimRight()
SetCustomAttribute()	NetObj method
SetEventParameter()	Event method
SetInterfaceExpectedState()	Interface method
sin()	Math::Sin()
SNMPGet()	SNMPTransport method
SNMPGetValue()	SNMPTransport method
SNMPSet()	SNMPTransport method
SNMPWalk()	SNMPTransport method
SplitString()	String::split()
sqrt()	Math::Sqrt()
strftime()	DateTime::format()
substr()	String::substring()
tan()	Math::Tan()
trim()	String::trim()
UnbindObject()	NetObj::unbind()
UnmanageObject()	NetObj method
upper()	String::toUpperCase()

Classes

Class	Domain
AccessPoint	Network Objects
Alarm	Events and Alarms
AlarmComment	Events and Alarms
Asset	Infrastructure
AssetProperties	Infrastructure
BusinessService	Infrastructure
BusinessServiceCheck	Infrastructure
ByteStream	Data Structures
Chassis	Infrastructure
Circuit	Network Objects
Class	Data Structures
ClientSession	Users and Security
Cluster	Infrastructure
Collector	Infrastructure
Component	Hardware and Software
Container	Infrastructure
DataCollectionTarget	Base Classes
DataPoint	Data Collection
DateTime	Data Structures
DCI	Data Collection
DeploymentPackage	Hardware and Software
DiscoveredInterface	Discovery and Diagnostics
DiscoveredNode	Discovery and Diagnostics
DowntimeInfo	Discovery and Diagnostics
Event	Events and Alarms
FILE	Data Structures
GeoLocation	Networking Utilities
HardwareComponent	Hardware and Software
InetAddress	Networking Utilities
Interface	Network Objects
JsonArray	Data Structures
JsonObject	Data Structures
LDAPObject	LDAP Integration
LinkDataSource	Data Collection
MacAddress	Networking Utilities
MaintenanceJournalRecord	Discovery and Diagnostics
MobileDevice	Infrastructure
NetObj	Base Classes
NetworkMap	Network Objects
NetworkMapLink	Network Objects
NetworkPathCheckResult	Discovery and Diagnostics
Node	Network Objects
NodeDependency	Discovery and Diagnostics
Object	Base Classes
OSPFArea	OSPF and Routing
OSPFNeighbor	OSPF and Routing
RadioInterface	Hardware and Software
Range	Data Structures
ScoredDciValue	Data Collection
Sensor	Infrastructure
ServiceRoot	Infrastructure
SNMPTransport	Networking Utilities
SNMPVarBind	Networking Utilities
SoftwarePackage	Hardware and Software
SSHSession	Networking Utilities
Subnet	Network Objects
Table	Data Collection
TableColumn	Data Collection
TableRow	Data Collection
Template	Infrastructure
Tunnel	Network Objects
User	Users and Security
UserDBObject	Users and Security
UserGroup	Users and Security
VLAN	Network Objects
WebService	Networking Utilities
WebServiceResponse	Networking Utilities
WirelessDomain	Network Objects
WirelessStation	Network Objects
Zone	Network Objects