Command-Ref-Common Options

CA Harvest SCM provides you with a command line interface. On UNIX and Linux, the command line utilities serve as the CA Harvest SCM clients.

CA Harvest SCM command line utilities use many common features including options and syntax. These features are described in this chapter, instead of being repeated for every command line utility.

The following options are available for all commands and are not required:

-arg

(Optional) Defines package names that begin with a hyphen (-).

This option has the following format:

command ... -arg="-packagename"

Example:

hcp ... -arg="-mypackagename"

-h

(Optional) Displays a brief description of help on the command usage.

-i inputfile.txt

(Optional) Defines the file name of an input file that contains all command line parameters. It is typically used to prevent login credentials from being displayed on the console. This file is read at program execution. The following considerations apply to the input file:

• The file must be a regular text file.
• The file cannot be encoded or encrypted.
• The input file can have any name and extension, and can reside in any directory.
• The file must be available before the command is executed.
• The options and arguments you specify in the file are the same ones available for the command line prompt. They are specified in the same one-line format as the other CA Harvest SCM command line programs.
• You cannot specify some options on the command line and others in an input file; they must all be included in one or the other.
• The input file maximum size is limited only by what the operating system can handle.

-di inputfile.txt

(Optional) Defines the file name of an input file that contains all command line parameters. It is typically used to prevent login credentials from being displayed on the console. This file is read at program execution and then deleted as soon as the file is parsed. If you use this option, you cannot also use the -i option. The following considerations apply to the input file:

• The file must be a regular text file.
• The file cannot be encoded or encrypted.
• The file can have any name and extension, and can reside an any directory.
• The file must be available before the command is executed.
• The options and arguments you specify in the file are the same ones available for the command line prompt. They are specified in the same one-line format as the other CA Harvest SCM command line programs.
• You cannot specify some options on the command line and others in an input file; they must all be included in one or the other.
• The file maximum size is limited only by what the operating system can handle.

-o filename

(Optional) Defines the file name of a file to receive the output log. A file name is required; if one is not supplied, the file utilityname.log is created in the current working directory (utilityname is the name of the command being executed). If a file of the same name already exists, the file will be replaced; log information is not appended to the existing file.

Note: This option cannot also be used with -oa.

-oa filename

(Optional) Defines the file name of a file to receive the output log. A file name is required; if one is not supplied, the file utilityname.log is created in the current working directory (utilityname is the name of the command being executed). If a file of the same name already exists, log information is appended to the existing file.

Note: This option cannot also be used with -o.

-prompt

(Optional) Specifies that the user should be prompted for a user name (‑usr) and password (-pw) at runtime. This option is typically used to hide login credentials from being exposed in plain text on the command line. Including this option overrides use of -usr and -pw. This option also overrides the -eh option.

-v

(Optional) Specifies that verbose option be used to display all relevant variables being used for the command execution.

UNIX and Linux: Using verbose mode, you can confirm whether the command should actually be process.

Windows: Verbose mode simply writes the appropriate values to the output file.

Note: An exception is hsigget, which uses the -v option to generate a report with a pre-selected subset of attributes related to version information, including file name, status, tag, version, and package.

-wts

(Optional) Specifies that the timestamp of command line execution be recorded in the output log.