Common command options for Publishing Server CLIs

Many Publishing Server CLI commands use the same options to perform the same functions. This section describes the options that are common to multiple commands.

[-c <ConfigFile>] [-h|-?] [-i <User/Password>[@<Host>[/<Port>][,<Host>[/<Port>][,...]]] [-q] [-l <HomeLocation>] {-p "<Var>=<Value>"} [-r <RequestLogFile>] [-t ConnectionInitTimeout] [-u <RequestTimeout>] [-v] [-z]

The following table describes the common options for the Publishing Server CLI commands:

Publishing Server common CLI command options

Option Syntax

Description

-c ConfigFile

Specifies another configuration file to use instead of the default installationDirectory/pw/server/etc/pclient.conf file

-h, -?

Displays help information, including command syntax and options

-i User/Password[@Host [/Port][,Host[/Port] [,...]]]

Authenticates the specified user name and password with the BMC TrueSight Infrastructure Management Server running on the specified host computer and port; you can specify multiple hosts and ports

This option is optional if you run a CLI command on the BMC TrueSight Infrastructure Management Server host computer. However, if you do use this option for local authentication and the credentials that you provide are invalid, the command fails.

If IASServer and IASPort are set in the configuration file pclient.conf, then you do not have to pass the host and port with the -i option.

-l HomeLocation

Specifies a home directory other than installationDirectory/pw/server for the command

-p "Var=Value"

Sets an option (Var) to the specified value (Value); this option modifies and overrides a value defined in the configuration file

-q

Invokes quiet execution (no banner appears)

-r RequestLogFile

Retrieves the XML-formatted log file and stores it as RequestLogFile
By default, the location of the log file is relative to the directory where you run the CLI. If you provide only a file name, the file is created in the directory where you run the CLI. You can also provide the absolute path for the log file.

-t ConnectionInitTimeout

Specifies the length of time, in seconds, for the command to wait for a connection before terminating; default is 5 seconds

-u RequestTimeout

Specifies the length of time, in seconds, for the command request to wait for an answer before terminating; default is 3600 seconds

-v

Activates verbose mode to display more information (such as detailed failure messages)

-z

Displays version information and ends command

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*