SoftTree Technologies SoftTree Technologies
Technical Support Forums
RegisterSearchFAQMemberlistUsergroupsLog in
List of Job properties via cons.sh

 
Reply to topic    SoftTree Technologies Forum Index » 24x7 Scheduler, Event Server, Automation Suite View previous topic
View next topic
List of Job properties via cons.sh
Author Message
Redemann



Joined: 11 Jul 2007
Posts: 90
Country: Germany

Post List of Job properties via cons.sh Reply with quote
Hello,

I would like to have a list of the internal job properties names. For example when I'm using cons.sh it is very simple to get a list of the configured jobs.
But how to get a complete list containing all attributes (User, Name and so on.)
When using the "describe" command I get the following output:

COMMAND> help describe
This command returns current value of specified job property.
The command takes 2 parameters: job and property.
Example: describe 65 START_DATE

But when I want to get all properties or the "Run as" I have to guess because I cannot find any keyword list. Can you help please?
Or can give give me an example on how to change the password for a "run as" job? Can this be done via shellscript? I have several jobs running as user 'root' and it would be very nice to change all jobs via script.

Thanks in advance
Mon Oct 01, 2007 8:36 am View user's profile Send private message
SysOp
Site Admin


Joined: 26 Nov 2006
Posts: 7962

Post Reply with quote
Hi,

The internal property names are described in the "JDL Properties" topic in the documentation. JDL stands for Job Definition Language. Some of the available API methods can also return complete list of properties in PROPERTY=VALUE format
Mon Oct 01, 2007 10:13 am View user's profile Send private message
SysOp
Site Admin


Joined: 26 Nov 2006
Posts: 7962

Post Reply with quote
for Run As Password you can use RUNAS_PASSWORD

Here is a slightly reformatted text from one of the help topics. This is a from a general topic describing JDL for both Windows and Multi-platform versions

ACCOUNT -- Email Account such as user ID, profile, or email address (email watch job).
The actual value may be different for different email interfaces. For MAPI interface you should use name of the MAPI profile that you use when logging to the email system. For Lotus Notes you should use name of the user (or ID) that you use when logging to the Lotus notes. For SMTP you should use your email address.
ALL_DAY_TYPE -- All Day Schedule Type, one of the following: R, L (R - recursive, repeat at specified intervals; L - fixed time list)
AGENT -- same as Host (see Host description)
ASYNC -- Asynchronous Process, one of the following: Y, N (yes, no)
BACKUP_AGENT -- Same as Backup Host (see backup Host description)
BACKUP_HOST -- Backup Remote Host (backup Remote Agent name)
COMMAND -- Program Command Line
DAY_END_TIME -- Daily End Time for " all day" jobs with limited run-time interval
DAY_LIST -- Monthly Schedule List of fixed Day Numbers, numbers must be in 1..31 range. Example: 1,3,5,7,14. This property is shared with TIME_LIST property for All Day Schedule.
DAY_NAME -- Monthly Schedule Day Name, one of the following: Monday , Tuesday , Wednesday , Thursday , Friday , Saturday , Sunday , Weekend , Weekday
DAY_NUMBER -- Monthly Schedule Day Number, a number from 1..31 range
DAY_START_TIME -- Daily Start Time for " all day" jobs with limited run-time interval
DELAY -- Allowed Job Delay Interval (minutes)
DELETE_RULE -- Delete, Move, and Rename Semaphore File Rules, one of the following: D, A, B, M, E, R, C, F, G (D - do not delete, move, rename; A - delete after job run; B - delete before job run; M - move before job run; E - move after job run; R - rename before job run; C - rename after job run; F - move and rename before job run; G - move and rename after job run)
DESCRIPTION -- Job Description
DISABLE_ON_ERROR -- Disable Job on Error, one of the following: Y, N (yes, no)
DISABLED -- Job Disabled Status, one of the following: Y, N (yes, no)
DETACHED -- Detached Job, one of the following: Y, N (yes, no)
END_DATE -- Last Job Start Date
END_TIME -- Last Job Start Date
EXIT_CODE -- Exit Code Condition ( as a string expression)
FILE -- Semaphore File Names(s) for file-watch jobs; Module Name for process-watch job
FOLDER -- Job Folder ID. This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command
FOLDER_NAME -- Job Folder Name. This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command
FRIDAY -- Execute Job On Fridays, one of the following: Y, N (yes, no)
HOST -- Remote Host (Remote Agent Name)
ID -- Job ID, This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command with Job Name parameter.
IGNORE_ERRORS -- Ignore Errors, one of the following: Y, N (yes, no)
INIT_TIMEOUT -- Initial Timeout before sending keystroke (seconds)
INTERVAL -- Repeat Interval for Job having Schedule Type T
JOB_PASSWORD -- Job Protection State and Password. Sets or removes job protection state and password. This is a write-only property. It can be changed using SET command, but it cannot be retrieved using GET command. The value in this property must be specified in the following format :
[old password][tab character][new password][tab character][protection state]If the job is not protected, the [old password] is ignored, otherwise a valid password must be specified in order to remove or change job password or protection state. If the protection exists and the new protection state is specified as an empty string the protection will be removed. The protection code must one of the following: F, E, R, an empty string (F – full protection; E – execute only; R – read only; an empty string indicates that a job is not protected).
JOB_TYPE -- Job Type, one of the following: P, D, S (program, database, script)
KEYSTROKE -- Keystroke
LOG -- Log Job Execution, one of the following: Y, N (yes, no)
MESSAGE -- Email Message Text (email watch job)
MODIFY_TERMINAL -- Network name of the computer from which the job was last modified. This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command
MODIFY_TIME -- Date and time when the job was modified. This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command
MODIFY_USER -- Name of the user who last modified the job. This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command
MONDAY -- Execute Job On Mondays, one of the following: Y, N (yes, no)
MONTHLY_TYPE -- Monthly Schedule Type, one of the following: D, T, L (D - by day number; T - by day name; L – fixed day list )
MOVE_DIR -- Name of the destination directory for semaphore file move and rename operations.
MSG_ACCOUNT -- Email Account for Notification Action of Email Type Email (user ID, profile, or email address).
The actual value may be different for different email interfaces. For MAPI interface you should use name of the MAPI profile that you use when logging to the email system. For Lotus Notes you should use name of the user (or ID) that you use when logging to the Lotus notes. For SMTP you should use your email address.
MSG_ACTIONS -- Map of Notification Actions and Events in text format. The map is represented as a comma-separated list of 2-character values where in every list item the first character represents Notification Event Type and the second character represents Notification Action Type. The following characters can be used for the event type: S – job start, F – job finish, E – job error, N – job file not found, L – job is late. The following characters can be used for the action type: E – send email, P – send page, N – send network popup message, D – execute database commands, F – create semaphore files, T – send SNMP trap, J – run job, R – run program, S – run script.
Example map: SE,FE,EE,FDThis example map represents the following Notification Events and Events:
1. Send notification email on job start.
2. Send notification email on job finish.
3. Send notification email on job error.
4. Execute database commands on job finish.
MSG_DATABASE -- Execute Notification Action of Database Type, one of the following: Y, N (yes, no)
MSG_EMAIL -- Execute Notification Action of Email Type, one of the following: Y, N (yes, no)
MSG_ERROR -- Execute Notification Action on Job Execution Error, one of the following: Y, N (yes, no)
MSG_FILE -- Execute Notification Action of Semaphore File Type, one of the following: Y, N (yes, no)
MSG_FILE_NAME -- File Name( s) for Notification Action of Semaphore File Type
MSG_FINISH -- Execute Notification Action on Job Finish, one of the following: Y, N (yes, no)
MSG_JOB -- Execute Notification Action of Run Job Type, one of the following: Y, N (yes, no)
MSG_JOB_ID -- Job name or job id for Notification Action of Run Job Type
MSG_LATE -- Execute Notification Action on Job Late Start, one of the following: Y, N (yes, no)
MSG_NET -- Execute Notification Action of Network Message Type, one of the following: Y, N (yes, no)
MSG_NET_RECIPIENT -- Message Recipient for Notification Action of Network Message Type
MSG_NOTFOUND -- Execute Notification Action on Job Executable Not Found Error, one of the following: Y, N (yes, no)
MSG_PAGE -- Execute Notification Action of Page Type, one of the following: Y, N (yes, no)
MSG_PAGER -- Page Recipient's Pager Number
MSG_PASSWORD -- Email Password for Notification Action of Email Type
MSG_PROFILE -- Database Profile for Notification Action of Database Type
MSG_PROGRAM -- Execute Notification Action of Run Program Type, one of the following: Y, N (yes, no)
MSG_PROGRAM_NAME -- Program name for Notification Action of Run Program Type
MSG_PROGRAM_TIMEOUT -- Process Timeout (seconds) for Notification Action of Run Program Type
MSG_RECIPIENT -- Email Recipient for Notification Action of Email Type
MSG_SCRIPT -- Execute Notification Action of Script Type, one of the following: Y, N (yes, no)
MSG_SCRIPT_CODE -- Script for Notification Action of Script Type
MSG_SCRIPT_TYPE -- Type of Script for Notification Action of Script Type, one of the following: JAL, VBS (Job Automation Language, Visual Basic Script)
MSG_SQL -- SQL Command( s) for Notification Action of Database Type
MSG_START -- Execute Notification Action on Job Start, one of the following: Y, N (yes, no)
MSG_TRAP -- Execute Notification Action of Send SNMP Trap Type, one of the following: Y, N (yes, no)
NAME -- Job Name
NUMBER_OF_RETRIES -- Maximum Number of Retries Before Job Gets Marked as Failed (number)
PASSWORD -- Email Password (email watch job)
POLLING_INTERVAL -- Polling Interval (minutes)
PRIORITY -- Job Priority, one of the following: -1 – low, 0 – normal, 1 – high
PROFILE -- Database Profile
PROTECTION -- Job Protection State, one of the following: F, E, R, an empty string (F – full protection; E – execute only; R – read only; an empty string indicates that a job is not protected). This is a read-only property. It cannot be changed using SET command. It can be retrieved using GET command.
QUEUE -- Job Queue
REBOOT -- Reboot Computer After Job Finished, one of the following: Y, N (yes, no)
RENAME_SUFFIX -- The name suffix used in semaphore file names for rename operations.
RETRY_INTERVAL -- Retry Interval (seconds)
RETRY_ON_ERROR -- Retry Job After an Error Occurred, one of the following: Y, N (yes, no)
RUNAS_DOMAIN -- Domain Name for authentication of jobs to be run using another user account.
RUNAS_PASSWORD -- Password for authentication of jobs to be run using another user account.
RUNAS_USER -- User Name for authentication of jobs to be run using another user account.
SATURDAY -- Execute Job On Saturdays, one of the following: Y, N (yes, no)
SAVE_ATTACHMENT -- Save Email Attachments (email watch job), one of the following: Y, N (yes, no)
SCHEDULE_TYPE -- Schedule Type, one of the following: O, D, T, M, F, P, A, E, I, L, S, B, X
Time triggers: O – run once, D – repeat daily, T – repeat at specified time interval, M – repeat monthly; File trigger: F – check semaphore files;
Process triggers: P – check process presence, A – check process absence;
Email triggers: E - check email message;
User and system triggers: I – wake up on "user idle" event, L- wake up on log off event, S – wake up on shutdown event, B – start on 24x7 Scheduler startup
Other: X – no trigger/schedule assigned.
SCRIPT -- Job Script
SCRIPT_TYPE -- Job Script Type, one of the following: JAL, VBS (Job Automation Language, Visual Basic Script)
SEND_KEYSTROKE -- Send Keystroke, one of the following: Y, N (yes, no)
SIZE_CHECK_INTERVAL -- File Size Stability Check Interval (used in File-watch jobs)
SKIP -- Skip Late Job, one of the following: Y, N (yes, no)
SKIP_HOLIDAY -- Skip Job on Holiday, one of the following: Y, N (yes, no)
SLIDE_HOLIDAY -- Slide Job Execution Time on the next non-holiday if it falls on holiday, one of the following: Y, N (yes, no)
SQL -- SQL Command(s)
START_DATE -- First Start Date
START_IN -- Program Start-up Directory
START_TIME -- First Start Time
SUBJECT -- Email Message Subject for (email watch job)
SUNDAY -- Execute Job On Sundays, one of the following: Y, N (yes, no)
THURSDAY -- Execute Job On Thursdays, one of the following: Y, N (yes, no)
TIME_LIST -- All Day Schedule List of fixed Times, values must be in valid 24-hour time format. Example: 11:10,12:10,17:10,18:10. This property is shared with DAY_LIST property for Monthly Schedule.
TIMEOUT -- Process Timeout (seconds)
TUESDAY -- Execute Job On Tuesdays, one of the following: Y, N (yes, no)
WEDNESDAY -- Execute Job On Tuesdays, one of the following: Y, N (yes, no)
WINDOW -- Window Style, one of the following: N, M, I, H (normal, maximized, iconic, hidden)
Mon Oct 01, 2007 10:18 am View user's profile Send private message
Redemann



Joined: 11 Jul 2007
Posts: 90
Country: Germany

Post Reply with quote
Excellent! Don't know how I could miss the topic in the documentation. That's what I've been looking for.

Thanks a lot!
Mon Oct 01, 2007 10:25 am View user's profile Send private message
Display posts from previous:    
Reply to topic    SoftTree Technologies Forum Index » 24x7 Scheduler, Event Server, Automation Suite All times are GMT - 4 Hours
Page 1 of 1

 
Jump to: 
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


 

 

Powered by phpBB © 2001, 2005 phpBB Group
Design by Freestyle XL / Flowers Online.