SHOW-SNAP-SESSION-STATUS Displays the status of snap pairs

Storage system:	ETERNUS DX/AF
Domain:	DEVICE
Privileges:	TSOS, OPERATING, HW-MAINTENANCE, SW-MONITOR-ADMINISTRATION, HSMS-ADMINISTRATION
Routing code:	@


/SHOW-SNAP-SESSION-STATUS provides information on the status of snap pairs in the storage system.

When device selection takes place, SHC-OSD automatically determines the correct volumes on the storage system concerned and then outputs the data which is relevant for the system. Only snap pairs of one storage system type can be selected.

The command supports structured output to S variables (for further information, see the manual “Commands” [1]).

SHOW-SNAP-SESSION-STATUS

UNIT = *BY-VOLUME(...) / *BY-PUBSET(...)  / *BY-STORAGE(...) /
			list-poss(24): <alphanum-name 1..4 with-wildcards>
	*BY-VOLUME(...)
		|	VOLUME = list-poss(24): <vsn 1..6>
	*BY-PUBSET(...)
		|	PUBSET = list-poss(24): <cat-id 1..4>
	*BY-STORAGE(...)
		|	SERIAL-NUMBER = *ALL / <alphanum-name 3..14>
		|	,LOGICAL-VOLUME = *ALL / <x-text 1..4>
,SELECT = *ALL-PRESEL ECTED / *BY-ATTRIBUTES(...)
	*BY-ATTRIBUTES(...)
		|	SNAP-STATUS = *ANY / *UNUSED / *IN-USE
		|	,REMOTE-COPY-USE = *STD / *TARGET-UNIT
		|	,DEVICE = *ALL-PRESEL ECTED / *ALL-DEFINED / *ATTACHED / *DETACHED / *ANY
,UPDATE = *STD / *NO

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.
At least one unit must be attached per emulated controller.

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

VOLUME = list-poss(24): <vsn 1..6>
Specifies the volume’s VSN.

UNIT = *BY-PUBSET(...)
Selects units by means of a pubset ID or volume set ID. Information is output for all volumes of the specified pubset. IDs of SF pubsets, volume sets or imported SM pubsets can be specified. No information is output for exported SM pubsets.

PUBSET = list-poss(24): <cat-id 1..4>
Specifies the pubset ID or volume set ID.

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

SERIAL-NUMBER = *ALL
All storage systems are selected.

All known snap pairs are output. Additionally, free snap units are output in UNUSED status, if they are configured as snap data volumes (SDVs).
Editing the command with this specification for several storage systems can take some time.

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

LOGICAL-VOLUME = *ALL
Selects all logical volumes of the storage system.

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

UNIT = list-poss(24): <alphanum-name 1..4 with-wildcards>
Selects the unit by means of the mnemonic device name of the logical volume.

SELECT =
Units are selected by means of the snap unit status, their remote copy use or their status as seen by BS2000.

SELECT = *ALL-PRESELECTED
The set of units is not restricted further. The global setting for SHC-OSD applies (value of DEVICE-PRESELECTION in the output of /SHOW-SHC-PROCESSING).

SELECT = *BY-ATTRIBUTES(...)
The set of units is restricted by means of selection criteria.

SNAP-STATUS =

Units are selected by means of the snap unit status.

SNAP-STATUS = *ANY
Information is output for all units irrespective of the status of the snap unit.

SNAP-STATUS = *UNUSED
Information is output only for free snap units (virtual devices) in the UNUSED status.

Thin Devices or Flex Volumes that can be used as snap units in a storage system ETERNUS DX/AF are not displayed here.

SNAP-STATUS = *IN-USE
Information is output only for snap pairs in which the snap unit has a status other than UNUSED.

REMOTE-COPY-USE =
Units with the specified remote copy use are selected.

REMOTE-COPY-USE = *STD
Outputs information on all units regardless of their remote copy use.

REMOTE-COPY-USE = *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.

DEVICE =
Selects the units by means of their status as seen by BS2000.

DEVICE = *ALL-PRESELECTED
Selects all units corresponding to the global setting for the SHC-OSD subsystem (value of DEVICE-PRESELECT in the output of /SHOW-SHC-PROCESSING).

DEVICE = *ALL-DEFINED
Selects all units generated in BS2000.

DEVICE = *DETACHED
Selects units which are generated in BS2000 but detached.

DEVICE = *ATTACHED
Selects all units attached in BS2000.

DEVICE = *ANY
Selects all units of the storage system which was specified in the UNIT operand.

UPDATE =
Controls updating of the data provided.

UPDATE = *STD
The data is updated in SHC-OSD before the command is executed.

UPDATE = *NO
The command is executed without the data being updated in SHC-OSD. 

Examples

/SHOW-SNAP-SESSION-STATUS UNIT=*BY-PUBSET(PUBSET=BT10)

/SHOW-SNAP-SESSION-STATUS UNIT=*BY-STORAGE(SERIAL-NUM=227,LOGICAL-VOLUME=100)

/SHOW-SNAP-SESSION-STATUS UNIT=*BY-STORAGE(SERIAL-NUM=227,
      LOGICAL-VOLUME=100),REMOTE-COPY-USE=*TARGET-UNIT

Output for snap pairs

The layout of the SYSOUT output differs because not all output fields are supplied with values by all storage systems. SHC-OSD automatically selects the correct output format.

Outputs for ETERNUS DX/AF

/SHOW-SNAP-SESSION-STATUS UNIT=2040

 %  -----------------------------------------------------------------------------
 %  UNIT       VOLUME!             !            !SERIAL-NO             LOG-VOL
 %  -----------------------------------------------------------------------------
 %       SNAP- VOLUME!STATE        !ACTIVE-FOR  !SNAP-POOL-NAME  !
 %       UNITS       !             !DDD.HH:MM:SS!                !
 %  =============================================================================
 %   2040      ET88.0!             !            !    4531107005        00040
 %        20D1 ET44.0!COPY-ON-WRITE!236.00:59:08!                !     001B6
 %        20C9 ET88.0!COPY-ON-WRITE!236.01:30:14!SDP00           !     001AE
 %        20E3 ET40.0!COPY-ON-WRITE!375.07:18:07!SDP00           !     001C8
 %  -----------------------------------------------------------------------------

Meaning of the output columns (in alphabetical order)

Keyword                 

Meaning

with INF =

ACTIVE-FOR

Time since activation (/START-SNAP-SESSION), format: DDD.HH:MM:SS

*STD
*ALL

LOG-VOL

Internal number of the logical volume in the storage system (original and snap units)

*STD
*ALL

SERIAL-NO

Serial number of the storage system

*STD
*ALL

SNAP-POOL-NAME

Snap pool name of the snap pair (ETERNUS DX/AF).
Appears only after SDPEs are assigned to the SDV, i.e. after the capacity of the SDV has been exhausted and areas in the snap pool are being used.

*STD
*ALL

SNAP-UNITS

MN of a snap unit or internal number of the logical volume in the storage system (with prefix #).

*STD
*ALL

SNAP-VOLS

Internal number of the logical volume in the storage system.
No output for snapshots without a connection to a snap unit.

*STD
*ALL

STATE

Device status

COPY-ON-WRITE	Snap session is activated, the snap unit is READY, separate processing
REST-IN-PROG	Unit being reconstructed from the snap unit, data being copied from the snap unit to the unit
TERM-IN-PROG	The snap pair is being canceled
UNUSED FAILED	The snap unit is not connected to any original unit. Error state

*STD
*ALL

UNIT

MN of a unit or internal number of the logical volume in the storage system
(with prefix #).

*STD

*ALL

VOLUME

VSN of a unit

*STD
*ALL

S variables

Output information	Name of the S variable	T	Contents	Condition INF =
Number of assigned snap units	var(*LIST).NUM-OF-SNAP-UNITS	I	<integer 0..65535>	*STD *ALL
Serial number of the storage system	var(*LIST).SERIAL-NO	S	'' <c-string 3..14>	*STD *ALL
Period in seconds since a snap unit was activated, format DDDD.HH:MM:SS without leading zeros	var(*LIST).SNAP-UNIT(*LIST).ACTIVE-FOR	S	'' <c-string 13..13>	*STD *ALL
Internal number of the logical volume	var(*LIST).SNAP-UNIT(*LIST).LOGIC-VOL	S	'' <c-string 1..5>	*STD *ALL
Save/snap pool name for a snap pair (ETERNUS DX/AF)	var(*LIST).SNAP-UNIT(*LIST).SAVE-POOL-NAME	S	'' <c-string 1..32>	*STD *ALL
Unchanged data on the snap unit during the *COPY-ON-WRITE status (in MB)	var(*LIST).SNAP-UNIT(*LIST).SNAP-INDIRECT-SIZE	I	<integer 0..268435456>	*STD *ALL
Device status of a snap unit *UNUSED: Virtual snap unit is not connected to a unit *COPY-ON-WRITE: Snap pair activated, separate processing *RESTORE-IN-PROGRESS: Copying from the snap unit to the unit (after /RESTORE-FROM-SNAP, ETERNUS DX/AF) *TERM-IN-PROGRESS: Snap pair being canceled *FAILED: Error state	var(*LIST).SNAP-UNIT(*LIST).STA	S	*UNUSED *COPY-ON-WRITE *RESTORE-IN-PROGRESS *TERM-IN-PROGRESS *FAILED	*STD *ALL
MN of a snap unit	var(*LIST).SNAP-UNIT(*LIST).UNIT	S	'' <mnemo-name>	*STD *ALL
VSN of a snap unit	var(*LIST).SNAP-UNIT(*LIST).VOL	S	'' <vsn>	*STD *ALL
MN of a unit	var(*LIST).UNIT	S	'' <mnemo-name>	*STD *ALL
Internal number of the logical volume	var(*LIST).UNIT-LOGIC-VOL	S	<c-string 1..5>	*STD *ALL
VSN of a unit	var(*LIST).UNIT-VOL	S	'' <vsn>	*STD *ALL

Command return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	Command executed successfully
	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	NDE1002	Controller not found
	64	NDE1003	Data medium not online or not unique
	64	NDE1004	Pubset not found or wrong pubset type
	64	NDE1043	Pubset type not supported
	64	NDE1100	Invalid pubset state
	64	NDE1119	No target unit found
	64	NDE1125	Initialization of storage system information running
	64	NDE1126	Device unknown or storage system not supported
	64	NDE1127	Device of a storage system is not accessible by SHC-OSD
	64	NDE1800	Device not found or not in storage system
	64	NDE1810	Storage system’s operating system version not supported
	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	NDE2000	Execution partially successful
	64	NDE2001	Command not executed
	64	NDE2006	No output information available
	130	NDE1082	Memory bottleneck during processing of command