Commands

This chapter provides a description of the syntax and semantics of all SHC-OSD commands. An overview of all the commands is provided on the next page.

The commands are described in alphabetical order, and the descriptions have the following structure:

• the command name and function

• a description of the command function

• an illustration of the command format

• a description of the command operands

• information on command processing, if necessary

• one or more examples, if necessary

• for SHOW commands: output formats

• for SHOW commands: output in S variables

• a description of the command return codes

The 1st volume of the manual “Commands” [1] provides general explanations regarding the metasyntax used, the command return codes and display of S variables.

Command overview

Command	Function	Symmetrix /VMAX3	ETERNUS DX/AF
ACTIVATE-CLONE	Activates a clone pair	X	X
ACTIVATE-SNAP	Activates a snap pair	X	X
FAILBACK-STORAGE-CLUSTER	Executes failback in a Storage Cluster		X
FAILOVER-STORAGE-CLUSTER	Executes failover in a Storage Cluster		X
HOLD-REMOTE-COPY	Interrupts remote copy mode	X	X
MODIFY-REMOTE-COPY-PARAMETER	Changes the processing mode and remote copy parameters	X	X
MODIFY-SHC-ENVIRONMENT	Modify configuration of the external servers		X
MODIFY-SHC-PROCESSING	Changes settings of SHC-OSD	X	X
RESTART-CLONE-SESSION	Re-creating a clone pair	X	X
RESTORE-FROM-CLONE	Reconstructs an original from a clone unit	X	X
RESTORE-FROM-SNAP	Reconstructs an original from a snap unit	X	X
RESUME-IO	Resume input/output activity	X	X
RESUME-REMOTE-COPY	Resumes remote copy mode	X	X
SET-REMOTE-COPY-ACCESS	Sets the access path to the data of a remote copy pair	X
SHOW-CLONE-SESSION-STATUS	Displays the status of clone pairs	X	X
SHOW-REMOTE-COPY-STATUS	Displays the status of remote copy pairs	X	X
SHOW-SHC-ENVIRONMENT	Displays configuration of the external servers	X	X
SHOW-SHC-PROCESSING	Displays settings of SHC-OSD	X	X
SHOW-SNAP-SESSION-STATUS	Displays the status of snap pairs	X	X
SHOW-STORAGE-CLUSTER-CONFIG	Displays configurations of Storage Clusters		X
SHOW-STORAGE-CONFIGURATION	Displays storage configuration		X
SHOW-STORAGE-DEVICE-CONFIG	Displays storage device configuration		X
SHOW-SYMMETRIX-CONFIGURATION	Shows the Symmetrix/VMAX3 configuration	X
SHOW-SYMMETRIX-DEVICE-CONFIG	Displays the Symmetrix/VMAX3 device configuration	X
START-CLONE-SESSION	Creates a clone pair	X	X
START-REMOTE-COPY	Creates a remote copy pair	X	X
START-SNAP-SESSION	Creates a snap pair	X	X
STOP-CLONE-SESSION	Cancels a clone pair	X	X
STOP-REMOTE-COPY	Cancels a remote copy pair	X	X
STOP-SNAP-SESSION	Cancels a snap pair	X	X
SWAP-CLONE-SESSION	Swaps original and clone attributes of a clone pair		X
SWAP-REMOTE-COPY	Swaps the source and target property of a remote copy pair	X	X
UNLOCK-SYMMETRIX	Lifts Symmetrix/VMAX3 device locks	X
UNLOCK-SYMMETRIX-DEVICE	Lifts Symmetrix/VMAX3 device locks	X

Commands according to function groups

An overview of the commands for the functions can be found in the chapters with the related functional description:

• for local replication with clones on "Local replication with clones (ETERNUS DX/AF, Symmetrix/VMAX3)"

• for local replication with snapshots on "Local replication with snapshots (ETERNUS DX/AF, Symmetrix/VMAX3)"

• for remote replication with REC on "Remote replication with REC (ETERNUS DX/AF)"

• for remote replication with SRDF on "Remote replication with SRDF (Symmetrix/VMAX3)"

• for thin provisioning on "Thin provisioning (ETERNUS DX/AF, Symmetrix/VMAX3)"

• for Automated Storage Tiering on "Automated Storage Tiering (ETERNUS DX/AF)"

• for Storage Cluster on "Storage Cluster Option (ETERNUS DX/AF)"

Commands for controlling the internal settings

Command	Function
MODIFY-SHC-ENVIRONMENT	Modify configuration of the external servers
MODIFY-SHC-PROCESSING	Changes settings of SHC-OSD
SHOW-SHC-ENVIRONMENT	Displays configuration of the external servers
SHOW-SHC-PROCESSING	Displays settings of SHC-OSD

The internal settings for execution, maintenance and diagnostics of the SHC-OSD subsystem can be displayed and modified dynamically. This option complements the settings via the SHC-OSD parameter file (see section "Configuration of SHC-OSD").

SHOW commands

Command	Function
SHOW-CLONE-SESSION-STATUS	Displays the status of clone sessions
SHOW-REMOTE-COPY-STATUS	Displays the status of remote copy pairs
SHOW-SHC-ENVIRONMENT	Displays configuration of the external servers
SHOW-SHC-PROCESSING	Displays settings of SHC-OSD
SHOW-SNAP-SESSION-STATUS	Displays the status of snap sessions
SHOW-STORAGE-CLUSTER-CONFIG	Displays the configuration of Storage Clusters (ETERNUS DX/AF)
SHOW-STORAGE-CONFIGURATION	Displays the configuration (ETERNUS DX/AF)
HOW-STORAGE-DEVICE-CONFIG	Displays device configuration (ETERNUS DX/AF)
SHOW-SYMMETRIX-CONFIGURATION	Displays the configuration (Symmetrix/VMAX3)
SHOW-SYMMETRIX-DEVICE-CONFIG	Displays device configuration (Symmetrix/VMAX3)

The SHOW commands support the structured output to S variables.