Difference between revisions of "NXSL:NetObj"

From NetXMS Wiki
Jump to navigation Jump to search
(Added description to the Methods table)
Line 28: Line 28:
|-
|-
| ipAddr || string || Primary IP address
| ipAddr || string || Primary IP address
|-
| mapImage || string || GUID of map presentation image (00000000-0000-0000-0000-000000000000 for default)
|-
|-
| name || string || Object name
| name || string || Object name
Line 47: Line 49:
! Name !! Parameters !! Return value !! Description
! Name !! Parameters !! Return value !! Description
|-
|-
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the node
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the object
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the object
|-
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the node
| [[NXSL:NetObj:setMapImage|setMapImage]] || string || int32 || Sets map presentation image for the object
|}
|}



Revision as of 18:12, 2 February 2017

Represents NetXMS object (subnet, container, etc.)


Class Name

NetObj


Attributes

Name Type Description
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
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
setGeoLocation Object of GeoLocation class none Sets GeoLocation data for the object
setMapImage string int32 Sets map presentation image for the object

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