Node

All Tidal Automation (TA) Version 6.5 configurations have a Master node (also known as the Primary Master node). TA systems with licenses for Fault Tolerance will also have a Backup Master node and a Fault Monitor mode. Some TA systems may also have a Remote Master.

TA systems also allow licensing of TA Agent nodes for selected OS and platforms.

Agent types (such as MVS, OVMS, Service, Unix, and Windows) support Agent List and an associated ordering (e.g., sequential, random, load balancing) of the agents in the Agent List.

Node Type

Node is the base of TA Version 6.5 node types.

Currently supported node types include:

  • AgentNode (base class of agents)

  • BackupMasterNode

  • FaultMonitorNode

  • MasterNode

  • MPENode

  • MVSNode

  • Node

  • OS400Node

  • OVMSNode

  • RemoteMasterNode

  • ServiceNode

  • UnixNode

  • WindowsNode

  • ZOSGatewayNode

Typical Operations:

  • Check master connection status

  • Update

  • Stop scheduler

  • Resume scheduler

  • Create schedule

  • Start today's schedule

  • Pause schedule

  • Pause queues

  • Resume queues

  • Reconnect

Common operations for an Agent node include:

  • Add an agent – The operation is similar to adding a node but it associates with an agent such as Windows, UNIX, etc.

  • Enable an agent – The operation is similar to enabling a connection

  • Disable an agent – The operation is similar to disabling a connection

Common operations for an Agent List include:

  • Get all agents by agent list id

Node Examples

From the browser, issue and click Manual Commands (Post). Test the REST API examples from the Client Manager API post screen that appears. Likewise, error messages and exceptions are displayed for invalid parameters and unsuccessful execution of a request.

Get a List of Available Nodes

The Node object provides a method called getList. It has no parameters. This REST API call returns a list of nodes.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://purl.org/atom/ns#">
<id>xxx</id>
<tes:Node.getList xmlns:tes="http://www.tidalsoftware.com/client/tesservlet">
</tes:Node.getList>
</entry>

Create a Schedule in the Master

The MasterNode object provides a method called createSchedule. The parameter called id (e.g., 1) specifies the master node. Additional parameters specify whether we need forecast, and the duration (start and end dates). This REST API call creates a schedule for the specified node and period if the values are valid and an exception with appropriate error message for invalid data.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://purl.org/atom/ns#">
<id>xxx</id>
<tes:MasterNode.createSchedule xmlns:tes="http://www.tidalsoftware.com/client/tesservlet">
<tes:id>1</tes:id>
<tes:forecast></tes:forecast>
<tes:fromDate>20100828</tes:fromDate>
<tes:toDate>20100831</tes:toDate>
</tes: MasterNode.createSchedule>
</entry>

Add a Windows Agent Node and Enable It

The WindowsNode object provides a method called create. The parameter type (6 = Agent) specifies the node type to be created. The parameter ostype (1 = Windows) specifies the node type to be created. The parameter active (Y or N) indicates whether the node should be enabled or disabled. This REST API call adds a Windows agent node and enable it.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://purl.org/atom/ns#">
<tes:WindowsNode.create xmlns:tes="http://www.tidalsoftware.com/client/tesservlet">
<tes:WindowsNode>
<tes:runuserdomain>tidalsoft</tes:runuserdomain>
<tes:port>5912</tes:port>
<tes:machine>winserver.dom</tes:machine>
<tes:runuser>30</tes:runuser>
<tes:joblimit>10</tes:joblimit>
<tes:type>6</tes:type>
<tes:ostype>1</tes:ostype>
<tes:name>Win_Agent</tes:name>
<tes:active>Y</tes:active>
</tes:WindowsNode>
</tes:WindowsNode.create>
</entry>

Enable or Disable a Windows Node

The WindowsNode object provides a method called enable. The parameter active (Y or N) indicates whether the node should be enabled or disabled. This REST API call disables a Windows agent node with the id 69.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://purl.org/atom/ns#">
<id>69</id>
<title>api</title>
<WindowsNode.enable>
<id>69</id>
<active>N</active>
</WindowsNode.enable>
</entry>