The CLI commands supported by the BCM Web API are as follows.
Command |
Function |
---|---|
YKBLDCMD |
Registers the specified command device in the storage system. |
YKBLDPTH |
Establishes all or some of the inter-disk controller or inter-control unit logical paths included in the path set information loaded by the YKLOAD command. |
YKBLDRMT |
Registers, in the storage system, all command devices defined in routes that originate from the execution host in the specified route list. |
YKDEFGRP |
Generates a copy group definition file with no copy pair definitions, and sets the optional copy group attributes according to the input parameters. |
YKDEFRMT |
Generates a route list definition file and a definition file for command devices in the route according to the input parameters. |
YKDELCMD |
Deletes the specified command device from the storage system. |
YKDELCNF |
Deletes the configuration file specified in the input parameters. |
YKDELETE |
Dissolves copy pairs from a P-VOL and changes the volume status to the SIMPLEX status. |
YKDELPTH |
Deletes all or some of the inter-disk controller or inter-control unit logical paths included in the path set information loaded by the YKLOAD command. |
YKDELRMT |
Deletes, from the storage system, all command devices defined in routes that originate from the execution host in the specified route list. |
YKDEXCTG |
Dissolves a journal group from an EXCTG. |
YKDROP |
Deletes the configuration file that was loaded on the BCM Web API server by using YKLOAD. |
YKDSPRMT |
Outputs the specified route list and the definitions of the command devices that are referenced in the route list. |
YKENV |
Outputs the Business Continuity Manager environment variables. |
YKERCODE |
Outputs storage system sense byte information (error codes). |
YKEWAIT |
Monitors the copy pair status transition and waits for a certain specified status. |
YKEXPORT |
Outputs the contents of a copy group definition file to a CSV file. |
YKFCSTAT |
Acquires the FlashCopy® information of the specified volume. |
YKFENCE |
Sets the soft fence for, or resets the soft fence of, a volume in the specified copy group. In addition, this command acquires the soft fence status and the SPID fence status. |
YKGETGRP |
Displays the status of the copy pair or copy group. |
YKGETHDA |
Outputs values read from the disk configuration definition file. |
YKGETPTH |
Outputs values read from the path set definition file. |
YKIMPORT |
Reads a CSV file and creates a copy group definition file. |
YKLISTID |
Searches for configuration files that match the conditions specified in the input parameters. |
YKLOAD |
Loads, to the BCM Web API server, the configuration file. This allows you to run CLI commands that require the configuration file. |
YKMAKE |
Makes copy pairs by full copy and changes the volume status to the DUPLEX status. |
YKQEXCTG |
Acquires EXCTG information from the supervisor disk controller. |
YKQHPATH |
Displays the I/O path status between the host and the storage system. |
YKQRYDEV |
Displays and outputs information about the specified volume. |
YKQRYPTH |
Acquires the status of the physical paths allocated to all or some of the inter-disk controller or inter-control unit logical paths included in the path set information loaded by the YKLOAD command. |
YKQRYRCD |
Acquires the remote command device information (whether it is registered, LDEVID) for the journal group in the copy group. |
YKQUERY |
Outputs copy pair information. |
YKRECVER |
Dissolves copy pairs from an S-VOL and changes the volume status to the SIMPLEX status. |
YKRESYNC |
Resynchronizes a copy pair by differential copy and changes the volume status to the DUPLEX status. |
YKRMTCDV |
Registers or deletes the remote command device defined in the copy group for the journal group. |
YKSTATS |
Acquires the operating information for the specified copy group. |
YKSUSPND |
Suspends copy pairs and changes the volume status to the SUSPOP status. |
Copy types and targets for which commands can be executed
Each command has certain copy types and targets that it can execute. The copy types and targets for which commands can be executed are indicated by the following phrases after the command name:
-
ShadowImage: When the copy type is ShadowImage, the command is executable.
-
TrueCopy: When the copy type is TrueCopy (without the HyperSwap attribute), the command is executable.
-
TrueCopy with the HyperSwap attribute: When the copy type is TrueCopy with the HyperSwap attribute, the command is executable.
-
Universal Replicator: When the copy type is Universal Replicator, the command is executable.
-
CMD: The command is for operating command devices.
-
PTH: The command is for operating logical paths.
The (SI) ShadowImage, (TC) TrueCopy, TrueCopy with the HyperSwap attribute, and (UR) Universal Replicator abbreviations following a parameter name indicate the copy types for which that parameter is effective, independent of the copy type for which the command executes. Commands without ShadowImage, TrueCopy, TrueCopy with the HyperSwap attribute, or Universal Replicator abbreviations listed after them can be executed on any copy type.
If any one of the parameters in a command is not specified with the correct syntax, the parameter might be handled as a parameter that is similar to the incorrect specification. To prevent incorrect operation, make sure that you use the correct syntax when specifying parameters.