collector.adoc

Collector

Object represent collector, extends [class-netobj].

Instance attributes

autoBindScript ⇒ String

Source of the script for automatic binding.

isAutoBindEnabled ⇒ Boolean

Indicate if automatic binding is enabled.

isAutoUnbindEnabled ⇒ Boolean

Indicate if automatic unbinding is enabled.

Instance methods

createCollector(name) ⇒ Collector

Create new collector under current collector.

Table 1. Parameters

name

String

Collector name

Return

Newly created collector of Collector class.

createContainer(name) ⇒ [class-container]

Create new container under current collector.

Table 2. Parameters

name

String

Container name

Return

Newly created container of [class-container] class.

createNode(name, ipAddress, zoneUIN) ⇒ [class-node]

Create new node under current collector.

Table 3. Parameters

name	String	Node name if second options is set or primary host name or IP address.
ipAddress	String	Optional. Primary host name or IP address.
zoneUIN	Integer	Optional. New node’s zone.

Return

Newly created node of [class-node] class or NULL if failed to create

setAutoBindMode(enableBind, enableUnbind) ⇒ void

Set automatic bind mode for the container.

Table 4. Parameters

enableBind	Boolean	Script should be used for automatic binding.
enableUnbind	Boolean	Script should be used for automatic unbinding.

setAutoBindScript(script) ⇒ void

Update automatic binding script source.

Table 5. Parameters

script

String

Script source.