Class: Agent

Agent

The Agent class.

Constructor

new Agent()

See:

Extends

Members

agentPort :Integer

The port used to connect to this agent.

Type:
  • Integer
Default Value:
  • 10001

(readonly) cpuCores :Integer

Detected amount of CPU cores.

Type:
  • Integer

(readonly) hostName :String

Detected agent host name.

Type:
  • String

(readonly) id :Integer

The ID of this object.

Type:
  • Integer
Inherited From:

(readonly) isVirtualServer :Integer

1 if this agent represents a cluster resource, 0 otherwise.

Type:
  • Integer

name :String

The name of this object.

Type:
  • String
Inherited From:

networkAddress :String

The name or address of this agent.

Type:
  • String

(readonly) networkAddresses :Array.<string>

List of cluster network addresses.

Type:
  • Array.<string>

(readonly) networkNames :Array.<string>

List of cluster network names.

Type:
  • Array.<string>

(readonly) osName :String

Detected operating system.

Type:
  • String

(readonly) physicalNetworkAddresses :Array.<string>

List of MAC addresses of this agent.

Type:
  • Array.<string>

properties :Object.<string, string>

A place to store arbitrary string properties. In some cases objects store their configuration inside this hash/dictionary. If you store custom properties make sure you prefix them with your moduleId.

Type:
  • Object.<string, string>
Inherited From:
See:
  • upgrade_module

(readonly) protocols :Array.<string>

List of protocols supported by this agent.

Type:
  • Array.<string>
See:

proxyAgent :Integer

The ID of the proxy agent to use, or 0.

Type:
  • Integer
Default Value:
  • 0
See:

reference :String

The reference of this object. May only contain the characters A-Za-z0-9_.+: -.

Type:
  • String
Inherited From:
Default Value:
  • ""

(readonly) resources :Array.<string>

List of cluster resources.

Type:
  • Array.<string>

serverId :Integer

Cluster Server allowed to use this agent.

Type:
  • Integer
Default Value:
  • 0
See:

status :ElementStatus

The object status.

Type:
Inherited From:
Default Value:
  • ElementStatus.Active

vmServerType :VmServerType

Type of VM Server this agent represents.

Type: