EMC Solutions Enabler CLI Command Reference

Chapter 1: SYMCLI Commands

symsg

Performs operations on storage groups located in a specified Symmetrix array.

SYNOPSIS symsg -h symsg [-sid <SymmID>] [-i <Interval>] [-c <Count>] [-v] list [-offline] list -by_port -demand

[-pg <PgName> | -dir <# [-p <#|ALL>] |ALL>] list -by_pg -demand [-pg <PgName>] list [-detail [-by_sl | -by_srp]] symsg -sid <SymmID> [-i <Interval>] [-c <Count>] [-v] create <SgName>

[-bw_max <MBperSec>]

[-iops_max <IOperSec>]

[-dynamic <NEVER | ALWAYS | ONFAILURE>]

[-sl <SLName> [-wl <WorkloadName>]]

[-srp <SRPName>] convert -cascaded <SgName> <ChildSgName>

[-host_IO <on_parent | on_child>] convert -standalone <SgName>

[-host_IO <keep_parent | keep_child>] delete <SgName> [-force] export <SgName> [-file <FileName>] [-offline]

700 EMC Solutions Enabler CLICommand Reference

exportall [-file <FileName>] [-offline] import <SgName> [-file <FileName>] importall [-file <FileName>] rename <OldSgName> <NewSgName> sg2cg <SgName> <CgName> [-bcv | -vdev | -tgt]

[-R1 | -R2 | -R21 | -noRDF]

[-apidb | -rdf_consistency] sg2dg <SgName> <DgName> [-bcv | -vdev | -tgt]

[-R1 | -R2 | -R21 | -noRDF] show <SgName> [-offline] symsg -sg <SgName> -sid <SymmID> [-i <Interval>]

[-c <Count>] [-v] [-celerra] [-rp] [-ckd] add dev <SymDevName> add sg <SgName1>[,<SgName2>,<SgName3>,.,<SgNamen>] copy dev <SymDevName> <DestSgName> move dev <SymDevName> <DestSgName> [-force] remove dev <SymDevName> [-force] remove sg <SgName1>[,<SgName2>,<SgName3>,.,<SgNamen>] symsg -sg <SgName> -sid <SymmID> [-i <Interval>]

[-c <Count>] [-v] [-celerra] [-rp] [-ckd]

[-SA <# | ALL>] [-p <#>] [-N <#>]

[-cap <#> [-captype <mb> | <cyl>]]


symsg 701


[-devs <<SymDevStart>:<SymDevEnd> | <SymDevName>

[,<<SymDevStart>:<SymDevEnd> | <SymDevName>>...]> |

-file <DeviceFileName> [-tgt] ] addall [pd | devs] copyall <DestSgName> moveall <DestSgName> [-force] rmall [-force] symsg -sg <SgName> -sid <SymmID> [-i <Interval>]

[-c <Count>] set <[-bw_max <MBperSec> | NOLIMIT ]

[-iops_max <IOperSec> | NOLIMIT ]

[-dynamic <NEVER | ALWAYS | ONFAILURE>]>

[-sl <SLName> [-wl <WorkloadName>] |-nosl]

[-srp <SRPName> | -nosrp] symsg -sg <SgName> -sid <SymmID> [-i <Interval>]

[-c <Count>] [-v] [-noprompt] [-rp] [-star]

[-celerra] [-skip -lockid <lockNum>] ready [-rdf_metro] not_ready [-rdf_metro] rw_enable write_disable hold unhold [-symforce]


compress [-stop] uncompress [-stop] bind -pool <PoolName> unbind rebind -pool <PoolName> allocate [-persistent] allocate -stop free [-all] free [-all] -stop reclaim [-persistent] reclaim -stop set -persistent unset -persistent set -orm < system | on | off > set -gcm [-symforce] unset -gcm [-symforce] set -no_identity symsg -sg <SgName> -sid <SymmID> [-i <Interval>]

[-c <Count>] [-v] [-noprompt] [-star]

[-skip -lockid <lockNum>]


symsg 703

Chapter 1: SYMCLI Commands pin unpin host_active [-force]

DESCRIPTION

The symsg command performs operations specific to storage groups: creating new storage groups, adding devices or other storage groups to a storage group, copying, moving and removing devices in a storage group, removing storage groups from a storage group, importing storage groups, exporting storage groups, deleting storage groups, renaming storage groups, converting storage groups between cascaded and standalone and listing and showing information about a storage group.

The symsg command also performs the following control actions on all of the devices in a storage group: write_disable, rw_enable, ready, not_ready, hold, unhold, pin, unpin, compress, uncompress, set, unset, bind, unbind, rebind, allocate, free and reclaim.

The export argument creates a group file (ASCII text) and the import argument reads a file to import a single storage group. The file contains as many device description lines or storage group description lines as there are devices or storage groups defined in the

Storage Group detailed. There cannot be both device and storage group description lines in the same file. In addition, there may also be Host I/O limit maximum bandwidth, maximum IOPS or dynamic distribution description lines. Any lines that are blank or have a pound sign (#) in the first column are ignored.


<SymDevName>

. . .

<SymDevName>

B <MBperSec>

I <IOperSec>

D <DynDistribution>

L <SLName>

R <SRPName>

W <WorkloadName> or

S <StorageGroupName>

. . .


B <MBperSec>

I <IOperSec>

D <DynDistribution>

L <SLName>

R <SRPName>

W <WorkloadName>

The exportall argument creates a group file (ASCII text) and the importall argument reads a file to import all storage groups. The file contains as many storage group records as there are storage groups defined. Each record can contain as many device description lines or storage group description lines as there are devices or storage groups defined in the storage group being detailed.

There cannot be both device and storage group description lines in the same record. In addition, there may also be

Host I/O limit maximum bandwidth, maximum IOPS or dynamic distribution description lines. Any lines that are blank or have a pound sign (#) in the first column are ignored.

Group files contain device or storage group parameters in the following formats:


symsg 705


<StorageGroupName>

<SymmID>

<SymDevName>

. . .

<SymDevName>

B <MBperSec>

I <IOperSec>

D <DynDistribution>

L <SLName>

R <SRPName>

W <WorkloadName>

<StorageGroupName>

<SymmID>


. . .


B <MBperSec>

I <IOperSec>

D <DynDistribution>

L <SLName>

R <SRPName>

W <WorkloadName>

ARGUMENTS add/addall Adds single or multiple devices or storage groups to a storage group.

allocate Allocates storage in the thin pool.

bind Binds the thin device(s) to the thin pool.

compress Starts data compression on thin device(s).

When combined with the -stop option, data compression is stopped.


convert Converts a storage group between cascaded and standalone.

copy/copyall Copies devices from the <SgName> to the

<DestSgName>.

create Creates a storage group.

delete Deletes a storage group. Deletion of a storage group is not allowed if the storage group is contained in a Masking View or associated with a FAST policy.

export Creates a text file that details the members of an existing storage group. The storage group can later be recreated from this file using the import command.

exportall Creates a text file that details the members of all existing storage groups. The storage groups can later be recreated from this file using the importall command.

free Frees storage in the thin pool.

hold Creates a hold on all available devices from an existing device group. When a hold is placed on a device, TimeFinder operations are blocked.

host_active Sets the host active mode on device(s).

The device(s) must be in a host passive mode for this operation to succeed.

import Creates a storage group from data contained in a text file previously created using the export command.


symsg 707

Chapter 1: SYMCLI Commands importall Creates storage groups from data contained in a text file previously created using the exportall command.

list Lists storage groups or with optional parameters produces Host IO Limit demand reports.

move/moveall Moves the device(s) and deletes them from the <SgName> before adding them to the

<DestSgName>. not_ready Sets the device(s) to Not Ready. The device must be in a User Ready status for this operation to succeed.

pin Sets the device(s) to a user-pinned state.

User-pinned devices are not moved by the FAST controller, but can be moved with Optimizer or Symmigrate.

ready Sets the device(s) to Ready. The device must be in a User Not Ready status for this operation to succeed. rebind Rebinds the device(s) to the thin pool.

reclaim Reclaims storage from the thin pool.

remove Removes a single device or a single or multiple storage groups from a storage group.

rename Renames the ASCII name of a storage group.

rmall Removes multiple devices from a storage


group. If an optional range of devices is specified, only those devices included in the range are removed. If no range of devices is provided, all of the devices are removed.

rw_enable Sets the device(s) to Read and Write

Enabled to the local hosts.

set Sets the persistent indicator for allocations on thin device(s) when combined with the -persistent option. Or sets Host

IO Limit on the specified storage group when combined with the -bw_max, -iops_max or

-dynamic options. Sets the Optimized Read

Miss mode when combined with the -orm option. Sets GCM mode when combined with

-gcm. Sets the device to its original identity when combined with -no_identity option.

sg2cg Adds selected members of a storage group to a target composite group. If the composite group does not exist, it is created. If none of the optional device types are specified, the default is to add standard devices.

sg2dg Adds selected members of a storage group to a target device group. If the device group does not exist, it is created. If none of the optional device types are specified, the default is to add standard devices.

show Shows detailed information about storage


symsg 709

Chapter 1: SYMCLI Commands groups.

unbind Unbinds device(s) from the thin pool.

uncompress Starts data decompression on thin device(s).

When combined with the -stop option, data decompression is stopped.

unhold Releases devices that were previously set to the hold state.

unpin Removes the device(s) from the user-pinned state.

unset Clears the persistent indicator for allocations on thin device(s) when combined with the -persistent option. Clears GCM mode when combined with -gcm.

write_disable Sets the devices to Write Disabled to their local hosts.

KEYWORDS dev Indicates a single Symmetrix device name.

devs Indicates multiple Symmetrix device names.

pd Indicates a physical (host) device name.

sg Indicates a list of storage group names.

OPTIONS

-all Used with the free operation in order to specify that all allocations associated with the indicated devices are to be


freed, regardless of whether data has been written or not.

-apidb Overrides the options file setting and stores the RDF CG in the SYMAPI database only.

-bcv Specifies that only local BCV devices are taken from the storage group and added to the device group, via usage of the sg2dg command, or to the composite group, via usage of the sg2cg command.

-bw_max Specifies the Host IO Limit maximum bandwidth in MB per second to be set on the storage group. The maximum bandwidth will be set to unlimited if NOLIMIT is specified.

-by_pg Specifies that the Host IO Limit demand report is being requested for port group information.

-by_port Specifies that the Host IO Limit demand report is being requested for port information.

-c Specifies the number (count) of times to attempt to acquire an exclusive lock on the Symmetrix host database.

The time to wait between attempts to acquire a needed lock is specified by

-i (interval).

If neither -c nor -i is specified, operations will fail if they are unable to acquire a requested lock.


symsg 711


-cap Sets a minimum device size to the selection criteria of devices.

-captype <mb | cyl>

Specifies the units of capacity, either megabytes or cylinders. The default if not specified is MB.

-cascaded Used with the convert operation to select that a standalone storage group be converted to a cascaded storage group.

-celerra Allows operations on Celerra FBA devices.

-ckd Allows operations on CKD devices.

-orm Allows setting the Optimized Read Miss mode to system default, on, or off for the specified devices.

-demand Specifies a Host IO Limit demand report.

-devs Specifies multiple range(s) of Symmetrix device names.

-dir Specifies the director number(s) for which the Host IO Limit demand report is being requested.

-dynamic Specifies the Host IO Limit dynamic distribution setting for the storage group.

-file Specifies a filename to use for the import/importall or export/exportall operations.

-file Specifies a filename to use as input.


-force Forces the operation on the storage group.

-gcm Allows setting or clearing the device GCM mode.

-h Provides online help.

-host_IO When converting a storage group to cascaded, it is used to select were an existing Host

IO Limit is set.

When converting a storage group to standalone it is used to select which Host IO Limit to keep.

-i Specifies the interval time, in seconds, to wait between attempts to acquire an exclusive lock on the Symmetrix host database.

The default interval is 30 seconds.

The minimum interval is 5 seconds.

For passive actions the minimum interval is

15 seconds. Passive actions are actions that do not acquire an exclusive lock.

-iops_max Specifies the Host IO Limit maximum IOPs in I/Os per second. The maximum IOPs will be set to unlimited if NOLIMIT is specified.

-lockid Specifies the lock holder ID for preserving the target locks on the control operation.

The lock number ID must be a hexadecimal number.

-N Sets a number of devices to add, remove, or move.


symsg 713


-no_identity Sets the device to its original identity.

-noprompt Disables the confirmation prompt.

The default is to prompt the user for confirmation before executing the operation.

-noRDF Copies non-SRDF devices only.

-nosl Specifies there is no Service Level or removes the Service Level (SL) set on the

SG. This will also remove any workload that was assigned for the Service Level. If the

SG has an SRP, then the SG will get an activity-based Service Level. Otherwise, there will be no Service Level or SRP for the SG and the SG will no longer be FAST

Managed.

-nosrp Specifies there is no SRP or removes the

SRP set on the SG. If the SG has a Service

Level (SL) set the system default SRP for the emulation type will be used with the SG.

Otherwise, there will be no SRP or SL for the SG and the SG will no longer be FAST

Managed.

-offline Obtains information from the Symmetrix host configuration database.

-p Specifies the front-end (SCSI or Fibre) director port number to only select devices that are primarily visible through this director port. By default, all ports are selected.

-persistent Used with set or unset it specifies operation on the persistent indicator. Used with


allocate or reclaim it specifies the use of persistent storage.

-pool Specifies a Thin Pool Name.

-pg Specifies that the Host IO Limit demand report is being requested for the port(s) in the specified port group.

-R1 Copies RDF1 (R1) devices only.



-rdf_consistency

Allowing created CG to be enabled for RDF consistency.

-rdf_metro When specified with ready and not_ready identifies the devices being controlled are part of an RDF/Metro configuration.

-rp Indicates the action is targeted for devices tagged for RecoverPoint.

-SA Specifies the front-end (SCSI or Fibre) director number to only select devices that are primarily visible through this director. Alternatively, if ALL

(the default) is specified, all devices satisfying any other selection criterion will be selected.

-standalone Used with the convert operation to select that a cascaded storage group be converted to a standalone storage group.


symsg 715


-sid Specifies the unique Symmetrix ID.

-sg Specifies the name of the storage group.

-skip Skips the device locks action for control operations. Requires the -lockid option.

-sl Specifies the Service Level name to be set on the SG.

-srp Specifies a SRP name to be set on SG.

-star Indicates that the action is targeted for devices in STAR mode.

-stop Specifies that the compress, uncompress, allocate, free or reclaim operation will be stopped.

-symforce Requests the Symmetrix array force the operation to be executed when normally it is rejected. Use extreme caution when using this option.

-tgt Allows the user to specify that only local TGT devices are taken from the storage group and added to the device group, via usage of the sg2dg command, or to the composite group, via usage of the sg2cg command.

When used in conjunction with -file, specifies that devices are only taken from the second column of

DeviceFileName.


-vdev Allows the user to specify that only local VDEV devices are taken from the storage group and added to the device group, via usage of the sg2dg command, or to the composite group, via usage of the sg2cg command.

-v Provides a more detailed, verbose listing.

-wl Specifies a workload name to be set on SG.

PARAMETERS

ALWAYS The Host IO Limits for the storage group are always dynamically redistributed.

ChildSgName The child storage group name.

DestSgName The name of the storage group to use as the destination of a copy/copyall or move/moveall operation.

DeviceFileName

The name of the file where devices are listed. The device file can contain devices (SymDevNames) separated by new lines or device pairs listing a pair each line

(the source device, followed by a target device).

Examples of a device file format:

Example 1:

0026 0029

0015 0016


symsg 717


Example 2:

0001

0002

DynDistribution

The Host IO Dynamic Distribution setting

FileName The specified output or input of export, exportall, import, and importall commands, respectively.

IOperSec The number of I/Os per second. Valid values are between 100 and 2000000 IO/sec, in units of 100 IO/sec.

MBperSec The number of Mega Bytes per second. Valid values are between 1 and 100000 MB/sec.

NEVER The Host IO Limits for a storage group are never dynamically redistributed (static).

NewSgName The new storage group name.

OldSgName The original storage group name.

ONFAILURE The Host IO Limits for the storage group are dynamically redistributed only upon failure of a Front-End Port.

SgName The storage group name.

SLName The name of the Service Level.

SRPName The name of the SRP.

SymDevName The Symmetrix device name.


SymDevEnd The last Symmetrix device name in a sequence, such as 00B6.

SymDevStart The first Symmetrix device name in a sequence, such as 001C.

SymmID The 12-digit ID of the Symmetrix array.

WorkloadName The name of the Workload.

RETURN CODES

Code # Code Symbol

------ -----------

0 CLI_C_SUCCESS

1 CLI_C_FAIL

EXAMPLES

To create a Symmetrix storage group named mysg_1 on

Symmetrix array ID# 59866000123, enter: symsg -sid 123 create mysg_1

To delete Symmetrix storage group storgrp_f and all contained devices on Symmetrix array ID# 59866000123, enter: symsg -sid 123 delete storgrp_f -force

To rename Symmetrix storage group mysg_1 to storgrp_a on

Symmetrix array ID# 59866000123, enter: symsg -sid 123 rename mysg_1 storgrp_a


symsg 719


To add a single device to storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a add dev 30

To add all devices that are primarily visible from this host to storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a addall pd

To add a range of physical devices to storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a addall pd -devs 30:3F

To add all devices listed in a file named my_storgrp_b.txt

to a Symmetrix storage group named storgrp_b on Symmetrix array ID# 59866000123, enter: symsg -sid 123 addall -file my_storgrp_b.txt

-sg storgrp_b

To add storage groups storgrp_1 and storgrp_2 to storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a add sg storgrp_1,storgrp_2

To copy a device from storage group storgrp_a to storgrp_b, enter: symsg -sid 123 -sg storgrp_a copy dev 30 storgrp_b

To move a device from storage group storgrp_a to storgrp_b, enter: symsg -sid 123 -sg storgrp_a move dev 30 storgrp_b


To copy multiple devices from storage group storgrp_a to storgrp_b, enter: symsg -sid 123 -sg storgrp_a copyall

-devs 30:3F,40 storgrp_b

To move multiple devices from storage group storgrp_a to storgrp_b, enter: symsg -sid 123 -sg storgrp_a moveall

-devs 30:3F,40 storgrp_b

To list all storage groups on Symmetrix array ID#

59866000123, enter: symsg -sid 123 list

To list all Symmetrix storage groups in detailed format, enter: symsg list -v

To show all devices in storage group storgrp_a, enter: symsg -sid 123 show storgrp_a

To export a Symmetrix storage group named storgrp_c on

Symmetrix array ID# 59866000123 to a file named my_storgrp_c, enter: symsg -sid 123 export storgrp_c -file my_storgrp_c

To import a Symmetrix storage group named storgrp_c to

Symmetrix array ID# 59866000123 from a file named my_storgrp_c, enter:


symsg 721

Chapter 1: SYMCLI Commands symsg -sid 123 import storgrp_c -file my_storgrp_c

To convert a Symmetrix storage group named storgrp_c to a device group named ProdDG, enter: symsg -sid 123 sg2dg storgrp_c ProdDG

To remove a single device from storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a remove dev 30

To remove all devices from storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a rmall

To remove multiple devices from storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a rmall -devs 31:35,37,40:43

To remove storage groups sgrp_1 and sgrp_2 from storage group storgrp_a, enter: symsg -sid 123 -sg storgrp_a remove sg sgrp_1,sgrp_2


EMC Solutions Enabler CLI Command Reference

symsg

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symsg

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents