ACTIVATE-CLONE Activates a clone pair

Storage system:	ETERNUS DX/AF
Domain:	DEVICE
Privileges:	TSOS


/ACTIVATE-CLONE activates one or more clone pairs, each of which consists of one original unit and one clone unit. Following successful activation, the original unit and the clone unit are split: Both can be accessed from the host by applications. From the application’s viewpoint, the clone unit contains all the data of the original unit at command processing time.

The original units of the clone pairs are specified in the UNIT operand.

When the original units are selected via a pubset (UNIT=*BY-PUBSET), clone units must exist for all units of the pubset. The clone pubset on the clone units can be renamed directly using the NEW-PUBSET operand if an SF pubset is involved.

The CLONE-UNIT operand enables the clone unit which is to be activated to be selected if several pairs in the CREATED status exist for an original unit. By default the first clone unit is activated.

The file consistency over multiple volumes must be ensured by the caller. For this purpose a synchronization point should be created for the data before the command is called, see section "Activating clone pairs".

SHC-OSD checks the global and task-specific security settings before this command is executed (see "Security settings of SHC-OSD"). The current security settings can be displayed with /SHOW-SHC-PROCESSING (see also "SHOW-SHC-PROCESSING Displays settings of SHC-OSD"). They can be changed in the SHC-OSD parameter file (see "Configuration of SHC-OSD") for the next time SHC-OSD is started or with /MODIFY-SHC-PROCESSING for ongoing operations (see "MODIFY-SHC-PROCESSING Changes settings of SHC-OSD").

For QuickOPC clone

The command is not required for this function and therefore rejected.

For EC clones

The command is executed only if the clone pair has the SYNCHRONIZED status.

The CLONE-UNIT operand enables the clone unit which is to be activated to be selected if multiple pairs in the SYNCHRONIZED status exist for an original unit.
By default the first possible clone unit is activated.

When the REC function is used, the original unit can also be the source unit of a remote copy pair. The target unit can also be the original unit of a clone pair. In this case the source unit is specified in the UNIT operand, and the clone pair on the target unit is selected using the SELECT=*TARGET-UNIT operand. No concurrent remote copy is supported in such a configuration.
After the clone pair has been activated, it assumes the SPLIT status.

ACTIVATE-CLONE

UNIT = *BY-VOLUME(...) / *BY-PUBSET(...) / *BY-STORAGE(...) /
			list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
	*BY-VOLUME(...)
		|	VOLUME = <vsn 1..6>
	*BY-PUBSET(...)
		|	PUBSET = <cat-id 1..4>
		|	,NEW-PUBSET = *SAME / *SPECIAL-VSN / <cat-id 1..4>
		|	,HOLD-IO = *NO / *UNTIL-ACTIVATED
	*BY-STORAGE(...)
		|	SERIAL-NUMBER = <alphanum-name 3..14>
		|	,LOGICAL-VOLUME = <x-text 1..4>
,CLONE-UNIT = *FIRST-POSSIBLE / *FROM-SHOW-OUTPUT(...) /
				*BY-STORAGE(...) / list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
	*FROM-SHOW-OUTPUT(...)
		|	POSITION = *LAST / <integer 1..16>
	*BY-STORAGE(...)
		|	CLONE-LOGICAL-VOLUME = <x-text 1..4>
,SELECT = *STD / *TARGET-UNIT

UNIT =
Selects the units by means of a particular VSN (*BY-VOLUME), a particular catalog ID (*BY-PUBSET), by means of the serial number and the internal number of the logical volume in the storage system (*BY-STORAGE), or directly by means of the logical volume's mnemonic device name.

UNIT = *BY-VOLUME(...)
Selects the units by means of a particular VSN.

VOLUME = <vsn 1..6>
Specifies the volume’s VSN.

UNIT = *BY-PUBSET(...)
Selects units by means of a pubset ID or volume set ID. The pubset is protected against reconfiguration during command processing. When an SF pubset is selected, the volumes of the clone pubset can be renamed using NEW-PUBSET.

PUBSET = <cat-id 1..4>
Specifies the pubset ID or volume set ID. When HOLD-IO=*UNTIL-ACTIVATED, no volume set ID may be specified.

NEW-PUBSET =
Determines the catalog ID of the clone pubset.

NEW-PUBSET = *SAME
The clone pubset is not renamed, i.e. it retains the same name.

NEW-PUBSET = *SPECIAL-VSN
All volumes of an SF pubset’s clone units are automatically renamed to prevent confusion with the original. For this purpose the period in a VSN in point notation is changed to a colon (e.g. AA.001 to AA:001), or in PUB notation the PUB string is changed to P:B (e.g. PUBA01 to P:BA01).

NEW-PUBSET = <cat-id 1..4>
An SF pubset’s clone pubset is renamed by specifying the new catalog ID explicitly. The catalog ID can also differ in length from the PUBSET operand. The new clone pubset also becomes an SF pubset. An existing MRSCAT entry is used if it is of the correct type. If it is not, it is deleted and created again. See the notes in section "Renaming SF pubsets with SHC-OSD".

HOLD-IO =
Handles inputs/outputs on the clone pair during splitting (see “Consistent splitting of a pubset in the shared pubset network” in "Activating clone pairs").

HOLD-IO = *NO
The inputs/outputs on the clone pair are executed without any change. This can lead to data inconsistencies on the clone units for applications which are not suspended before splitting takes place.

HOLD-IO = *UNTIL-ACTIVATED
The inputs/outputs on the clone pair are suspended until all the imported pubset’s clone pairs are in the COPY-ON-ACCESS status. Subsequently inputs/outputs are resumed on the units. If an error occurs when inputs/outputs are suspended or resumed, the command is aborted. The input/output activity may need to be resumed using /RESUME-IO.

UNIT = *BY-STORAGE(...)
Selects the unit by means of the serial number and the internal number of the logical volume in the storage system.

SERIAL-NUMBER = <alphanum-name 3..14>
Specifies the serial number of the storage system (make sure it is unique!).

LOGICAL-VOLUME = <x-text 1..4>
Specifies the internal number of the logical volume in the storage system.

UNIT = list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
Selects the unit by means of the mnemonic device name of the logical volume.

CLONE-UNIT =
Selects the clone unit. If more than one clone unit exists for a unit, a specific clone unit must be selected.

CLONE-UNIT = *FIRST-POSSIBLE
Selects the first possible clone unit for the command.

CLONE-UNIT = *FROM-SHOW-OUTPUT(...)
Selects the clone unit via its position in the output list of /SHOW-CLONE-SESSION-STATUS.

POSITION = *LAST
Selects the last clone unit in the output list.

POSITION = <integer 1..16>
Specifies the position of the clone unit.

CLONE-UNIT = *BY-STORAGE(...)
Selects the clone unit by means of the internal number of the logical volume in the storage system.

CLONE-LOGICAL-VOLUME = <x-text 1..4>
Specifies the internal number of the logical volume in the storage system.

CLONE-UNIT = list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
Specifies the mnemonic device name of the logical volume.

SELECT =
Selects the clone pairs.

SELECT = *STD
Selects the clone pairs which were defined using the UNIT operand.

SELECT = *TARGET-UNIT
Selects the clone pairs which are assigned to the target unit of a remote copy pair. The relevant source unit is specified in the UNIT operand.
The selection can only be made if the target unit is unique. Concurrent remote copy is not supported here.

Command processing

Message NDE1073 is output to SYSOUT for each device and distributed via routing code 0, i.e. it is logged in the CONSLOG file only. You will find detailed information on the CONSLOG file (log file) in the “Introduction to System Administration” manual [5].

Examples

/ACTIVATE-CLONE UNIT=*BY-PUBSET(PUBSET=OLD,NEW-PUBSET=*SAME)

/ACTIVATE-CLONE UNIT=*BY-PUBSET(PUBSET=OLD,NEW-PUBSET=NEW, HOLD-IO=*UNTIL-ACTIVATED)

Command return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	Command executed successfully
1	0	NDE2003	Command successfully executed, no processing necessary
2	0	NDE2004	Command successfully executed but not yet completed
	1	CMD0202	Syntax error
	1	NDE1036	PUBSET and NEW-PUBSET have different lengths
	32	NDE2002	Internal error
	64	CMD0087	Function not permitted in the current input mode or with the current task privileges
	64	CMD0216	Required privilege not available
	64	NDE1000	Device not found or not in the storage system
	64	NDE1001	Device not attached
	64	NDE1003	Data medium not online or not unique
	64	NDE1004	Pubset not found or wrong pubset type
	64	NDE1005	Pubset not homogeneous
	64	NDE1008	Volume cannot be allocated
	64	NDE1015	Device not defined in BS2000
	64	NDE1043	Pubset type not supported
	64	NDE1044	NEW-PUBSET already exists
	64	NDE1057	Function not supported
	64	NDE1087	HOLD-IO=*UNTIL-ACTIVATED permitted only for imported pubsets
	64	NDE1100	Invalid pubset state
	64	NDE1101	More than one sharer for pubset
	64	NDE1102	Not all volumes could be allocated
	64	NDE1103	No reconfiguration lock for pubset
	64	NDE1104	HOLD-IO=*UNTIL-ACTIVATED: DAB caching active
	64	NDE1105	Inconsistent pubset
	64	NDE1108	SELECT=*TARGET-UNIT: UNIT is not a source unit
	64	NDE1109	SELECT=*TARGET-UNIT: TARGET-UNIT not found
	64	NDE1120	Error suspending or resuming input/output access to pubset
	64	NDE1143	Error occurred during processing of mirror pair
	64	NDE1171	Target unit is not unique
	64	NDE1530	No clone function for the unit
	64	NDE1531	Different number of devices in the unit and clone unit specifications
	64	NDE1535	Device is a clone unit
	64	NDE1540	Incorrect state of unit
	64	NDE1541	Incorrect state of clone unit
	64	NDE1548	Clone type cannot be determined clearly
	64	NDE1549	No clone unit assigned for clone unit selection
	64	NDE1553	Device is not a clone unit
	64	NDE1584	Clone pair already activated
	64	NDE1592	Clone pair already activated and clone unit renamed
	64	NDE1596	Clone pair(s) already activated
	64	NDE1800	Device not found or not in storage system
	64	NDE1802	Error communicating with StorMan server
	64	NDE1803	Management instance not available
	64	NDE1810	Storage system’s operating system version not supported
	64	NDE1811	Function not supported for storage system
	64	NDE1812	StorMan server switched off by command
	64	NDE1814	Storage system’s serial number not found
	64	NDE1815	Storage system’s serial number not unique
	64	NDE1816	Storage system’s logical volume not found
	64	NDE1833	No suitable Storman server found
	64	NDE1853	Storage unit locked
	64	NDE1890	Management instance not found
	64	NDE1899	Command not possible for current status of the mirror pair
	64	NDE2000	Execution partially successful
	64	NDE2001	Command not executed
	64	NDE2009	Command aborted with K2 key
	64	NDE2014	StorMan error in command
	64	NDE2017	Command not possible for current status of the replication
	130	NDE1082	Memory bottleneck during processing of command
	130	NDE2005	Command cannot be executed at the moment