You can view a list and brief description of all of the commands available in the DSA command-line interface. The basic syntax and usage of commands is shown for each command.
You can also specify a command name to view more detailed information about the command, including a syntax example and a list and description of each of the parameters associated with the command.
- Type dsc help in the command line, and do one of the following:
Option Description View all commands - Press Enter to view a list of all of the command names.
View a specific command - Add a specific command name to view information about a particular command.
- Press Enter.
For example, for information about the create_job command, type dsc help create_job and press Enter. The following is displayed:
NAME: create_job - Create Job Command DESCRIPTION: Creates a DSA job based on the file, with user modifications from the following parameters. User will be required to authenticate username and password to the source/target system on the console. EXAMPLE: create_job -n|-name job1 -f|-file parameters.xml PARAMETERS: Parameter Example Description n|name job1 (Optional) Name for the job, must be unique d|description backup web apps (Optional) Description of the job. For multi-word surround by \\" must be escaped with backslash. t|type restore (Optional) Type of the job: [BACKUP,RESTORE,ANALYZE_READ,ANALYZE_VALIDATE] b|backup_name backupWeb1 (Optional) Backup job name(only for RESTORE or ANALYZE jobs) v|backup_version 60 (Optional) Backup version number(only for RESTORE or ANALYZE jobs). Type LATEST or 0 for latest save set. f|file parameters.xml XML File to upload as basis for new job. u|user_authentication user (Required when security management is enabled) Supplies command with Viewpoint user
For example, for information about the run_repository_job command, type dsc help run_repository_job with Data Stream Controller Command Line 17.10.02.00 connected to DSC version 17.10.02.00 and press Enter. The following is displayed:
NAME: run_repository_job - Run repository job command DESCRIPTION: Runs a job for the DSC Repository. Requires option -t and -v for REPLICATE_TO, REPLICATE_FROM type. Supported replication target groups type are: Azure Blob, AWS S3, GCP, NBU, DFS, DDBoost EXAMPLE: run_repository_job -t|-type BACKUP run_repository_job -t|-type REPLICATE_TO -v|backup_version -r|replication_target run_repository_job -t|-type REPLICATE_FROM -v|backup_version -r|replication_target PARAMETERS: Parameter Example Description t|type BACKUP Type of job: BACKUP, REPLICATE_TO (replication from landing zone to target group), REPLICATE_FROM (replication from target group to landing zone) v|backup_version 60 (Optional) Backup version number to be replicated to or from the third-party storage. This is the number visible in the backup file name (bar_12345676789.out) r|replication_target target1 (Optional) Target group for replication. If not specified, it creates backup of the repository to the landing zone only. u|user_authentication user (Required when security management is enabled) Supplies command with Viewpoint user, and triggers password prompt for authentication.