Storage Center Powershell Command Set Admin Guide

Storage Center

Command Set 7.0for Windows PowerShell

Administrators Guide

Storage Center Command Set 7.0 for Windows PowerShell Administrators GuideDocument Number: 680-037-005

Notes, Cautions, and Warnings

Copyright Notice and Trademarks 2013 Dell Inc.

Trademarks used in this text: Dell, the Dell logo, and Compellent are trademarks of Dell Inc.

Contacting Dell Technical Support ServicesFor technical support, go to support.dell.com/compellent/.

Revision Date DescriptionA January 2013 Initial release.

B October 2013 Updated the directory for sample scripts.

C December 2013 Updated to indicate support for Windows Server 2012 R2.

Note: Indicates important information that helps you complete a procedure.

Caution: Indicates either potential damage to hardware or loss of data and tells you how to avoid the problem.

Warning: Indicates that failure to follow directions could result in property damage, personal injury, or death.

Dell iii

Contents

1 Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Whats New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

New Cmdlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Modified Cmdlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3New Cmdlet Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Using the Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Installation and Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Accessing the Storage Center Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Using the Storage Center Command Set Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Using the Windows PowerShell Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Connecting to a Storage Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Establishing a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Creating Default Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Creating SecureString Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Using PowerShell Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Object Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Available Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Entering Single Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Creating Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Running Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Storage Center Snapin Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Formatting and Exporting Command Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Format Command Output in the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Export Command Output to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Viewing and Printing Command Line Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

A Migrating Scripts from 5.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Syntax Modification Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Sample One: ExpandSCVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Sample Two: SetSCVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Migrating Existing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Install Procedure Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24New Name for PowerShell Snapin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Internal Object Type Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Snapins for Versions 5.x and 7. x Script Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Example Using Version 5.x Snapin Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

iv Storage Center Command Set 7.0 for Windows PowerShell Administrators Guide

Contents

Example Using Version 7.x Snapin Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Example with One Snapin Loaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Example with Both Snapins Loaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Dell 1

1 Before You Begin

This chapter gives a brief overview of the Storage Center Command Set for Windows Powershell snapin, lists requirements for using the command set, and briefly describes features and enhancements new with this release.

ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Whats New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

IntroductionStorage Center Command Set for Windows PowerShell provides access to cmdlets and scripting objects that interact with a Dell Compellent Storage Center via Windows PowerShell interactive shell, scripts, and PowerShell hosting applications. For detailed information on all available cmdlets, access cmdlet online help. See Viewing and Printing Command Line Help on page 19 for instructions.

RequirementsStorage Center Command Set 7.0 for Windows PowerShell requires the following:

Requirement Description

Storage Center Version 5.5.6 or higher.

Operating System Windows 2003 or higher with the latest service packs and hotfixes.or

Windows Server 2003 or higher with the latest service packs and hotfixes.

.NET Framework Version 3.5.

Chapter 1 Before You Begin

2 Storage Center Command Set 7.0 for Windows PowerShell Administrators Guide

Whats NewStorage Center Command Set 7.0 for Windows PowerShell includes the following new features and enhancements. Support for Windows PowerShell 3.0. Support for Windows Server 2012 and Windows Server 2012 R2. Additional cmdlets. See New Cmdlets on page 2 for a list of all cmdlets added in this

release. Modified cmdlets. See Modified Cmdlets on page 3 for a list of all cmdlets that have

been modified in this release.

In addition, miscellaneous enhancements have been made to address customer issues. For a list of all resolved customer issues, see the Storage Center Command Set 7.0 for Windows PowerShell Release Notes.

New CmdletsCommand Set 7.0 for Windows PowerShell adds the following cmdlets:

Windows PowerShell Version 2.0 or 3.0Note: Install Windows PowerShell before installing the Storage Center Command Set for Windows PowerShell snapin. See Installation and Setup on page 6 for step-by-step instructions.

Storage Center User Privileges

Cmdlet access to Storage Center folders, volumes, and views is dependent on the Storage Center user privilege and the group membership: Administrators have full system control. Volume Managers have access folders associated with their assigned

User Groups. They can create volumes in the allowed volume folders and map them to existing servers in the allowed server folders.

Reporters have read-only access to folders associated with their assigned user group.

Script Privileges Script file execution requires the following: Write access to either the directory in which the PowerShell executable

is located or the directory in which the script file is located. Appropriate Storage Center access privileges for the user running the

script to allow all cmdlets to execute without access errors. If the user running a script lacks the required privileges for the script, the script will fail.

Note: Windows PowerShell connections to Disk Manager and other Microsoft products are provided by Microsoft to enable full disk control between a Storage Center and a Windows server.

Requirement Description

Command Description

Add-SCReplayProfileRule Adds a new SCReplaySchedule to a Replay profile.

Get-SCRecycleBinVolume Retrieves the volumes in the Storage Center recycle bin.

Get-SCReplaySchedule Gets a Replay schedule by index or all of the Replay schedules for a Replay profile.

New-SCReplayProfile Creates a new Replay profile.

Whats New

Dell 3

Modified CmdletsCommand Set 7.0 for Windows PowerShell includes the following cmdlet modifications:

New-SCReplaySchedule Creates a new SCReplaySchedule instance.

Pause-SCAsyncReplication Pauses the asynchronous replication.

Pause-SCCmm Pauses the copy, mirror, migrate.

Remove-SCRecycleBinVolume Removes (permanently deletes) one or more volumes from the Storage Center recycle bin.

Remove-SCReplayProfile Removes the Replay profile from the Storage Center.

Remove-SCReplaySchedule Removes a Replay schedule from a Replay profile.

Remove-SCStorageProfile Removes the storage profile from the Storage Center.

Restore-SCRecycleBinVolume Restores one or more volumes from the recycle bin into its parent folder.

Resume-SCAsyncReplication Resumes the asynchronous replication.

Resume-SCCmm Resumes the copy, mirror, migrate.

Set-SCReplay Sets the description and expiration time for an existing Replay. The ExpirationTime and NeverExpires switch cannot both be specified.

Command Modification

Get-SCAsyncReplication Live Volumes: Added the IncludeLiveVolume parameter to return Live Volumes using asynchronous replication. Without the IncludeLiveVolume parameter, the cmdlet excludes Live Volume asynchronous replications.

Replication Progress Properties: Added additional replication progress properties for each returned asynchronous replication.

Get-SCCmm In previous releases, the Get-SCCmm cmdlet returned the copy, mirror, and migrate (CMM) objects created for copy, mirror, and migrate operations, as well as the CMM objects created to support asynchronous and synchronous replications. With this release, the cmdlet returns CMM objects for copy, mirror, and migrate operations only. CMMs created to support replications are not returned.

Get-SCLiveVolume Added SourceVolumeName parameter.

Get-SCVolume Added the TotalDiskSpaceConsumed property to SCVolume objects. TotalDiskSpaceConsumed represents the space consumed by a volume plus all Replay overhead. For a view volume, the value includes the space from the underlying Replay. There are no syntax or parameter changes.

New-SCAsyncReplication Added Name parameter. Added SCDestinationVolume parameter.

Command Description

Chapter 1 Before You Begin


New Cmdlet NamesThe following set of cmdlets can be called by using the CML prefix to avoid name collisions with other vendor cmdlets. The non-prefixed names are still available in version 7.0 of the Command Set, but the non-prefixed command names may be depreciated in a future release.

New-SCLiveVolume Added Name parameter. Added ReplicateToLowestTier parameter. Added SCDestinationVolume parameter. Added MinAmountBeforeSwapString parameter. Added MinSecondaryPercentBeforeSwap. Added MinTimeAsPrimaryBeforeSwap.

New-SCReplay Added SCReplayProfile parameter. Returns the expire time and freeze date and time using the

regional format dictated by the Windows regional setting. In addition, the expire time returns a value of Never Expire if the Replay has no expiration.

New-SCVolume No longer displays a warning when the volume name conflicts with a volume in the recycle bin.

Set-SCAsyncReplication Added Name parameter.

Set-SCLiveVolume Added Name parameter. Added ReplicateToLowestTier parameter.

Set-SCUser Added Password parameter to modify the password of a user.

Prefixed Cmdlet Name Existing CmdLet Name

Get-CMLNextFreeDriveLetter Same as Get-NextFreeDriveLetter. Avoids name collisions.

Get-CMLVolume Same as Get-Volume. Avoids name collisions.

New-CMLVolume Same as New-Volume. Avoids name collisions.

Set-CMLVolume Same as Set-Volume. Avoids name collisions.

Add-CMLVolumeAccessPath Same as Add-VolumeAccessPath. Avoids name collisions.

Remove-CMLVolumeAcccessPath Same as Remove-VolumeAcccessPath. Avoids name collisions.

Get-CMLDiskDevice Same as Get-DiskDevice. Avoids name collisions.

Rescan-CMLDiskDevice Same as Rescan-DiskDevice. Avoids name collisions.

Set-CMLDiskDevice Same as Set-DiskDevice. Avoids name collisions.

Command Modification

Dell 5

2 Using the Command Set

This chapter provides instructions for installing and setting up Storage Center Command Set for Windows Powershell and provides information to get started using the Command Set.

ContentsInstallation and Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Accessing the Storage Center Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Connecting to a Storage Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Using PowerShell Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Available Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Formatting and Exporting Command Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Viewing and Printing Command Line Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 2 Using the Command Set


Installation and SetupTo install the Storage Center Command Set:1 If necessary, download and install Windows PowerShell from the Microsoft web site.

Windows PowerShell must be installed prior to installing Storage Center Command Set for Windows PowerShell.

2 Navigate to the location of the Storage Center Command Set setup file.3 Double-click the setup file. The InstallShield Wizard appears.4 Follow the InstallShield Wizard directions to complete installation.

Accessing the Storage Center Command SetThere are two methods for accessing the Storage Center Command Set: Shell access Console access

Using the Storage Center Command Set ShellTo access the Storage Center Command Set using the Command Set shell, select:

Start All Programs Compellent Technologies Storage Center PowerShell Snapin Compellent Storage Center Command Set Shell

The shell provides a shortcut to a Windoes PowerShell console with the Storage Center Command Set already loaded. This is the recommended way to access the Storage Center Command Set.

Using the Windows PowerShell ConsoleTo access the Storage Center Command Set using the standard Windows PowerShell console:1 Access the Windows PowerShell console:

On Windows 2003 or higher:Start All Programs Windows PowerShell Windows PowerShell

On Windows 7:Start All Programs Accessories Windows PowerShell Windows PowerShell

2 Open the console and load the Storage Center Command Set snapin by enter the following command:Add-PSSnapin Compellent.StorageCenter.PSSnapin

The snapin must be loaded each time the Windows PowerShell console is opened prior to using Storage Center Command Set.

Note: Refer to Appendix A: Migrating Scripts from 5.x, on page 21 for examples of loading two versions of the Command Set to facilitate migrating from version 5.x to 6.x or 7.x.

Connecting to a Storage Center

Dell 7

Connecting to a Storage CenterStorage Center cmdlets require a connection to a Storage Center. This section details how to establish a connection to a Storage Center. In addition, this section describes how to use SecureString input to safeguard password information.

Establishing a ConnectionThe Get-SCConnection cmdlet establishes a connection to a Storage Center. There are several ways to provide connection information to the cmdlet: Using a Variable Using a ConnectionName Object Interactively

Save Connection Information in a VariableConnection information can be stored in a variable and then used on subsequent cmdlets. For example:

$connection = Get-SCConnection -HostName mmt1 -User Admin -Password $pass

The $connection variable is used with the Connection parameter to connect to a Storage Center. For example:

Get-SCVolume -Connection $connectionSave Connection Information to a -ConnectionName ObjectConnection information can be saved to a ConnectionName object using the Save parameter with Get-SCConnection. For example:

Get-SCConnection -HostName mmt1 -User Admin -Password $pass -Save connectionname

The saved object is used with the ConnectionName parameter to connect to a Storage Center. For example:

Get-SCVolume -ConnectionName connectionnameEnter Connection Information InteractivelyIf you do not provide all required parameters (HostName, User, Password) for the GetSCConnection, the system prompts for the missing information. This method still requires storing connection information in a variable or as a connection name.

Creating Default ConnectionsTo create a default Storage Center connection, use the -Default or -DestinationDefault parameters when executing the Get-SCConnection cmdlet. Saving a connection as the default allows Storage Center cmdlets to be executed

without specifying the -Connection or -ConnectionName parameters. Saving a destination default connection allows Storage Center cmdlets that require a

destination connection to be executed without specifying the -DestConnection or -DestConnectionName parameters.

For details and examples, see Get-Help Get-SCConnection -full.



Creating SecureString PasswordsSecureString objects are used in Windows PowerShell cmdlets as a security measure. SecureStrings are encrypted in memory and the content of a SecureString variable cannot be displayed. For this reason, SecureString objects are commonly used for sensitive information such as passwords.

SecureString InputCreate a variable with SecureString content by entering the following command in the PowerShell console:

$pass = Read-Host -AsSecureString -Prompt "Please provide password"The PowerShell console returns the following:

Please provide password: The password is obscured by asterisks (*) and stored in the variable.

Stored ValuesSecureString values can be stored for later access. The encryption used for the SecureString is based on the logged-on user credentials. This helps prevent another user from accessing the stored value and deriving the password. However, the saved data should be kept in a secure location and NTFS permissions may also be used to further protect it from unwanted access.

To store your password in an encrypted file:1 Enter the following command:

$pass = Read-Host -AsSecureString -Prompt "Please provide password"PowerShell prompts for a password.Please provide password:

2 Enter your password.3 Save your password to a text file.

ConvertFrom-SecureString $pass > C:\password.txtA script can now access this file using the following command:

$pass = ConvertTo-SecureString (Get-Content C:\password.txt)

Note: If security is not a prime concern, passwords can be entered directly on the command line without obscuring the text. For example:

$pass = ConvertTo-SecureString "mypassword" -AsPlainText -Force

Using PowerShell Objects

Dell 9

Using PowerShell ObjectsWindows PowerShell cmdlet parameters, including those available with the Storage Center Command Set, accept objects as arguments. These include standard objects such as string and integer objects, as well as Storage Center specific objects.

Store Objects in VariablesObjects can be created and stored in variables. For example, an SCVolume object can be created and stored in a variable using the GetSCVolume command:

$myvolume = Get-SCVolume -Name My VolumeThe SCVolume object can be moved using the following commands:

$myvolume = Get-SCVolume -Name My Volume$newfolder = Get-SCVolumeFolder -Name My VolumeFolderSet-SCVolume -SCVolume $myvolume -ParentSCVolumeFolder $newfolder

Access Object InformationUse the GetMember command to access object information. The GetMember command accepts pipeline input from commands that return objects. For example, the GetSCVolume command returns an SCVolume object. To view SCVolume object information, type the following:

Get-SCVolume|Get-MemberThis returns a list of methods and properties for the SCVolume object.

Object DescriptionsThe following table lists and describes common PowerShell objects as well as Storage Center-specific objects.

Object Description

Boolean Represents a true or false value. For true, type 1 or $true. For false, type 0 or $false.

DataVolume Represents a logical volume in Windows.

DateTime Represents dates and times with values ranging from 12:00:00 midnight, January 1, 0001 AD (CE) through 11:59:59 pm December 31, 9999 AD. (CE). Time values are measured in 100-nanosecond units called ticks.

DiskDeviceObject Represents a disk drive in Windows.

Int32 Represents a 32-bit signed integer. Signed integers can be either positive or negative.

Int64 Represents a 64-bit signed integer. Signed integers can be either positive or negative.

SCAlert Represents a Storage Center alert.

SCAsyncReplication Represents a Storage Center asynchronous replication.

SCCmm Represents a Storage Center copy/mirror/migrate operation.

SCConnection Represents Storage Center connection information.

SCController Represents Storage Center controller.

SCDisk Represents a Storage Center disk.



SCDiskFolder Represents a Storage Center disk folder.

SCLiveVolume Represents a Storage Center Live Volume.

SCOSType Represents a Storage Center operating system type.

SCPort Represents a Storage Center controller port.

SCReplay Represents a Storage Center Replay.

SCReplayProfile Represents a Storage Center Replay profile.

SCReplaySchedule Represents a Storage Center Replay schedule.

SCReplicationQos Represents a Storage Center replication quality of service definition.

SCServer Represents a Storage Center server.

SCServerFolder Represents a Storage Center server folder.

SCStorageCenter Represents a Storage Center.

SCStorageProfile Represents a Storage Center storage profile.

SCStorageType Represents a Storage Center storage type.

SCUser Represents a Storage Center user account.

SCVolume Represents a Storage Center volume.

SCVolumeFolder Represents a Storage Center volume folder.

SCVolumeMap Represents a Storage Center volume-to-server mapping.

SecureString Represents an encrypted string for private data.

String Represents a combination of alphanumeric characters. Strings that contain the space character must be enclosed by quotation marks.

UInt32 Represents a 32-bit unsigned integer. Unsigned integers cannot be negative.

UInt64 Represents a 64-bit unsigned integer. Unsigned integers cannot be negative.

Object Description

Available Commands

Dell 11

Available CommandsThe following table lists and describes available Storage Center Command Set 7 cmdlets.

Command Description

Acknowledge-SCAlert Mark a Storage Center alert as acknowledged.

Add-CMLVolumeAccessPath Same as Add-VolumeAccessPath. Avoids name collisions.

Add-SCReplayProfileRule Adds a new SCReplaySchedule to a Replay profile. The SCReplaySchedule can be created using the New-SCReplaySchedule cmdlet or copied from an existing SCReplaySchedule retrieved with the Get-SCReplaySchedule cmdlet.

Add-SCReplayProfileRule Adds a new SCReplaySchedule to a Replay profile.

Add-SCServerPort Add additional world-wide name or iSCSI addresses to an existing server definition.

Add-VolumeAccessPath Add a drive letter or mount point to an existing volume.

CancelSwapRole-SCLiveVolume Cancel the swap role of a Live Volume.

ConvertTo-SCAsyncReplication Convert a Live Volume to an asynchronous Replication.

ConvertTo-SCLiveVolume Convert an asynchronous Replication to a Live Volume.

Expand-SCVolume Expand a Storage Center by additional reported capacity.

Get-CMLDiskDevice Same as Get-DiskDevice. Avoids name collisions.

Get-CMLNextFreeDriveLetter Same as Get-NextFreeDriveLetter. Avoids name collisions.

Get-CMLVolume Same as Get-Volume. Avoids name collisions.

Get-DiskDevice Retrieve disk drive information from the Windows Virtual Disk Service.

Get-NextFreeDriveLetter Query the Windows Virtual Disk service for the next available drive letter that could be used to assign as a volume path.

Get-SCAlert Get all alerts that were generated on the controller with a specified serial number.

Get-SCAsyncReplication The Get-SCAsyncReplication cmdlet returns async replications that include those async replications supporting Live Volume replications. Does not return async replications used in Live Volume replications by default. LiveVolume parameter includes async replications supporting live volume replications to preserve previous behavior.

Get-SCCmm Retrieve, Copy, Mirror or Migrate operations from Storage Center.

Get-SCCommandSetVersion Return a system, version object containing the version of the currently loaded Storage Center Command Set.

Get-SCConnection Establish connection credentials to a Storage Center system.

Get-SCDisk Retrieve disk information from Storage Center

Get-SCDiskFolder Retrieve disk folder information from Storage Center.



Get-SCLiveVolume Retrieve Live Volume operations from Storage Center. New SourceVolumeName parameter

Get-SCOSType Retrieve the defined server operating system type.

Get-SCPort Retrieve all front-end primary port information from Storage Center.

Get-SCRecycleBinVolume Retrieves the volumes in the Storage Center recycle bin. New TotalDiskSpace attribute.

Get-SCRecycleBinVolume Retrieves the volumes in the Storage Center recycle bin

Get-SCReplay Retrieve Replay information from Storage Center.

Get-SCReplayProfile Retrieve all available Replay profiles from Storage Center.



Get-SCReplicationsQos Get Replication QoS definitions from Storage Center.

Get-SCServer Retrieve server definitions from Storage Center.

Get-SCServerFolder Retrieve server folder definitions from Storage Center.

Get-SCStorageCenter Retrieve Storage Center information.

Get-SCStorageProfile Retrieve all available storage profiles from Storage Center.

Get-SCStorageType Retrieve available storage types from Storage Center.

Get-SCUser Allow admin-level users to retrieve all users from Storage Center.

Get-SCVolume Retrieve volumes from Storage Center. Includes new TotalDiskSpace attribute. This value represents the Volume Space Consumed plus the Replay overhead. Note that in the case of a view volume, this number includes the space borrowed from the underlying Replay.

Get-SCVolumeFolder Retrieve volume folders from Storage Center.

Get-SCVolumeMap Retrieve volume maps from Storage Center.

New-CMLVolume Same as New-Volume. Avoids name collisions.

New-SCAsyncReplication Create a new asynchronous replication. New Name parameter SCDestinationVolume parameter.

New-SCCmmCopy Create a Copy, Mirror or Migrate operation on Storage Center to copy all data from one volume to another.

New-SCCmmMigrate Create a Copy, Mirror or Migrate operation on Storage Center to migrate all data from one volume to another.

New-SCCmmMirror Create a Copy, Mirror or Migrate operation on Storage Center to mirror all data from one volume to another.

New-SCLiveVolume Create a new Live Volume.

Command Description

Available Commands

Dell 13

New-SCReplay Create a new Replay on a volume. Added SCReplayProfile parameter The expire time and freeze time returned from the Get-

SCReplay cmdlet now format the date values using the Windows regional settings. Expire Time displays Never Expire if the Replay is set to never expire.

New-SCReplayProfile Creates a new Replay profile. Add a single rule when a Profile is created using the optional Rule parameter. To add multiple rules to the profile see the Add-SCReplayProfileRule on page 11. To remove rules from a Replay profile see Remove-SCReplayProfile on page 14.

New-SCReplaySchedule Creates a new SCReplaySchedule instance. The result of this cmdlet can be passed as the -SCReplaySchedule parameter in the New-SCReplayProfile and Add-SCReplayProfileRule on page 11 cmdlets. Note that the Replay schedule is not created on the storage center until it is associated with a Replay profile.

New-SCServer Define a new server.

New-SCServerFolder Create a new volume folder that can contain other volumes and folders.

New-SCUser Creates a new user account on Storage Center.

New-SCVolume Creates a new volume on Storage Center. No longer displays a warning when the volume name conflicts with a volume in the recycle bin.

New-SCVolumeFolder Creates a new volume folder.

New-SCVolumeMap Expose volumes to servers by creating a path and LUN assignment for a volume between a controller port and server port.

New-Volume Communicate with the Windows Virtual Disk Manager service to create a new volume on a disk.

Pause-SCAsyncReplication Pauses the asynchronous replication.

Pause-SCCmm Pauses the cmm.

Preallocate-SCVolume Pre-allocate space for a volume. Pre-allocating storage physically assigns storage to a volume before use by the server.

Remove-CMLVolumeAcccessPath Same as Remove-VolumeAcccessPath. Avoids name collisions.

Remove-SCAsyncReplication Stop a replication operation on Storage Center.

Remove-SCCmm Remove a Copy, Mirror or Migrate from Storage Center by stopping the operation.

Remove-SCConnection Remove Storage Center connection settings saved using the -Save parameter from Get-SCConnection.

Remove-SCLiveVolume Remove a Live Volume from Storage Center.

Command Description



Remove-SCRecycleBinVolume Removes (permanently deletes) one or more volumes from the Storage Center recycle bin.

Remove-SCReplay Set Replays on Storage Center to expire immediately.

Remove-SCReplayProfile Removes the Replay profile from the Storage Center. Displays an error if the profile is currently applied to any volumes. The -Force parameter removes the Replay profile from assigned volumes and then removes the Replay profile. Attempting to remove a system-created Replay profile returns an error.

Remove-SCReplayProfile Removes the Replay profile from the Storage Center.

Remove-SCReplaySchedule Removes a Replay schedule from a Replay profile.

Remove-SCServer Remove server object definitions from Storage Center.

Remove-SCServerFolder Delete an empty server folder.

Remove-SCServerPort Remove a Fibre Channel or iSCSI port from a server definition.

Remove-SCStorageProfile Removes the storage profile from the Storage Center. Displays an error if the storage profile is currently applied to any volumes. Attempting to remove a system-created storage profile returns an error.

Remove-SCUser Allow admin-level users to remove user accounts from Storage Center.

Remove-SCVolume Delete a volume, removing volume mappings if necessary.

Remove-SCVolumeFolder Delete an empty volume folder.

Remove-SCVolumeMap Delete maps between a volume and a server.

Remove-SCVolumeReplayProfile Remove a Replay Profile from a volume.

Remove-VolumeAccessPath Communicate with the Microsoft Virtual Disk Service to remove a volume drive letter or mount point from a volume.

Rescan-CMLDiskDevice Same as Rescan-DiskDevice. Avoids name collisions.

Rescan-DiskDevice Communicate with the Microsoft Virtual Disk service to cause a rescan for changes to the disk devices attached to the server.

Restore-SCRecycleBinVolume Restores one or more volumes from the recycle bin into its parent folder.

Resume-SCAsyncReplication Resumes the asynchronous replication.

Resume-SCCmm Resumes the cmm

Set-CMLDiskDevice Same as Set-DiskDevice. Avoids name collisions.

Set-CMLVolume Same as Set-Volume. Avoids name collisions.

Set-DiskDevice Set the online status of a disk device.

Set-SC Volume Storage Profile Applies a Storage Profile to a volume.

Set-SCAsyncReplication Set attributes of an asynchronous Replication operation on Storage Center. Added Name parameter.

Command Description

Available Commands

Dell 15

Help for individual cmdlets is available online. Refer to Viewing and Printing Command Line Help on page 19 for more information.

Entering Single CommandsWindows PowerShell provides an interactive command prompt that can be used to execute single commands.

Open the Storage Center Command Set Shell and type a single command. For example:Get-SCConnection -HostName mmt1 -User Admin -Password $pass

Creating ScriptsA script is a text file that contains one or more Windows PowerShell commands. In PowerShell version 1.0 scripting is most often done in Notepad. PowerShell version 2.0 includes the Integrated Scripting Environment (ISE), which provides a graphical user interface for script editing, which includes advanced features such as syntax color coding and auto-completion for cmdlet names.

Follow these guidelines for creating script files: Include one command per line. Use the pound sign (#) as the first character on a line to denote a comment.

During installation, sample scripts are installed to [INSTALLDIR]\Script Samples. For example:

C:\Program Files (x86)\Dell\Storage Center PowerShell Command Set\Script Samples

Set-SCCmm Set the priority of a Copy, Mirror or Migrate operation.

Set-SCDisk Set attributes of a disk object on Storage Center.

Set-SCLiveVolume Sets attributes of a Live Volume operation on Storage Center. Added Name parameter. Added ReplicateToLowestTier parameter

Set-SCReplay Sets the description and expiration time for an existing Replay. The Expiration Time and Never Expires switch cannot be simultaneously specified.

Set-SCServer Set attributes of a server definition such as name and notes.

Set-SCServerFolder Set attributes of a server folder object such as name and parent folder.

Set-SCUser Set attributes of user accounts on Storage Center. Version 7.0 includes a new Password parameter for this cmdlet.

Set-SCVolume Set a new name for a volume.

Set-SCVolumeFolder Set attributes of a volume folder such as name and parent folder.

Set-SCVolumeReplayProfile Applies a Replay profile to a volume.

Set-Volume Set or clear flags of a volume on a Windows server.

Swap Role-SCLiveVolume Swap role of a Live Volume.

Command Description



These sample scripts should be used as templates that are edited to conform to specific requirements. Sample scripts are a starting point for script development and are not guaranteed to work in all situations. Installed scripts offer samples for: Creating new volumes and a SQL server database Creating new volumes and an Exchange mailbox storage group Creating new user account for everyone in a user group Exposing a Replay to a backup server for offloading a backup to tape

Running ScriptsFor script file execution, you must have all privileges required by commands in the script or the script fails. Follow these guidelines for running a script: By default, Windows PowerShell script execution policy is set to restricted. For

information on enabling scripts, enter: GetHelp SetExecutionPolicy or GetHelp about_signing

Run scripts from the Storage Center Command Set Shell or from the PowerShell console with the Storage Center Command Set snapin loaded (for more information, see Installation and Setup on page 6).

The Storage Center Command Set does not support running multiple scripts concurrently.

Specify the entire file path of your script.C:\scripts\myscript.ps1

If the path to your script includes blank spaces, type an ampersand (&) followed by the path enclosed in quotation marks.&C:\my scripts\myscript.ps1

To run a script from the current directory, use .\: .\myscript.ps1

Include the folder containing your script in your Windows PATH, then type the name of the script.myscript.ps1

Storage Center Snapin UtilityThe Storage Center Snapin Utility module provides a library of common functions. The utility module was developed using PowerShell scripting.

Note: The Compellent.StorageCenter.PowerShell Snapin must be added to the current PowerShell session to use the functions provided by the utility.

Available Commands

Dell 17

Command Description

Get-CMLDiskSignature Gets the disk signatures of all disks or the disk specified in the index parameter.

Get-CMLDuplicateDiskSignature Returns groups of disks with identical signatures. This can occur when a view volume for a clustered shared volume (CSV) is mounted to a server as Windows will not update the signature for a CSV.

Set-CMLDiskSignature Sets the disk signature of the disk specified by the index parameter.

Set-CMLVolumeSignature Sets the disk signature for a specified volume by mapping the volume on the computer identified by the ComputerName parameter, changing the signature and removing the mapping. This is particularly useful for automating the process of fixing the disk collision issue when attempting to mount the view volume of a Clustered Shared Volume (CSV) on a cluster node. To accomplish this, the ComputerName parameter must refer to a computer that is not a node in the cluster. When this function completes successfully, the view volume can then be mapped to a node in the cluster without a disk signature collision.



Formatting and Exporting Command OutputWindows PowerShell provides commands that can either format the way information appears in the console or export information to an xml, csv, or text file. These commands accept the output of other commands as input from the pipeline.

Format Command Output in the ConsoleBy default, Storage Center Command Set cmdlets print information to the console in a table format. The FormatList command will format information outputted to the console as a list. For example, the following command will display a list of all properties for a Storage Center volume named MyVolume:

Get-SCVolume -Name MyVolume|Format-ListFor more information on displaying information in the console, type the following:

Get-Help about_display

Export Command Output to a FileCommand output can be stored in various file formats. The examples below show how to save the information of a Storage Center volume named MyVolume as an xml, csv, or text file.

Save information in an xml fileFor example:

Get-SCVolume -Name MyVolume|Export-Clixml -path\ C:\volumeInformation\MyVolume.xml

Save information in a csv fileFor example:

Get-SCVolume -Name MyVolume|Export-Csv -path\ C:\volumeInformation\MyVolume.csv

Save information as a text fileFor example

Get-SCVolume -Name MyVolume|Format-List|Out-File -filePath\ C:\volumeInformation\MyVolume.txt

Viewing and Printing Command Line Help

Dell 19

Viewing and Printing Command Line HelpGet help information for each cmdlet in the Command Set ShellEnter the GetHelp command. For example:

Get-Help Get-SCVolumeThis returns the following information: Name Synopsis Syntax Detailed description Related Links Remarks

View additional informationEnter the detailed option. For example:

Get-Help Get-SCVolume -detailedThis returns all of the information listed above and additional information about Parameters and Examples.

View all information available for a cmdletEnter the full option. For example:

Get-Help Get-SCVolume -fullView a list of all available Storage Center snapin cmdletsEnter the Get command. For example:

Get-Command -Module Compellent.StorageCenter.PSSnapinPrint help for all cmdletsEnter the full option and export output to a file. For Example

Get-Command -Module Compellent.StorageCenter.PSSnapin | %{Get-Help $_.Name -Full}

Dell 21

A Migrating Scripts from 5.x

This appendix provides information on migrating from Storage Center Command Set version 5.x to 7.x. Scripts written with version 6.x are compatible with version 7.

ContentsSyntax Modification Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Migrating Existing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Snapins for Versions 5.x and 7. x Script Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Appendix A Migrating Scripts from 5.x


Syntax Modification ExamplesAt release 6.x, cmdlet syntax was modified to make parameters consistent, increase the ability to pipeline results, and simplify cmdlet syntax. No additional syntax modifications were made in version 7.x. The following samples illustrate how modifications achieve these goals.

Sample One: ExpandSCVolumeExpandSCVolume is a representative example that illustrate differences between cmdlet syntax between versions 5.x and 6.x/7.x. Examining the syntax shows that the version 6.x/7.x syntax is much simpler than version 5.x.

ExpandSCVolume Syntax Version 5.xExpand-SCVolume [[-NewSize] ] [[-ExpandBy] ] [[-Name] ] [-Index ] [-ParentFolder ] [-LogicalPath ] [-Notes ] [-Size ] [-ReadCacheEnabled []] [-ReadAheadCacheEnabled []] [-WriteCacheEnabled []] [-ActiveController ] [-Status ] [-SerialNumber ] [-StorageType ] [-IsReplicated []] [-IsCopying []] [-IsMirrored []] [-SCStorageProfile ] [-StorageProfileIndex ] [-StorageProfileName ] [-ReplayProfileIndex ] [-ReplayProfileName ] [-SCReplayProfile ] [-SCVolume ] [-Connection ] [-ConnectionName ] [-WarningAction ] [-WarningVariable ] [-WhatIf] [-Confirm] []

ExpandSCVolume Syntax Version 6.x or 7.xExpand-SCVolume [-SCVolume] [[-NewSize] ] [[-ExpandBy] ] [-Connection ] [-ConnectionName ] [-WhatIf] [-Confirm] []

Further examination of the parameters that have been removed, shows them to be parameters used to select volume(s) to be expanded. These parameters are referred to as filtering parameters. These filtering parameters are available in the GetSCVolume cmdlet.

The following examples show that filtering, which had been done as part of the ExpandSCVolume cmdlet in version 5.x, is now performed by the GetSCVolume cmdlet in version 6.x. Sample use of ExpandSCVolume version 5.x:

ExpandSCVolume Name TestVolume ExpandBy 10G Sample use of ExpandSCVolume version 6.x using PowerShell variables:

$vol = Get-SCVolume -Name TestVolumeExpand-SCVolume -SCVolume $vol -ExpandBy 10G

Sample use of ExpandSCVolume version 6.x using embedded cmdlets:Expand-SCVolume -SCVolume (Get-SCVolume -Name TestVolume) -ExpandBy 10G

Sample use of ExpandSCVolume version 6.x using cmdlets with pipelines:GetSCVolume Name TestVolume | ExpandSCVolume ExpandBy 10G

The last three bullets also demonstrate three different ways in which the result of the GetSCVolume cmdlet can be used as input to the ExpandSCVolume cmdlet.

In a similar way, other modified cmdlets have changed to remove filtering and provide pipelining.

Syntax Modification Examples

Dell 23

Sample Two: SetSCVolumeSetSCVolume Syntax Version 5.x

Set-SCVolume [-NewName ] [-NewNotes ] [-EnableReadCache []] [-EnableReadAheadCache []] [-EnableWriteCache []] [-NewParentFolder ] [-NewParentSCVolumeFolder ] [[-Name] ] [-Index ] [-ParentFolder ] [-LogicalPath ] [-Notes ] [-Size ] [-ReadCacheEnabled []] [-ReadAheadCacheEnabled []] [-WriteCacheEnabled []] [-ActiveController ] [-Status ] [-SerialNumber ] [-StorageType ] [-IsReplicated []] [-IsCopying []] [-IsMirrored []] [-SCStorageProfile ] [-StorageProfileIndex ] [-StorageProfileName ] [-ReplayProfileIndex ] [-ReplayProfileName ] [-SCReplayProfile ] [-SCVolume ] [-Connection ] [-ConnectionName ] [-WarningAction ] [-WarningVariable ] [-WhatIf] [-Confirm] []

SetSCVolume Syntax Version 6.x/7.xSet-SCVolume [-SCVolume] [-Name ] [-Notes ] [-EnableReadCache []] [-EnableReadAheadCache []] [-EnableWriteCache []] [-ParentSCVolumeFolder ] [-Connection ] [-ConnectionName ] [-WhatIf] [-Confirm] []

In this case the filtering commands were removed and replaced by the required SCVolume parameter, thus simplifying the syntax.



Migrating Existing ScriptsSyntax changes described above impact existing scripts. Scripts written for version 5.x will not run using version 6.x or 7.x without modification. It is recommended that old scripts be modified to run with version 7.x as soon as possible. Once undertaken, the modification process should be fairly straightforward.

As an interim solution, the version 6.x and 7.x snapins were designed to coexist with the version 5.x snapin. To accomplish this, the following changes were made in version 6.x and 7.x.

Install Procedure ModificationTo preserve version 5.x availability, the version 6.x and 7.x install procedures do not automatically remove version 5.x. When version 5.x is no longer needed, you must explicitly remove the version 5.x software by going to Windows Control Panel > Programs and Features and manually uninstall the older version.

New Name for PowerShell SnapinThe snapin name for version 6.x/7.x is Compellent.StorageCenter.PSSnapin. For version 5.x, the snapin name remains Compellent.StorageCenter.Scripting. Scripts using the version 5.x snapin should include the AddPSSnapin

Compellent.StorageCenter.Scripting cmdlet. Scripts using the version 6.x or 7.x snapin should include the AddPSSnapin

Compellent.StorageCenter.PSSnapin cmdlet.

For script examples, refer to Snapins for Versions 5.x and 7. x Script Examples on page 25.

Internal Object Type ModificationsNames and definitions for internal types have changed. For example, in version 5.x the name of the Volume type was SCCommandSet.SCObjects.Volume, in version 6.x/7.x the name of the type is SCCommandSet.SCObjects.SCVolume.

This means you cannot pass objects between versions of commands. For example, you cannot take the result of the version 5.x GetSCVolume cmdlet and pipe it into the version 6.x/7.x SetSCVolume cmdlet.

Snapins for Versions 5.x and 7. x Script Examples

Dell 25

Snapins for Versions 5.x and 7. x Script ExamplesStorage Center Command Set 7.x allows you have snapins for versions 5.x and 7.x loaded at the same time to accommodate cmdlet modifications. The following script examples demonstrate using the AddPSSnapin cmdlet when migrating from version 5.x to 7.x. Script examples in this section are written to run in a PowerShell console. Therefore,

you must explicitly load the Storage Center snapins. If scripts are run from a Storage Center Command Set Shell, one of the snapins will already be loaded (depending on the version of the Command Set Shell run) and the script examples will have to be modified appropriately.

If a script needs only one version of the snapin, only that snapin should be loaded. If a script needs both versions of the snapin, snapins can be loaded one at a time or

both can be loaded at the same time.

Example Using Version 5.x Snapin OnlyAdd-PSSnapin Compellent.StorageCenter.ScriptingExpand-SCVolume -Name TestVolume -ExpandBy 10GRemove-PSSnapin Compellent.StorageCenter.Scripting

Example Using Version 7.x Snapin OnlyAdd-PSSnapin Compellent.StorageCenter.PSSnapinGet-SCVolume -Name TestVolume | Expand-SCVolume -ExpandBy 10GRemove-PSSnapin Compellent.StorageCenter.PSSnapin

Example with One Snapin LoadedAdd-PSSnapin Compellent.StorageCenter.ScriptingExpand-SCVolume -Name TestVolume -ExpandBy 10GRemove-PSSnapin Compellent.StorageCenter.ScriptingAdd-PSSnapin Compellent.StorageCenter.PSSnapinGet-SCVolume -Name TestVolume | Expand-SCVolume -ExpandBy 10GRemove-PSSnapin Compellent.StorageCenter.PSSnapin

Example with Both Snapins LoadedAdd-PSSnapin Compellent.StorageCenter.ScriptingAdd-PSSnapin Compellent.StorageCenter.PSSnapinCompellent.StorageCenter.Scripting\Expand-SCVolume -Name TestVolume -ExpandBy 10GCompellent.StorageCenter.PSSnapin\Get-SCVolume -Name TestVolume | Compellent.StorageCenter.PSSnapin\Expand-SCVolume -ExpandBy 10GRemove-PSSnapin Compellent.StorageCenter.PSSnapinRemove-PSSnapin Compellent.StorageCenter.Scripting

Note: If both snapins are loaded at the same time, cmdlets duplicated in both versions should be fully qualified with the snapin name.

680-037-005 C

Storage Center Command Set 7.0 for Windows PowerShell Administrators GuideContents1 Before You BeginIntroductionRequirementsWhats NewNew CmdletsModified CmdletsNew Cmdlet Names

2 Using the Command SetInstallation and SetupAccessing the Storage Center Command SetUsing the Storage Center Command Set ShellUsing the Windows PowerShell Console

Connecting to a Storage CenterEstablishing a ConnectionCreating Default ConnectionsCreating SecureString PasswordsSecureString InputStored Values

Using PowerShell ObjectsObject Descriptions

Available CommandsEntering Single CommandsCreating ScriptsRunning ScriptsStorage Center Snapin Utility

Formatting and Exporting Command OutputFormat Command Output in the ConsoleExport Command Output to a File

Viewing and Printing Command Line Help

A Migrating Scripts from 5.xSyntax Modification ExamplesSample One: ExpandSCVolumeExpandSCVolume Syntax Version 5.xExpandSCVolume Syntax Version 6.x or 7.x

Sample Two: SetSCVolumeSetSCVolume Syntax Version 5.xSetSCVolume Syntax Version 6.x/7.x

Migrating Existing ScriptsInstall Procedure ModificationNew Name for PowerShell SnapinInternal Object Type Modifications

Snapins for Versions 5.x and 7. x Script ExamplesExample Using Version 5.x Snapin OnlyExample Using Version 7.x Snapin OnlyExample with One Snapin LoadedExample with Both Snapins Loaded

Documents

Storage Center Powershell Command Set Admin Guide