Event management common command options
Many commands use the same options that perform the same functions in each command. Additional options that are specific to the command are listed in the topic that is dedicated to that command.
Note
A few commands have command-specific options that override the common event management CLI command options listed in the following table. For example, the -p option for the mkb command, when executed from within the installationDirectory/pw/server/etc/CellName/kb/manifest.kb file, prints the contents of the installationDirectory/pw/server/etc/CellName/kb/manifest.kb file, rather than assigning the specified value (Value) to the option Var. If a command has an option that overrides the common option, the command-specific option is noted in the section, dedicated to that command.
The following table describes the common command options that apply to all event management commands.
Common options for event management CLI commands
Option | Description |
|---|---|
| Specifies a configuration file to use instead of the default installationDirectory/pw\server \etc\mclient.conf file |
| Displays help information, including syntax and options |
| Specifies home directory (HomeLocation) for the command if it is not specified with the installationDirectory/pw/server environment variable |
| Starts the cell named cellName (as defined in mcell.dir). For more information, see Using the -n option. Note Cell names on UNIX are case-sensitive. When entering the |
| Assigns the specified value (Value) to the option |
| Invokes quiet execution (no banner appears) |
| Activates verbose mode to display more information |
| Displays version information |
Using the -n option
To interact with another cell, a cell uses the installationDirectory/pw/server/etc/mcell.dir file, which maps cell names to a host name or to an IP address and port. With CLI commands, you can use the -n option to specify a cell by using either of the following formats that are used in the installationDirectory\pw\server\etc\mcell.dir file.
- Designate a cell name by specifying
-ncellName.
This format maps the cellName to the host, port, and encryption key in the mcell.dir file. - Designate the host, port, and encryption key by using
-n@Host[/Port[#Key]], whereHostis either a host name or an IP address.Portis the port number.Keyis the encryption key.
The importance of setting a valid encryption key when using the -n option
If you do not specify Key or Key and Port, the default values are applied. The default value for Key is 0, and the default value for Port is 1828.
Accepting the default value for Port means that your cell has to listen on port 1828, which is normally the case with the default installation procedure.
When a cell is installed, the default installation procedure sets Key to mc, instead of 0. Unless you change the encryption key to 0 during installation or afterward by manually editing the installationDirectory/pw/server/etc/mcell.dir file, you need to specify the encryption key explicitly. If you do not specify the encryption key, the CLI will not be able to connect to the cell.
For security purposes, you must set Key to a valid value other than the default.
Comments
Log in or register to comment.