YKSTATS (gets the operating information of a journal group)

Applies to Universal Replicator.

The command acquires journal group operating information from both the master journal and restore journal storage systems.

Request body format

{ "action":"submit",
   "cliname":"YKSTATS",
   "operands":"
     [GROUP(copy-group-ID)]
   "
}

Parameters specified in the request body

`GROUP(copy-group-ID)` ~ <GROUP string>

Specify the ID of the target copy groups that are loaded. If only one copy group is loaded, you can omit this parameter.

Notes

Before running the YKSTATS command, configure the following settings:
- For models other than VSP One B85:
  
  From Storage Navigator or Command Control Interface, specify as the collection target the control unit to which the journal volume used by the specified copy group belongs, and start the Usage Monitor after setting the information collection interval to within 10 minutes.
- For VSP One B85:
  
  Specify as the collection target the control unit to which the journal volume used by the specified copy group belongs, and start ExportTool2 after setting the information collection interval to within 10 minutes.
In order to obtain correct information, you must start Usage Monitor or ExportTool2 for the control unit containing the journal volumes used by the copy group. For models other than VSP One B85, use the Usage Monitor, and for VSP One B85, use ExportTool2.
Before using the YKSTATS command to obtain operating information, use the YKQUERY or YKEWAIT command to check if the copy pair status has been set. If no command is entered, a determination is made based on the copy group status for the YKQUERY or YKEWAIT command, and N/A might be displayed for operating information.

If the YKRESYNC command is used to change the copy direction of a Universal Replicator copy group and then the YKSTATS command is used to acquire the operating information of the copy group, the operating information before the change might be temporary acquired.

To acquire the latest operating information about the copy group, execute the YKSTATS command after Usage Monitor or ExportTool2 collects information for the first time after the change (that is, when the collection interval of Usage Monitor or ExportTool2 information has elapsed). For models other than VSP One B85, use the Usage Monitor, and for VSP One B85, use ExportTool2.

Responses

See Responses returned by YKSTATS.

Return code

If the CLI command has finished running, the return code of the CLI command is set in the rc key of the response. If an error occurs before the CLI command is run, the BCM Web API server sets the return code.

The following table lists and describes the return codes of the YKSTATS command.

Table. YKSTATS command return code list
Return code	Meaning
`-3`	The module cannot be loaded. Possible causes are as follows: The library dataset has not been linked. The module is protected by the RACF program control function.
`-1`	An interruption occurred during execution.
`0`	The command completed normally.
`32`	One or more I/O error was encountered. A change in an I/O configuration definition was detected.
`36`	Invalid or missing data in a REXX variable structure. The copy group specified in the `GROUP` parameter has not been loaded.
`40`	An error occurred while a REXX variable was being written.
`44`	Termination due to processing errors.
`48`	Termination due to invalid parameters.
`128`	The command terminated abnormally. Alternatively, the user does not have permission to execute this command.