Versions Compared

Old Version 11

changes.mady.by.user Former user

Saved on

compared with

New Version 12

changes.mady.by.user IT Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

name

Property

UI Field Name

Description

Specifications

Required

Anchor
currentCount - CAC
currentCount - CAC
currentCount

Current Task Count

If limitType is Limited (2); Current number of tasks currently being run by the Agents in this agent cluster.

Integer; Read only.

N

Anchor
description - CAC
description - CAC
description

Description

User-defined; description of this record.


N

Anchor
distribution - CAC
distribution - CAC
distribution

Distribution

Method used to select an Agent in the Agent Cluster.

Valid Values:

Html bobswift
<ul>
<li> As String = Any, As Value = 1
<li> As String = Round Robin, As Value = 2
<li> As String = Lowest CPU Utilization, As Value = 3
<li> As String = Network Alias, As Value = 4
</ul>

Default is Any (1).

N

Anchor
exportReleaseLevel - CAC
exportReleaseLevel - CAC
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - CAC
exportTable - CAC
exportTable

n/aRecord table information.read onlyN

Anchor
ignoreInactiveAgents - CAC
ignoreInactiveAgents - CAC
ignoreInactiveAgents

Ignore Inactive Agents

Specification for whether or not inactive (offline) Agents should be ignored when the agent cluster is used for broadcasting.

Optional; Valid values: true/false (default is false).

N

Anchor
ignoreSuspendedAgents - CAC
ignoreSuspendedAgents - CAC
ignoreSuspendedAgents

Ignore Suspended Agents

Specification for whether or not suspended Agents should be ignored when the agent cluster is used for broadcasting.

Optional; Valid values: true/false (default is false).

N

Anchor
lastAgentUsed - CAC
lastAgentUsed - CAC
lastAgentUsed

Last Agent Used

Agent that was selected the last time a task was sent to this Agent Cluster.

Read only.

N

Anchor
lastResolution - CAC
lastResolution - CAC
lastResolution

Last Resolution

If distribution is Network Alias (4); Last attempted time of Network Alias resolution.

Read only.

N

Anchor
limitAmount - CAC
limitAmount - CAC
limitAmount

Limit Amount

If limitType is Limited (2); Number of tasks that can be running at the same time by the Agents in this agent cluster.


N

Anchor
limitType - CAC
limitType - CAC
limitType

Task Execution Limit

Specification for whether a Limited or Unlimited number of task instances can be run concurrently by the Agents in this Agent Cluster.

Valid Values:

Default is Unlimited (1).

N

Anchor
name - CACname - CAC
Html bobswift
<ul>
<li> As String = Unlimited, As Value = 1
<li> As String = Limited, As Value = 2
</ul>

Default is Unlimited (1).

N

Anchor
name - CAC
name - CAC
name

Cluster Name

Name of this Agent Cluster.


Y

Anchor
networkAlias - CAC
networkAlias - CAC
networkAlias

Network Alias

If distribution is Network Alias (4); Network alias (or VIP).


N

Anchor
networkAliasPort - CAC
networkAliasPort - CAC
networkAliasPort

Agent Port

If distribution is Network Alias (4); Network alias (or VIP) port that the Agent's Universal Broker is listening on.


N

Anchor
opswiseGroups - CAC
opswiseGroups - CAC
opswiseGroups

Member of Business Services

List of Business Services that this Agent Cluster belongs to.
 
Format:
 
XML

Panel
Html bobswift
<pre>
&lt;opswiseGroups&gt;
  &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt;
&lt;/opswiseGroups&gt;
</pre>

 
JSON

AnchorresolutionDescription - CACresolutionDescription
Panel

N

Html bobswift
<pre>
"opswiseGroups": ["test"]
</pre>


N

Anchor
resolutionDescription - CAC
resolutionDescription - CAC
resolutionDescription

Resolution Description

If distribution is Network Alias (4); Description of the last attempted resolution.

Read only.

N

Anchor
resolutionStatus - CAC
resolutionStatus - CAC
resolutionStatus

Resolution Status

If distribution is Network Alias (4); Status of the last resolution of the Network Alias.

Read only.

N

Anchor
resumedOn - CAC
resumedOn - CAC
resumedOn

Resumed On

Date and time when a suspended Agent Cluster was resumed.

Read only.

N

Anchor
retainSysIds - CAC
retainSysIds - CAC
retainSysIds

n/a

Specification for whether or not the Create an Agent Cluster web service will persist the sysId property.

Note
titleNote

In XML web services, retainSysIds is specified as an attribute in the <agentCluster> element.

Optional; Valid values: true/false (default is true


Html bobswift
<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and  <code>sysId</code> is included in the request, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. 
</ul>
Note
titleNote

In XML web services, retainSysIds is specified as an attribute in the <agentCluster> element.

Optional; Valid values: true/false (default is true).

N

Anchor
suspended - CAC
suspended - CAC
suspended

Suspended

Indication of whether or not the ability for this cluster of Agents to run tasks has been suspended.

Read only; Boolean; Valid Values: true/false.

N

Anchor
suspendedOn - CAC
suspendedOn - CAC
suspendedOn

Suspended On

Date and time when the Agent Cluster was suspended.

Read only.

N

Anchor
sysId - CAC
sysId - CAC
sysId

n/a

sys_id used within the Controller to identify this Agent Cluster.


N

Anchor
type - CAC
type - CAC
type

n/a

Type of Agent Cluster.

For List Agent Clusters: Read only; Valid values:

Html bobswift
<ul>
<li> Windows
<li> Linux/Unix
</ul>

For Create/Modify/Read Agent Clusters: Applicable to JSON only; Specifies agent cluster type to create/modify. Valid values: windowsAgentCluster and unixAgentCluster

N

...

subject

Property

UI Field Name

Description

Specifications

Anchor
bcc - email
bcc - email
bcc

Bcc

Email address of the party being sent a blind (hidden) copy of the email, if any.

Use commas to separate multiple recipients. Variables and Functions are supported.

Anchor
body - email
body - email
body

Body

Text of the email message.

Variables and Functions are supported. If the emailTemplate contains text in the body, this text is appended.

Anchor
cc - email
cc - email
cc

Cc

Email address of the party being sent a copy of the email, if any.

Use commas to separate multiple recipients. Variables and Functions are supported.

Anchor
emailConnection - email
emailConnection - email
emailConnection

Email Connection

Name of an Email Connection.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Anchor
emailTemplate - email
emailTemplate - email
emailTemplate

Email Template

Name of an Email Template.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Anchor
replyTo - email
replyTo - email
replyTo

Reply-To

Email address of the sender of the email.

Use commas to separate multiple recipients. Variables and Functions are supported.

Anchor
state - email
state - email
state

Notification State

Comma-separated list of Notification states

Subject

Valid values:

Anchor
html-
emailsubject - emailsubject

Subject

bobswift
<ul>
<li> As String = Agents Unavailable, As Value = 1
<li> As String = Agent Available, As Value = 2
<li> As String = Suspended, As Value = 4
<li> As String = Resumed, As Value = 8
</ul>

Anchor
subject - email
subject - email
subject

Subject

Subject line of the email.

Variables and Functions are supported.

Anchor
sysid - email
sysid - email
sysId

n/a

sys_id used within the Controller to identify this Email Notification.


Anchor
to - email
to - email
to

To

Email address of the recipient.

Use commas to separate multiple recipients Variables and Functions are supported.

...

snmpManagerstate

Property

UI Field Name

Description

Specifications

Anchor
severity - snmp
severity - snmp
severity

Notification Severity

Severity level of this notification.

Valid values:

Default is Normal (1).

Anchor
snmpManager - snmpsnmpManager - snmp

SNMP Manager

SNMP Manager that will receive this notification.

Anchor
state - snmpstate - snmp

Notification State

Comma-separated list of Notification states

Valid values:

Anchor
Html bobswift
<ul>
<li> As String = Normal, As Value = 1
<li> As String = Warning, As Value = 2
<li> As String = Minor, As Value = 3
<li> As String = Major, As Value = 4
<li> As String = Critical, As Value = 5
</ul>

Default is Normal (1).

Anchor
snmpManager - snmp
snmpManager - snmp
snmpManager

SNMP Manager

SNMP Manager that will receive this notification.


Anchor
state - snmp
state - snmp
state

Notification State

Comma-separated list of Notification states

Valid values:

Html bobswift
<ul>
<li> As String = Agents Unavailable, As Value = 1
<li> As String = Agent Available, As Value = 2
<li> As String = Suspended, As Value = 4
<li> As String = Resumed, As Value = 8
</ul>

Anchor
sysId - snmp
sysId - snmp
sysId

n/a

sys_id used within the Controller to identify this SNMP Notification.


...

Property

UI Field Name

Description

Specifications

Required

Anchor
agentClusterName - TEL
agentClusterName - TEL
agentClusterName

Cluster Name

Name used within the Controller to identify this agent cluster.


Y

Anchor
limitAmount - TEL
limitAmount - TEL
limitAmount

Limit Amount

Number of tasks that can be running at the same time by the Agents in this agent cluster.

Set only if limitType is Limited (2).

N

Anchor
limitType - TEL
limitType - TEL
limitType

Task Execution Limit

Specification for whether a Limited or Unlimited number of task instances can be run concurrently by the Agents in this agent cluster.
 
For purposes of imposing this task execution limit, running task instances are those in any of these statuses: Cancel Pending, Queued, Received, Running, Submitted, and Started.

Valid values:


Html bobswift
<ul>
<li> As String = Unlimited, As Value = 1
<li> As String = Limited, As Value = 2</ul>

Y

Anchor
Suspend an Agent Cluster
Suspend an Agent Cluster
Suspend an Agent Cluster

...