getState

Purpose

Use this command to retrieve information about the status of an SAG.

Because this command is always executed in synchronous mode, you receive a response only after the SAG attempts to execute the command. The response indicates whether the command was successfully executed.

Required access rights:
CT:  DnfSAGopcfg
CO: <SAG name>
attr: getState
Predefined roles that provide required access rights:
SagOperator
Issue for OU: DNFSYSOU
Issue to service: DNFSAGOP

Format

Read syntax diagramSkip visual syntax diagramgetStategs-sagsag-levelSystem-levelOverview-levelDetailed

Parameters

-sag sag
Name of the SAG.
-level
The level of detail. Possible values:
System
Shows the overall status of the SAG. This is the default.
Overview
Shows the status of the SAG on a component level.
Detailed
Shows the status of the SAG on a process level.
Note: For compatibility reasons, the following values can still be specified for the -level parameter:
PlugIn
This value is mapped to the value Overview.
Executable
This value is mapped to the value Detailed.

Examples

The following command checks the overall status of SAG1:
INST1.DNFSYSOU.DNFSAGOP>gs -sag SAG1
The command returns output similar to this:
DNFS1718I System state is 'started'.
The following command displays an overview of the status of the components of SAG1.
INST1.DNFSYSOU.DNFSAGOP>gs -sag SAG1 -level Overview
The command returns output similar to this:
DNFS1719I SWIFTNet Interface (SI) is 'started'.
DNFS1719I File Transfer Interface (FTI) is 'started'.
DNFS1719I SWIFTAlliance Gateway kernel (KERNEL) is 'started'.
DNFS1719I Application Interface (AI) is 'started'.