Cisco Tidal Enterprise Scheduler 6.2.1 Command Line Program Guide
Total Page:16
File Type:pdf, Size:1020Kb
Cisco Tidal Enterprise Scheduler 6.2.1 SP3 Command Line Program Guide February 5, 2016 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 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 OR IMPLIED, 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. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) 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. Cisco Tidal Enterprise Scheduler 6.2.1 SP3 Command Line Program Guide © 2016 Cisco Systems, Inc. All rights reserved. CONTENTS Preface ix Audience ix Related Documentation ix Obtaining Documentation and Submitting a Service Request ix Document Change History x Introduction 1-11 Overview 1-11 Installing the Command Line Program 1-11 Windows 1-11 Linux/Unix 1-12 Activating the Command Line Program 1-12 Using Job Aliases 1-13 Scripts and Batch Files 1-13 Running the Command Line from TES 1-13 Command Modes 1-13 Single Command Mode 1-14 Multiple Command Mode 1-14 Command Line Interface 1-15 Command Line Syntax 1-15 Text Conventions 1-16 Job Status ID Cross Reference 1-16 Command Summary 1-17 Master Commands 1-18 Individual Job Occurrence Commands 1-18 Production Schedule Commands 1-19 Dependency Commands 1-19 Job and Job Group Definitions Commands 1-19 Batch Processing Command 1-20 Help Command 1-20 Command Descriptions 2-23 addrule 2-23 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide 6.2.1 iii Contents Syntax 2-24 addrule -options 2-24 Examples 2-25 agent 2-26 Syntax 2-26 agent -options 2-26 Examples 2-26 alerts 2-27 Syntax 2-27 alert[s] -options 2-27 Examples 2-27 alertset 2-28 Syntax 2-28 alertset -options 2-28 Operation 2-28 Examples 2-28 calendar 2-28 Syntax 2-29 calrecalc 2-29 Syntax 2-29 calrecalc -options 2-29 Operation 2-29 compile 2-29 Syntax 2-29 compile -options 2-30 Operation 2-30 Examples 2-30 delrule 2-30 Syntax 2-30 delrule -options 2-31 Operation 2-31 Examples 2-31 depadd 2-31 Syntax 2-31 depadd -options 2-32 Job Dependency Options 2-32 File Dependency Options 2-33 Variable Dependency Options 2-34 Examples 2-34 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide iv 6.2.1 Contents depdel 2-34 Syntax 2-34 depdel -options 2-35 Examples 2-36 file 2-37 Syntax 2-37 Operation 2-37 Example 2-37 grpupd 2-38 Syntax 2-38 grpupd -options 2-38 help 2-38 Syntax 2-38 help -options 2-38 Operation 2-38 Example 2-39 historyPurge 2-39 Syntax 2-39 historyPurge -options 2-39 Operation 2-40 Example 2-40 hosts 2-40 Syntax 2-40 hosts -options 2-40 inactrule 2-40 Syntax 2-40 inactrule -options 2-41 Examples 2-41 jobadd 2-41 Syntax 2-41 jobadd -options 2-42 Examples 2-42 jobcancel 2-42 Syntax 2-42 jobcancel -options 2-43 Operation 2-43 Examples 2-43 jobdep 2-43 Syntax 2-43 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide 6.2.1 v Contents jobdep -options 2-44 Examples 2-44 jobgo 2-44 Syntax 2-44 jobgo -options 2-44 Operation 2-44 jobhold 2-45 Syntax 2-45 jobhold -options 2-45 Operation 2-45 jobmod 2-45 Syntax 2-45 jobmod -options 2-45 jobmon 2-46 Syntax 2-47 jobmon -options 2-47 Examples 2-48 jobrelease 2-48 Syntax 2-48 jobrelease -options 2-49 Operation 2-49 Example 2-49 jobremove 2-49 Syntax 2-49 jobremove -options 2-49 Operation 2-50 Examples 2-50 jobrerun 2-50 Syntax 2-50 jobrerun -options 2-50 Operation 2-51 Example 2-51 jobset 2-51 Syntax 2-51 jobset -options 2-52 Operation 2-52 Examples 2-52 listrule 2-52 Syntax 2-52 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide vi 6.2.1 Contents listrule -options 2-53 Examples 2-54 liststat 2-54 Syntax 2-54 liststat -options 2-55 modrule 2-55 Syntax 2-55 modrule -options 2-55 Operation 2-61 Examples 2-61 output 2-62 Syntax 2-62 output -options 2-62 Operation 2-62 pause 2-62 Syntax 2-62 pause -options 2-62 qlimit 2-62 Syntax 2-62 qlimit -options 2-63 Operation 2-63 resume 2-63 Syntax 2-63 resume -options 2-63 status 2-63 Syntax 2-64 status -options 2-64 Examples 2-64 submit 2-65 Syntax 2-65 submit -options 2-65 Examples 2-65 useradd 2-65 Syntax 2-65 useradd -options 2-66 Operation 2-66 varset 2-66 Syntax 2-66 varset -options 2-66 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide 6.2.1 vii Contents Operation 2-67 Using the Master Command Line Utility 3-71 Overview 3-71 Options for the TESM Command 3-71 cm 3-72 FT 3-72 JMX 3-72 keystoremgr 3-73 loglevel 3-73 pause 3-73 resume 3-74 setpwd 3-74 superuseradd userid domainname 3-74 systemvalue 3-75 Customizing the Command Line Program 4-1 Overview 4-1 tescmd.props 4-2 table.props 4-3 Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide viii 6.2.1 Preface This guide describes how to the Command Line Program for Cisco Tidal Enterprise Scheduler (TES) 6.2. Audience This guide is for administrators who want to use the Command Line program to automate TES job control functions. Related Documentation See the Cisco Tidal Enterprise Scheduler 6.2 Documentation Overview for a list of all TES 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 Tidal Enterprise Scheduler 6.2 Command Line Program Guide 6.2.1 ix Preface Preface Document Change History The table below provides the revision history for the Command Line Program Guide. Version Number Issue Date Reason for Change 6.2 May 2014 • Updates for 6.2 release. 6.2.1 (SP3) February 2016 • Added <‐r TES variable>, a new alternative option for the varset command. This option indicates that the value for the variable is contained in another TES variable which has to be resolved first. •Minor corrections and restructuring. Cisco Tidal Enterprise Scheduler 6.2 Command Line Program Guide x 6.2.1 CHAPTER 1 Introduction Overview A hidden aspect of TES is its command line program. The sacmd.cmd (Windows) or sacmd.sh (Unix/Linux) program provides access to TES through the MS-DOS command prompt. The Unix version of TES uses a similar program called tesmcmd. The command line program is generally done from the Tidal Web client but you can also use the sacmd.cmd (Windows) or sacmd.sh (Unix/Linux) program on a master machine.