Cisco Workload Automation REST API Reference Guide

190 Pages·2016·9.41 MB·English

Cisco Workload Automation
REST API Reference Guide
Version 6.3
First Published: August, 2015
Last Updated: September 23, 2016
Cisco Systems, Inc. www.cisco.com
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE
WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE
ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL
RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE
INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU
ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR
A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California,
Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981,
Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE
PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED
ORIMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL
DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR
INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and
phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the
document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is
unintentional and coincidental.
All printed copies and duplicate soft copies are considered un-Controlled copies and the original on-line version should be
referred to for latest version.
Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at
www.cisco.com/go/offices.
© 2016 Cisco Systems, Inc. All rights reserved.
2
Contents
Contents 3
Preface 7
Audience 7
Related Documentation 7
Obtaining Documentation and Submitting a Service Request 7
Document Change History 8
Introducing the CWA REST API 9
Overview 9
REST API Objects 9
REST API Call Template 10
Using the CWA REST API 11
Overview 11
REST API from a Browser 11
REST API Security Notes 12
Java Client REST API Examples 12
Code Example 1 – GET Request 12
Code Example 2 – POST Request 13
Code Example 3 – Session Management Using the Session Cookie 14
Code Example 4 – Execute a Query with Conditions 15
CWA APIs in the WebService Adapter 16
CWA APIs in the SOAP UI Tool 16
Accessing Documentation for REST API Objects and Methods 17
Calendar 19
Overview 19
Calendar Type 19
Typical Operations 19
Specifying Calendar Days 20
Calendar Examples 21
Calendar Example 1 – Get a List of Available Calendars 21
Calendar Example 2 – Get a Specific Calendar 21
Calendar Example 3 – Compile a Single Calendar 21
Calendar Example 4 – Compile All Calendars 22
Calendar Example 5 – Create a List Calendar 22
Calendar Example 6 – Create a Group Calendar 23
Calendar Example 7 – Create a Daily Calendar with Details and a Condition 24
Calendar Example 8 – Delete a Detail in a Calendar 24
Calendar Example 9 – Delete a Condition in a Calendar 25
Calendar Example 10 – Add Details and Conditions in a Group Calendar 25
Calendar Example 11 – Delete Calendar Days in a List Calendar 26
Calendar Example 12 – Add Calendar Days to a List Calendar 27
Cisco Systems, Inc. www.cisco.com
3
Contents
Calendar Example 13 – Delete a Condition in a Daily Calendar 28
Calendar Example 14 – Add a Condition to a Daily Calendar 28
Calendar Example 15 – Delete a Calendar 29
Job 31
Overview 31
Job Type 31
Job Instance 32
Typical Operations 32
Job Examples 32
Job Example 1 – Get a List of Available Job Definitions 32
Job Example 2 – Get a Specific Job Definition 32
Job Example 3 – Create a Simple Job 33
Job Example 4 – Create a Job with Many Parameters 33
Job Example 5 – Insert a Job into the Schedule 34
Job Example 6 – Update a JobGroup with a Variable Update 34
Job Example 7 – Update an SAP ServiceJob 35
JobRun 37
Overview 37
JobRun Type 37
Typical Operations 37
JobRun Examples 38
JobRun Example 1 – Override a JobRun Instance 38
JobRun Example 2 – Override a JobDependency Instance of a JobRun 38
JobRun Example 3 – Cancel a JobRun 38
JobRun Example 4 – Set the Status of a JobRun 38
JobRun Example 5 – Hold a JobRun 39
JobRun Example 6 – Release a JobRun 39
JobRun Example 7 – Rerun a JobRun 39
Node 41
Overview 41
Node Type 41
Typical Operations 42
Node Examples 42
Node Example 1 – Get a List of Available Nodes 42
Node Example 2 – Create a Schedule in the Master 43
Node Example 3 – Add an Agent Node and Enable It 43
Node Example 4 – Enable or Disable a Windows Node 43
Action 45
Overview 45
Action Type 45
Typical Operations 45
Action Examples 46
Action Example 1 – Get a List of Available Actions 46
Action Example 2 – Set the Value of a Variable 46
Action Example 3 – Update a Variable 46
Action Example 4 – Create a Value Variable 47
Action Example 5 – Update the Value of a Variable 47
Action Example 6 – Create a Web Service Action 48
4
Contents
Action Example 7 – Create a Web Service Action with Parameters 48
Queues 49
Overview 49
Typical Operations 49
Queue Examples 49
Queue Example 1 – Enable a Queue 49
Appendix A—REST API Object Descriptions 51
Actions 51
AdapterLicense 51
AgentLicense 52
AgentList 52
AgentListJoin 53
AgentNode 53
AlarmptAction 53
Alert 54
AlertAction 54
BackupMasterNode 55
BusinessUnit 56
BusinessView 57
Calendar 57
CalendarChild 58
CalendarCondition 59
CalendarPrint 59
CalendarYear 60
CalendarYear2 60
DataMoverJob 61
DataMoverJobRun 64
DependencyUnion 68
EmailAction 69
EventActionJoin 69
EventActionRun 70
EventCalendarJoin 71
EventJobClassJoin 71
EventJobJoin 72
Events 72
EventsFile 73
EventsJob 74
EventsService 75
EventsSystem 76
EventsVariable 77
FaultMonitorNode 78
FileDependency 79
FiscalCalendar 79
FolderConfiguration 80
FTPJob 80
FTPJobRun 83
ImageRepository 87
ImageRepositoryLink 87
5
Contents
InfoNodeJoin 88
InterMasterVariable 88
ITOAction 88
JESDependency 89
Job 89
JobAction 92
JobClass 93
JobDependency 93
JobGroup 94
JobOutput 96
JobPrint 96
JobReport 99
JobRun 99
JobRunDep 102
JobRunGroup 104
JobRunResource 107
JobRunStatistics 107
JobRunStatus 108
JobRunSystemResourceDetails 108
LogAction 108
MasterJavaTimeZone 109
MasterLicense 109
MasterNode 110
MasterVariables 111
MessageCatalog 111
MessageLog 111
MPEJob 112
MPEJobRun 114
MPENode 118
MVSAgentList 119
MVSNode 119
Node 120
NodeOutage 122
NodeResourceValue 122
NullContent 123
OS400Job 123
OS400Node 126
OSJob 127
OSJobRun 130
OVMSAgentList 133
OVMSBatch 133
OVMSBatchJobRun 136
OVMSCommand 139
OVMSCommandJobRun 141
OVMSJob 145
OVMSJobRun 147
OVMSNode 150
OwnerAgent 151
Owners 152
Queue 152
6
Contents
QueuedJobRun 153
QueueFilter 154
RemoteMasterNode 155
Resource 156
ResourceJobJoin 157
ResourceJobJoin2 158
ResourceJobLocks 158
ResourceLock 159
ResourceNodeJoin 159
Schedules 159
SecurityPolicy 160
SecurityServiceJoin 162
Service 163
ServiceAction 164
ServiceAgentList 164
ServiceDist 165
ServiceJob 165
ServiceJobRun 168
ServiceNode 171
SNMPAction 172
Statistics 173
StatisticsTotal 173
SystemActivityMessage 174
SystemResource 174
SystemValue 175
UnixAgentList 175
UnixNode 176
UserJoin 177
UserMessage 178
UserSecurityPolicySet 178
UserSecurityServiceSet 179
Users 179
UserService 180
UserSession 180
Variable 181
VariableAction 182
VariableDependency 182
VirtualResource 183
WindowsAgentList 183
WindowsNode 183
WorkGroup 185
WorkGroupRunUser 185
WorkGroupUserJoin 186
ZOSGatewayNode 186
7
Contents
8
Preface
This guide describes how to generate and use the Cisco Workload Automation (CWA) 6.3 REST API.
Audience
This guide is for engineers who want to integrate their applications or systems with Cisco Workload Automation for
Workload Management activities.
Related Documentation
See the Cisco Workload Automation 6.3 Documentation Overview for a list of all Cisco Workload Automation guides.
Note: We sometimes update the documentation after original publication. Therefore, you should also review the
documentation on Cisco.com for any updates.
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see
What’s New in Cisco Product Documentation at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.
Subscribe to What’s New in Cisco Product Documentation, which lists all new and revised Cisco technical
documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds
are a free service.
Cisco Systems, Inc. www.cisco.com
7
Preface
Document Change History
Document Change History
The table below provides the revision history for the Cisco Workload Automation REST API Reference Guide.
Version Number Issue Date Reason for Change
6.2 May 2014 Updates for 6.2 release.
6.2.1 (SP2) May 2015 New examples for many of the REST objects.
New Appendix A documenting all REST objects.
New Appendix B for how to access REST objects and methods documentation.
General content validation and editorial improvements throughout.
6.2.1 (SP3) February 2016 Moved Appendix B Accessing Documentation for REST API Objects and
Methods, page17 to Chapter 2.
Minor edits.
6.3 July 2016 Rebranded “Cisco Tidal Enterprise Scheduler” to “Cisco Workload
Automation”.
8