NXSL:NetObj

From NetXMS Wiki
Jump to navigation Jump to search
This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

Represents NetXMS object (subnet, container, etc.)


Class Name

NetObj


Attributes

Name Type Description
alarms array (Alarm) Array of object's active alarms
city string Object location city string
comments string Object's comments
country string Object location country string
customAttributes HashMap HashMap of object's custom attributes
geolocation object (GeoLocation) Object's location
guid string Object's GUID
id uint32 Object identifier
ipAddr string Primary IP address
mapImage string GUID of map presentation image (00000000-0000-0000-0000-000000000000 for default)
name string Object name
postcode string Object location postcode string
responsibleUsers array (UserDBObject) Array of object's responsible users
status int32 Object status (see possible values in table below)
streetAddress string Object location street address string
type int32 Object type (class)
[any other string] string Returns object's custom attribute with the name of the given string

Methods

Name Parameters Return value Description
clearGeoLocation none none Clears GeoLocation data from the object
setComments string none Sets object's comments
setGeoLocation Object of GeoLocation class none Sets GeoLocation data for the object
setMapImage string int32 Sets map presentation image for the object
setStatusCalculation vary none Sets objects's status calculation method
setStatusPropagation vary none Sets object's status propagation method

Possible values for "status" attribute

Status ID Desc
0 Normal
1 Warning
2 Minor
3 Major
4 Critical
5 Unknown
6 Unmanaged
7 Disabled
8 Testing

Object types

Object type Desc
0 Generic
1 Subnet
2 Node
3 Interface
4 Network
5 Container
6 Zone
7 Serviceroot
8 Template
9 Templategroup
10 Templateroot
11 Networkservice
12 Vpnconnector
13 Condition
14 Cluster