get_instance

Displays the procedure instance status identified by the GUID on the command line.

Format

emcli get_instance_status  
        -instance=<instance_guid> 
        [-exec=<execution_guid>] 
        [-name=<execution_name>] 
        [-owner=<execution_owner>] 
        [-xml [-details] [-showJobOutput [-tailLength=<last_n_characters>]]]

[ ]  indicates that the parameter is optional

Options

instance
Display the details of a procedure instance identified by the GUID number. You can find the GUID number by using the emcli get_instances command.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
xml
Shows the complete status of each of the steps in XML format.
details
Displays more details for the command output. This option also requires the -xml option.
showJobOutput
Shows the output or errors for the job execution steps. This option also requires the -xml option.
tailLength
Limits the number of characters in the job step output or error. This option also requires the -showJobOutput option.

<Last N Characters> is a positive non-zero number until which the characters are chosen from the end of the job step output. The system sets the maximum permissible characters to dump. If you do not provide this option, the maximum permissible characters are dumped.

Output Columns

GUID, Procedure Type, Instance Name, Status

Status Values

Possible status/return values are as follows:

SCHEDULED
EXECUTING
ACTION_REQUIRED
SUSPENDED_USER
FAILED
COMPLETED
STOPPED
SKIPPED C
OMPLETED_WITH_ERRORS

Examples

Example 1

This example shows procedure details in CSV format:

emcli get_instance_status -guid=12345678901234567890123456789012

Example 2

This example shows details in XML format with the last 1024 characters of output:

 emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -showJobOutput -tailLength=1024