Administrative client options

You can enter the DSMADMC command with your user ID and password by using the -CREDENTIALSFILE option so that you are not prompted for that information. To have IBM® Storage Protect redirect all output to a file, specify the -OUTFILE option with a destination file name. For example, to issue the QUERY NODE command in batch mode with the output redirected to the SAVE.OUT file, enter:

dsmadmc -credentialsfile=secretpwdfile -outfile=save.out query node 

Administrative client options can be specified with the DSMADMC command and are valid from an administrative client session only. You can type an option in uppercase letters, lowercase letters, or any combination. Uppercase letters denote the shortest acceptable abbreviation. If an option appears entirely in uppercase letters, you cannot abbreviate it.

-ALWAYSPrompt

Specifies that a command prompt is displayed if the input is from the keyboard or if it is redirected (for example, from a file). If this option is not specified and the input is redirected, the command prompt is not written.

If the input is redirected, only the command output is displayed. If this option is specified, the command prompt and the command output are displayed.

-CHECKAliashalt

Allows the administrative client to recognize an alias for the HALT command as set in the ALIASHALT server option. See ALIASHALT for details.

-COMMAdelimited

Specifies that any tabular output from a server query is to be formatted as comma-separated strings rather than in readable format. This option is intended to be used primarily when you redirect the output of an SQL query (SELECT command). The comma-separated value format is a standard data format, which can be processed by many common programs, including spreadsheets, databases, and report generators.

-CONsolemode

Specifies that IBM Storage Protect runs in console mode. Most server console output is echoed to your screen. The exception are items such as responses to query commands that are issued from the console, trace output, or any system messages that displayed on the console.

-DATAONLY=NO or YES

Specifies whether product version information and output headers display with the output. The default is NO.

NO

Specifies that the product version information and output column headers display.

YES

Suppresses the product version information and output column headers.

-DISPLaymode=LISt or TABle

You can force the QUERY output to tabular or list format regardless of the command-line window column width.

If you are using the -DISPLAYMODE option and you want the output to go to a file, do not specify the -OUTFILE option. Use redirection to write to the file.

-ID=userid

Specifies the administrator's user ID.

Tip: The -CREDENTIALSFILE option is preferred as a secure alternative to the -ID and -PASSWORD options. However, the -CREDENTIALSFILE option cannot be used with administrator IDs that are configured for multifactor authentication (MFA).

-Itemcommit

Specifies that IBM Storage Protect commits commands inside a script or a macro as each command is processed.

-MOUNTmode

Specifies that IBM Storage Protect runs in mount mode. All server removable-media mount messages are echoed to your screen.

-NEWLINEAFTERPrompt

Specifies that a newline character is written after the command prompt and commands that are entered from the keyboard are displayed underneath the prompt. If this option is not specified, commands entered from the keyboard are displayed to the right side of the prompt.

-NOConfirm

Specifies that you do not want IBM Storage Protect to request confirmation before processing commands that affect the availability of the server or data that is managed by the server.

-OUTfile

Specifies that output from a server query is displayed in one row. If the output in a row exceeds the column width that is defined by the server, the output is displayed on multiple lines in that row. This option is available in batch mode only.

-OUTfile=filename

Specifies that output from a server query is redirected to a specified file. In batch mode, output is redirected to a file you specify and the format of the output matches the format of the output on your screen.

In interactive, console, or mount mode sessions, output displays on your screen.

-PAssword=password

Specifies the administrator's password.

If the administrator has multifactor authentication (MFA) set up on the account, a time-based one-time password (TOTP) must also be appended at the end of the password.

Tip: The -CREDENTIALSFILE option is preferred as a secure alternative to the -ID and -PASSWORD options. However, the -CREDENTIALSFILE option cannot be used with administrator IDs that are configured for multifactor authentication (MFA).

-CREDentialsfile=filename

Specifies the name of the file that contains the administrator ID and password. For noninteractive sessions, the -CREDENTIALSFILE option is preferred as a secure alternative to the -ID and -PASSWORD options. This option cannot be used with administrator IDs that are configured for multifactor authentication (MFA).

The filename is a plain text file that consists of two lines. The first line is the administrator ID, beginning in column 1. The second line is the password, beginning in column 1. Do not add blank spaces or other extra characters to the file.

Example:

Create a plain text file for admin ID monitoradmin and password topsecretpw.

monitoradmin
topsecretpwd

Attention: Store the credentials file in a directory to which only the owner and other authorized users have access. Set permissions on the file to grant access only to the owner and authorized users.

-Quiet

Specifies that IBM Storage Protect does not display standard output messages to your screen. However, when you use this option, certain error messages still appear.

-SErveraddress

Specifies the server stanza in the dsm.sys file. The client uses the server stanza to determine the server it connects to. The SERVERADDRESS option is supported by administrative clients that are running on UNIX, Linux®, and Macintosh operating systems only.

-TABdelimited

Specifies that any tabular output from a server query is to be formatted as tab-separated strings rather than in readable format. This option is intended to be used primarily when you redirect the output of an SQL query (SELECT command). The tab-separated value format is a standard data format, which can be processed by many common programs, including spreadsheets, databases, and report generators.

-TCPPort

Specifies a TCP/IP port address for an IBM Storage Protect server. The -TCPPORT option is only supported by administrative clients that are running on Windows operating systems and is valid on the Windows administrative client command line.

-TCPServeraddress

Specifies a TCP/IP server address for an IBM Storage Protect server. The -TCPSERVERADDRESS option is only supported by administrative clients that are running on Windows operating systems and is valid on the Windows administrative client command line.

In addition to the options that are listed here, you can also specify any option that is in the client options file. Each option must be preceded with a hyphen and delimited with a space.