This appendix describes LSMS and certain third-party application commands used to manage the LSMS. Third-party commands identify their software source. All other commands in this appendix are LSMS commands.
All commands in this appendix are case-sensitive and are entered at the command-line prompt. After entering a command, you must press the Enter key. When the command has executed, you can enter another command.
This appendix uses the following syntax notational conventions for commands entered at the command-line prompt:
Keywords - identify the principal action to be performed by the system.
Permission - identifies the group to which the user must belong to execute the command, or for certain commands, whether the user must be logged in with a particular user name. The possible groups are lsms as primary group, or secondary groups lsmsadm, lsmsuser, lsmsuext,lsmsview, and lsmsall (all users defined to be a member of one of these secondary groups should have lsms defined as their primary group). For more information about primary and secondary group definitions, see Managing User Accounts.
Restrictions - note restrictions or limitations applying to the use of the command.
Syntax - identifies the command’s keywords, options (if any), parameters, and their proper order. In syntax, the following symbols are used:
<xxx> indicates a variable
[xxx] indicates a parameter or option that is optional
{xxx|yyy} indicates a mandatory parameter; you must specify one of the values shown (in this case xxx or yyy)
Options - tell the operating system how to perform a command. Options are also known as switches.
Parameters - further define the command’s operation.
Sample Output - is an example of typical output produced by the command.
Environment - identifies any special environment variables or condition that must exist on the system for the process to execute. All commands use only default environment variables, with the exception of start_mgui, which requires setting the $DISPLAY environment variable.
Response Notes - identifies any pertinent command performance information.
Related Commands - identifies other commands or programs related to this command.
Files - identifies, describes, and provides the location of the configuration files required for proper execution of this command.
The following is an example of an LSMS command entry:
$ $LSMS_DIR/resync_db_setup create
The environment variable is $LSMS_DIR, the directory containing the LSMS software. It is followed by the keyword resync_db_setup (command for creating or removing the resynchronization database). A single parameter is given for this command, create (indicates the resynchronization database is to be created). This command has no options.