Difference between revisions of "NXSL:NetObj"

Jump to navigation Jump to search
2,330 bytes added ,  18:13, 13 September 2022
m
Text replacement - "^" to "{{deprecated}}"
m (Text replacement - "^" to "{{deprecated}}")
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Represents NetXMS object (subnet, container, etc.)
{{deprecated}}Represents NetXMS object (subnet, container, etc.)




Line 12: Line 12:
|-
|-
! Name !! Type !! Description
! Name !! Type !! Description
|-
| alarms|| array ([[NXSL:Alarm|Alarm]])  || Array of object's active alarms
|-
| city|| string || Object location city string
|-
|-
| comments || string || Object's comments
| comments || string || Object's comments
|-
| country|| string || Object location country string
|-
| customAttributes|| HashMap || HashMap of object's custom attributes
|-
| geolocation || object ([[NXSL:GeoLocation|GeoLocation]]) || Object's location
|-
|-
| guid || string || Object's GUID
| guid || string || Object's GUID
Line 20: Line 30:
|-
|-
| 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
|-
|-
| status || int32 || Object status
| postcode|| string || Object location postcode string
|-
| responsibleUsers|| array ([[NXSL:UserDBObject|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)
| type || int32 || Object type (class)
|-
| [any other string] || string || Returns object's custom attribute with the name of the given string
|}
|}
'''Methods'''
{| class="wikitable"
|-
! Name !! Parameters !! Return value !! Description
|-
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the object
|-
| [[NXSL:NetObj:setComments|setComments]] || string || none || Sets object's comments
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the object
|-
| [[NXSL:NetObj:setMapImage|setMapImage]] || string || int32 || Sets map presentation image for the object
|-
| [[NXSL:NetObj:setStatusCalculation|setStatusCalculation]] || vary || none || Sets objects's status calculation method
|-
| [[NXSL:NetObj:setStatusPropagation|setStatusPropagation]] || vary || none || Sets object's status propagation method
|}
'''Possible values for "status" attribute'''
{| class="wikitable"
|-
! Status ID !! Desc
|-
| 0 || Normal
|-
| 1 || Warning
|-
| 2 || Minor
|-
| 3 || Major
|-
| 4 || Critical
|-
| 5 || Unknown
|-
| 6 || Unmanaged
|-
| 7 || Disabled
|-
| 8 || Testing
|}
'''Object types'''
{| class="wikitable"
|-
! 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
|}
[[Category:NXSL Class Reference]]

Navigation menu