rda-python-dscheck 2.0.4__py3-none-any.whl → 2.0.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,57 +1,54 @@
1
1
 
2
2
  1 INTRODUCTION
3
3
 
4
- Program 'dscheck' is a utility to add, remove, view and process recorded commands
5
- of other utility programs in Research Data Archive Management System (GDEXMS). For
6
- delayed execution, or called batch process, of utility programs, 'dsarch', 'dsupdt'
7
- and 'dsrqst', the commands information and the directories where the commands are
8
- initiated are saved into GDEXDB as check records. For any other specialist-defined
9
- commands, they can be also put in delayed mode if the commands are added to
10
- 'dscheck' control via Action -AC (-AddCheck).
11
-
12
- The check records are processed automatically via a centralized 'dscheck' daemon,
13
- although they can be processed manually on command line. During the execution of a
14
- recorded command, the check record is locked in GDEXDB to prevent multiple executions
15
- of the same command. The check records that retain command information are
16
- automatically purged into check history when the commands are finished.
17
-
18
- When a recorded command fails due to failures of computer system, storage disk/tape,
19
- or the Database Management System, the check record is normally purged with status 'E'
20
- for error, unless check-reprocessing ability is built into the utility program, such
21
- as 'dsarch'. For a check-reprocessing command, the check record is retained in GDEXDB
22
- Until the command is processed successfully or the number of executions reaches the
23
- try limits allowed. Utility programs 'dsrqst' and 'dsupdt' carry their own failure-
24
- recovering ability and they do not need check-reprocessing.
25
-
26
- The purged check records are retained in GDEXDB. The check history can be viewed via
27
- utility program 'viewcheckusage'.
28
-
29
- Program 'dscheck' supports the following major functions:
30
- - Set daemon control records for individual specialists to configure how many
31
- concurrent processes of a specified command can be executed on a given host, and
32
- the host priorities to define the order of which host is picked for processing
33
- a check. Without the daemon control information, a recorded command will not be
34
- started automatically.
35
- - ADD a check record for delayed command execution of any specialist-defined commands
4
+ 'dscheck' is a utility for adding, removing, viewing, and processing recorded
5
+ commands of other utility programs in the Research Data Archive Management System
6
+ (GDEXMS). Utility programs 'dsarch', 'dsupdt', and 'dsrqst' support delayed
7
+ execution (also called batch processing): when a command is deferred, its
8
+ information and the directory from which it was invoked are saved to GDEXDB as
9
+ a check record. Specialist-defined commands can also be deferred by adding them
10
+ to 'dscheck' control via Action -AC (-AddCheck).
11
+
12
+ Check records are processed automatically by a centralized 'dscheck' daemon,
13
+ though they can also be processed manually from the command line. While a
14
+ recorded command is running, its check record is locked in GDEXDB to prevent
15
+ duplicate executions. Once a command finishes, its check record is automatically
16
+ moved to check history.
17
+
18
+ When a recorded command fails due to a system, storage, or database error, the
19
+ check record is normally purged with status 'E' (error). However, if the utility
20
+ program supports check-reprocessing as 'dsarch' does the record is retained
21
+ in GDEXDB until the command succeeds or the maximum retry limit is reached.
22
+ 'dsrqst' and 'dsupdt' handle their own failure recovery and do not require
23
+ check-reprocessing.
24
+
25
+ Completed check records are retained in GDEXDB as history and can be viewed via
26
+ the utility program 'viewcheckusage'.
27
+
28
+ 'dscheck' supports the following major functions:
29
+ - Set daemon control records for individual specialists to configure how many
30
+ concurrent processes of a specified command can run on a given host, and
31
+ the host priorities that determine which host is selected for processing
32
+ a check. Without daemon control information, recorded commands will not
33
+ start automatically.
34
+ - Add a check record for delayed execution of any specialist-defined command
36
35
  - View utility command information currently saved in GDEXDB
37
- - Email the current status of a specified utility command or a list of commands,
38
- and include error messages if any, to a specialist
39
- - Delete recorded command information, because the command is not needed anymore
40
- - Unlock a given recorded command in case lock information was not cleaned
41
- properly when the command was failed
42
- - Interrupt a utility command that is under execution and kill recursively all
43
- the associated child processes
44
- - Add the due 'dsrqst' and 'dsupdt' actions into dscheck records
45
- - Process commands that have been recorded into GDEXDB or the ones have failed
46
- previously.
47
-
48
- The specialist who executes a utility command under 'dscheck' control remains
49
- the exclusive owner of the check record in GDEXDB. This prevents the command to be
50
- processed or deleted accidentally by other specialists.
51
-
52
- In the following sections, general usages of 'dscheck' are described first; and
53
- detail descriptions of Action options are given; and finally Mode and Info
54
- options are explained.
36
+ - Email the current status of a specified command or list of commands,
37
+ including any error messages, to a specialist
38
+ - Delete recorded command information when a command is no longer needed
39
+ - Unlock a check record when lock information was not cleaned up properly
40
+ after a command failure
41
+ - Interrupt a running command and recursively kill all associated child
42
+ processes
43
+ - Add due 'dsrqst' and 'dsupdt' actions into dscheck records
44
+ - Process commands recorded in GDEXDB, including ones that previously failed
45
+
46
+ The specialist who submits a command under 'dscheck' control remains its
47
+ exclusive owner in GDEXDB, preventing the command from being processed or
48
+ deleted accidentally by other specialists.
49
+
50
+ The following sections describe general 'dscheck' usage first, then Action
51
+ options in detail, followed by Mode and Info options.
55
52
 
56
53
  2 GENERAL DSCHECK USAGE
57
54
 
@@ -59,51 +56,48 @@ options are explained.
59
56
  or
60
57
  dscheck [-(IF|InputFile)] InputFileNames
61
58
 
62
- Quotes [] indicate optional. A pipeline '|' in parentheses as in format (A|B)
63
- means either A or B can be used. The options applied to 'dscheck' are divided
64
- into three categories, Action, Mode, and Information (Info for short) options.
65
- Action options are used to specify what tasks this utility program to execute,
66
- Mode options are used to modify behaviors of the actions, and the Info options
67
- are used to pass information, one or multiple values, to run 'dscheck'. An option
68
- can be given in form of either short name or long name, -DS or -Dataset for
69
- example. Some options have alias names for convenience; -UnLock, for example,
70
- is an alias option name for Mode option -UL (-UnLockCheck). Option names can be
71
- given in either upper or lower cases, while the values following Info options
72
- are case sensitive.
73
-
74
- Specify one of the Action options each time to execute 'dscheck'. Based on what
75
- Action is chosen, some of the Info options are mandatory and others are optional
76
- and certain Mode options can be applied to alter the behaviors of the Action.
77
-
78
- All options, except Info option -IF (-InputFile), can be given either on command
79
- line or in input files. Input file names are presented per Info option -IF and
80
- can only be provided on command line. Referring to description of Info option -IF
81
- (-InputFile) for detail on how to present options in input files. One or multiple
82
- input files, combined with options on command line, are allowed to run 'dscheck'.
83
- The option name, -IF (-InputFile), itself can be omitted if a single input file is
84
- given on command line and all other option information are provided inside the
85
- input file.
86
-
87
- When information of daemons and checks are retrieved, Info options are used to
88
- specify conditions for querying information from GDEXDB. Some special signs can be
89
- used to further confine the information with special and complicated conditions;
90
- they are '!', '<', '>' and '<>'. These special signs, if provided on command
91
- line, must be quoted or escaped to avoid of being interpreted by Unix OS system.
92
- The '!', or \!, means exclusion to the following value(s) and it must be the
93
- first item following an Info option name, while '<' or '>' mean greater or less
94
- than the following value and '<>' means between the following two values.
95
- Combine '!' and '<', as syntax "'!' '<' OptionValue", to make a condition of
96
- 'larger than or equal to OptionValue'.
97
-
98
- Description of an individual option is displayed if 'dscheck' is issued on
99
- command line as
59
+ Brackets [] indicate optional elements. A pipe '|' within parentheses, as in
60
+ (A|B), means either A or B may be used. Options fall into three categories:
61
+ Action options - specify the task to execute
62
+ Mode options - modify how an action behaves
63
+ Info options - pass one or more values to the action
64
+
65
+ An option can be given in short or long form for example, -DS or -Dataset.
66
+ Some options have alias names for convenience; for example, -UnLock is an alias
67
+ for Mode option -UL (-UnLockCheck). Option names are case-insensitive, but
68
+ values following Info options are case-sensitive.
69
+
70
+ Specify exactly one Action option per 'dscheck' invocation. Based on the chosen
71
+ action, certain Info options are required, others are optional, and specific
72
+ Mode options may be used to alter the action's behavior.
73
+
74
+ All options except -IF (-InputFile) may be given either on the command line or
75
+ in input files. Input file names are provided via -IF and can only be specified
76
+ on the command line. See the -IF option description for details on how to format
77
+ options in input files. One or more input files may be combined with command-line
78
+ options. The option name -IF itself may be omitted when a single input file is
79
+ given on the command line and all other options are contained within that file.
80
+
81
+ When retrieving daemon or check information, Info options serve as query filters.
82
+ Four special characters can refine queries further — quote or escape them on the
83
+ command line to prevent shell interpretation:
84
+ '!' - exclude matches; must appear immediately after the option name
85
+ '<' - less-than comparison on the following value
86
+ '>' - greater-than comparison on the following value
87
+ '<>' - range between the following two values
88
+
89
+ Combining '!' and '<' as "'!' '<' OptionValue" expresses a 'greater than or
90
+ equal to OptionValue' condition.
91
+
92
+ The description of an individual option is shown when 'dscheck' is run as
100
93
 
101
94
  dscheck [Option] -(h|help) [Option]
102
95
 
103
- A description is displayed for an option given either before or after -(h|help).
104
- If no option is specified or 'dscheck' is issued by itself, this whole document
105
- is displayed per UNIX utility 'more'. A hard copy of this help document can be
106
- printed from the saved file, dscheck.usg, under python package rda_python_dscheck.
96
+ A description is shown for the option placed either before or after -(h|help).
97
+ If no option is specified, or 'dscheck' is run without arguments, the full
98
+ document is displayed via the UNIX utility 'more'. A hard copy of this document
99
+ can be printed from the saved file, dscheck.usg, under python package
100
+ rda_python_dscheck.
107
101
 
108
102
  #The online HTML version of this document is available at
109
103
  #https://gdex-docs-dscheck.readthedocs.io
@@ -111,46 +105,42 @@ printed from the saved file, dscheck.usg, under python package rda_python_dschec
111
105
 
112
106
  3 ACTION OPTIONS
113
107
 
114
- Action options are used to specify what task 'dscheck' executes. No values
115
- are allowed to follow Action options. Multiple Action options provided
116
- simultaneously are blocked.
108
+ Action options specify what task 'dscheck' executes. They take no values.
109
+ Specifying more than one Action option at a time is not allowed.
117
110
 
118
- Based on the information being manipulated, the actions are divided into three
111
+ Based on the information being manipulated, actions are divided into four
119
112
  categories:
120
- Daemon Control Actions - create, delete, modify and view daemon control information
121
- in GDEXDB, of specified specialist, command and hostname
122
- Check Actions - add, delete, unlock and view check information of the
123
- active individual checks
124
- Check Process Actions - process checks by starting commands on remote hosts as
125
- configured in daemon controls and purge checks by recording
126
- the commands and their execution information into check
127
- history; interrupt the current executing commands by killing
128
- the current process and its all children; and email status
129
- of current checks
113
+ Daemon Control Actions - create, delete, modify and view daemon control
114
+ information in GDEXDB, for specified specialists,
115
+ commands, and hostnames
116
+ Check Actions - add, delete, unlock and view check information
117
+ for active individual checks
118
+ Check Process Actions - process checks by starting commands on remote hosts
119
+ as configured in daemon controls; purge checks by
120
+ recording commands and execution results into check
121
+ history; interrupt running commands by killing the
122
+ current process and all its children; and email
123
+ check status to a specialist
130
124
  Daemon Host Connectivity - check connectivity of daemon hosts for specialists
131
125
 
132
126
  3.1 Daemon Control Actions
133
127
 
134
- A daemon control record for a command, a specialist and a hostname is used to
135
- configure how many concurrent processes the specified command can be executed
136
- for the specialist on specified hostname, and the priority the the hostname is
137
- picked to start the command. A running centralized daemon reads this record
138
- periodically in case the configuration is changed while the daemon is still
139
- running, so that specialists can reset the values in daemon control records to
140
- change the behave of dscheck daemon dynamically without shutting the daemon down.
141
-
142
- Daemon control information can be created, modified and viewed via Actions
143
- included in this section:
144
- Set Daemon Control - create and modify daemon control information for specified
145
- specialists, commands and hostnames
146
- Get Daemon Control - retrieve information of existing daemon controls
147
- Delete Daemon Control - delete one or multiple daemon control records
128
+ A daemon control record configures how many concurrent processes of a given
129
+ command a specialist may run on a specified host, and the priority order in
130
+ which hosts are selected. The centralized daemon reads these records
131
+ periodically, so specialists can update daemon control values at any time
132
+ without restarting the daemon.
133
+
134
+ Daemon control records are managed with the following actions:
135
+ Set Daemon Control - create or modify daemon control records for specified
136
+ specialists, commands, and hostnames
137
+ Get Daemon Control - retrieve existing daemon control information
138
+ Delete Daemon Control - remove one or more daemon control records
148
139
 
149
140
  3.1.1 Set Daemon Control
150
- -SD or -SetDaemon, creates and modifies daemon control information into
151
- GDEXDB for given specialist login names, commands, and hostnames of computers on
152
- which the check commands are processed. One or multiple records can be set each
153
- time.
141
+ -SD or -SetDaemon, creates or modifies daemon control records in GDEXDB for
142
+ given specialist login names, commands, and hostnames. One or more records
143
+ can be set per execution.
154
144
 
155
145
  dscheck -(SD|SetDaemon) [Mode Option]
156
146
  [-(DI|DaemonIndex) controlIndices]
@@ -161,36 +151,34 @@ categories:
161
151
  [-(PL|ProcessLimit) MaxNumberOfProcesses],
162
152
  [-(PO|Priority) HostListOrder]
163
153
 
164
- Mode option that can be specified for this action include:
165
- -(ND|NewDaemon) - sets a new daemon control record into GDEXDB
154
+ Available mode option:
155
+ -(ND|NewDaemon) - adds a new daemon control record to GDEXDB
156
+
157
+ If a daemon control record already exists in GDEXDB for the given specialist,
158
+ command, and hostname, the record is updated. A new record is created when the
159
+ daemon index is 0 and Mode option -ND (-NewDaemon) is present. The combination
160
+ of specialist login name, command name, and hostname must be unique for each
161
+ daemon control record.
166
162
 
167
- If information of a daemon control exists already in GDEXDB for a given specialist,
168
- a command and a hostname, the daemon control record is modified; otherwise, a new
169
- daemon control record is added if daemon index is 0 and Mode option -ND (-NewDaemon)
170
- is present. Combination of specialist login name, command name and hostname of
171
- computer must be unique for for each daemon control record.
163
+ Specify hostname 'PBS' to submit the command to the PBS batch control system.
164
+ If the specified command name is not found in the daemon control, the general
165
+ 'ALL' configuration is used.
172
166
 
173
- Specify host name 'PBS' for putting the command in the PBS batch control system. If
174
- a specified command name is not found in the daemon control, the general 'dscheck'
175
- configuration for command name 'ALL' is used.
176
-
177
- For example, set daemon control information for schuster, all commands on PBS hosts,
178
- for maximum 4 checks can be processed at the same time with priority 1, the smaller
179
- the number the higher the priority is, via input file daemon.ctl:
167
+ For example, to set daemon control for schuster on PBS hosts for all commands,
168
+ allowing up to 4 concurrent checks at priority 1 (lower number = higher
169
+ priority), using input file daemon.ctl:
180
170
 
181
- dsrqst SD -ND -IF daemon.ctl
171
+ dscheck -SD -ND -IF daemon.ctl
182
172
 
183
173
  <<Content of input file daemon.ctl>>
184
- DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
174
+ DaemonIndex<:>Specialist<:>Command<:>Hostname<:>ProcessLimit<:>Priority<:>
185
175
  0<:>schuster<:>ALL<:>PBS<:>4<:>1<:>
186
176
 
187
177
 
188
178
  3.1.2 Get Daemon Control
189
- -GD or -GetDaemon, retrieves daemon control information for given commands,
190
- specialists or hostnames. Daemon control information of specified specialists
191
- are retrieved if the specialist login names are provided. Without specified
192
- condition, only the daemon control records set for the specialist who runs
193
- 'dscheck' are retrieved.
179
+ -GD or -GetDaemon, retrieves daemon control records for specified commands,
180
+ specialists, or hostnames. If no conditions are provided, only records owned
181
+ by the specialist running 'dscheck' are returned.
194
182
 
195
183
  dscheck -(GD|GetDaemon) [Mode Option]
196
184
  [-(FN|FieldNames) FieldNameString]
@@ -200,18 +188,16 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
200
188
  [-(HN|HostName) HostMachineName]
201
189
  [-(PL|ProcessLimit) MaxNumberOfProcesses]
202
190
  [-(PO|Priority) ProcessPriority]
203
- [-(OF|OutputFile) OutputFileName]
191
+ [-(OF|OutputFile) OutputFileName]
204
192
  [-(DB|Debug) DebugModeInfo]
205
193
 
206
- Mode option that can be specified for getting check control Action:
207
- -(FO|FormatOutput) - format the column output with a fix width for all values
208
- of a given field
194
+ Available mode option:
195
+ -(FO|FormatOutput) - formats each column to a uniform fixed width
209
196
 
210
- Use Info option -FN (-FieldNames) to specify what daemon control fields to be
211
- retrieved. It defaults to all available fields if option -FN is not provided.
197
+ Use -FN (-FieldNames) to specify which daemon control fields to retrieve.
198
+ Defaults to all available fields when -FN is not provided.
212
199
 
213
- Valid field names of daemon controls and their corresponding Info option
214
- names:
200
+ Valid daemon control field names and their corresponding Info options:
215
201
 
216
202
  Names Info Options Descriptions
217
203
  I -(DI|DaemonIndex) daemon control index
@@ -222,46 +208,41 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
222
208
  P -(PL|ProcessLimit) Max check count to be processed at the same times
223
209
  O -(PO|Priority) host priority a specified command to start on
224
210
 
225
- Daemon control information can be retrieved for specified specialist per option
226
- -SN (-Specialist), and/or other conditions. Info option -SN, -CM and -HN accept
227
- wildcard input of '%' for matching any number of characters.
228
-
229
- If daemon control index is not given, 'dscheck' gathers only the daemon control
230
- records owned by the specialist who executes this getting daemon control Action.
231
- To view daemon control records owned by another specialist, you need specify Info
232
- option -SN (-Specialist). To view all control records, you simply provide option
233
- -SN with value of 'ALL'.
234
-
235
- For example, to get all daemon control information currently set for you:
236
-
211
+ Results can be filtered by specialist (-SN), and/or other conditions.
212
+ Options -SN, -CM, and -HN accept the '%' wildcard.
213
+
214
+ To view records owned by another specialist, provide their login name via
215
+ -SN (-Specialist). To view all control records, use -SN ALL.
216
+
217
+ For example, to retrieve all daemon control records set for you:
218
+
237
219
  dscheck GD
238
220
 
239
221
 
240
222
  3.1.3 Delete Daemon Control
241
- -DL or -Delete (Alias: -RM, -Remove), deletes one or multiple daemon control records
242
- from GDEXDB for given daemon control indices.
243
-
223
+ -DL or -Delete (Alias: -RM, -Remove), removes one or more daemon control
224
+ records from GDEXDB for the specified daemon control indices.
225
+
244
226
  dscheck -(DL|Delete)
245
227
  -(DI|DaemonIndex) DaemonControlIndices
246
228
  [-(DB|Debug) DebugModeInfo]
247
229
 
248
- Use this action to delete daemon control information. Delete a daemon
249
- control record to remove the daemon specific configuration for a command,
250
- a specialist and a hostname.
230
+ Deleting a daemon control record removes the specific configuration for a
231
+ command, specialist, and hostname combination.
251
232
 
252
233
  3.2 Check Actions
253
- Delayed mode command executions for due actions of 'dsupdt' and 'dsrqst' are
254
- recorded automatically, while other commands, including 'dsarch' and specialist-
255
- defined ones, can be manually added into 'dscheck'. Command information can be
256
- added, viewed and manipulated via 'dscheck' actions:
257
- Add Check - Add a new check record for a specified command
258
- Get Check - get the command information recorded in check records
259
- Delete Check - delete check records for no need of processing the commands
260
- Unlock Check - unlock check records in case that its recorded command is aborted
261
- without cleaning the lock
234
+
235
+ Delayed command executions for due 'dsupdt' and 'dsrqst' actions are recorded
236
+ automatically. Other commands including 'dsarch' and specialist-defined ones
237
+ can be added to 'dscheck' manually. The following actions manage check records:
238
+ Add Check - add a new check record for a deferred command
239
+ Get Check - retrieve command information from check records
240
+ Delete Check - delete check records for commands that no longer need processing
241
+ Unlock Check - unlock a check record whose command aborted without releasing
242
+ the lock
262
243
 
263
244
  3.2.1 Add Check
264
- -AC or -AddCheck, adds check information for a delayed mode command execution.
245
+ -AC or -AddCheck, adds a check record for delayed command execution.
265
246
 
266
247
  dscheck -(AC|AddCheck) [Mode Option]
267
248
  -(CM|Command) CommandNames
@@ -277,53 +258,52 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
277
258
  [-(MO|Modules) ModuleList]
278
259
  [-(EV|Environments) EnvironmentPairList]
279
260
  [-(QS|QsubOptions) PBSBatchOptions]
280
- [-(OF|OutputFile) OutputFileName]
261
+ [-(OF|OutputFile) OutputFileName]
281
262
  [-(DB|Debug) DebugModeInfo]
282
263
 
283
- Mode option that can be specified for adding check control Action:
284
- -(AW|AnyWhere) - sets Working directory empty in check record to start processing
285
- the check anywhere.
264
+ Available mode option:
265
+ -(AW|AnyWhere) - leaves the working directory empty in the check record so
266
+ the command can be processed from any location
286
267
 
287
- Command name is mandatory for adding a new check for delayed mode execution.
288
- Unless they are specified, the current specialist who adds the command is defaulted
289
- as the owner of the added check record, and the current path is defaulted as the
290
- working directory when the command is executed later.
268
+ The command name is required. If not specified, the current specialist is
269
+ set as the owner of the check record and the current directory is used as
270
+ the working directory when the command runs later.
291
271
 
292
- Specified additional PBS batch options via Info option -QS (-QSubOptions) to add a check;
293
- and specify a parent check index to put the current command on hold until the parent
294
- check is finished.
272
+ Pass additional PBS batch options via -QS (-QsubOptions). Use -PI
273
+ (-ParentIndex) to put the current command on hold until a parent check
274
+ finishes.
295
275
 
296
- Commands containing redirections and pipes are not supported for delayed mode.
297
- A simple shell script can be used to wrap a complicated command.
298
-
299
- For example, to list file names in the current directory with name containing 'test'
300
- by catching the standard output into a log and display it on screen:
301
-
302
- dsheck AC -CM test1.sh -HN PBS
276
+ Commands with redirections or pipes are not supported for delayed mode.
277
+ Wrap complex commands in a simple shell script instead.
278
+
279
+ For example, to list files containing 'test' in the current directory,
280
+ capturing stdout to a log and displaying it on screen:
281
+
282
+ dscheck -AC -CM test1.sh -HN PBS
303
283
 
304
284
  <<Content of shell script test1.sh>>
305
285
  #!/bin/sh
306
286
  (ls -l | grep test) | tee test1.out
307
287
 
308
- For example, to list file names in the current directory with name containing 'test'
309
- by catching the standard output and error into separate log files:
288
+ For example, to list files containing 'test', capturing stdout and stderr
289
+ to separate log files:
310
290
 
311
- dsheck AC -CM test2.sh -HN PBS
291
+ dscheck -AC -CM test2.sh -HN PBS
312
292
 
313
293
  <<Content of shell script test2.sh>>
314
294
  #!/bin/sh
315
295
  (ls -l | grep test) 1> test2.out 2>test2.err
316
296
 
317
- For example, to add testing command 'test2' into 'dscheck' for delayed mode execution on
318
- PBS:
297
+ For example, to add command 'test3' to 'dscheck' for deferred execution on PBS:
319
298
 
320
- dsheck AC -CM test3 -HN PBS
299
+ dscheck -AC -CM test3 -HN PBS
321
300
 
322
- The command 'test3' must be executable at the current working directory on PBS machines.
301
+ The command 'test3' must be executable in the current working directory on
302
+ PBS machines.
323
303
 
324
304
 
325
305
  3.2.2 Get Check
326
- -GC or -GetCheck, gets check information recorded in GDEXDB.
306
+ -GC or -GetCheck, retrieves check information recorded in GDEXDB.
327
307
 
328
308
  dscheck -(GC|GetCheck) [Mode Options]
329
309
  [-(FN|FieldNames) FieldNameString]
@@ -338,16 +318,17 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
338
318
  [-(CT|CheckTime) CommandTime]
339
319
  [-(WD|WorkDir) WorkingDirectory]
340
320
  [-(PQ|PBSQueue) PBSBatchQueue]
341
- [-(OF|OutputFile) OutputFileName]
321
+ [-(OF|OutputFile) OutputFileName]
342
322
  [-(DB|Debug) DebugModeInfo]
343
323
 
344
- Mode options that can be specified for getting check Action:
345
- -(CS|CheckStatus) - check and show detail information on check status
346
- -(FO|FormatOutput) - format the column output with a fix width for all values
347
- of a given field
324
+ Available mode options:
325
+ -(CS|CheckStatus) - displays detailed check status, including progress
326
+ percentage for running commands and error messages
327
+ for failed ones
328
+ -(FO|FormatOutput) - formats each column to a uniform fixed width
348
329
 
349
- Use Info option -FN (-FieldNames) to specify what check fields to retrieve.
350
- It defaults to "COVTUFJDNW" if -FN is not given.
330
+ Use -FN (-FieldNames) to specify which check fields to retrieve.
331
+ Defaults to "COVTUPFJDNW" when -FN is not given.
351
332
 
352
333
  Valid check field names and their corresponding Info options:
353
334
 
@@ -377,54 +358,55 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
377
358
  X -(AX|ArgumentExtra) additional argument line beyond 100 characters
378
359
  E -(ER|ErrorMessage) error message from failed command
379
360
 
380
- Check information can be retrieved for specified check index per option
381
- -CI (-CheckIndex). Without any condition, the check records owned by the
382
- current specialist are retrieved.
361
+ Filter results by check index via -CI (-CheckIndex). Without any condition,
362
+ only check records owned by the current specialist are returned.
383
363
 
384
364
 
385
365
  3.2.3 Delete Check
386
- -DL or -Delete, deletes one or multiple 'dscheck' records from GDEXDB
387
- for given check indices.
388
-
366
+ -DL or -Delete, removes one or more 'dscheck' records from GDEXDB for
367
+ the specified check indices.
368
+
389
369
  dscheck -(DL|Delete)
390
370
  -(CI|CheckIndex) CheckIndices
391
371
  [-(DB|Debug) DebugModeInfo]
392
372
 
393
- Use this action to delete check information. A deleted check record is saved
394
- into check history for viewing later via utility program 'viewcheckusage'.
373
+ A deleted check record is saved to check history and can be viewed later
374
+ via the utility program 'viewcheckusage'.
395
375
 
396
376
 
397
377
  3.2.4 Unlock Check
398
- -UL or -UnLockCheck, (Alias: -UnLock), unlocks check records that their
399
- commands aborted abnormally during processes.
400
-
401
- Process ID and computer hostname are saved in a check record when the recorded
402
- command is running. If the process aborts abnormally, the PID and hostname may
403
- sometimes be not cleaned properly. Use this action to clean up the locking
404
- information to allow the command to be reprocessed or purged.
378
+ -UL or -UnLockCheck (Alias: -UnLock), unlocks check records whose commands
379
+ aborted abnormally during processing.
405
380
 
406
- dscheck -(-UL|UnLockCheck)
407
- -(CI|CheckIndex) CheckIndices
408
- [-(DB|Debug) DebugModeInfo]
381
+ When a command is running, its process ID and hostname are saved in the
382
+ check record. If the process aborts abnormally, this lock information may
383
+ not be cleared properly. Use this action to remove the lock so the command
384
+ can be reprocessed or purged.
409
385
 
410
- It is mandatory to provide a check index to remove lock on a recorded command.
386
+ dscheck -(UL|UnLockCheck)
387
+ -(CI|CheckIndex) CheckIndices
388
+ [-(DB|Debug) DebugModeInfo]
389
+
390
+ A check index is required to unlock a recorded command.
411
391
 
412
392
 
413
393
  3.3 Check Process Actions
414
- Delayed mode command executions recorded in GDEXDB are automatically started,
415
- or restarted, by the common 'dscheck' daemon. Running commands can be interrupted
416
- at any time and the child processed of the interrupted commands are also cleaned up.
417
- The status of the current check records can be gathered and emailed to a specialist.
418
-
419
- Here are the actions for process checks:
420
- Process Check - start a command from its information recorded in 'dscheck'
421
- Interrupt Check - interrupt a running command for given check record and clean the
422
- child processes
423
- Email Check - email a specialist for the status of the current check records
394
+
395
+ Deferred commands recorded in GDEXDB are started (or restarted) automatically
396
+ by the centralized 'dscheck' daemon. Running commands can be interrupted at any
397
+ time, and all child processes of the interrupted command are also cleaned up.
398
+ The current check status can be gathered and emailed to a specialist.
399
+
400
+ Available actions:
401
+ Process Check - start a command from its check record, in daemon or
402
+ non-daemon mode
403
+ Interrupt Check - interrupt a running command for a given check record and
404
+ kill all its child processes
405
+ Email Check - email a specialist the current status of their check records
424
406
 
425
407
  3.3.1 Process Check
426
- -PC or -ProcessCheck, starts process commands in check records in daemon or
427
- non-daemon modes. Check indices can be specified if in non-daemon mode.
408
+ -PC or -ProcessCheck, starts commands from check records in daemon or
409
+ non-daemon mode. Check indices may be specified in non-daemon mode.
428
410
 
429
411
  dscheck -(PC|ProcessCheck) [Mode Options]
430
412
  [-(CI|CheckIndex) CheckIndices]
@@ -434,47 +416,46 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
434
416
  [-(MT|MaxrunTime) MaximumRunTimeInSeconds]
435
417
  [-(DB|Debug) DebugModeInfo]
436
418
 
437
- Mode options that can be specified for processing check Action:
438
- -(BG|BackGround) - background process to turn off screen display for both
439
- standard outputs and errors
440
- -(CP|CheckPending) - Check and kill long pending checks
441
- -(LO|LogOn) - log detail for daemon mode
442
- -(NC|NoCommand) - does not issue remote commands if this Mode option is present
443
- -(WU|WithdsUpdt) - in non-daemon mode, add check records for due 'dsupdt' actions
444
- configured in update control records
445
- -(WR|WithdsRqst) - in non-daemon mode, add check records for 'dsrqst' records
446
- due to be built or purged
447
-
448
- In daemon mode, 'dscheck' sleeps two minutes (120 seconds as default), unless
449
- provided differently per option -WI (-WaitInterval), between processing check
450
- records. Every time it wakes up, 'dscheck' first tries to add the due update
451
- controls for command 'dsupdt' and add requests due to be built or purged for
452
- command 'dsrqst', and then starts, or restarts, commands recorded in check
453
- records on a computer according the priorities configured in the daemon controls.
454
-
455
- In non-daemon mode, Mode options -WU and -WR must be present for due actions
456
- of 'dsupdt' and 'dsrqst' to be added to check records. All current standing
457
- check records, unless check indices are specified, are processed on machines
458
- according to the configured information in daemon controls.
459
-
419
+ Available mode options:
420
+ -(BG|BackGround) - runs as a background process, suppressing screen output
421
+ and errors
422
+ -(CP|CheckPending) - checks and kills long-pending checks
423
+ -(LO|LogOn) - enables detailed logging in daemon mode
424
+ -(NC|NoCommand) - suppresses remote command execution
425
+ -(WU|WithdsUpdt) - in non-daemon mode, adds check records for due 'dsupdt'
426
+ actions configured in update control records
427
+ -(WR|WithdsRqst) - in non-daemon mode, adds check records for 'dsrqst'
428
+ records due to be built or purged
429
+
430
+ In daemon mode, 'dscheck' sleeps for two minutes (120 seconds by default,
431
+ or as configured via -WI) between processing cycles. On each wake-up, it
432
+ first adds due 'dsupdt' and 'dsrqst' check records, then starts or restarts
433
+ commands from check records according to the host priorities set in daemon
434
+ controls.
435
+
436
+ In non-daemon mode, Mode options -WU and -WR must be present for due
437
+ 'dsupdt' and 'dsrqst' actions to be added to check records. All current
438
+ check records (unless indices are specified) are then processed on machines
439
+ according to the daemon control configuration.
440
+
460
441
  3.3.2 Interrupt Check
461
- -IC or -InterruptCheck, interrupts checks that their commands are currently running
462
- and also kills recursively all the child processes that are running under the
463
- commands. Locks are cleaned too when the checks are interrupted.
442
+ -IC or -InterruptCheck, interrupts checks whose commands are currently
443
+ running and recursively kills all child processes. Locks are released when
444
+ the check is interrupted.
464
445
 
465
- dscheck -(-IC|InterruptCheck) [Mode Option]
466
- -(CI|CheckIndex) CheckIndices
467
- [-(DB|Debug) DebugModeInfo]
446
+ dscheck -(IC|InterruptCheck) [Mode Option]
447
+ -(CI|CheckIndex) CheckIndices
448
+ [-(DB|Debug) DebugModeInfo]
468
449
 
469
- Mode option that can be specified for this action:
470
- -(FI|ForceInterrupt) - it must be present for this action to interrupt a check
471
- that is under processing.
450
+ Available mode option:
451
+ -(FI|ForceInterrupt) - required to interrupt a check that is currently
452
+ being processed
472
453
 
473
- It is mandatory to provide a check index to interrupt its command.
454
+ A check index is required to interrupt its command.
474
455
 
475
456
  3.3.3 Email Check
476
- -EC or -EmailCheck, sends an email to a specialist for the current status of all check
477
- records owned by the specialist, unless more specific conditions are provided.
457
+ -EC or -EmailCheck, sends an email to a specialist with the current status
458
+ of all their check records, unless more specific conditions are provided.
478
459
 
479
460
  dscheck -(EC|EmailCheck)
480
461
  [-(CI|CheckIndex) CheckIndices]
@@ -488,12 +469,11 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
488
469
  [-(CC|CarbonCopy) Cc'dEmailAddresses]
489
470
  [-(DB|Debug) DebugModeInfo]
490
471
 
491
- Command error messages are included too if any error messages are recorded in
492
- the check record.
472
+ Any error messages recorded in the check record are included in the email.
493
473
 
494
474
  3.4 Daemon Host Connectivity
495
475
  -CH or -CheckHost, checks connectivity of daemon hosts for specialists.
496
-
476
+
497
477
  dscheck -(CH|CheckHost)
498
478
  [-(DI|DaemonIndex) controlIndices]
499
479
  [-(CM|Command) UtilityProgramNames]
@@ -506,7 +486,7 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
506
486
  3.5 Set Batch Options Dynamically
507
487
  -SO or -SetOptions (Alias: -SetBatchOptions), processes batch options with
508
488
  a leading '!' to build options dynamically.
509
-
489
+
510
490
  dscheck -(SO|SetOptions)
511
491
  [-(HN|HostName) HostNames]
512
492
  [-(PL|ProcessLimit) MaxNumberOfProcesses]
@@ -515,227 +495,207 @@ DaemonIndex<:>Command<:>Specialist<:>Hostname<:>ProcessLimit<:>Priority<:>
515
495
  [-(QS|QsubOptions) PBSBatchOptions]
516
496
  [-(DB|Debug) DebugModeInfo]
517
497
 
518
-
498
+
519
499
  4 MODE OPTIONS
520
500
 
521
- Use proper Mode options to modify behaviors of Action options. Mode options
522
- are all optional. No value is allowed to be passed in following any Mode option.
501
+ Mode options modify the behavior of Action options. They are all optional and
502
+ take no values.
503
+
504
+ -AW or -AnyWhere, used with Action -AC (-AddCheck), leaves the working
505
+ directory empty in the check record so the command can run from any location.
506
+
507
+ -BG or -BackGround (Alias: -b), runs as a background process, suppressing
508
+ all screen output and error messages.
523
509
 
524
- -AW or -AnyWhere, for Action -AC (-AddCheck), sets Working directory empty in
525
- check record to start processing the check anywhere.
510
+ -CP or -CheckPending, when used with Action -PC (-ProcessCheck), checks and
511
+ kills long-pending checks.
526
512
 
527
- -BG or -BackGround (Alias: -b), background process. When it presents
528
- screen display is turned off for both standard outputs and errors. -(CP|CheckPending) - Check and kill long pending checks
529
-
530
- -CP or -CheckPending, if present for Action -PC (-ProcessCheck), check and kill
531
- long pending checks
513
+ -CS or -CheckStatus, displays detailed status information for recorded
514
+ commands, including progress percentage for running commands and error
515
+ messages for failed ones.
532
516
 
533
- -CS or -CheckStatus, if present, displays detailed status information of the
534
- recorded commands, including progress percentage for a running command and
535
- error message for a failed command.
536
-
537
- -FI or -ForceInterrupt, if present, force interrupts a check that is still under
538
- processing; otherwise a warning message will display.
517
+ -FI or -ForceInterrupt, required to interrupt a check that is currently being
518
+ processed; without it, a warning message is displayed instead.
539
519
 
540
- -FO or -FormatOutput, if present, formats column output results for get
541
- actions. A same width, evaluated dynamically, is applied for all values of a
542
- given field.
520
+ -FO or -FormatOutput, formats column output for GET actions. A uniform width,
521
+ evaluated dynamically, is applied to all values of a given field.
543
522
 
544
- -LO or -LogOn (Alias: -LoggingOn), turns detail logging on when 'dscheck' starts
545
- in Daemon mode. The detail logging is off as default if this Mode option is
546
- not present.
523
+ -LO or -LogOn (Alias: -LoggingOn), enables detailed logging when 'dscheck'
524
+ starts in daemon mode. Detailed logging is off by default.
547
525
 
548
- -MD or -MyDataset, allows a specialist to manipulate check information of
549
- a given dataset listed for another specialist.
526
+ -MD or -MyDataset, allows a specialist to access check information for a
527
+ dataset owned by another specialist.
550
528
 
551
- -NC or -NoCommand (Alias: -NoRemoteCommand), does not issue remote commands if
552
- this Mode option is present for action -PC (-ProcessCheck).
529
+ -NC or -NoCommand (Alias: -NoRemoteCommand), suppresses remote command
530
+ execution when used with Action -PC (-ProcessCheck).
553
531
 
554
- -ND or -NewDaemon, a new daemon control can only be added when this Mode option is
555
- present and daemon control index is given as 0 when Action -SD (-SetDaemon) of
556
- 'dscheck' is executed. This Mode option blocks mistakes of adding daemon control
557
- records unintentionally.
532
+ -ND or -NewDaemon, required to add a new daemon control record when Action
533
+ -SD (-SetDaemon) is run with a daemon control index of 0. This flag prevents
534
+ daemon control records from being added unintentionally.
558
535
 
559
- -NT or -NoTrim, skips trimming of spaces and comments from input values to
560
- speed up reading input file(s).
536
+ -NT or -NoTrim, skips stripping spaces and comments from input values to
537
+ speed up reading of input files.
561
538
 
562
- -WR or -WithdsRqst, adds requests due to be built or purged of command 'dsrqst'
563
- for 'dscheck' Action -PC (-ProcessCheck) in non-daemon mode.
564
-
565
- -WU or -WithdsUpdt, adds due update controls of command 'dsrqst' for 'dscheck'
566
- Action -PC (-ProcessCheck) in non-daemon mode.
539
+ -WR or -WithdsRqst, adds 'dsrqst' records due to be built or purged to check
540
+ records, for use with Action -PC (-ProcessCheck) in non-daemon mode.
541
+
542
+ -WU or -WithdsUpdt, adds due 'dsupdt' update controls to check records, for
543
+ use with Action -PC (-ProcessCheck) in non-daemon mode.
567
544
 
568
545
  5 INFORMATION OPTIONS
569
546
 
570
- Information options are used to pass information, one or multiple values, into
571
- 'dscheck'. Two types of Info options are used:
572
- Single-Value Info Options - pass a single value to 'dscheck'
573
- Multi-Value Info Options - pass one or multiple values to 'dscheck'
547
+ Info options pass data values into 'dscheck'. They come in two forms:
548
+ Single-Value Info Options - accept exactly one value per invocation
549
+ Multi-Value Info Options - accept one or more values per invocation
574
550
 
575
551
  5.1 Single-Value Info Options
576
552
 
577
- A single-value Info option is used to pass one value into this application.
578
- One value, and one only, must follow a single-value option; otherwise an
579
- error message is displayed if no value or more than one value passed in.
553
+ A single-value Info option accepts exactly one value. Providing no value or
554
+ more than one causes an error.
555
+
556
+ -DM or -DaemonMode, passes a daemon mode value — start, stop, logon, or
557
+ logoff — to Action -PC (-ProcessCheck) to start, stop, enable, or disable
558
+ detailed logging, respectively.
580
559
 
581
- -DM or -DaemonMode, passes daemon mode values, start, stop, logon or logoff
582
- to 'dscheck' Action -PC (-ProcessCheck) to start, to stop, to log detail or
583
- not to log detail, correspondingly.
560
+ -DV or -Divider (Alias: -Delimiter, -Separator), the column delimiter for
561
+ multi-value Info options in input files. Defaults to '<:>'.
584
562
 
585
- -DV or -Divider (Alias: -Delimiter, -Separator), delimiter for separating
586
- columns of multi-value Info options in input files. It is default to '<:>'.
563
+ -ES or -EqualSign, the token used to assign a value to an option in input
564
+ files. Defaults to '<=>'.
587
565
 
588
- -ES or -EqualSign, for an equal sign of assigning one value to either a
589
- single-value option or multi-value option in input files. It is defaulted
590
- to '<=>'.
566
+ -FN or -FieldNames, a string of single-letter field codes selecting which
567
+ fields to retrieve for check information via Action -GC (-GetCheck).
591
568
 
592
- -FN or -FieldNames, for a string of single letter field names. Values of
593
- the selected fields are retrieved for check information per actions -GC
594
- (-GetCheck).
569
+ -LH or -LocalHost, the local hostname on which to process checks for Action
570
+ -PC (-ProcessCheck). Defaults to the current hostname. Specify PBS to process
571
+ batch jobs.
595
572
 
596
- -LH or -LocalHost, specify a local hostname to processes checks on the host for
597
- action -PC(-ProcessCheck). It defaults to '' to use the local host name. Specify
598
- PBS to process batch jobs.
573
+ -MT or -MaxrunTime, the maximum run time for daemon mode. Defaults to 0
574
+ (unlimited). For example, 5000 means 5000 seconds, and 1D means 1 day
575
+ (86400 seconds).
599
576
 
600
- -MT or -MaxrunTime, specify the maximum run time for daemon mode. It defaults to 0
601
- for unlimit time. For examples, 5000 means seconds, and 1D means 1 day for 86400
602
- seconds.
577
+ -OF or -OutputFile, redirects output to a file instead of the screen.
603
578
 
604
- -OF or -OutputFile, leads an output file name into which the output result
605
- of this application is dumped. If this option is not given, the result is
606
- displayed as standard output.
607
-
608
- -ON or -OrderNames, for a string of single letter field names use to order
609
- the results of getting check information via action -GC (-GetCheck).
610
-
611
- -AO or -ActOption, for setting Action and Mode options in input files. It is
612
- default to '<!>'.
579
+ -ON or -OrderNames, a string of single-letter field codes controlling the
580
+ sort order of results from Action -GC (-GetCheck).
613
581
 
614
- -WI or -WaitInterval, defaults to 2 minutes (120 seconds). It is used as a time
615
- intervals for the 'dscheck' daemon to sleep between processing check records.
582
+ -AO or -ActOption, the token that marks Action and Mode options in input
583
+ files. Defaults to '<!>'.
584
+
585
+ -WI or -WaitInterval, the time the 'dscheck' daemon sleeps between processing
586
+ cycles. Defaults to 2 minutes (120 seconds).
616
587
 
617
588
  5.2 Multi-Value Info Options
618
589
 
619
- A multi-value Info option is used to pass multiple values for one Info option
620
- into 'dscheck'. At lease one value must follow each multi-value option.
621
-
622
- -AN or -ActionName (Alias: -Action), specifies an action name for given command
623
- name recorded in check record.
624
-
625
- -AV or -ArgumentVector, the space delimited argument vector string up to 100
626
- characters. It is quoted with single quotes '' for a individual argument
627
- containing spaces.
628
-
629
- -AX or -ArgumentExtra, the space delimited argument vector string beyond 100
630
- characters. This field is not empty only if the argument vector string is
631
- longer than 100 characters.
632
-
633
- -CC or -CarbonCopy, provides additional one or multiple email addresses on
634
- command line to send Cc'd email notification of the check status. For
635
- DECS specialist, login user names themselves are acceptable; otherwise full
636
- email addresses are required for email domains other than 'ucar.edu'.
637
-
638
- -CD or -CheckDate, the check date of the recorded command is first processed.
639
-
640
- -CI or -CechkIndex, check record indices for commands recorded in GDEXDB. A check
641
- record is automatically purged if the command is finished.
642
-
643
- -CM or -Command (Alias: -CommandName), the command name recorded in check record.
644
-
645
- -CT or -CheckTime, the check time of the recorded command is first processed.
646
-
647
- -DB or -Debug, turns on debug mode with specified information. This option
648
- provides up to 3 values, they are Debug Level, debug log file path and debug
649
- log file name. The debug level is mandatory for this option. It can be a
650
- single integer value, for example, 1000 means to log debug messages for debug
651
- levels 1 to 1000; or a range of values, for example, 200-1000 means to log
652
- debug messages from debug levels 200 to 1000. The default debug file path is
653
- '$DSSHOME}/dssdb/log' and the default debug file name is 'mydss.dbg'. Provides
654
- the second and third values for this option to override the default ones
655
- respectively.
656
-
657
- -DC or -DoneCount, the number of files that are processed successfully already.
658
-
659
- -DF or -DownFlags, storage system down flags. The current supported flags are:
660
- D-DRDATA, G-GLADE, O-ObjectStore. It can hold multiple flags, up to 5,
661
- for all down storage systems.
662
-
663
- -DI or -DaemonIndex, daemon control indices. A daemon control record retains
664
- configuration information for how many processes on what host and its priority
665
- can a command be started for specified specialist.
666
-
667
- -DS or -Dataset, for dataset numbers, or called dataset IDs in form as [a-z]NNNNNN.
668
-
669
- -ER or -ErrorMessage, error message of a failed check command.
670
-
671
- -EV or -Environments, (Alias: -Envs), specifies environment variables, in form of
672
- VarName=VarValue and separated by ',', needed to be set to execute a command as
673
- a batch job. The environment variables will be set in the batch starting script.
590
+ A multi-value Info option accepts a list of one or more values. Supplying
591
+ zero values causes an error.
592
+
593
+ -AN or -ActionName (Alias: -Action), the action name associated with a given
594
+ command recorded in a check record.
595
+
596
+ -AV or -ArgumentVector, the space-delimited argument string following the
597
+ command, up to 100 characters. Quote individual arguments containing spaces
598
+ with single quotes.
599
+
600
+ -AX or -ArgumentExtra, the space-delimited argument string beyond 100
601
+ characters. Non-empty only when the argument vector exceeds 100 characters.
602
+
603
+ -CC or -CarbonCopy, one or more additional email addresses for Cc'd
604
+ notification of check status. For DECS specialists, login names are
605
+ acceptable; for other domains, full email addresses are required.
606
+
607
+ -CD or -CheckDate, the date the recorded command was first processed.
608
+
609
+ -CI or -CheckIndex, the check record indices for commands recorded in GDEXDB.
610
+ A check record is automatically purged when the command finishes.
611
+
612
+ -CM or -Command (Alias: -CommandName), the command name recorded in a check
613
+ record.
614
+
615
+ -CT or -CheckTime, the time the recorded command was first processed.
616
+
617
+ -DB or -Debug, enables debug logging. Up to 3 values may be given: debug
618
+ level (required), log file path, and log file name. The level can be a
619
+ single integer (e.g., 1000 means levels 1 to 1000) or a range (e.g.,
620
+ 200-1000). Defaults: log path '${DSSHOME}/dssdb/log', file name 'mydss.dbg'.
621
+
622
+ -DC or -DoneCount, the number of files successfully processed so far.
623
+
624
+ -DF or -DownFlags, storage system down flags. Supported values: D-DRDATA,
625
+ G-GLADE, O-ObjectStore. Up to 5 flags may be combined.
626
+
627
+ -DI or -DaemonIndex, daemon control indices. A daemon control record holds
628
+ the configuration for how many processes of a given command a specialist may
629
+ run on a given host, and at what priority.
630
+
631
+ -DS or -Dataset, dataset numbers (also called dataset IDs), in the format
632
+ [a-z]NNNNNN.
633
+
634
+ -ER or -ErrorMessage, the error message from a failed check command.
635
+
636
+ -EV or -Environments (Alias: -Envs), environment variables required to
637
+ execute a command as a batch job, in the form VarName=VarValue and separated
638
+ by commas. These variables are set in the batch startup script.
674
639
 
675
640
  -FC or -FileCount, the number of files to be processed by a check command.
676
-
677
- -HN or -HostName, specify the host names the check can or cannot be processed on.
678
-
679
- -IF or -InputFile, for input file names; one or multiple file names may be
680
- given on command line. Input files are used to hold all valid options and
681
- the associated values of Info options that need to be passed in for
682
- execution of 'dscheck'.
683
-
684
- In a input file, lines start with sign '#' are considered as comments;
685
- Option Names can be given either short, long or alias names. Action and Mode
686
- options are given in format of OptionName<!>. Single value Assignment is
687
- given in format of OptionName<=>OptionValue. One option is given on each line.
688
- Different setting sign of Action and Mode options can be provided by Info
689
- option -AO (-ActOption, default to <!>); and different equal sign of single
690
- value assignment can be provided by Info option -ES, (-EqualSign, default to
691
- '<=>'). Multi-value assignments can be given in columns delimited with
692
- separator specified per option -SP (-Separator, default to '<:>'). It starts
693
- with a column title line for multi-value option names and the rest holds
694
- values corresponding to each column titles. The value information stops at
695
- the end of the file or when a new column name line or another single value
696
- assignment appears. If the last column is a multi-line value field, an
697
- additional separator must be appended for each line, including the column
698
- title line to end lines properly.
699
-
700
- -MC or -MaxCount, the maximum number of tries for a check command can be processed
701
- if the command is failed.
702
-
703
- -MH or -MatchHost (Alias: -MatchHostname), flag to control hostname match.
704
- 'G' - general match, including empty hostname specified, or exclusive hostnames
705
- given but the hostname is not in the list, and 'M' - match only the hostname
706
- specified is identical to the current host.
707
-
708
- -MO or -Modules, (Alias: -Mods), specifies module names, separated by ',',
709
- needed to be loaded to execute a command as a batch job. The modules will
710
- be set in the batch starting script.
711
-
712
- -PI or -ParentIndex, specifies a parent check index for the current check to
713
- wait on.
714
-
715
- -PO or -Priority, specifies the priority of a given host so that the host is
716
- picked in such an order to start a 'dscheck' process.
717
-
718
- -PL or -ProcessLimit, specifies how many processes can be started for specified
719
- command and specialist on a given host; Work for Action -SO (-SetOptions) to limit
720
- how many concurrent cron processes.
721
-
722
- -PQ or -PBSQueue, specifies PBS batch queue index the current check to submit to.
723
-
724
- -QS or -QsubOptions, (Alias: -PBSOptions), specifies options to execute a command
725
- as a batch job via qsub on PBS nodes. The qsub options must be quoted when presented
726
- on command line, such as, -QS '-l walltime=12:00:00'.
727
-
728
- -SN or -Specialist, the specialist who runs the original command. This Info
729
- option is working with Action -GC (-GetCheck) only to view check information
730
- of a specified specialist.
731
-
732
- -ST or -Status, check command status for a check record. Include command
733
- progress percentage if under process and error message for a failed command.
734
-
735
- -SZ or -DataSize, the total bytes of data is processed for the check record.
736
-
737
- -TC or -TryCount, the number of tries for a check command being processed. It
738
- is up to the number of tries specified via info option -MC.
739
-
740
- -WD or -WorkDir (Alias: -WorkDirectory), the working directory where the
641
+
642
+ -HN or -HostName, the host names on which the check can or cannot be
643
+ processed.
644
+
645
+ -IF or -InputFile, one or more input file names provided on the command line.
646
+ Input files hold options and their values for a 'dscheck' execution.
647
+
648
+ In an input file:
649
+ - Lines beginning with '#' are comments and are ignored.
650
+ - Option names may be given in short, long, or alias form.
651
+ - Action/Mode options: OptionName<!> (marker changeable via -AO)
652
+ - Single-value assignments: OptionName<=>OptionValue, one per line
653
+ (delimiter changeable via -ES; default '<=>')
654
+ - Multi-value (tabular) assignments: a title row followed by data rows,
655
+ with columns separated by '<:>' (changeable via -DV).
656
+ - Tabular data ends at EOF or when a new title line or single-value
657
+ assignment is encountered.
658
+ - If the last column contains multi-line text, append the separator to
659
+ every row (including the title line).
660
+
661
+ -MC or -MaxCount, the maximum number of times a failed check command may be
662
+ retried.
663
+
664
+ -MH or -MatchHost (Alias: -MatchHostname), controls how hostnames are
665
+ matched: 'G' (general match includes empty hostname or exclusive hostname
666
+ lists where the current host is not listed) or 'M' (exact match — only
667
+ the specified hostname).
668
+
669
+ -MO or -Modules (Alias: -Mods), module names, separated by commas, needed
670
+ to execute a command as a batch job. These modules are loaded in the batch
671
+ startup script.
672
+
673
+ -PI or -ParentIndex, the parent check index that the current check must wait
674
+ for before it can run.
675
+
676
+ -PO or -Priority, the priority of a given host, determining the order in
677
+ which hosts are selected to start a 'dscheck' process.
678
+
679
+ -PL or -ProcessLimit, the maximum number of concurrent processes that can be
680
+ started for a given command and specialist on a specified host. Also used with
681
+ Action -SO (-SetOptions) to limit concurrent cron processes.
682
+
683
+ -PQ or -PBSQueue, the PBS batch queue to which the current check is submitted.
684
+
685
+ -QS or -QsubOptions (Alias: -PBSOptions), options passed to qsub when running
686
+ a command as a PBS batch job. Quote the value on the command line, e.g.,
687
+ -QS '-l walltime=12:00:00'.
688
+
689
+ -SN or -Specialist, the specialist who ran the original command. Used with
690
+ Action -GC (-GetCheck) to view check records owned by a specific specialist.
691
+
692
+ -ST or -Status, the check status for a recorded command, including progress
693
+ percentage for running commands and error messages for failed ones.
694
+
695
+ -SZ or -DataSize, the total bytes of data processed for the check record.
696
+
697
+ -TC or -TryCount, the number of times the check command has been attempted,
698
+ up to the limit set via -MC.
699
+
700
+ -WD or -WorkDir (Alias: -WorkDirectory), the working directory from which
741
701
  the recorded command is started.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: rda_python_dscheck
3
- Version: 2.0.4
3
+ Version: 2.0.6
4
4
  Summary: RDA python package to add and process batch jobs
5
5
  Author-email: Zaihua Ji <zji@ucar.edu>
6
6
  Project-URL: Homepage, https://github.com/NCAR/rda-python-dscheck
@@ -2,11 +2,11 @@ rda_python_dscheck/PgCheck.py,sha256=lvh0XSWJID9J9fjqmDtpq6xW2ULC-bChAxAkm8MFzbk
2
2
  rda_python_dscheck/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
3
  rda_python_dscheck/ds_check.py,sha256=-js5Ex1k7V8ziE_k-ld5Z0l44QGYhvQtdYri9vsqNJA,24303
4
4
  rda_python_dscheck/dscheck.py,sha256=-vv7gw4xYIa1xofWo-o3972dDnR_FQZxZz6_S_kCCuk,24805
5
- rda_python_dscheck/dscheck.usg,sha256=9CJ6EtshsbkwEY29WiKfvhcUZajlyDlqPf-7pov0XMs,36126
5
+ rda_python_dscheck/dscheck.usg,sha256=L0HZRoFGIqBPVQGjJQmb6mxMBsuqpN8QSp0RQ4YGjmc,30895
6
6
  rda_python_dscheck/pg_check.py,sha256=Riv1nJYocSKLDsOIIYmOmkKlWZLKDrA1uPpbUEYo1uo,67388
7
- rda_python_dscheck-2.0.4.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
8
- rda_python_dscheck-2.0.4.dist-info/METADATA,sha256=r4TXXRtlOh3w0V7VHZ4v87Kudg3p048iRzvGFKVImY4,812
9
- rda_python_dscheck-2.0.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
10
- rda_python_dscheck-2.0.4.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
11
- rda_python_dscheck-2.0.4.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
12
- rda_python_dscheck-2.0.4.dist-info/RECORD,,
7
+ rda_python_dscheck-2.0.6.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
8
+ rda_python_dscheck-2.0.6.dist-info/METADATA,sha256=ZA1dxKZhTevLCRPZNlS5jr2YcS_ILiKtLSFGq-ZfSWc,812
9
+ rda_python_dscheck-2.0.6.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
10
+ rda_python_dscheck-2.0.6.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
11
+ rda_python_dscheck-2.0.6.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
12
+ rda_python_dscheck-2.0.6.dist-info/RECORD,,