sagcc get monitoring

DEPRECATED. Replaced by the sagcc get monitoring state command. Retrieves the run-time statuses, run-time states, or states of run-time components.

Run-time status indicates whether a run-time component is running or not. Examples of a run-time status are ONLINE or STOPPED.

Run-time state indicates the health of a run-time component by providing (key performance indicators (KPIs) for the component. Each KPI provides information about the current use, marginal use, critical use, and maximum use. For example, a component might display a KPI for the amount of memory that would include the current memory use, when memory use is considered marginal, when memory use is considered critical, and the maximum memory use allowed.

State provides both the run-time status and the run-time state.

For a list and description of run-time statuses and run-time states for a specific run-time component, see information in this reference for the product with which the run-time component is associated.

Syntax

Command Central syntax:

sagcc get monitoring {runtimestatus | runtimestate | state} node_alias
componentid [options]

Platform Manager syntax:

sagcc get monitoring {runtimestatus | runtimestate | state} componentid
[options]

options:
[{--check-every | -c} seconds]
[{--debug | -d}]
[{--error | -r} file]
[{--expected-values | -e} values]
[{--format | -f} {tsv args | xml | csv args | json}]
[{--log | -l} file]
[{--output | -o} file]
[{--password | -p} password]
[{--quiet | -q}]
[{--server | -s} url]
[{--username | -u} user_name]
[{--wait | -w} seconds]

Arguments and Options

Argument or Option	Description
{runtimestatus \| runtimestate \| state}	Required. Specifies whether you want to retrieve run-time statuses, run-time states, or state.
node_alias	Command Central only. Required. Specifies the alias name of the installation on which the run-time component is installed. You can view a list of installations and their aliases using sagcc list landscape nodes.
componentid	Required for runtimestatus and rumtimestate. Not applicable for state. Specifies the ID of the run-time component for which you want to retrieve information. You can determine the IDs for run-time components using sagcc list inventory components.
[options]	Optional. Refer to the command syntax for a list of the options the command supports. For a description of the options, see Common Options.

Usage Notes

The following are general descriptions of run-time statuses:

FAILED when a run-time component failed, for example, ended unexpectedly.

NOT_READY when a run-time component is started, but not ready to accept client requests.

ONLINE when a run-time component is running.

PAUSED when a run-time component is paused.

STARTING when a run-time component is starting.

STOPPED when a run-time component is not running.

STOPPING when a run-time component is stopping.

UNKNOWN when the status cannot be determined.

UNRESPONSIVE when a run-time component is running, but is unresponsive.

Note:
A specific run-time component might support only a subset of the statuses.

Examples When Executing on Command Central

To retrieve the run-time status of the run-time component that has the ID “OSGI-SPM” and is installed in the installation with alias name “sag01” and have the output returned to the console in XML format:

sagcc get monitoring runtimestatus sag01 OSGI-SPM --format xml
--password secret

Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.

To initiate the shutdown of the Integration Server with the component ID “OSGI-IS” running in the installation “sag01”, then execute the sagcc get monitoring runtimestatus command to wait 60 seconds for the command to complete and return the expected results “STOPPED”, checking for results every 5 seconds:

sagcc exec lifecycle stop sag01 OSGI-IS --password secret

sagcc get monitoring runtimestatus sag01 OSGI-IS --expected-values STOPPED
--wait 60 --check-every 5 --password secret

Example When Executing on Platform Manager

To retrieve the state of the run-time component that has the ID “OSGI-SPM” and is installed in the installation that the Platform Manager server with host name “rubicon2” and port “8092”” manages, and have the output returned to the console in XML format:

sagcc get monitoring state OSGI-SPM --format xml
--server http://rubicon2:8092/spm --password secret

Because the {--username | -u} option is not specified, the command uses the default user name. For more information, see username. The command specifies “secret” for the user’s password.