NAME

      mxstatus - Displays or returns (via exit code) the current ready
      state of Systems Insight Manager

SYNOPSIS

      mxstatus [[[-w [-t minutes]] [-v]] | [-l] | [-h] | [-v]]

DESCRIPTION

      The mxstatus command may be used to determine if Systems Insight
      Manager is running and in a ready or accessable state. This command is
      primarily intended to be called from a SIM partner application that
      wants to perform some installation or upgrade process on the Systems
      Insight Manager CMS, and needs to know if all SIM communications
      interfaces are ready and accessable. SIM communications interfaces
      would include all SOAP APIs, CLIs and Portal URLs. Note that this
      command may also be invoked through the standard command line
      interface and does support online usage help and a verbose mode to
      show operation progress.

      Note that the command supports two main modes of operation. A WAIT
      mode and a NOWAIT mode.

      When used in WAIT mode, the command will not return to the caller
      until Systems Insight Manager is determined to be in a ready state or
      the internal safety timeout period has expired. This mode alleviates
      the calling application the burden of providing the same
      looping/checking process as provided by the command's internal WAIT
      loop process. The WAIT mode is enabled by using the -w option.

      When used in NOWAIT mode, the command will return immediately to the
      caller with the current ready/not-ready state of System Insight
      Manager. The command will not block, regardless of the state of SIM.
      This mode then allows the calling application to provide its own
      looping and waiting process, if so desired. The NOWAIT mode is the
      default mode of operation for the command.

      Also note that in normal operation, this command will not display any
      textual information via STDOUT.  The calling application must check
      the exit code that is returned by mxstatus to determine SIM
      running/ready state.  See the section below labeled RETURN VALUE for
      valid mxstatus exit values. Do note however, that mxstatus will
      display progress and SIM running/ready information if the '-v' verbose
      option is used.

OPTIONS

      mxstatus supports the following options:

      -w   The WAIT option forces the command to wait or block (not return
	   to caller) until Systems Insight Manager is in a ready state, or
	   a default or specified safety timeout period has expired.  If the
	   -w option is not provided, then the normal default behavior for
	   the command is the NOWAIT mode, whereby the command will return
	   immediately to the calling application with the current SIM
	   ready/not-ready state.

      -t   The TIMEOUT option may be used to specify a safety timeout period
	   that will be utilized when the -w Wait option is used.  The
	   safety timeout provides a way for the command to return to the
	   calling application in case Systems Insight Manager never reaches
	   a ready state - i.e. SIM is actually not running.  The -t option
	   requires an integer argument which specifies the timeout to be
	   used, in minutes.  If the -t option is not provided, the default
	   timeout period that the command will use is 30 minutes.

      -v   The VERBOSE option may be used to enable verbose mode which
	   forces the command to print progress messages to the console
	   (stdout), while the command is running.  This option is provided
	   for command line use and would only be beneficial for SIM partner
	   developers who may have the need to determine the command
	   behavior by manual command line invocation.

      -l   The LIST option is also intended for command line usage and will
	   force the command to print/display the current Systems Insight
	   Manager ready/non-ready state to the console.  Note that when the
	   LIST option is used, mxstatus will run in the NOWAIT mode to
	   determine and print the current SIM ready/non-ready state.

      -h   The HELP option prints the command usage help to the console.

RETURN VALUE

      Upon completion, mxstatus returns:

      0	   All Systems Insight Manager communications interfaces are in a
	   ready or accessable state.

      1	   All or some Systems Insight Manager communications interfaces are
	   not ready or accessable.

COMMAND USAGE EXAMPLES

      The command below checks for current SIM ready/not-ready state in
      NOWAIT mode.

      mxstatus

      The command below checks for current SIM ready/not-ready state in WAIT
      mode.

      mxstatus -w

      The command below checks for current SIM ready/not-ready state in WAIT
      mode with a specified timeout value of 3 minutes.

      mxstatus -w -t 3

      The command below checks for current SIM ready/not-ready state in
      NOWAIT mode with verbose mode enabled.

      mxstatus -v

      The command below checks for current SIM ready/not-ready state in WAIT
      mode with verbose mode enabled.

      mxstatus -w -v

      The command below checks for current SIM ready/not-ready state in WAIT
      mode with a specified timeout value of 3 minutes with verbose mode
      enabled.

      mxstatus -w -t 3 -v

      The command below will display current SIM ready/not-ready state.

      mxstatus -l

      The command below will display usage help.

      mxstatus -h

AUTHOR

      mxstatus was developed by the Hewlett-Packard Company.

SEE ALSO for HP-UX

      mxstatus(1M)

SEE ALSO for Linux

      mxstatus(8)