Business Continuity Manager Web API Reference Guide

Version: 10.1.x
Audience: anonymous
Part Number: MK-96HC137-06
Published: 2026-05-04

Overview
Overview of BCM Web API
System configuration
Prerequisite conditions
Configuring environment settings for the BCM Web API
Designing storage
Configuring security settings
Creating a default parameter dataset
Creating BCM Web API log datasets
Creating a BCM Web API server startup procedure
Setting up z/OSMF
Configuring RACF settings for z/OSMF
Starting z/OSMF
Checking CEA startup
Registering plug-ins for API scripts
Configuring the BCM GUI for use
Installing Python
Installing the BCM GUI
Updating the BCM GUI configuration file
Installing a client certificate
Writing a CLI macro file
Verifying environment settings
Running BCM Web API requests
Running the BCM Web API
User authentication
Common specifications of the BCM Web API
Starting a TSO/E address space
Starting the BCM Web API server
Running Business Continuity Manager CLI commands by using the BCM Web API
Getting the results if the CLI command does not finish within the time limit or another CLI command is running
Stopping the BCM Web API server
Ending the TSO/E address space
Operations on configuration files
Format of BCM Web API requests that run CLI commands
CLI commands supported by the BCM Web API
YKBLDCMD (registers a command device)
YKBLDPTH (establishes logical paths)
YKBLDRMT (registers command devices for all routes)
YKBTSCAN (scans volumes)
YKDEFGRP (generates a copy group definition file)
YKDEFRMT (defines a route list)
YKDELCMD (deletes a command device)
YKDELCNF (deletes a configuration file)
YKDELETE (dissolves copy pairs)
YKDELPTH (deletes logical paths)
YKDELRMT (deletes route lists)
YKDEXCTG (deletes a journal group from EXCTG)
YKDROP (deletes loaded configuration files)
YKDSPRMT (outputs the statuses of routes and command devices)
YKENV (outputs Business Continuity Manager environment variables)
YKERCODE (outputs error code details)
YKEWAIT (waits for a copy group to reach a specified status)
YKEXPORT (outputs copy group information)
YKFCSTAT (gets FlashCopy information)
YKFENCE (sets and resets the soft fence, and getting the soft fence status)
YKGETDFL (outputs the values specified in the default parameter dataset)
YKGETGRP (gets copy group information)
YKGETHDA (loads the disk configuration definition file)
YKGETPTH (gets path set definitions)
YKIMPORT (inputs copy group information)
YKLISTID (displays a list of configuration file IDs)
YKLOAD (loads a configuration file)
YKMAKE (creates copy pairs)
YKQEXCTG (gets EXCTG information)
YKQHPATH (gets the I/O path status of a volume)
YKQRYDEV (gets volume information)
YKQRYPTH (gets the statuses of physical paths)
YKQRYRCD (gets remote command device information)
YKQUERY (displays the copy pair status)
YKRECVER (dissolves copy pairs from a secondary site)
YKRESYNC (resynchronizes copy pairs)
YKRMTCDV (registers or deletes a remote command device)
YKSTATS (gets the operating information of a journal group)
YKSUSPND (suspends copy pairs)
Responses of BCM Web API requests that run CLI commands
Format of the responses of BCM Web API requests that run CLI commands
Responses common to all CLI commands
Responses returned by YKBLDPTH or YKDELPTH
Responses returned by YKDELETE, YKMAKE, YKRECVER, YKRESYNC, YKSUSPND, or YKRMTCDV
Responses returned by YKDSPRMT
Responses returned by YKENV
Responses returned by YKERCODE
Responses returned by YKEWAIT
Responses returned by YKFCSTAT
Responses returned by YKFENCE
Responses returned by YKGETDFL
Responses returned by YKGETGRP
Responses returned by YKGETHDA
Responses returned by YKGETPTH
Responses returned by YKLISTID
Responses returned by YKLOAD
Responses returned by YKQEXCTG
Responses returned by YKQRYDEV
Responses returned by YKQRYPTH
Responses returned by YKQRYRCD
Responses returned by YKQUERY
Responses returned by YKSTATS
Return codes set by the BCM Web API server
How to run the BCM GUI
Functions provided by the BCM GUI
Starting and ending the BCM GUI
Updating the BCM GUI configuration file
How to start the BCM GUI
Ending the BCM GUI
How to check the BCM GUI version
Configuration of the BCM GUI window
Dashboard tab
cgSummary (copy group summary) tab
cgPair (copy group pair) tab
Ctg tab
Stats tab
Exctg tab
Action menu
Make Option dialog box
Suspend Option dialog box
Resync option dialog box
Delete confirmation dialog box
Recover confirmation dialog box
Device information window
CLI macro function
Overview of the CLI macro function
How to write a CLI macro file
Example of writing a CLI macro file
Configuration of the CLI macro window and execution method
Operation examples
Tasks for the operation examples
Diagram of the configuration used in operation examples
Creating default parameters
Creating a procedure for starting the BCM Web API server
Starting the BCM Web API server
Configuring an environment for the Remote DKC Control function
Getting volume information
Creating a logical path
Defining a copy group
Creating a copy group
Stopping the BCM Web API server
Troubleshooting
BCM Web API log
Information to collect and the output destination
Allocating BCM Web API log record datasets
Allocating the BCM Web API log control dataset
Writing to the log dataset
BCM Web API log format
z/OSMF logs
BCM GUI logs
Sample codes
List of sample codes and how to run them
bcmapi.py
bcmapi_test.py
bcmapi_remote.py
bcmapi_scan.py
bcmapi_cgdef.py
bcmapi_cgmake.py
Conventions in syntax explanations
Conventions in syntax explanations
Acronyms and Abbreviations

Back to home page