YKIMPORT (inputs copy group information)

Applies to ShadowImage, TrueCopy, TrueCopy with the HyperSwap attribute, and Universal Replicator.

This command reads the following files and creates a copy group definition file:

• Pair information CSV file

  CSV file containing information about the copy pairs in the CG container

• EXCTG information CSV file

  CSV file containing information about the EXCTG in the CG container in a 4x4 configuration (This file is required only when a 4x4 configuration is used.)

• CTG information CSV file

  CSV file containing information about the CTG in the CG container in a Universal Replicator configuration (This file is required only when a Universal Replicator configuration is used.), or CSV file containing information about the remote command device to be registered for the journal group for Universal Replicator copy pairs in a Cascade or Multi-Target configuration with TrueCopy copy pairs (This file is required when a TrueCopy configuration is used.)

• Disk configuration definition file

• Copy group definition file

  Copy group definition file that defines attributes of a copy group to be created

Before running this command, allocate areas for the CSV file datasets and catalog the files.

Specify the CSV file dataset names for the operands key value parameter. For the CSV files to be input, in advance, use the z/OS dataset and file REST interface to transfer and save the files to the dataset specified for the operands key value parameter.

For details about CSV files, see the description "CSV files used by the copy group definition file generation function" in the Hitachi Business Continuity Manager Reference Guide.

Request body format

{"action":"submit",
"cliname":"YKIMPORT",
"operands":"[PREFIX(prefix)]
             △1BASEGROUP(copy-group-ID)
             △1NEWGROUP(copy-group-ID)
            [△1INPAIR(pair-information-CSV-dataset-name)]
            [△1INCTG(CTG-information-CSV-dataset-name)]
            [△1INEXCTG(EXCTG-information-CSV-dataset-name)]
            [△1CAPACITY({CHECK|NOCHECK})]
            [△1CFGUPDTE({INPLACE|REALLOC})]
            [△1STORCLAS(storage-class)]
            [△1VOLUME(volser)]
            [△1UNIT(device-type)]
            [△1AUTOPAIR] "
            }

Parameters specified in the request body

PREFIX(prefix) ~ <PREFIX string>

Specify the prefix of the copy group definition file.

Specify the copy group ID of the copy group that is to be used as the base.

Specify the copy group ID of the copy group that is to be created.

A new copy group definition file is created under the name specified in this parameter. To update an existing copy group definition file, specify the same name in the BASEGROUP and NEWGROUP parameters.

INPAIR(pair-information-CSV-dataset-name) ~ <dataset prefix>

Use the full dataset name (excluding the single quotation marks before and after the dataset name) to specify the name of the pair information CSV dataset to be input by the YKIMPORT command.

If you omit this parameter, the name used is .CSV.INPAIR concatenated with the value specified for the PREFIX operand. (If the PREFIX operand was omitted, the PREFIX parameter value of the default parameter is used.) Allocate the dataset name specified for this operand to the DD name INPAIR.

INCTG(CTG-information-CSV-dataset-name) ~ <dataset prefix>

Use the full dataset name (excluding the single quotation marks before and after the dataset name) to specify the name of the CTG information CSV dataset to be input by the YKIMPORT command. For Universal Replicator copy groups, you must specify this parameter. Allocate the dataset name specified for this operand to the DD name INCTG.

INEXCTG(EXCTG-information-CSV-dataset-name) ~ <dataset prefix>

Use the full dataset name (excluding the single quotation marks before and after the dataset name) to specify the name of the EXCTG information CSV dataset to be input by the YKIMPORT command. For Universal Replicator copy groups in an EXCTG configuration, you must specify this parameter. Allocate the dataset name specified for this operand to the DD name INEXCTG.

CAPACITY({CHECK|NOCHECK})

Specify whether to check the capacities of the P-VOL and S-VOL for the newly defined copy pair. The default is CHECK.

CHECK

Checks whether the capacities of the P-VOL and S-VOL of the defined copy pair match.

NOCHECK

Does not check whether the capacities of the P-VOL and S-VOL of the defined copy pair match. Specify this parameter when defining a copy pair for migration whose P-VOL and S-VOL capacities are different.

Specify the method for allocating the copy group definition file. The default value is INPLACE.

INPLACE

Creates the copy group definition file without creating a temporary file. If updating a copy group definition file that already exists, the file is overwritten.

REALLOC

Creates a temporary file and then creates a copy group definition file. If updating a copy group definition file that already exists, a new file is allocated.

Specify this parameter if you want to assign the configuration file to a specific storage class. If the file is going to be overwritten, this parameter will be disregarded.

Specify this parameter if you want to assign the configuration file to a specific volume. Only one volume can be specified. If the file is going to be overwritten, this parameter will be disregarded.

Specify this parameter if you want to assign the configuration file to a specific device type. If the file is going to be overwritten, this parameter will be disregarded.

Specify this parameter to use the automatic pairing function.

When this parameter is specified, for the pairs for which S-VOL information is specified in the pair information CSV file, the specified volumes are defined as the S-VOLs of copy pairs.

Notes

If dummy device numbers are automatically assigned, the disk configuration definition file is updated.

Responses

See Responses common to all CLI commands.

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 YKIMPORT command.

For details about return codes set by the BCM Web API server, see Return codes set by the BCM Web API server.