SHC-OSD V14.0 (en)

Storage system:	ETERNUS DX/AF, Symmetrix/VMAX3
Domain:	DEVICE
Privileges:	TSOS

/STOP-SNAP-SESSION terminates the snap session and cancels the assignment of one or more snap pairs. For this purpose the snap session must be in the COPY-ON-WRITE status or, for Symmetrix, in the CREATED or RESTORED status.

The information function for the original unit shows no snap use after the connection to the last snap unit has been canceled.

When the snap pair is canceled, the data on the snap unit is discarded. On command execution, the snap unit assumes the status UNUSED (for ETERNUS DX/AF only for the usage of preconfigured snap data volumes (SDV) as snap units for Symmetrix).

When the original units are selected via a pubset (UNIT=*BY-PUBSET), snap units must exist for all units of the pubset.

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 SnapOPC+ in ETERNUS DX/AF

If more than one snap session (snap unit) exists for an original unit, by default SnapOPC+ only enables the "oldest" snap session to be terminated.

"Younger" snap sessions can be terinated using the FORCE=*YES operand. In this case all other "older" snap sessions are also terminated implicitly.

Beginning with ETERNUS DX S5/AF S3 systems STOP-SNAP-SESSION can end any SnapOPC+ snap sessions, not just the oldest.

For TimeFinder/Snap on Symmetrix/VMAX3

The first possible, a particular preceding, the oldest or all snap sessions for an original/unit can be canceled.

STOP-SNAP-SESSION

UNIT = BY-PUBSET(...) / BY-VOLUME(...) / BY-SYMMETRIX(...) / BY-STORAGE(...) /
			<alphanum-name 2..2> / <x-text 4..4>
	*BY-PUBSET(...)
		\|	PUBSET = <cat-id 1..4>
	*BY-VOLUME(...)
		\|	VOLUME = <vsn 1..6>
	*BY-SYMMETRIX(...)
		\|	SERIAL-NUMBER = <alphanum-name 3..12>
		\|	,LOGICAL-VOLUME = <x-text 1..4>
	*BY-STORAGE(...)
		\|	SERIAL-NUMBER = <alphanum-name 3..14>
		\|	,LOGICAL-VOLUME = <x-text 1..4>
,SNAP-UNIT = FIRST-POSSIBLE / FROM-SHOW-OUTPUT(...) / ALL / RESTORED / *BY-PUBSET(...) /
				BY-SYMMETRIX(...) / BY-STORAGE(...) / *BY-SNAPSHOT-NAME(...) /
				list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
	*FROM-SHOW-OUTPUT(...)
		\|	POSITION = <integer 1..127> / *LAST
	*BY-PUBSET(...)
		\|	SNAP-PUBSET = <cat-id 1..4>
	*BY-SYMMETRIX(...)
		\|	SNAP-LOGICAL-VOLUME = <x-text 1..4>
	*BY-STORAGE(...)
		\|	SNAP-LOGICAL-VOLUME = <x-text 1..4>
	*BY-SNAPSHOT-NAME(...)
		\|	NAME = <posix-filename_1..32>
,FORCE = NO / YES
,SELECT = STD / TARGET-UNIT(...)
	*TARGET-UNIT(...)
		\|	RA-GROUP = *UNIQUE / <integer 1..250>
,SNAP-VSN = DESTROY / UNUSED

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

UNIT = *BY-PUBSET(...)
Selects units by means of a pubset ID or volume set ID. The pubset is protected against reconfiguration during command processing.

PUBSET = <cat-id 1..4>
Specifies the pubset ID or volume set ID.

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

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

UNIT = *BY-SYMMETRIX(...)
Only relevant for Symmetrix/VMAX3.
Selects the units by means of the serial number of the storage system and the internal number of the logical volume in the storage system.

SERIAL-NUMBER = <alphanum-name 3..12>
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 = *BY-STORAGE(...)
Only relevant for ETERNUS DX/AF.
Selects the units 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 = <alphanum-name 2..2> / <x-text 4..4>
Selects the unit by means of the mnemonic device name of the logical volume.

SNAP-UNIT =
Selects the snap units. If more than one snap unit exists for a unit, a specific snap unit must be selected.

SNAP-UNIT = *FIRST-POSSIBLE
Selects the first assigned snap unit possible for the command.

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

POSITION = <integer 1..127>
Specifies the position of the snap unit.

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

SNAP-UNIT = *ALL
Selects all snap units.

SNAP-UNIT = *RESTORED
Only relevant for Symmetrix.
Selects the snap unit in the *RESTORED status.

SNAP-UNIT = *BY-PUBSET(...)
Selects the snap unit via the pubset ID of the activated and renamed pubset.

SNAP-PUBSET = <cat-id 1..4>
Specifies the pubset ID.

SNAP-UNIT = *BY-SYMMETRIX(...)
Only relevant for Symmetrix/VMAX3.
Selects the snap unit by means of the internal number of the logical volume in the storage system.

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

SNAP-UNIT = *BY-STORAGE(...)
Only relevant for ETERNUS DX/AF.
Selects the snap unit by means of the internal logical number in the storage system.

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

SNAP-UNIT = *BY-SNAPSHOT-NAME(...)
Only relevant for VMAX3.
Selects the snapshots by means of the snapshot name.

NAME = <posix-filename_1..32>
Specifies the snapshot name, see section “Snapshot name” in "Snap units (VMAX3)".
Use of case sensitivity and uniqueness within the VMAX3 must be ensured.

SNAP-UNIT = list-poss(256): <alphanum-name 2..2> / <x-text 4..4>
Specifies the mnemonic device name of the snap units.
A list is accepted only if a pubset was specified in the UNIT operand.

FORCE =
Only relevant for ETERNUS DX/AF and Symmetrix.
FORCE controls the termination of a snap session.

FORCE = *NO
The "oldest" snap session is terminated (ETERNUS DX/AF).
Termination of a snap session in the RESTORE-IN-PROG status (Symmetrix) is rejected with a message.

FORCE = *YES
The snap session is terminated irrespective of its status. For ETERNUS DX/AF it is also terminated if a snap session which is not the "oldest" was selected. The snap pair is canceled. All "older" snap sessions are also terminated.

SELECT =
Selects the snap pairs.

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

SELECT = *TARGET-UNIT(...)
Selects the snap pairs which are assigned to the target unit of a remote copy pair. The relevant source unit is specified in the UNIT operand.

RA-GROUP =
Only relevant for Symmetrix/VMAX3.
Selects the target unit using the RA group in the case of concurrent target units.

RA-GROUP = *UNIQUE
Selects the one existing target unit.

RA-GROUP = <integer 1..250>
Specifies the RA group for selecting the target unit.

SNAP-VSN =
Only relevant for VMAX3. On other storage systems the VSN is discarded.
Determines the VSN of the snap unit after the snap session has ended.

SNAP-VSN = *DESTROY
The VSN of the snap unit is discarded after the end of the snap session.

SNAP-VSN = *UNUSED
The VSN of the snap unit at the end of the snap session is S#<mn>. It can then be selected again as the snap unit with /START-SNAP-SESSION using the SNAP-UNIT=*AUTO-SELECT operand.

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

/STOP-SNAP-SESSION UNIT=5000,SNAP-UNIT=*ALL

/STOP-SNAP-SESSION UNIT=*BY-PUBSET(PUBSET=TFS)

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
	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/volume in use
	64	NDE1006	Pubset not found or wrong pubset type
	64	NDE1008	Volume cannot be allocated
	64	NDE1010	Enginuity version is not supported (too low)
	64	NDE1015	Device not defined in BS2000
	64	NDE1043	Pubset type not supported
	64	NDE1100	Invalid pubset state
	64	NDE1102	Not all volumes could be allocated
	64	NDE1103	No reconfiguration lock for pubset
	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	NDE1114	Serial number not found
	64	NDE1115	Serial number not unique
	64	NDE1116	Storage system’s logical volume not found
	64	NDE1150	No gatekeeper device found
	64	NDE1153	Symmetrix device lock set
	64	NDE1154	Disk belongs to a meta-disk
	64	NDE1171	Target unit is not unique
	64	NDE1172	RA group invalid for the specified unit
	64	NDE1430	No Snap function for device
	64	NDE1431	Different number of devices in the unit and snap unit specifications
	64	NDE1435	Device is a virtual unit
	64	NDE1437	MNs of the unit and of the snap unit are identical
	64	NDE1438	Unit and virtual snap unit are different types
	64	NDE1440	Incorrect state of unit (of a snap pair)
	64	NDE1441	Incorrect state of snap unit
	64	NDE1449	No snap unit assigned to specified snap unit
	64	NDE1453	Device is not a snap unit
	64	NDE1454	Device is unused snap unit
	64	NDE1702	Connection to SYMAPI server aborted
	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	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	NDE1820	Reconstruction in storage system not yet completed
	64	NDE1833	No suitable Storman server found
	64	NDE1853	Storage unit locked
	64	NDE1897	Command not permitted in current status, use `FORCE=*YES`
	64	NDE2000	Execution partially successful
	64	NDE2001	Command not executed
	64	NDE2009	Command aborted with K2 key
	64	NDE2011	Symmetrix license not entered
	64	NDE2013	SYMAPI error in command
	64	NDE2014	StorMan error in command
	64	NDE2017	Command not possible for current status of the replication
	64	NDE2018	Error on SYMAPI server during the current editing
	64	NDE2020	No license for local replication (ETERNUS DX/AF)
	130	NDE1082	Memory bottleneck during processing of command
	130	NDE2005	Command cannot be executed at the moment

Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly

STOP-SNAP-SESSION Cancels a snap pair

For SnapOPC+ in ETERNUS DX/AF

For TimeFinder/Snap on Symmetrix/VMAX3

Command processing

Examples

Command return codes