Manage all aspects of scheduler configurations
Available Sub Commands
add
Add a new scheduler configuration
GeneralArgument | Description |
|---|
-h [ --help ] | Display this message | --service-name arg | A unique name for the scheduler e.g. MyServer | --scheduler-name arg | A unique name using the WhereScape naming scheme e.g. WIN0001 | --exe-path-name arg | The path of the executable file that is the service | --work-dir arg | A local path in which to store temporary files | --tns-name arg | The TNS name to use when the scheduler's metadata repository | --startup-mode arg | The service startup mode for the scheduler. Either Manual, Automatic or Disabled | --poll-seconds arg | How many seconds must elapse before the scheduler polls the meta repo for jobs | --max-jobs arg | The maximum number of simultaneous jobs to run | --clean-hour arg | Which hour of the day to perform a clean operation (0-23) |
Windows LoginArgument | Description |
|---|
--login-mode arg | Either LocalSystemAccount or SpecificUser. A LocalSystemAccount does not require a user name and password. | --login-name arg | The Windows user name the scheduler will log in as | --login-password arg | The Windows password the scheduler will use |
Metadata RepositoryArgument | Description |
|---|
--sched-meta-dsn arg | The ODBC DSN representing the metadata repository the scheduler will connect to | --sched-meta-dsn-arch arg | The architecture of the scheduler's DSN. Valid values are 32 and 64. Defaults to 32 if not specified. | --sched-meta-database arg | Which database to use from within the ODBC DSN. Required for Teradata and DB2 | --sched-meta-user-name arg | The user name to supply when connecting to the ODBC DSN | --sched-meta-password arg | The password to supply when connecting to the ODBC DSN | --sched-meta-td-wallet | If present, then the password is considered to be a Teradata Wallet |
OtherArgument | Description |
|---|
--host-name arg | The machine name, or IP Address, of the host computer | --ip-service arg | The IP service the scheduler will use. This is almost always tcp. | --api-mode arg | Which API the scheduler should internally use. Either ODBC or OracleOCI | --ini-version arg | The version of the INI file configuration to use | --ins-schema arg | The schema that the clean up thread will use |
LoggingArgument | Description |
|---|
--log-file-name arg | The name of the scheduler's log file | --log-generations arg | How many generations of logs to keep | --sched-log-level arg | The log level the scheduler will use. 0=none, 9=debug |
|
delete
Delete an existing scheduler configuration
Delete ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler configuration |
|
generate-id
Generates a scheduler ID that is unique on the local machine
GenerateId ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -p [ --prefix ] arg | A three letter prefix that will be used with the ID. If not supplied the text "WIN" will be used. |
|
list-all
List all scheduler configurations
List All ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message |
|
modify
Modify an existing scheduler configuration
GeneralArgument | Description |
|---|
-h [ --help ] | Display this message | --service-name arg | A unique name for the scheduler e.g. MyServer | --scheduler-name arg | A unique name using the WhereScape naming scheme e.g. WIN0001 | --exe-path-name arg | The path of the executable file that is the service | --work-dir arg | A local path in which to store temporary files | --tns-name arg | The TNS name to use when the scheduler's metadata repository | --startup-mode arg | The service startup mode for the scheduler. Either Manual, Automatic or Disabled | --poll-seconds arg | How many seconds must elapse before the scheduler polls the meta repo for jobs | --max-jobs arg | The maximum number of simultaneous jobs to run | --clean-hour arg | Which hour of the day to perform a clean operation (0-23) |
Windows LoginArgument | Description |
|---|
--login-mode arg | Either LocalSystemAccount or SpecificUser. A LocalSystemAccount does not require a user name and password. | --login-name arg | The Windows user name the scheduler will log in as | --login-password arg | The Windows password the scheduler will use |
Metadata RepositoryArgument | Description |
|---|
--sched-meta-dsn arg | The ODBC DSN representing the metadata repository the scheduler will connect to | --sched-meta-dsn-arch arg | The architecture of the scheduler's DSN. Valid values are 32 and 64. Defaults to 32 if not specified. | --sched-meta-database arg | Which database to use from within the ODBC DSN. Required for Teradata and DB2 | --sched-meta-user-name arg | The user name to supply when connecting to the ODBC DSN | --sched-meta-password arg | The password to supply when connecting to the ODBC DSN | --sched-meta-td-wallet | If present, then the password is considered to be a Teradata Wallet |
OtherArgument | Description |
|---|
--host-name arg | The machine name, or IP Address, of the host computer | --ip-service arg | The IP service the scheduler will use. This is almost always tcp. | --api-mode arg | Which API the scheduler should internally use. Either ODBC or OracleOCI | --ini-version arg | The version of the INI file configuration to use | --ins-schema arg | The schema that the clean up thread will use |
loggingArgument | Description |
|---|
--log-file-name arg | The name of the scheduler's log file | --log-generations arg | How many generations of logs to keep | --sched-log-level arg | The log level the scheduler will use. 0=none, 9=debug |
|
pause
Pauses a started scheduler
Pause ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler |
|
restart
Restarts a started scheduler
Restart ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler |
|
resume
Resumes a paused scheduler
Resume ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler |
|
show
Show the contents of an existing scheduler configuration
Show ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler configuration |
|
start
Starts a stopped scheduler
Start ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler |
|
stop
Stops a started scheduler
Stop ArgumentsArgument | Description |
|---|
-h [ --help ] | Display this message | -n [ --name ] arg | The name of an existing scheduler |
|
Scheduler Arguments
Argument | Description |
|---|
| -h [ --help] | Displays This message |
Common Arguments
