Manage inserting, updating and deleting external scheduler rows

Available Sub Commands

add

Add a new external scheduler

External Scheduler Arguments

Argument

Description

-h [ --help ]

Display this message

--sched-name arg

A unique name for the Scheduler

--publish-script-name arg

Script that publishes jobs to the Scheduler

--dashboard-url arg

Address of the Scheduler Dashboard

--dashboard-user-name arg

User with access to the Dashboard

--dashboard-password arg

Password for the dashboard User

--dashboard-login-script-name arg

Script that logs into the Scheduler Dashboard

--rest-api-url arg

Address of the REST API service

--rest-api-user-name arg

User with access to the REST API

--rest-api-password arg

Password for the REST API User

--lookup-scheds-script-name arg

Script that returns known Schedulers

--replace-existing

If specified, an existing scheduler configuration with the specified name will be replaced

Metadata Repository Login Arguments

Argument

Description

--meta-dsn arg

ODBC DSN of the metadata repository

--meta-dsn-arch arg (=32)

The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.

--meta-user-name arg

Username for the ODBC DSN

--meta-password arg

Password for the ODBC DSN

--meta-database arg

Database used by the ODBC DSN

--td-wallet

The supplied password will be treated as a TDWallet string

--dimension-space arg

A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2).

--index-space arg

A named area of the RDBMS to store the metadata (DB2 only).

--meta-space arg

A named area of the RDBMS to store the metadata.

--meta-index-space arg

A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL).

--meta-con-string arg

ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$.

--red-profile arg

Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use.

delete

Delete an existing external scheduler

Delete Arguments

Argument

Description

-h [ --help ]

Display this message

-n [ --name ] arg

The name of an existing external scheduler

-f [ --force ]

force the deletion of an external scheduler that's in use

Metadata Repository Login Arguments

Argument

Description

--meta-dsn arg

ODBC DSN of the metadata repository

--meta-dsn-arch arg (=32)

The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.

--meta-user-name arg

Username for the ODBC DSN

--meta-password arg

Password for the ODBC DSN

--meta-database arg

Database used by the ODBC DSN

--td-wallet

The supplied password will be treated as a TDWallet string

--dimension-space arg

A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2).

--index-space arg

A named area of the RDBMS to store the metadata (DB2 only).

--meta-space arg

A named area of the RDBMS to store the metadata.

--meta-index-space arg

A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL).

--meta-con-string arg

ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$.

--red-profile arg

Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use.

list-all

List all external schedulers

List All Arguments

Argument

Description

-h [ --help ]

Display this message

Metadata Repository Login Arguments

Argument

Description

--meta-dsn arg

ODBC DSN of the metadata repository

--meta-dsn-arch arg (=32)

The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.

--meta-user-name arg

Username for the ODBC DSN

--meta-password arg

Password for the ODBC DSN

--meta-database arg

Database used by the ODBC DSN

--td-wallet

The supplied password will be treated as a TDWallet string

--dimension-space arg

A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2).

--index-space arg

A named area of the RDBMS to store the metadata (DB2 only).

--meta-space arg

A named area of the RDBMS to store the metadata.

--meta-index-space arg

A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL).

--meta-con-string arg

ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$.

--red-profile arg

Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use.

modify

Modify an existing external scheduler

External Scheduler Arguments

Argument

Description

-h [ --help ]

Display this message

--sched-name arg

A unique name for the Scheduler

--publish-script-name arg

Script that publishes jobs to the Scheduler

--dashboard-url arg

Address of the Scheduler Dashboard

--dashboard-user-name arg

User with access to the Dashboard

--dashboard-password arg

Password for the dashboard User

--dashboard-login-script-name arg

Script that logs into the Scheduler Dashboard

--rest-api-url arg

Address of the REST API service

--rest-api-user-name arg

User with access to the REST API

--rest-api-password arg

Password for the REST API User

--lookup-scheds-script-name arg

Script that returns known Schedulers

Metadata Repository Login Arguments

Argument

Description

--meta-dsn arg

ODBC DSN of the metadata repository

--meta-dsn-arch arg (=32)

The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.

--meta-user-name arg

Username for the ODBC DSN

--meta-password arg

Password for the ODBC DSN

--meta-database arg

Database used by the ODBC DSN

--td-wallet

The supplied password will be treated as a TDWallet string

--dimension-space arg

A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2).

--index-space arg

A named area of the RDBMS to store the metadata (DB2 only).

--meta-space arg

A named area of the RDBMS to store the metadata.

--meta-index-space arg

A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL).

--meta-con-string arg

ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$.

--red-profile arg

Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use.

show

Show the contents of an existing external scheduler

Show Arguments

Argument

Description

-h [ --help ]

Display this message

-n [ --name ] arg

The name of an existing external scheduler

Metadata Repository Login Arguments

Argument

Description

--meta-dsn arg

ODBC DSN of the metadata repository

--meta-dsn-arch arg (=32)

The architecture of the ODBC DSN. Valid values are 32 and 64. Defaults to 32 if not specified.

--meta-user-name arg

Username for the ODBC DSN

--meta-password arg

Password for the ODBC DSN

--meta-database arg

Database used by the ODBC DSN

--td-wallet

The supplied password will be treated as a TDWallet string

--dimension-space arg

A named area of the RDBMS to store DSS tables (Oracle, SQL Server and DB2).

--index-space arg

A named area of the RDBMS to store the metadata (DB2 only).

--meta-space arg

A named area of the RDBMS to store the metadata.

--meta-index-space arg

A named area of the RDBMS to store the metadata indexes and constraints (Oracle, SQL Server and PostgreSQL).

--meta-con-string arg

ODBC connection string for the metadata repository when using Advanced Connect. This arg will override the values stored in the RED Profile if provided. Accepts RED tokens $DSN$, $USER$ and $PASSWORD$.

--red-profile arg

Path to the RED Profile file to be used with Advanced Connect, usually necessary for data warehouse actions when Advanced Connect is in use.

External Scheduler Arguments

Argument

Description

-h [ --help]Displays a list of available sub commands and their description.

Common Arguments