Versions Compared

Old Version 24

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel1

...

Universal Controller supports the following RESTful-based web services for Agent Cluster operations, which are listed alphabetically on this page.

  • Create an Agent Cluster
  • Delete an Agent Cluster
  • List Agent Clusters
  • Modify an Agent Cluster
  • Read an Agent Cluster
  • Resolve an Agent Cluster
  • Resume an Agent Cluster
  • Resume an Agent Cluster Membership
  • Return an Agent from an Agent Cluster
  • Set an Agent Cluster Task Execution Limit
  • Suspend an Agent Cluster
  • Suspend an Agent Cluster Membership

Formatting specifications for each web service, including details about property requirements, are provided.

...

Property

UI Field Name

Description

Specifications

Required

Anchor
agentLimitAmount - CAC
agentLimitAmount - CAC
agentLimitAmount

Agent Limit AmountIf agentLimitType = Limited; Limit of number of agents in this agent cluster.Default is 10.N

Anchor
agentLimitType - CAC
agentLimitType - CAC
agentLimitType

Agent LimitSpecification for whether the agent cluster has a Limited or Unlimited number of agents. 

Valid Values:

  • As String = Unlimited, As Value = 1
  • As String = Limited, As Value = 2

Default is Unlimited (1).

N

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:

  • As String = Any, As Value = 1
  • As String = Round Robin, As Value = 2
  • As String = Lowest CPU Utilization, As Value = 3
  • As String = Network Alias, As Value = 4

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:

  • As String = Unlimited, As Value = 1
  • As String = Limited, As Value = 2

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
<opswiseGroups>
  <opswiseGroup>test</opswiseGroup>
</opswiseGroups>

 
JSON

Panel
"opswiseGroups": ["test"]



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 - CAC property.

  • If retainSysIds="true" and sysId is included in the request, sysId will be persisted to the database.
  • If retainSysIds="false" and sysId is included in the request, sysId will be ignored; it will be autogenerated by the Controller.
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
Strict Business Services Membership - CAC
Strict Business Services Membership - CAC
strictBsrvcMembership

Strict Business Services Membership

Specifies whether to only allow Agent to Cluster Associations where the Business Service matches.If true, only agents with matched Member of Business Services can be added to the cluster.

Boolean; Valid values: true/false. Default is false.

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:

  • Windows
  • Linux/Unix

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

N

...