Monitor service instances (optimcmd -monitor)

Use the Monitor service instances command to view a list of service instances or to view detailed information about a specific service instance.

Command structure

The following diagram indicates the structure of the command and its parameters.

Read syntax diagramSkip visual syntax diagram
>>-optimcmd--+- -monitor-+--+-connection=-+--connection_name---->
             '- -m-------'  '-cn=---------'                    

>--+-------------------------------------------------------------------------------------------------+-><
   +-+---------------------------+--+------------------------------+--+----------------------------+-+   
   | '-+-servicename=-+--service-'  '-+-enddatefrom=-+--mm-dd-yyyy-'  '-+-enddateto=-+--mm-dd-yyyy-' |   
   |   '-sn=----------'               '-edfrom=------'                  '-edto=------'               |   
   '-+-instanceid=-+--execution_id--+----------------------------------+-----------------------------'   
     '-iid=--------'                '-+-artifactname=-+--artifact_name-'                                 
                                      '-aname=--------'                                                  

Input

The following information can be entered with the command.

optimcmd
The optimcmd tool.
-monitor or -m
The Monitor service command.
connection=connection_name or cn=connection_name
The connection name of the Optim™ directory in which the service instances are located.
servicename=service or sn=service
The name of the service whose service instances you want to view.
enddatefrom=mm-dd-yyyy or edfrom=mm-dd-yyyy
The start of the range of dates whose service instances you want to view.
enddateto=mm-dd-yyyy or edto=mm-dd-yyyy
The end of the range of dates whose service instances you want to view.
instanceid=execution_id or iid=execution_id
The execution ID for the service instance that you want to view.
artifactname=artifactname or aname=artifactname
The name of the artifact that you want to view. Artifacts are XML or HTML files that contain more information about the service instance. Specify REPORT_HTML for a process report in HTML format or REPORT_RAW for a process report in XML format.

Output

The output depends on the parameters that you specify.
  • If you do not specify any parameters, the command returns a list of all service instances. Each line contains information for a service instance (the execution ID, the service ID, and the return code).
  • If you specify a service name, the command returns a list of service instances for the specified service name.
  • If you specify a range of end dates, the command returns a list of service instances whose end dates are in the specified range.
  • If you specify a service name and a range of end dates, the command returns a list of service instances for the specified service name and range of end dates.
  • If you specify an execution ID without an artifact name, the command returns detailed information about the service instance. The information includes the execution ID, the service ID, the start and end date, and the return code. The information also contains a list of artifacts that contain detailed information about the service instance.
  • If you specify an execution ID with an artifact name, the command returns the contents of the artifact. The artifact can be HTML or XML code.


Feedback