Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide
- Updated:
- June 9, 2014
Chapter: Node
Overview
All TES 6.2 configurations have a Master node (also known as the Primary Master node). TES systems with licenses for Fault Tolerance will also have a Backup Master node and a Fault Monitor mode. Some TES systems may also have a Remote Master.
TES systems also allow licensing of TES 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.
Typical Operations
The Master Node supports the following:
- Check master connection status
- Update
- Stop scheduler
- Resume scheduler
- Create schedule
- Start today's schedule
- Pause schedule
- Pause queues
- Resume queues
- Reconnect
REST API Examples
From the browser, issue and then click Manual Commands (Post) to take you to the API post screen of the Client Manager. You can test the REST API examples from that screen. For valid parameters and successful execution of a request, you will get a response/result. For invalid parameters and unsuccessful execution of a request, you will get error messages and/or exceptions.
Example NODE–1: Get a list of available nodes
The Node object provides a method called getList. It has no parameters. The following REST API call will return a list of nodes.
Example NODE–2: Create schedule in 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). The following REST API call will create a schedule for the specified node and period if the values are valid and an exception with appropriate error message for invalid data.
Example NODE–3: Add an agent node and enable it
The Node object provides a method called create . The parameter type (e.g. 6 = Agent) specifies the node type to be created. The parameter ostype (e.g. 1 = Windows) specifies the node type to be created. The parameter active (e.g. Y or N) indicates whether the node should be enabled or disabled. The following REST API call will add a Windows agent node and enable it.
Feedback