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.
The following table describes the common command options that apply to all event management commands.
Common options for event management CLI commands
Option | Description |
|---|---|
-c ConfigFile | Specifies a configuration file to use instead of the default installationDirectory/pw\server \etc\mclient.conf file |
-h or ? | Displays help information, including syntax and options |
-i UserID[/Password][@Host[/Port]] | (Optional) Specifies that user authentication is required to execute the CLI |
-l HomeLocation | Specifies home directory (HomeLocation) for the command if it is not specified with the installationDirectory/pw/server environment variable |
-n cellName or -n @Host[/Port[#Key]] | Starts the cell named cellName (as defined in mcell.dir). For more information, see Using the -n option. |
-p Var=Value | Assigns the specified value (Value) to the option Var |
-q | Invokes quiet execution (no banner appears) |
-v | Activates verbose mode to display more information |
-z | 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]], where- Host is either a host name or an IP address.
- Port is the port number.
- Key is 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 BMC ProactiveNet 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 afterwards 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 enccryption 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.