Starting the Siebel Server Manager Command-Line Interface

The topics in this chapter describe the procedures available from the Siebel Server Manager command-line interface, which is also known as the srvrmgr program. This program is available on both the Windows and UNIX environments.

An overview of the srvrmgr program and its administration is followed by individual commands used to administer the Siebel Enterprise Server, individual Siebel Servers, and Siebel Server components and component groups. You must have administrative responsibilities defined by the Siebel application and have a user definition in the database in order to access and use the Siebel Server Manager command-line interface.

Note:

When using the Siebel Server Manager command-line interface, only use ASCII characters. If you want to enter parameters containing non-ASCII characters (for example, accented French characters, or Russian, Arabic, Japanese, Chinese, Korean, or Thai characters), then use the Siebel Server Manager GUI.

Starting the Siebel Server Manager Program

This procedure describes how to start the Siebel Server Manager program, srvrmgr.

To start the srvrmgr program

For Windows servers only: at the DOS prompt, change to the bin subdirectory within the Siebel Server root directory:
```
cd SIEBSRVR_ROOT\bin
```
Note:
You cannot use the Uniform Naming Convention (UNC) in the Siebel Server Manager command when specifying the path and computer names.
Execute the srvrmgr program using flags to specify the parameters that you want:
```
srvrmgr flags
```
For a list of srvrmgr flags, see Table 7-2.
After the Siebel Server Manager has started, the prompt changes to:
```
srvrmgr:server_name>
```
The server_name parameter appears in the prompt only if you executed the srvrmgr program by specifying a Siebel Server using the /s or -s flag, or after you specify a Siebel Server by using the set server command.

For example, to start the srvrmgr program on a Windows server using the parameters specified in Table 7-1, enter a command like the following:

srvrmgr /g gateway1:2320 /e enterprise1 /s server1 /u sadmin /p pwd

To start the srvrmgr program on a UNIX server using the parameters specified in Table 7-1, enter a command like the following:

srvrmgr -g gateway1:2320 -e enterprise1 -s server1 -u sadmin -p pwd

Table 7-1 Example Parameters for Starting the srvrmgr Program

Siebel Gateway	Enterprise	Siebel Server	User Name	Password
gateway1	enterprise1	server1	sadmin	pwd

Command-Line Flags for the Siebel Server Manager Program

Table 7-2 lists the command-line flags available for the Siebel Server Manager program, srvrmgr.

Table 7-2 Command-Line Flags for srvrmgr

Windows Flag	UNIX Flag	Parameter	Description	Required
/b	-b	Not applicable	Batch mode (use with /i to indicate exit when an error is encountered).	No
/c	-c	"command"	Executes a single command (the command must be bounded within double quotes).	No
/e	-e	entrpr_server	Siebel Enterprise Server name.	Yes
/g	-g	gateway_server	Network address of the Siebel Gateway. This value is usually provided with the TLS port for the Siebel Gateway, as specified during installation. For example, the value provided using this flag might be gateway1:2320.	Yes
/h or /?	-h or -?	Not applicable	Prints a usage help message	No
/i	-i	input_file	Gets commands from the input file	No
/k	-k	delimiter	Uses delimiter specified to parse columns in output file	No
/l	-l	language	Language code (default is ENU)	No
/m	-m	Not applicable	Compression enabled	No
/o	-o	output_file	Logs information generated in interactive mode to the specified output file. The types of information logged include, for example, the command issued, command output, type of task, task status, start time, and end time. Use this flag with either the flag that specifies a command to log `(c)` or the flag that specifies an input file with numerous commands `(i)`.	No
/p	-p	password	Siebel Server administrator password	Yes
/r	-r	Not applicable	Encryption for network packets is enabled (default is N)	No
/s	-s	siebel_server	Siebel Server name (the default is all servers). Starting srvrmgr with this flag connects the program only with that specific Siebel Server. All commands and user authentication are sent only to that Siebel Server. You cannot change the targeted Siebel Server in this mode.	No
/u	-u	username	Siebel Server administrator user name Note: The srvrmgr program expects the database to store user names in upper-case format. User names are automatically converted to upper case during the authentication process and login issues result if database user names are stored in lower case.	Yes
/z	-z	server_group_name	Server group name. Starting srvrmgr with this flag connects the program to the specified server group and, as a result, to all of the Siebel Servers that are assigned to the server group. For information about managing the assignment of Siebel Servers with server groups, see "Server Group Management Commands".	No

About Error Handling for the Siebel Server Manager Program

Error codes are returned by the Siebel Server Manager program (srvrmgr) in the manner described in this topic. Program behavior is described for different usage cases, including those based on the flags that you use to run srvrmgr. Any nonzero values returned are those that might be expected from a shell script. In earlier versions of Siebel CRM, srvrmgr returns 0 (zero) in all of the following cases.

When you run srvrmgr with valid syntax and valid arguments for flags and no error occurs, then srvrmgr returns 0 (zero).
When you run srvrmgr with invalid syntax, such as without the required flag /g or -g, then srvrmgr returns a nonzero value.
When you run srvrmgr with valid syntax but with invalid arguments for any flags, such as with an invalid user name with the /u or -u flag, then srvrmgr returns a nonzero value.
When you run srvrmgr with the /c or -c flag:
- If no error occurs, then srvrmgr returns 0 (zero).
- If any error occurs, then srvrmgr returns a nonzero value.
When you run srvrmgr with the /i or -i flag and without the /b or -b flag:
- If no error occurs, then srvrmgr returns 0 (zero).
- If one or more command process specified in the input file fails, then srvrmgr returns 0 (zero).
- If srvrmgr cannot connect with the Siebel Gateway or cannot open the specified input or output file, then srvrmgr returns a nonzero value.
When you run srvrmgr with the /i or -i flag and the /b or -b flag:
- If no error occurs, then srvrmgr returns 0 (zero).
- If any error occurs, then srvrmgr returns a nonzero value.