Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 1.75 KB

container.adoc

File metadata and controls

79 lines (56 loc) · 1.75 KB

Container

Object represent container, 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

createContainer(name) ⇒ Container

Create new container under current container.

Table 1. Parameters

name

String

Container name

Return

Newly created container of Container class.

createCollector(name) ⇒ [class-collector]

Create new collector under current container.

Table 2. Parameters

name

String

Collector name

Return

Newly created collector of [class-collector] class.

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

Create new node under current container.

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.