Using the Siebel Server Manager Command-Line Interface

This chapter describes how to use the Siebel Server Manager command-line interface. It includes the following topics:

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 Command-Line Flags for the Siebel Server Manager Program.
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 using the parameters specified in the following table on a Windows server, enter a command like:
```
srvrmgr /g gateway1:2320 /e enterprise1 /s server1 /u sadmin /p pwd 
```
To start the srvrmgr program on a UNIX server using the parameters described in the following table, enter a command like the following:
```
srvrmgr -g gateway1:2320 -e enterprise1 -s server1 -u sadmin -p pwd 
```

The following table shows example parameters for starting the srvrmgr program.

Table 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

The following table lists the command-line flags available for the Siebel Server Manager program, srvrmgr.

Table 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.

Recommendations for Using the Command-Line Interface

This topic provides recommendations for using the Server Manager command-line interface.

Target specific Siebel Servers without using the /s or -s flag:
- Use the directive for server siebel_server_name in individual commands. Specifying the name of a specific Siebel Server targets the command to only that Siebel Server.
- Use a partial name with the % wildcard character to target the command to all of the Siebel Servers with names matching the pattern. Only patterns that start or end with the wildcard character are matched. Wildcards in the middle of the string are not matched. For example, the following command lists components for all of the Siebel Servers with a name beginning with WF:
```
list components for server WF%
```
- Use the command set server siebel_server_name. To return to the mode where commands are targeted to all of the Siebel Servers, use unset server. For more information about these commands, see Siebel Server Manager Environment Commands.
  
  Note: When you are using the set command, the connections to other Siebel Servers are maintained and continue to run.
Start srvrmgr using the /s or -s flag for frequent list operations. Parse the resulting data for each Siebel Server. Aggregate the list data for the enterprise externally to the srvrmgr process. This method improves performance by keeping srvrmgr from serializing the operations.
Use the show clause to specify only the columns with data that you are using. For more information about using the show clause, see List Command Configuration.
Use the /i or -i option to open a single long-running srvrmgr session and send it commands rather than using the /c or -c option. You can also execute commands conditionally from a script, by using the /i or -i option.
When using srvrmgr commands from a file or script, use the sleep command to configure wait periods (in seconds) before the next srvrmgr command. For example, after starting the Siebel Server, use the sleep command to wait until the Siebel Server and its component are running before issuing the next command.
Use the read command during an active srvrmgr session to dynamically input srvrmgr commands from a file.
Specify a value for the parameter TaskTag when starting a new task. This text appears in the list tasks command if you include the TK_TASKTAG column. For example, enter a command like the following:
```
list tasks show TK_TASKTAG
```
Start srvrmgr using the /z or -z flag to connect to a server group. For example, on a Windows server, enter a command like the following:
```
srvrmgr /g gateway1 /e enterprise1 /z server_group_name /u sadmin /p pwd
```
On a UNIX server, enter a command like the following:
```
srvrmgr -g gateway1 -e enterprise1 -z server_group_name -u sadmin -p pwd
```
This command connects you to all of the Siebel Servers assigned to the server group.

Siebel Server Manager Commands

After the Siebel Server Manager has been started, you can execute administrative tasks by using the commands described in this topic.

These commands can also be written into an ASCII text file, exactly as you execute them through the Siebel Server Manager, and used as a batch input file by running srvrmgr by using the /i or -i flag. Running the batch input file is especially useful in the administration of similar Siebel Server component definitions for multiple Siebel Servers.

Note: You must have the Siebel Administrator responsibility to connect with the srvrmgr command-line tool.

The Siebel Server Manager commands are divided into the following categories:

Help. For more information, see Help Commands.
Environment. For more information, see Siebel Server Manager Environment Commands.
List. For more information, see List Commands and List Command Configuration.
Server group management. For more information, see Server Group Management Commands.
Siebel Server management. For more information, see Siebel Server Management Commands.
Component group definition. For more information, see Component Group Definition Commands.
Component definition. For more information, see Component Definition Commands and Reconfiguring Component Definition Commands.
Component management. For more information, see Component Management Commands.
Task management. For more information, see Task Management Commands.
Parameter management. For more information, see Parameter Management Commands.
Named subsystem management. For more information, see Named Subsystem Management Commands.
System alert notification. For more information, see System Alert Notification Commands.
List definition. For more information, see List Definition Commands and List Parameter Override Commands.
Event logging. For more information, see Event Logging Commands.
Preferences. For more information, see Server Manager Command-Line Preferences.

Command Syntax

This topic lists the command-line syntax and usage for Siebel Server Manager commands.

Component names and parameter names used in the command-line interface differ from the Siebel Server Manager GUI. To get the actual component and parameter names used in the command-line interface, use the list commands. For information about using the list commands, see List Commands.

For user-defined values such as siebel_server_name, component_alias_name, and parameter_alias_name, you must enclose these values in quotes if the value:

Contains spaces
Is a keyword such as server or component that you do not want to be parsed

For example, you must enclose the Siebel Server name in double quotes for the following command, because the Siebel Server name contains a space:

start task for component EIM server "North America" with Config=default.ifb

Note: If a srvrmgr command contains nested quotes, that is, quotes contained within quotes, then precede the inner quotes by the backslash escape character (\).

Help Commands

Use the Help command for Siebel Server Manager to retrieve a list of commands or obtain help on a specific command.

To obtain help

Enter the following command:
```
help
```
For help for a specific command, enter a command like the following:
```
help command
```

Siebel Server Manager Environment Commands

Use environment commands to set the Siebel Server Manager environment variables, which control the current Siebel Server Manager session.

To set the current working Siebel Server

Enter the following command:
```
set server siebel_server_name
```
This command works only if you did not specify a Siebel Server when executing the srvrmgr program using the -s flag.

To unset (clear) the current working Siebel Server

Enter the following command:
```
unset server
```
This command works only if you did not specify a Siebel Server when executing the srvrmgr program using the -s flag.

To show the environment variables

Enter the following command:
```
show
```

To show an individual environment variable

Enter the following command:
```
show variable_name 
```

To spool output to a file

Enter the following command:
```
spool output_file
```

To stop spooling to a file

Enter the following command:
```
spool off
```

To read commands from a file

Enter the following command:
```
read input_file
```

To refresh the Siebel Enterprise Server connections

Enter the following command:
```
refresh enterprise
```
The refresh enterprise command closes all of the connections to the existing Siebel Servers and creates new connections to these servers.

To remove header and footer information from srvrmgr command-line output

Enter the following command:
```
set header false
```
and
```
set footer false
```
Removing the header and footer information is useful if you are trying to parse the output of srvrmgr commands.

To add header and footer information to the srvrmgr command-line output

Enter the following command:
```
set header true
```
and
```
set footer true
```

To exit the srvrmgr program

Enter the following command:
```
exit
```
To save any configuration changes prior to exiting, use a backup command listed in Siebel Server Management Commands.

List Commands

Use the list command to display current data only. This command does not change any data.

To list available Siebel Servers

Enter the following command:
```
list servers
```

For a component, enter the following command:

list servers for component component_alias_name

For a component group, enter the following command:

list servers for component group component_group_alias_name

To list component groups

For all component groups, enter the following command:
```
list component groups
```
For a particular Siebel Server, enter the following command:
```
list component groups for server siebel_server_name
```
If you are connected to the Siebel Server, then this list command list only component groups from shared memory. Otherwise, it lists the component groups assigned to that Siebel Server from the Siebel Gateway. See also the describe command in Component Group Definition Commands.

To list current component group status

For all instances of the component group, enter the following command:
```
list component group component_group_alias_name
```

For a particular Siebel Server, enter the following command:

list component group component_group_alias_name for server siebel_server_name

To list current component status

For all components, enter the following command:
```
list component
```
For all instances of the component, enter the following command:
```
list component component_alias_name
```
For a particular Siebel Server, enter the following command:
```
list component for server siebel_server_name
```
For a particular task, enter the following command:
```
list component for task task_number
```
To list values for a particular task, you first must set the current working Siebel Server by using the set server command. For information about this command, see Siebel Server Manager Environment Commands.

To list subsystems

For all subsystems, enter the following command:
```
list subsystem
```

To list named subsystems

For all named subsystems, enter the following command:
```
list named subsystem
```

For a particular subsystem, enter the following command:

list named subsystem for subsystem subsystem_alias_name

For a particular Siebel Server, enter the following command:
```
list named subsystem for server siebel_server_name
```

To list current processes

To list the status of current tasks, enter the following command:
```
list processes
```
For all tasks, enter the following command:
```
list tasks
```
For a particular Siebel Server, enter the following command:
```
list tasks for server siebel_server_name
```
For a particular component, enter the following command:
```
list tasks for component component_alias_name
```
For a particular component group, enter the following command:
```
list tasks for component group component_group_alias_name
```
For a particular task, enter the following command:
```
list task task_number
```
To list values for a particular task, you first must set the current working Siebel Server by using the set server command. For information about this command, see Siebel Server Manager Environment Commands.

Note: The number of tasks returned is determined by the Maximum Tasks parameter for that component. For more information about the Maximum Tasks parameter, see Siebel Enterprise, Server, and Component Parameters.

To list tasks for session mode components

For a particular Siebel Server, enter the following command:
```
list sessions for server siebel_server_name
```
For a particular component, enter the following command:
```
list sessions for comp component_alias_name
```
For a particular Application Object Manager login, enter the following command:
```
list sessions for login object_manager_login
```

For a list of hung tasks, enter the following command:

list hung sessions for server siebel_server_name [or] comp component_alias_name
[or] login object_manager_login

For a list of active tasks, enter the following command:

list active sessions for server siebel_server_name [or] comp component_alias_name
[or] login object_manager_login

To list current parameter values

For the Siebel Enterprise Server, enter the following command:
```
list ent param
```
For all Siebel Servers, enter the following command:
```
list parameters
```
For a particular Siebel Server, enter the following command:
```
list parameters for server siebel_server_name
```
For a particular component on all Siebel Servers, enter the following command:
```
list parameters for component component_alias_name
```
For a particular component on a particular Siebel Server, enter the following command:
```
list parameters for component component_alias_name server siebel_server_name
```

For a particular task, enter the following command:

list parameters for task task_number server siebel_server_name

To list current advanced parameter values

Use the previously documented commands for listing parameters, but preface advanced before parameters. For example:
```
list advanced parameters for server siebel_server_name
```

To list current state values

For all state values, enter the following command:
```
list state values
```
For a particular Siebel Server, enter the following command:
```
list state values for server siebel_server_name
```
For a particular task, enter the following command:
```
list state values for task task_number
```
To list values for a particular task, you first must set the current working Siebel Server by using the set server command. For information about this command, see Siebel Server Manager Environment Commands.

To list current statistic values

For all statistics, enter the following command:
```
list statistics
```
For a particular Siebel Server, enter the following command:
```
list statistics for server siebel_server_name
```
For a particular component, enter the following command:
```
list statistics for component component_alias_name
```
For a particular task, enter the following command:
```
list statistics for task task_number
```
To list values for a particular task, you first must set the current working Siebel Server by using the set server command. For information about this command, see Siebel Server Manager Environment Commands.

List Command Configuration

The following commands modify or configure the output for the list commands described in List Commands.

To modify the output of an individual list command

To display specific columns, enter the following command:

list list_object
show column_1, column_2, ..., column_n

For example:

list components show SV_NAME, CC_ALIAS

To display specific columns with a for clause, enter the following command:

list list_object
 for for_object
 show column_1, column_2, ..., column_n

For example:

list components for SRVR_1 show CC_ALIAS

To list available columns for a list command

Enter the following command:
```
configure list list_object
```

To configure the output of the list command

To display only specific columns, enter the following command:
```
configure list list_object
 show column_1, column_2, ..., column_n
```
This command changes future list list_object commands to display only those columns defined.

Note: Once you configure a specific list command for a given srvrmgr session, it cannot be configured again in that session. A new session must be started to view other columns for that list command.

Server Group Management Commands

Use the server group management commands to manage the assignment of Siebel Servers with server groups. A Siebel Server can only be assigned to one server group at a time. A server group can contain many Siebel Servers.

Once you assign Siebel Servers to a server group, you can specify the server group name as a parameter for the /z or -z flag when starting the srvrmgr program. Specifying the server group connects the srvrmgr program to all of the Siebel Servers assigned to the specified server group.

For example, on a Windows server, enter a command like the following:

srvrmgr /g gateway1 /e enterprise1 /z server_group_name /u sadmin /p pwd

On a UNIX server, enter a command like the following:

srvrmgr -g gateway1 -e enterprise1 -z server_group_name -u sadmin -p pwd

For more information about starting the srvrmgr program, see Starting the Siebel Server Manager Command-Line Interface.

To assign a Siebel Server to a server group

Enter the following command:

change attribute groupname=server_group_name for server siebel_server_name

To unassign a Siebel Server from a server group

Enter the following command:
```
change attribute groupname=" " for server siebel_server_name
```
Note: Make sure to include a space between the quotation marks.

Siebel Server Management Commands

Use the Siebel Server management commands to start or stop a Siebel Server.

To start a Siebel Server

Enter the following command:
```
startup appserver siebel_server_name
```

To shut down a Siebel Server

Enter the following command:
```
shutdown appserver siebel_server_name
```

Component Group Definition Commands

Use these commands to create, delete, assign, remove, enable, and disable component groups.

To create a component group

Enter the following command:

create component group component_group_alias_name full name "descriptive_name"
description "description_of_component_group"

To assign a component group to a Siebel Server

Enter the following command:

assign component group component_group_alias_name to server siebel_server_name

To unassign a component group from a Siebel Server

Enter the following command:
```
unassign component group component_group_alias_name from server siebel_server_name 
```
Caution: Unassigning a component group from a Siebel Server results in a loss of component group customization, for example, parameter settings. Before unassigning a component group, review About Assigned and Unassigned Component Group.

To enable a component group for the Siebel Enterprise Server

Enter the following command:

enable component group component_group_alias_name

Stop and restart the system service to make the changes take effect.
For more information about how to stop or start the Siebel Server system service, see Administering the Siebel Server System Service.

This procedure works only if you did not run Siebel Server Manager command-line interface using the /s or -s flag.
Note: Before you enable a component group for the Siebel Enterprise Server, at least one component in the group must be active.

To enable a component group on a Siebel Server

Enter the following command:

enable component group component_group_alias_name to server siebel_server_name

Stop and restart the system service to make the changes take effect.

For more information about how to stop or start the Siebel Server system service, see Administering the Siebel Server System Service.
Note: Use this command when enabling a component that was previously disabled on a particular server. Newly created component groups are enabled by default.

To disable a component group for the Siebel Enterprise Server

Enter the following command:

disable component group component_group_alias_name

Stop and restart the system service to make the changes take effect.
For more information about how to stop or start the Siebel Server system service, see Administering the Siebel Server System Service.

To disable a component group for a Siebel Server

Enter the following command:

disable component group component_group_alias_name for server siebel_server_name

Stop and restart the system service to make the changes take effect.
For more information about how to stop or start the Siebel Server system service, see Administering the Siebel Server System Service.

To list component groups from the Siebel Gateway

Enter the following command:
```
describe component group
```
The describe command lists the component groups from the Siebel Gateway.

To remove a component group from a Siebel Server

Enter the following command:

remove component group component_group_alias_name from server siebel_server_name

To delete a component group

Enter the following command:
```
delete component group component_group_alias_name
```
In order for you to delete a component group, the component group cannot contain any server components or component definitions.

Component Definition Commands

Use the component definition commands to create, activate, or delete defined components. Component definitions are contained in component groups, both of which are defined at the Siebel Enterprise Server level. To use a new component, make sure that the component definition is activated and the component group containing the new component is assigned to the appropriate server. For component group commands, see Component Group Definition Commands.

Note: When working with component definition commands, start and run the srvrmgr program for the enterprise. That is, do not start srvrmgr with the /s or -s flag and do not run the command set server.

To create a new component

Enter the following command:

create component definition component_alias_name for component type existing_component_type_alias_name
component group existing_component_group_alias_name
run mode run_mode
full name "component_full_name"
description "description_of_component"
with parameter parameter_alias_name=value
fixparam fixed_parameter_alias_name=fixed_value

The run mode options are:

Batch
Interactive
Background

The component alias must be unique across the enterprise. The length of the alias name is dependent on the operating system.

You must enclose in quotes any keywords that you use in the component description, such as the keywords for or component. The alias or short name is required for the component group that you specify for this component definition. For a list of existing component groups and their corresponding aliases, see Siebel Server Components. For more information about component types, see About Server Component Types.

After running the create command, use the activate component definition command to enable the component definition at the enterprise, component definition level, and to enable and assign the component to the component group that you created. This action only occurs if the component definition is in the creating state. If the component definition is not in the creating state, then the command only enables the component definition at the enterprise level.

To activate a component definition

After defining the component, activate the defined component by entering:
```
activate component definition component_alias_name
```
Note: If you receive an error when attempting to activate a new component definition, then make sure that you did not start the srvrmgr command-line interface program by using the /s or -s flag, which targets only a specific server.

To deactivate a component definition

Enter the following command:

deactivate component definition component_alias_name

To delete a component definition

Enter the following command:

delete component definition component_alias_name

To copy a Siebel Server component definition

Enter the following command:

copy compdef from source_comp_def_alias to target_comp_def_alias

Reconfiguring Component Definition Commands

To reconfigure component definitions, you must start the component reconfiguration, make the necessary configurations (for parameter configuration, see Parameter Management Commands), and then commit the reconfiguration. See the following procedures for these commands.

Caution: Review the background information about component definition reconfiguration before performing this task. For more information, see Reconfiguring Siebel Server Component Definitions.

To start a component definition reconfiguration

Enter the following command:
```
reconfig compdef component_alias_name
```

To commit a component definition reconfiguration

Enter the following command:

commit reconfig compdef component_alias_name

To cancel a component definition reconfiguration

Enter the following command:

cancel reconfig compdef component_alias_name

Component Management Commands

Use component management commands to start or shut down Siebel Server components.

The startup systemcomps, shutdown systemcomps, startup systemauxcomps, shutdown systemauxcomps, startup nonsystemcomps, and shutdown nonsystemcomps commands manage the components in the System Management (alias System) component group or the Auxiliary System Management (alias SystemAux) component group, as follows:

The components in the System component group include Server Manager, Server Request Broker, and Siebel Connection Broker.
The components in the SystemAux component group include File System Manager, Server Request Processor, Server Tables Cleanup, and Siebel Administrator Notification Component.

To start a Siebel Server component

Enter the following command:

startup component component_alias_name for server siebel_server_name

To shut down a Siebel Server component

Enter the following command:

shutdown component component_alias_name for server siebel_server_name

To configure a Siebel Server component to start automatically

Enter the following command:

auto start comp component_alias_name for server siebel_server_name

To start a Siebel Server component manually

Enter the following command:

manual start comp component_alias_name for server siebel_server_name

To start Siebel Server components for the System component group

Enter the following command:

startup systemcomps for server siebel_server_name

To shut down Siebel Server components for the System component group

Enter the following command:

shutdown systemcomps for server siebel_server_name

To start Siebel Server components for the SystemAux component group

Enter the following command:

startup systemauxcomps for server siebel_server_name

To shut down Siebel Server components for the SystemAux component group

Enter the following command:

shutdown systemauxcomps for server siebel_server_name

To start Siebel Server components for all components except those in the System or SystemAux component group

Enter the following command:

startup nonsystemcomps for server siebel_server_name

To shut down Siebel Server components for all components except those in the System or SystemAux component group

Enter the following command:

shutdown nonsystemcomps for server siebel_server_name

Task Management Commands

Use task management commands to manage tasks for components running in batch or background mode.

You can start a new process by using the start task command or the run task command. Use the start task command if you plan to start multiple processes and use the run task command if you want to make sure that a process has run to completion.

The following are the two task management commands:

Start task. The start task command starts a new process and allows you to execute a new command immediately. You are not notified of the task status, nor are you alerted if the task fails to perform. Instead, use the list task command to check the status of processes that were started by using the start task command.
Run task. The run task command starts a new process that runs to completion (or exits with an error). You cannot execute a new command until the process has run to completion. The task status is displayed as the process is running.
To use multiple task parameters in a task command, list the parameters in a comma-separated list. The following example shows how to start a new process using various values for a given parameter:
```
start {task | server} for component component_alias_name with parameter_alias_
name=value1, value2, value3
```

To start a new task in batch mode

Enter the following command:

start task for component component_alias_name server siebel_server_name with 
parameter_alias_name1=value1, parameter_alias_name2=value2

This command starts a new task in batch mode and returns to the Siebel Server Manager immediately.

To start a new task in background mode

Enter the following command:

start server for component component_alias_name server siebel_server_name with 
parameter_alias_name1=value1, parameter_alias_name2=value2

This command starts a new task in background mode and returns to the Siebel Server Manager immediately.

To run a new task in batch mode

Enter the following command:

run task for component component_alias_name server siebel_server_name with 
parameter_alias_name1=value1, parameter_alias_name2=value2

This command runs a new task in batch mode to completion before returning to the Siebel Server Manager.

To pause a running task

Enter the following command:
```
pause task task_ID for server siebel_server_name
```
Note: Only tasks from certain component types can be paused. For a list of these component types, see Pausing a Siebel Server Task.

To resume a paused task

Enter the following command:

resume task task_ID for server siebel_server_name

To stop a running task

Enter the following command:

stop task task_ID for server siebel_server_name

To terminate a running task using the kill command

Enter the following command:
```
kill task task_ID for server siebel_server_name
```
The kill task command signals the Siebel Server to use operating system control to terminate the task. This command replicates the GUI procedure of clicking Menu and then Stop Task three times in succession on a running task.

Parameter Management Commands

Use the parameter management commands to change the values of a parameter.

To change an enterprise parameter

Enter the following command:

change ent param parameter_alias_name1=value1, parameter_alias_name2=value2

To change a component definition parameter

Enter the following command:

change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for compdef component_definition_name

To change a component type parameter

Enter the following command:

change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for comptype component_type_name for server siebel_server_name

To change a Siebel Server parameter

Enter the following command:

change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for server siebel_server_name

To change a component parameter

Enter the following command:
```
change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for 
component component_alias_name server siebel_server_name
```
Note: If you started srvrmgr with the /s or -s flag, then you do not have to include server siebel_server_name for this command.

To change a task parameter

Enter the following command:
```
change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for 
task task_number
```
Note: After a server, component, or named subsystem parameter is modified, it ignores future parameter changes at higher levels. That is, future parameter changes at higher levels in the hierarchy do not cascade down to lower levels. Use the following commands to delete overrides and reinstate this functionality.

To delete an enterprise parameter override

Enter the following command:

delete enterprise parameter override param parameter_alias_name

To delete a Siebel Server parameter override

Enter the following command:

delete parameter override for server siebel_server_name param "parameter_alias_name"

To delete a named subsystem parameter override

Enter the following command:

delete parameter override for named subsystem named_subsystem_alias_name param "parameter_alias_name"

To delete a server component parameter override

Enter the following command:

delete parameter override for comp component_alias_name server siebel_server_name param "parameter_alias_name"

To delete a server component definition parameter override

Enter the following command:

delete parameter override for compdef component_alias_name param "parameter_alias_name"

Named Subsystem Management Commands

Use named subsystem management commands to create, delete, and modify named subsystems. For more information about named subsystems, see About Named Subsystem Parameters and Application Object Manager Named Subsystem Parameters.

To create a new named subsystem

Enter the following command:

create named subsystem named_subsystem_alias_name for subsystem subsystem_alias_name with parameter_alias_name1=value1, parameter_alias_name2=value2

To delete a named subsystem

Enter the following command:

delete named subsystem named_subsystem_alias_name

To list all named subsystem parameters

For a particular named subsystem, enter the following command:

list parameters for named subsystem named_subsystem_alias_name

To list a particular named subsystem parameter

Enter the following command:

list parameter parameter_alias_name for named subsystem named_subsystem_alias_name

To modify one or more named subsystem parameters

Enter the following command:

change parameter parameter_alias_name1=value1, parameter_alias_name2=value2 for named subsystem named_subsystem_alias_name

System Alert Notification Commands

Use the following commands to configure system alert notification for server components. For more information about system alert notification, see About System Alert Notification.

To troubleshoot any problems with system alert notification, see Troubleshooting System Alert Notification.

To set the administrator email address

Enter the following command:
```
change param AdminEmailAddress=Admin_Email_Address for named subsystem AdminEmailAlert
```
where Admin_Email_Address is the email address that receives the alert notification email.

To set the SMTP host and port number used for email notifications

Enter the following command:
```
change param SMTPServer=SMTP_Server for named subsystem AdminEmailAlert
```
where SMTP_Server is the email server that routes the alert notification email.

To set the From email address

Enter the following command:
```
change param FromAddress=Server_Email_Address for named subsystem AdminEmailAlert
```
where Server_Email_Address is the email address that sends the alert notification email.

To test the system alert notification

Enter the following command:
```
start task for comp AdminNotify server Siebel_Server_Name
```
where Siebel_Server_Name is the name of the Siebel Server that hosts the AdminNotify server component.

List Definition Commands

Use list definition commands to list definitions for components, parameters, state values, and statistics.

To list component definitions

For a particular component, enter the following command:

list component definitions for component component_alias_name

For a particular task, enter the following command:
```
list component definitions for task task_number
```

List Parameter Override Commands

Use list parameter override commands to list parameter overrides for an enterprise, a Siebel Server, a component, a component definition, or a named subsystem.

For more information about parameter overrides, see About the Siebel Enterprise Server. See also Deleting System Parameter Overrides.

To list parameters for the enterprise

Enter the following command:
```
list entparam overrides
```

To list parameters for a Siebel Server

Enter the following command:

list param overrides for server siebel_server_name

To list parameters for a component

Enter the following command:

list param overrides for comp component_alias_name server siebel_server_name

To list parameters for a component definition

Enter the following command:

list param overrides for compdef component_definition_alias_name

To list parameters for a named subsystem

Enter the following command:

list param overrides for named subsystem named_subsystem_alias_name

To list parameters for component definitions

Enter the following command:

list param overrides for component component_alias_name

Event Logging Commands

Use the event logging commands to list event types for components and to change the values for event log levels. For more information about event logging, see Siebel System Monitoring and Diagnostics Guide.

To list event types

Enter the following command:

list evtloglvl for component component_alias_name

To change the event log level for a component

Enter the following command:

change evtloglvl event_alias_name=level for component component_alias_name

To change the event log level for a component on a Siebel Server

Enter the following command:

change evtloglvl event_alias_name=level for server siebel_server_name component component_alias_name

To change the event log level for a Siebel Server

Enter the following command:

change evtloglvl event_alias_name=level for server siebel_server_name

Server Manager Command-Line Preferences

You can create aliases for commands and configure list commands to return specific columns. These can be saved in a preferences file which is available to load the next time that you open a Siebel Server manager session. The preferences file is stored in the same directory as the Server Manager program. For the location of the Server Manager program, see Starting the Siebel Server Manager Command-Line Interface.

To create an alias for a command

Enter the following command:
```
alias alias command_name
```
For example, the following command creates an alias lc for the command list components:
```
srvrmgr> alias lc list components
```

To delete an alias for a command

Enter the following command:
```
unalias alias
```

To list the columns returned for a list command

Enter the following command:
```
configure list_command
```

To configure a list command to show specific columns

Enter the following command:
```
configure list_command show column1, column2, column3...
```
For example, the following command configures the list components command to return the component name column only.
```
srvrmgr> configure list components show CC_NAME
```

To configure a list command to show all columns

Enter the following command:
```
configure list_command show all
```
For example, the following command configures the list components command to return all columns.
```
srvrmgr> configure list components show all
```
Note: The columns that are returned might not contain useful data. However, by using subsequent commands, you can specify which columns to display.

To save preferences

Enter the following command:
```
save preferences
```
Preferences are saved in the same directory as the Server Manager program.

To load preferences

Enter the following command:
```
load preferences
```