Cluster

Object represents cluster. Extends DataCollectionTarget.

Instance attributes

Inherited from NetObj

alarms ⇒ array: List of active Alarms for this object.
alarmStats ⇒ array: Integer array that consists of 5 numbers - each number represents number of alarms for this and child objects for each of severity.
alias: String: Object alias. For interfaces it is automatically collected on configuration poll (e.g. from SNMP ifAlias).
asset ⇒ Asset: Reference to asset class of asset linked to this object.
assetId: int: Id of linked asset object.
assetProperties ⇒ AssetProperties: Reference to asset properties class of asset linked to this object.
backupZoneProxy: Node: Currently selected backup zone proxy (null if zoning is disabled or backup proxy is not assigned)
backupZoneProxyId: int: ID of currently selected backup zone proxy (0 if zoning is disabled or backup proxy is not assigned)
category: String: Object’s category name
categoryId: int: Object’s category ID
children ⇒ array: List of child objects. Use classof to differentiate.
city: String: Postal address - city.
comments: String: Object comments.
country: String: Postal address - country.
creationTime: int64: Object creation time as UNIX timestamp
customAttributes ⇒ HashMap: Hash map of object custom attributes.
district: String: Postal address - district.
geolocation ⇒ GeoLocation: Object geographical location.
guid: String: Object GUID as string.
id: int: Unique object identifier.
ipAddr: String: Primary IP address. Deprecated and will be removed in a future version, use ipAddress instead.
ipAddress ⇒ InetAddress: Added in version 5.1

Primary IP address.
isInMaintenanceMode: bool: Maintenance mode indicator (true if object currently is in maintenace mode).
maintenanceInitiator: int: Maintenance initiator user id
mapImage: String: GUID of object image used for representation on the maps.
name: String: Object name.
nameOnMap: String: Object name displayed on map.
parents ⇒ array: List of direct parents for this object (most likely either Container or Cluster).
postcode: String: Postal address - postal code.
primaryZoneProxy: Node: currently selected primary zone proxy (null if zoning is disabled or primary proxy is not assigned)
primaryZoneProxyId: int: ID of currently selected primary zone proxy (0 if zoning is disabled or primary proxy is not assigned)
region: String: Postal address - region.
responsibleUsers: Array: Array with user objects that are added as responsible users for this object. Objects are User or UserGroup
state: int: Current object state. One of: Node State, Cluster State, Sensor State
status: int: Current object status.
streetAddress: String: Postal address - street.
type: int: Object type.

Inherited from DataCollectionTarget

templates: Array: Returns array of templates (Template) applied on this object. Return value also affected by trusted nodes settings.

nodes: Array: Will return all nodes of class Node, that are under this cluster

zone ⇒ Zone: Will return zone this cluster is under

zoneUIN: int: Will return zone UIN this cluster is under

Instance methods

Inherited methods from NetObj

bind(childObject): void: Bind childObject to the current object as a child.
bindTo(parentObject): void: Bind current object to parentObject as a child.
calculateDowntime(tag, periodStart, periodEnd): Array: Calculate node downtime. Returns array of DowntimeInfo objects.
clearGeoLocation(): void: Clears GeoLocation data from the node.
createUserAgentNotification(message, startTime, endTime, showOnStartup): int: Send user agent notification. Returns message id.
delete(): void: Deletes current object.
deleteCustomAttribute(name): void: Delete custom attribute.
enterMaintenance(): void: Enable maintenance mode for the object.
expandString(string): String: Expand string by replacing macros with their values.
getCustomAttribute(name): String: Returns value of the custom attribute with the provided name.
getResponsibleUsers(tag) ⇒ array: Returns list of responsible users with specific tag.
isChild(object): bool: Returns TRUE if provided object is child of this object.
isDirectChild(object): bool: Returns TRUE if provided object is direct child of this object.
isDirectParent(object): bool: Returns TRUE if provided object is direct parent of this object.
isParent(object): bool: Returns TRUE if provided object is parent of this object.
leaveMaintenance(): void: Disable maintenance mode for the object.
manage(): void: Sets object to managed state.
readMaintenanceJournal(startTime, endTime): Array: Read maintenance entries. Returns array of MaintenanceJournalRecord objects.
rename(name): void: Rename object.
setAlias(name): void: Set object alias name.
setCategory(idOrName): void: Set object category id or name.
setComments(comment, [isMarkdown]): void: Set object comments.
setCustomAttribute(key, value, inherit=false): void: Update or create custom attribute.
setGeoLocation(newLocation): void: Sets node geographical location.
setMapImage(image): void: Sets object image for network map display.
setNameOnMap(name): void: Sets object’s name for network map display.
setStatusCalculation(type, …): void: Sets status calculation method.
setStatusPropagation(type, …): void: Sets status propagation method.
unbind(object): void: Unbind provided object from the current object.
unbindFrom(object): void: Unbind current object from the provided object.
unmanage(): void: Set object into unmanaged state.
writeMaintenanceJournal(description): void: Add entry to maintenance journal.

Inherited methods from DataCollectionTarget

applyTemplate(template): void: Apply template to node.
enableConfigurationPolling(flag): void: Enable or disable configuration polling.
enableDataCollection(flag): void: Enable or disable data collection polling.
enableStatusPolling(flag): void: Enable or disable status polling.
readInternalParameter(name): String: Reads object internal metric (metric with source "Internal").
readInternalTable(name): String: Reads object internal table metric (metric with source "Internal").
removeTemplate(template): void: Remove template from node.

add(object): void

Add node to cluster

Table 1. Parameters
object	Node	Object to be added to cluster

getResourceOwner(name) ⇒ Node

Get node which currently owns named resource.

Table 2. Parameters
name	String	Name of the resource.

Return

Node object instance which currently owns resource of null if failed.

remove(object): void

Remove node from cluster

Table 3. Parameters
object	Node	Object to be removed from cluster