110-6098-En-R2 HIT Power Shell Tools Reference Guide V4.0 Web

PowerShell ToolsReferenceGuide

Version 4.0

Copyright 2011 Dell Inc. All rights reserved.

EqualLogic is a registered trademark of Dell Inc.

Dell is a trademark of Dell Inc.

All trademarks and registered trademarks mentioned herein are the property of their respectiveowners.

Information in this document is subject to change without notice.

Reproduction in any manner whatsoever without written permission is strictly forbidden.

October 2011

Part Number: 110-6098-EN-R2

Table of Contents

1 Introduction to the PowerShell Tools 1

Types of PowerShell cmdlets 1

Syntax Conventions and Case-Sensitivity 2

Inputs and Outputs for the cmdlets 3

Common Parameters 4

Getting Help on the PowerShell cmdlets 4

2 Installation 5

Installing the PowerShell Tools on Windows 5

Requirements for Using the PowerShell Interface 5

To Get Started Using the PowerShell Tools: 6

3 Session cmdlets 7

Connect-EqlGroup cmdlet 7

Disconnect-EqlGroup cmdlet 9

4 Array Management Cmdlets 13

Restart-EqlMember cmdlet 13

Stop-EqlMember cmdlet 15

5 Group Administration cmdlets 19

Group Configuration cmdlets 19

Get-EqlGroupID cmdlet 19

Get-EqlGroupDefaults cmdlet 20

Set-EqlGroupDefaults cmdlet 22

Get-EqlGroupConfiguration cmdlet 25

Set-EqlGroupConfiguration cmdlet 27

Get-EqlMember cmdlet 37

Set-EqlMember cmdlet 40

Get-EqlNetInterface cmdlet 43

Set-EqlNetInterface cmdlet 45

Get-EqlLDAPServer cmdlet 48

iii

PowerShell Tools Reference Guide Contents

New-EqlLDAPServer cmdlet 50

Remove-EqlLDAPServer cmdlet 54

Set-EqlLDAPServer cmdlet 56

Pool Configuration cmdlets 59

New-EqlPool cmdlet 60

Get-EqlPool cmdlet 61

Set-EqlPool cmdlet 64

Merge-EqlPool cmdlet 66

Remove-EqlPool cmdlet 68

Local CHAP Account cmdlets 70

New-EqlChapUser cmdlet 70

Get-EqlChapUser cmdlet 72

Set-EqlChapUser cmdlet 73

Remove-EqlChapUser cmdlet 76

6 Volume Administration Cmdlets 79

Basic cmdlets 79

New-EqlVolume cmdlet 79

Get-EqlVolume cmdlet 85

Get-EqlVolumeConnection cmdlet 93

Set-EqlVolume cmdlet 95

Remove-EqlVolume cmdlet 102

New-EqlVolumeACL cmdlet 104

Get-EqlVolumeACL cmdlet 108

Remove-EqlVolumeACL cmdlet 111

Advanced Volume Administration cmdlets 113

New-EqlVolumeClone cmdlet 113

ConvertTo-EqlTemplateVolume cmdlet 116

ConvertFrom-EqlTemplateVolume cmdlet 119

iv


New-EqlThinClone cmdlet 121

ConvertFrom-EqlThinClone cmdlet 124

7 Snapshot Cmdlets 127

New-EqlSnapshot cmdlet 127

Get-EqlSnapshot cmdlet 131

Get-EqlSnapshotConnection cmdlet 134

Set-EqlSnapshot cmdlet 136

Restore-EqlSnapshot cmdlet 140

Remove-EqlSnapshot cmdlet 143

New-EqlSnapshotClone cmdlet 146

8 Replication Cmdlets 149

Replication Configuration cmdlets 149

New-EqlReplicationPartner cmdlet 149

Get-EqlReplicationPartner cmdlet 153

Set-EqlReplicationPartner cmdlet 155

Remove-EqlReplicationPartner cmdlet 160

New-EqlReplicaSet cmdlet 162

Get-EqlReplicaSet cmdlet 165

Set-EqlReplicaSet cmdlet 168

Remove-EqlReplicaSet cmdlet 170

Replication Management cmdlets 172

New-EqlReplica cmdlet 173

Get-EqlReplica cmdlet 175

Remove-EqlReplica cmdlet 178

Suspend-EqlReplication cmdlet 180

Resume-EqlReplication cmdlet 182

ConvertTo-EqlPromotedReplicaSet cmdlet 184

ConvertTo-EqlDemotedReplicaSet cmdlet 186

v


Get-EqlInboundReplica cmdlet 187

Get-EqlInboundReplicaSet cmdlet 189

9 Schedule Cmdlets 193

New-EqlSchedule cmdlet 193

Get-EqlSchedule cmdlet 198

Set-EqlSchedule cmdlet 201

Remove-EqlSchedule cmdlet 206

Contacting Dell 209

Online Services 209

vi

1 Introduction to the PowerShell Tools

The PowerShell Tools provide a powerful, comprehensive set of PowerShell cmdlets formanaging one or many PS Series groups. Using the PowerShell Tools, you can:

• Manage a PS Series group in the preferred object-based scripting environment for Windowsplatforms (using PowerShell cmdlets in a script or through a command line).

• Automate routine PS Series management tasks.

• Integrate data center processes that involve PS Series tasks.

Types of PowerShell cmdletsThe PowerShell cmdlets help to manage a PS Series group. They are divided into the followingcategories:

• Session cmdlets — A session is a connection to a PS Series group. The session cmdletscreate or terminate a session to a group. A connection to a group is required to use cmdletsin any of the other categories.

• Array cmdlets — Array management cmdlets act on individual PS Series arrays and areused to perform maintenance tasks on individual arrays.

• Group administration cmdlets — The Group Administration cmdlets are divided into thefollowing subcategories:

– Group Configuration: These cmdlets allow you to perform operations such as retrievingor changing group default settings, and changing configuration settings for an array thatbelongs to a group.

– Pool Configuration: These cmdlets allow you to perform operations such as creating anew pool in a PS Series group, moving members and volumes from one pool to another,and deleting a pool from a PS Series group.

– Local CHAP Accounts: These cmdlets allow you to perform operations such as addingor removing a CHAP user to a group, changing a password, and retrieving all the CHAPusernames for a PS Series group.

• Volume administration cmdlets — Volume Administration cmdlets help manage the volumesin a PS Series group. They are divided into the following subcategories:

– Basic: These cmdlets allow you to perform operations such as creating a new volume ona PS Series group, managing access control lists (ACLs) for a volume and its snapshots,retrieving or changing configuration information for volumes on a group, listing all of theiSCSI connections to a volume, or deleting a volume and all its snapshots, schedules andaccess control lists (ACLs) from a group.

– Advanced: These cmdlets allow you to perform operations such as creating a clone of avolume, converting a volume to a template volume, creating a thin clone from a templatevolume, converting a template volume to a regular volume, or detaching a thin clonevolume from its template volume.

1

PowerShell Tools Reference Guide 1 Introduction to the PowerShell Tools

• Snapshot management cmdlets — The Snapshot Management cmdlets allow you to performoperations such as creating a new snapshot, deleting a snapshot, retrieving or changingsettings for a snapshot, restoring a volume from a snapshot, cloning a snapshot, and listingiSCSI connections to a snapshot. Snapshots created by the PowerShell Tools are crashconsistent, and not application consistent. To create application consistent snapshots, use theAuto-Snapshot Manager/Microsoft Edition (ASM/ME) console or the ASM CLI. The ASMCLI is a set of commands that you can execute at the Windows command prompt instead ofusing the ASM/ME GUI for Smart Copy operations. See the Auto-Snapshot ManagerUser Guide for more information.

• Replication cmdlets — The Replication cmdlets are divided into the followingsubcategories:

– Replication Configuration: These cmdlets allow you to perform operations such assetting up replication between two PS Series groups, retrieving or changing the definitionof a replication partnership between two groups, canceling a replication partnershipbetween two groups, configuring replication of a volume to a replication site, retrievingor changing settings for a replica set of a volume, and deleting a replica set for avolume.

– Replication Management: These cmdlets allow you to perform operations on individualreplicas within a replica set, such as creating a new replica, getting a list of replicas, ordeleting a specific replica. They also allow you to perform operations such assuspending or resuming replication of a volume, promoting a replica set to a volume, anddemoting a replica set to a normal replica set.

• Schedule cmdlets — The Schedule cmdlets allow you to perform operations such as creatingor removing a schedule for taking snapshots or replicas of a specified volume, and changingor retrieving schedule information for a volume.

Syntax Conventions and Case-SensitivityThe following conventions apply to the PowerShell Tools cmdlet syntax.Convention Usage

<string>

Angle brackets indicate that a specific value (whatever data type islisted within the angle brackets) should be used. For example,<string> means that a character string should be used in the cmdletsyntax and <int> means that an integer should be used.

[parameter] Brackets indicate that the parameter within them is an optionalparameter.

> A greater than symbol represents a Windows system prompt.

Names of volumes, groups, snapshots, pools, members, and schedules are case-sensitive.Further, some cmdlets support only IPv4 addresses while others support either IPv4 or IPv6. Thecmdlets handle IPV4 and IPv6 correctly as long as the values entered are enclosed in quotes.

For each parameter, the following five properties are listed:

• Required? — Whether or not the parameter is required.

2


• Named? — Whether the parameter is positional or named. Currently, only namedparameters are used.

• Default value? — Whether or not the parameter has a default value.

• Whether or not the parameter accepts pipeline input.

• Whether or not the parameter accepts wildcard characters. Wildcard parameter matching isnot case-sensitive.

See the documentation for a specific cmdlet for more information about that cmdlet.

Inputs and Outputs for the cmdletsThere are different ways to feed inputs to the cmdlets. For example, different parameter valuescan be piped to cmdlets from other sources, such as an XML file that uses parameter names forelement names. A specific object from a cmdlet can be fed as an input to another cmdlet. Forexample, the output of the Get-VolumeACL cmdlet (an Interop.EqlPsaMgmtAPI.EQL_ACL_SPECobject) can be piped to the New-VolumeACL cmdlet in order to copy the access control lists(ACLs) from one volume to another. Some cmdlets may not accept any input at all.

Similarly, outputs also vary according to the cmdlet. Most cmdlets return a string acknowledgingthe successful completion of the cmdlet. Cmdlets with the new and set verbs will return anobject if the PassThru parameter is specified. If the PassThru parameter is not specified, astring acknowledging the successful completion of the cmdlet will be returned. The get cmdletsreturn an object for a specific item. For example, Get-Volume will return an EQL_VOLUME_SPECfor a volume specified by name. If a name is not specified, Get-Volume will return a collectionof objects of the appropriate type to which the connected user has access. Regardless of thecmdlet, all names used to identify objects on a PS Series group are case-sensitive and must beunique.

Helpful Parameters for Identifying Volumes

The MemberIndex [<uint>], VolumeIndex[<uint>], and UseIndex [<SwitchParameter>]parameters are optional parameters that provide a fast method for accessing a volume. If anarray has a lot of volumes, or if cmdlets are being executed in a loop, specifying theseparameters provides an efficient way to uniquely identify volumes. The values for theseparameters can be obtained for one or more volumes by executing the Get-EqlVolume cmdletand piping them to other cmdlets that support the UseIndex parameter, such as New-EqlSnapshotor Get-EqlVolumeAcl.

These three parameters can be used for the following cmdlets: Get-EqlVolume, Set-EqlVolume,Remove-EqlVolume, New-EqlThinClone, New-EqlVolumeAcl, Get-EqlVolumeAcl,Remove-EqlVolumeAcl, New-EqlSnapshot, Get-EqlSnapshot, Set-EqlSnapshot,Restore-EqlSnapshot, Remove-EqlSnapshot, New-EqlSnapshotClone, New-EqlSchedule,Get-EqlSchedule, Set-EqlSchedule, Remove-EqlSchedule, Get-EqlVolumeConnection,Get-EqlSnapshotConnection, and New-EqlReplica.

3


Note: Refer to the documentation for a specific cmdlet to see what is available for itsinput and output.

Common ParametersAll the PowerShell Tool cmdlets support the following parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. Formore information, type get-help about_commonparameters. For further documentation on theseparameters, see the Microsoft Windows PowerShell documentation.

Getting Help on the PowerShell cmdletsThe PowerShell Tools allow you to get help for using the cmdlets in the same way that you gethelp for standard PowerShell operations. You can get a complete list of cmdlets, or you can gethelp for an individual cmdlet. The different methods of getting help are as follows:

• To get detailed syntax information and examples of cmdlet usage, type the PowerShellGet-Help cmdlet and specify the cmdlet name, such as New-EqlSnapshot, followed by theparameter -Full. Refer to the PowerShell Get-Help cmdlet documentation for other options.

• To get a list of available cmdlets, type Get-Command -Module EqlPSTools.

• To get the syntax for an individual cmdlet, execute the cmdlet with the parameter -?.

Note: Although the cmdlet names are not case-sensitive, the PowerShell convention usescamel-casing to make them more readable.

4

2 Installation

The PowerShell Tools are included in the installation kit for Host Integration Tools 3.5 or later.

Installing the PowerShell Tools on Windows1. Run setup.exe for Windows 32 bit installation, or setup64.exe for Windows 64 bit

installation.

2. Select to install the PowerShell Tools and any other Host Integration Tools componentsincluded in the installation kit.

Requirements for Using the PowerShell Interface• PowerShell 2.0 is required. If you are running Microsoft Exchange 2007 SP1, PowerShell 2.0

is not supported. You will therefore have to upgrade to Microsoft Exchange 2007 SP2 priorto upgrading to PowerShell 2.0.

Note: To verify the PowerShell version you are using, you can launch a Windowscommand prompt and enter powershell host. You can also launch the PowerShellconsole and enter host.

• You must be running a Windows operating system. See the section below for a list ofsupported Windows operating systems.

• You must be running PS Series firmware V4.2.0 or later. Some cmdlets may require laterversions of the firmware.

• In order to enable communication between the PS Series group and the PowerShell Tools,you must create a new administrative account or reset the password for any existingadministrative account (you can reuse the same password) on the PS Series group. This onlyneeds to be done once for each set of credentials you want to use for each PS Series group.

Supported Operating Systems

The supported operating systems are:

• Windows XP SP3

• Windows Server 2003 R2

• Windows Vista

• Windows Server 2008 SP2

• Windows 7

• Windows Server 2008 R2

5

PowerShell Tools Reference Guide 2 Installation

To Get Started Using the PowerShell Tools:1. Install the PowerShell Tools.

2. Click Start, then Programs, then EqualLogic, then PowerShell Tools, and then HITPowerShell Tools to launch the PowerShell 2.0 console and automatically load theEqlPSTools module.

Note: If you launch the PowerShell Tools and get the following error, you do not havePowerShell 2.0 installed. This is a Microsoft error message.The term "import-module" is not recognized as a cmdlet, function, operableprogram, or script file. Verify the term and try again.

3. To load the cmdlets into a regular or third-party PowerShell Console, launch the console andexecute the PowerShell cmdlet:

import-module -name <install path>\EqlPSTools.dll

4. To view a list of PowerShell Tool cmdlets, execute the PowerShell cmdlet:

get-command -Module EqlPSTools

5. To view the syntax and help with examples for a cmdlet, execute the PowerShell cmdlet:

get-help <cmdletname> -full

6. To view the syntax for a cmdlet, execute the cmdlet with the parameter -?:

7. Refer to chapters 3 through 8 for complete syntax and descriptive information for all of thecmdlets.

6

3 Session cmdlets

You must be connected to a PS Series group to execute any of the cmdlets that require access toa PS Series group. You can use the Connect-EqlGroup and Disconnect-EqlGroup cmdlets tomanage sessions to PS Series groups, and to switch between groups.

You can also connect to more than one group. To do this, you can use the Connect-EqlGroupcmdlet and specify the group on which a cmdlet should execute. To specify the group, use theGroupName and GroupAddress parameters. If those parameters are not specified, the cmdlet willexecute on the current group and not the group on which you want the cmdlets to execute. Thecurrent group is the most recent group explicitly specified in a previous cmdlet.

Connect-EqlGroup cmdletCreates a session to a PS Series group.

Command SyntaxConnect-EqlGroup -GroupAddress <string>[-Credential <System.Management.Automation.PSCredential>][-Username <string>][-Password <string>] [-SMTPTimeoutSeconds <uint>][-SMTPRetryAttempts <uint>][<CommonParameters>]

Command Description

The Connect-EqlGroup cmdlet creates a session—in the current PowerShell runspace—to a PSSeries group and makes it the current group. The group must be specified by its IP address. Theadministrator name and password must be specified using either the -Credential parameter orthe Username and Password parameters. Any subsequent cmdlets in the current PowerShellrunspace will perform actions on this group until the Disconnect-EqlGroup cmdlet is executedfor this group, or until Connect-EqlGroup is used to connect to another group, or a group isspecified for the cmdlet using either the GroupName or GroupAddress parameter.

Inputs

None. You cannot pipe objects to Connect-EqlGroup.

Outputs

None. Returns a string acknowledging the successful completion of the cmdlet action. Thisstring includes the name of the group to which the connection was made.

Command ParametersParameter: GroupAddress <string>

Specifies the IP Address of a PS Series group for which the user has a valid administrator nameand password. This parameter can be either IPv4 or IPv6.

7

PowerShell Tools Reference Guide 3 Session cmdlets

Required?: truePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: Credential <System.Management.Automation.PSCredential>

Specifies a PSCredential object containing the name and password of an administrative userwith access to the specified PS Series group. Refer to the PowerShell documentation forPSCredential for alternative methods for initializing the PSCredential object. The Password andUsername parameters can be used instead of the Credential parameter.

Required?: true, unless Username and Password are specified.Position?: namedDefault value?: noneAccept pipeline input?: falseAccept wildcard characters?: false

Parameter: Username <string>

Specifies the name of an administrative user with access to the specified PS Series group. TheCredential parameter can be used instead of the Password and Username parameters.

Required?: true, unless Credential is specified.Position?: namedDefault value?: noneAccept pipeline input?: falseAccept wildcard characters?: false

Parameter: Password <string>

Specifies the password of an administrative user with access to the specified PS Series group.The Credential parameter can be used instead of the Password and Username parameters.

Required?: true, unless Credential is specified.Position?: namedDefault value?: noneAccept pipeline input?: falseAccept wildcard characters?: false

Parameter: SMTPTimeoutSeconds <uint>

Specifies the number of seconds to wait for completion of an SMTP request.

Required?: falsePosition?: namedDefault value?: 60Accept pipeline input?: falseAccept wildcard characters?: false

Parameter: SMTPRetryAttempts <uint>

Specifies the number of times to retry an SMTP request if it fails or times out.

Required?: false

8


Position?: namedDefault value?: 1Accept pipeline input?: falseAccept wildcard characters?: false

Notes

Under some circumstances, especially the first time, you may get the following error whentrying to connect to a PS Series Group:

Error -23035 - Group address, admin account, or password is invalid:

This error can be caused by several factors. Try the following corrective actions:

1. Verify that the parameters and values are correct.

2. Verify that you can log onto the Group Manager using these credentials.

3. Verify that all members of the group are running the minimum required firmware revision4.2 or later.

4. Reset the admin account password using the Group Manager to force the reinitialization andclear this condition. You only need to do this once, and you can use the same password.

Examples

Example 1

This command uses the PowerShell Get-Credential cmdlet to pop up a dialog, prompt for ausername and password, and create a session to the PS Series group using 10.100.100.10. Allsubsequent cmdlets in the current PowerShell runspace will execute on the specified group.

C:\PS>Connect-EqlGroup -GroupAddress 10.100.100.10 -Credential (Get-Credential)

Example 2

This command will create a session to the PS Series group using 10.100.100.10 if grpadmin hasaccess to the group and mypassword is valid. All subsequent cmdlets in the current PowerShellrunspace will execute on the specified group.

C:\PS>Connect-EqlGroup -GroupAddress 10.100.100.10 -Username grpadmin -Passwordmypassword

Related Commands

• Disconnect-EqlGroup cmdlet

Disconnect-EqlGroup cmdletTerminates the session to a PS Series group to which a connection exists in the currentPowerShell runspace.

9


Command SyntaxDisconnect-EqlGroup [-GroupName <string>] [-GroupAddress <string>][<CommonParameters>]

Command Description

The Disconnect-EqlGroup cmdlet terminates a session to a PS Series group to which aconnection exists in the current PowerShell runspace identified by the group name or its IPaddress. You can specify the target group using either the GroupName or GroupAddressparameter. Any subsequent cmdlets will fail unless a connection to another group exists, or untilthe Connect-EqlGroup cmdlet is used to create a new group session.

Inputs

None. You cannot pipe objects to Disconnect-EqlGroup.

Outputs

None. Returns a string acknowledging the successful completion of the cmdlet action.

Command ParametersParameter: GroupName <string>

Specifies the name of a PS Series group for which a session was created from this PowerShellrunspace. The GroupAddress parameter can be used instead of the GroupName parameter.

Required?: true, unless GroupAddress is specifiedPosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: GroupAddress <string>

Specifies the IP address of a PS Series group for which a session was created from thisPowerShell runspace. This parameter can be either IPv4 or IPv6. If this parameter is used, theGroupName parameter is not necessary.

Required?: true, unless GroupName is specifiedPosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Examples

Example 1

This command will terminate the session to MyGroup. All subsequent cmdlets will fail until anew connection is created.

10


C:\PS>Disconnect-EqlGroup -GroupName MyGroup

Example 2

This command will terminate the session connected to the group at IP address 10.100.100.10. Allsubsequent cmdlets will fail until a new connection is created.

C:\PS>Disconnect-EqlGroup -GroupAddress 10.100.100.10

Related Commands

• Connect-EqlGroup cmdlet

11

4 Array Management Cmdlets

Array management cmdlets act on individual PS Series arrays and are used to performmaintenance tasks.

Restart-EqlMember cmdletShuts down and restarts an array. Restarting an array has no effect on member, volume, or groupconfiguration information or volume data. When you restart an array, network connections areclosed and the array is shut down. Then, the array automatically restarts. When the restartcompletes, the member rejoins the group automatically. Volumes with data located on themember will be unavailable until the restart completes.

Restart an array only when you are updating the array firmware. Do not repeatedly restart anarray.

SyntaxRestart-EqlMember [-GroupName <string>] [-GroupAddress <string>] -MemberName<string> [-Force[<SwitchParameter]] [<CommonParameters>]

Command Description

The Restart-EqlMember cmdlet shuts down and restarts the specified array that is a member ofa PS Series group to which a connection exists in the current PowerShell runspace. This cmdletwill display a prompt to the console to confirm the restart. The Force parameter can be used tosuppress this prompt for scripts.

Inputs

None.

Outputs

Returns a string acknowledging the successful initiation of the array restart process.


Specifies the name of a PS Series group for which a session exists in this PowerShell runspace.The GroupAddress parameter can be used instead of this parameter. The cmdlet will execute onthe specified group.

Required?: falsePosition?: namedDefault value?: noneAccept pipeline input?: true

13

PowerShell Tools Reference Guide 4 Array Management Cmdlets

Accept wildcard characters?: false


Specifies the IP address of a PS Series group for which a session exists in this PowerShellrunspace. This parameter can be either IPv4 or IPv6. Either this parameter or the GroupNameparameter can be used to identify a group for this cmdlet. The cmdlet will execute on thespecified group.

Required?: falsePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: MemberName <string>

Specifies the name of a member of a PS Series group that identifies the member to which thiscmdlet applies. This name is case-sensitive.


Parameter: Force [<SwitchParameter>]

Specifies that the cmdlet should bypass the confirmation prompt and restart the array.

Required?: falsePosition?: namedDefault value?: falseAccept pipeline input?: falseAccept wildcard characters?: false

Examples

Example 1

This command prompts for confirmation and initiates the shutdown and restart of Member1 ifconfirmed.

C:\PS>Restart-EqlMember -MemberName Member1

Example 2

This command initiates the shutdown and restart of Member1 without prompting forconfirmation.

C:\PS>Restart-EqlMember -MemberName Member1 -Force

Related Commands


14


• Get-EqlMember cmdlet

• Stop-EqlMember cmdlet

Stop-EqlMember cmdletCleanly shuts down an array. Shutting down an array has no effect on member, volume, or groupconfiguration information or volume data stored on the member. Any volumes with data on thearray will be set offline until the array is completely restarted. Once the array is restarted, itrejoins the group automatically. Any iSCSI connections to volumes and snapshots on the arraywill be terminated and will not be available until the array is restarted.

Note: The Stop-EqlMember cmdlet does not power off the array. To power off the array,you must turn off both power supplies after the array shuts down. Do not repeatedly shutdown and restart an array.

If you are using a network connection to run the Stop-EqlMember cmdlet, the session will bedisconnected before the array is shut down. Therefore, make sure that the ACT LED on eachcontrol module is off (not lit) before turning off power to both power supplies. To fully restart thearray, turn on power to both power supplies. When the array restart completes, volumes will beset online.

SyntaxStop-EqlMember [-GroupName <string>] [-GroupAddress <string>] -MemberName <string>[-Force[<SwitchParameter]] [<CommonParameters>]

Command Description

The Stop-EqlMember cmdlet shuts down the specified array that is a member of a PS Seriesgroup to which a connection exists in the current PowerShell runspace. This cmdlet will displaya prompt to the console to confirm the shut down. The Force parameter can be used to suppressthis prompt for scripts.

Inputs

None.

Outputs

Returns a string acknowledging the successful initiation of the array shutdown process.



15










Specifies that the cmdlet should bypass the confirmation prompt and shut down the array.


Examples

Example 1

This command prompts for confirmation and initiates the shutdown of Member1 cleanly ifconfirmed.

C:\PS>Stop-EqlMember -MemberName Member1

Example 2

This command initiates the shutdown of Member1 without prompting for confirmation.

C:\PS>Stop-EqlMember -MemberName Member1 -Force

16


Related Commands



• Restart-EqlMember cmdlet

17

5 Group Administration cmdlets

Group Configuration cmdletsYou can use the group configuration cmdlets to view or change the current settings for a group.You can also manage the pools and member arrays that are part of the group configuration.

Get-EqlGroupID cmdletRetrieves the unique identifier for a PS Series group.

SyntaxGet-EqlGroupID [-GroupName <string>] [-GroupAddress <string>] [<CommonParameters>]

Command Description

The Get-EqlGroupID cmdlet retrieves the unique identifier for a PS Series group to which aconnection exists in the current PowerShell runspace. If you are connected to more than onegroup, you can specify the target group using either the GroupName or GroupAddress parameter.

Inputs

None. You cannot pipe objects to Get-EqlGroupID.

Outputs

This command outputs a string containing a Group ID.


Specifies the name of a PS Series group for which a session exists in this PowerShell runspace.Either this parameter or the GroupAddress parameter can be used to identify a group for thiscmdlet.



19

PowerShell Tools Reference Guide 5 Group Administration cmdlets

Specifies the IP address of a PS Series group for which a session exists in this PowerShellrunspace. This parameter can be either IPv4 or IPv6. Either this parameter or the GroupNameparameter can be used to identify a PS Series group for this cmdlet.


Example

This command will return the unique Group ID for the group to which a connection exists in thecurrent PowerShell runspace.

C:\PS>Get-EqlGroupID

The following Group ID is an example of a Group ID that will be output to the console.6-0C0909-252711EE5-C2D4A40000002000

Related Commands


Get-EqlGroupDefaults cmdletRetrieves the current default value settings for a PS Series group.

SyntaxGet-EqlGroupDefaults [-GroupName <string>][-GroupAddress <string>][<CommonParameters>]

Command Description

The Get-EqlGroupDefaults cmdlet retrieves the current default value settings for a PS Seriesgroup to which a connection exists in the current PowerShell runspace. If you are connected tomore than one group, you can specify the target group using either the GroupName orGroupAddress parameter. These defaults include snapshot reserve percent, snapshot warningpercent, snapshot space recovery policy, thin provisioning warning percent, thin provisioning setvolume offline percent, iSCSI Target name prefix, and use volume name for iSCSI alias. Thesedefaults are used during volume creation if parameters for these values are not specified whenthe New-EqlVolume cmdlet is executed.

Inputs

None.

20


OutputsInterop.EqlPsaMgmtAPI.EQL_PSGROUP_DEFAULT_SPEC

You can pipe objects from Get-EqlGroupDefaults to other cmdlets, such asSet-EqlGroupDefaults. Pipe the objects through format-list to filter out parameters that you donot want to use.





Specifies the IP address of a PS Series group for which a session exists in this PowerShellrunspace. This parameter can be either IPv4 or IPv6. Either this parameter or the GroupNameparameter can be used to identify a Group for this cmdlet.


Examples

Example 1

This command will return the default values used for the PS Series group to which a connectionexists in the current PowerShell runspace.

C:\PS>Get-EqlGroupDefaults

When you execute the Get-EqlGroupDefaults cmdlet, the names of the defaults and their valuesare output to the console. See the following for sample output:

UseVolumeNameForiSCSIAlias : yesISCSITargetNamePrefix : iqn.2001-05.com.mycompanyThinProvisionWarningPercent : 60ThinProvisionMaxGrowPercent : 100SnapshotDeletionPolicy : delete_oldestSnapshotReservePercent : 100SnapshotReserveWarnPercent : 90

21


Example 2

This command gets the group default values for GroupA and copies them to GroupB.

C:\PS>Get-EqlGroupDefaults -GroupName GroupA | Set-EqlGroupDefaults -GroupNameGroupB

Related Commands


• Set-EqlGroupDefaults cmdlet

Set-EqlGroupDefaults cmdletChanges the current default value settings for a PS Series group.

Command SyntaxSet-EqlGroupDefaults [-GroupName <string>][-GroupAddress <string>][-SnapshotReservePercent <uint>][-UseVolumeNameForiSCSIAlias <string>] [-ISCSITargetNamePrefix <string>][-SnapshotReserveWarnPercent <uint>] [-SnapshotDeletionPolicy <string>][-ThinProvisionWarningPercentDefault <uint>] [-ThinProvisionMaxGrowPercent <uint>][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Set-EqlGroupDefaults cmdlet changes the current default value settings for a PS Seriesgroup to which a connection exists in the current PowerShell runspace. If you are connected tomore than one group, you can specify the target group using either the GroupName orGroupAddress parameter. These defaults include snapshot reserve percent, snapshot warningpercent, snapshot space recovery policy, thin provisioning warning perecent, thin provisioningset volume offline percent, iSCSI Target name prefix, and use volume name for iSCSI alias.These defaults are used during volume creation if parameters for these values are not specifiedwhen the New-EqlVolume cmdlet is executed.

InputsInterop.EqlPsaMgmtAPI.EQL_PSGROUP_DEFAULT_SPEC

You can pipe objects from Get-EqlGroupDefaults to Set-EqlGroupDefaults if you want tocopy the defaults from one group to another. Pipe the objects through format-list to filter outparameters that you do not want to set.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_PSGROUP_DEFAULT_SPEC object if the PassThru parameter is

22


present.







Parameter: SnapshotReservePercent <uint>

Changes the default percent of the volume size set aside for snapshot reserve.

Required?: falsePosition?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: UseVolumeNameForiSCSIAlias <string>

Changes whether to use the volume name as the default iSCSI alias. Enter (y)es or $true to usethe volume name. Enter (n)o or $false to not create a default iSCSI alias.


Parameter: ISCSITargetNamePrefix [<string>]

Specifies the default prefix to use when creating an iSCSI target name.

Required?:falsePosition?: named

23


Default value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: SnapshotReserveWarnPercent <uint>

Changes the default percent for the snapshot reserve that can be used before a low spacewarning is issued.


Parameter: SnapshotDeletionPolicy <string>

Changes the default policy to apply when the snapshot reserve is insufficient to create snapshotsof the volume. Enter (m)ake_volume_offline or (d)elete_oldest for the policy.


Parameter: ThinProvisionWarningPercent <uint>

Changes the default percent of the requested volume size that can be used before a warning isissued. This only applies to thin provisioned volumes.


Parameter: ThinProvisionMaxGrowPercent <uint>

Changes the default percent of the requested volume size to which the volume can grow, beforethe total size of the volume must be increased if it is thin provisioned.


Parameter: PassThru [<SwitchParameter>]

Specifies that the cmdlet should return an EQL_PSGROUP_DEFAULT_SPEC object for the changeddefaults on successful completion.

Required?: falsePosition?: namedDefault value?: false

24


Accept pipeline input?: falseAccept wildcard characters?: false

Examples

Example 1

This command will change the threshold for thin provisioning warning events to 80 percent andthe maximum grow percent to 95 percent for the group to which a connection exists in thecurrent PowerShell runspace.

C:\PS>Set-EqlGroupDefaults -ThinProvisionWarningPercentDefault 80-ThinProvisionMaxGrowPercentDefault 95

Example 2

This command gets the group default values for GroupA and copies them to GroupB.

C:\PS>Get-EqlGroupDefaults -GroupName GroupA | Set-EqlGroupDefaults -GroupNameGroupB

Related Commands


• Get-EqlGroupDefaults cmdlet

Get-EqlGroupConfiguration cmdletRetrieves the current configuration settings for a PS Series group.

SyntaxGet-EqlGroupConfiguration [-GroupName <string>][-GroupAddress <string>] [<CommonParameters>]

Command Description

The Get-EqlGroupConfiguration cmdlet retrieves the current configuration settings for a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_PSGROUP_SPEC

25


You can pipe objects from Get-EqlGroupConfiguration to other cmdlets, such asSet-EqlGroupConfiguration. Pipe the objects through format-list to filter out parameters thatyou do not want to use.







Examples

Example 1

This command will return the current configuration settings for the PS Series group to which aconnection exists in the current PowerShell runspace.

C:\PS>Get-EqlGroupConfiguration

When you execute the Get-EqlGroupConfiguration cmdlet, the names of the settings and theirvalues are output to the console. See the following for sample output:

GroupName : GroupBGroupAddress : 10.100.100.5GroupID : 6-0C0909-252711EE5-C2D4A40000002000ClientAccessSSH : enabledClientAccessTelnet : enabledWebAccess : enabledWebAccessNoEncrypt : enabledConnectionBalancing : enabledPerformanceBalancing : enabledGroupDate : 11/14/10GroupTime : 06:34:06GroupTimeZone : VAL_eqlGroupTimeZone_america_New_YorkGroupDescription : This is the database group for North AmericaUseCHAPForDiscovery : disabledEmailHomeContact :

26


SMTPServers : 10.100.100.1;10.100.100.2:80EmailSender : [email protected] : myCompany.comEmailSenderName : emailSenderEmailRecipientList :[email protected];[email protected] : disabledFTPService : enabledUseLocalChapForIscsi : enabledGroupLocation : defaultMembershipPassword : ****************SyslogNotification : disabledNTPServers : 10.100.100.3:123;10.100.100.4SyslogServers : 10.100.100.1RadiusIscsiAuthentication : disabledRadiusLoginAuthentication : disabledRadiusAuthenticationServers : 10.100.100.1RadiusAuthenticationSecrets : ****************RadiusAuthenticationTimeoutSeconds : 2RadiusAuthenticationRetryCount : 1RadiusUserAccounting : disabledRadiusAccountingServers : 10.100.100.1RadiusAccountingSecrets : ****************RadiusAccountingTimeoutSeconds : 2RadiusAccountingRetryCount : 1LDAPLoginAuthentication: disabled

Example 2

This command retrieves the group configuration settings for GroupA and copies them to GroupB.

C:\PS>Get-EqlGroupConfiguration -GroupName GroupA | Set-EqlGroupConfiguration-GroupName GroupB

Related Commands


• Set-EqlGroupConfiguration cmdlet

Set-EqlGroupConfiguration cmdletChanges the current configuration settings for a PS Series group.

Command SyntaxSet-EqlGroupConfiguration [-GroupName <string>] [-GroupAddress <string>][-ClientAccessSSH <string>] [-ClientAccessTelnet <string>] [-WebAccess <string>][-WebAccessNoEncrypt <string>] [-ConnectionBalancing <string>][-PerformanceBalancing <string>] [-GroupDescription [<string>]][-UseCHAPForDiscovery <string>] [-EmailHomeContact [<string>]][-SMTPServers [<string>]] [-NTPServers [<string>]][-EmailSender [<string>]] [-EmailRecipientList [<string>]][-EmailNotification <string>] [-FTPService <string>][-SendInfoMessages <string>] [-UseLocalChapForIscsi <string>][-GroupLocation [<string>]][-Credential <System.Management.Automation.PSCredential>]

27


[-MembershipPassword [<string>]] [-SyslogNotification <string>][-SyslogServers <string>] [-RadiusIscsiAuthentication <string>][-RadiusLoginAuthentication <string>] [-RadiusAuthenticationServers <string>][-RadiusAuthenticationSecrets <string>][-RadiusAuthenticationTimeoutSeconds <int>][-RadiusAuthenticationRetryCount <int>] [-RadiusUserAccounting <string>][-RadiusAccountingServers <string>] [-RadiusAccountingSecrets <string>][-RadiusAccountingTimeoutSeconds <int>] [-RadiusAccountingRetryCount <int>][-LDAPLoginAuthentication <string>] [-PassThru [<SwitchParameter>]][<CommonParameters>]

Command Description

The Set-EqlGroupConfiguration cmdlet modifies the current configuration settings for a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter.

Inputs

None.

Outputs

string or Interop.EqlPsaMgmtAPI.EQL_PSGROUP_SPEC

You can pipe objects from Get-EqlGroupConfiguration to Set-EqlGroupConfiguration if youwant to copy the settings from one group to another. Pipe the objects through format-list to filterout parameters that you do not want to use.






Required?: false

28


Position?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ClientAccessSSH <string>

Changes whether the SSH service on the group is enabled or disabled. Enter (e)nabled or $trueto enable the service and allow SSH access to the group and its member arrays. Enter (d)isabledor $false to disable the service.

Required?: falsePosition?: namedDefault value?: enabledAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ClientAccessTelnet <string>

Changes whether the Telnet service on the group is enabled or disabled. Enter (e)nabled or $trueto enable the service and allow Telnet access to the group and its member arrays. Enter(d)isabled or $false to disable the service.


Parameter: WebAccess <string>

Changes whether the use of standard HTTP Web connections (through port 80) to the GroupManager GUI is enabled or disabled. Enter (e)nabled or $true to enable the standard HTTP Webconnections to the Group Manager GUI. Enter (d)isabled or $false to disable standard HTTPWeb connections.

Required?:falsePosition?: namedDefault value?: enabledAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: WebAccessNoEncrypt <string>

Changes whether the SSL encryption is required for access on the standard HTTP Webconnection to the Group Mnager GUI. Enter (e)nabled or $true to require SSL encryption. Enter(d)isabled or $false to not require SSL encryption.

Required?: falsePosition?: namedDefault value?: disabledAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ConnectionBalancing <string>

29


Changes whether iSCSI connection load balancing across group members is enabled or disabled.Enter (e)nabled or $true to enable iSCSI connection load balancing. Enter (d)isabled or $false todisable it.


Parameter: PerformanceBalancing <string>

Changes whether performance load balancing based on the optimal RAID level for a volume isenabled or disabled. Enter (e)nabled or $true to enable performance load balancing. Enter(d)isabled or $false to disable it.


Parameter: GroupDescription <string>

Changes the description of the group (up to a maximum of 63 characters). Enter the parameterwithout a value to remove a group description. If the description contains spaces, surround itwith quotation marks.


Parameter: UseCHAPForDiscovery <string>

Changes whether the requirement for iSCSI initiators trying to discover targets to provide CHAPcredentials is enabled or disabled. Enter (e)nabled or $true to require the use of CHAP fordiscovery. Enter (d)isabled or $false to disable the requirement.


Parameter: EmailHomeContact [<string>]

Changes the local IP Address used as a destination for sending notifications of firmware updatesand hardware failures. If an address is specified, the E-Mail Home feature is enabled to sendthe notifications to Dell Customer Support. An SMTP server IP Address must also be specifiedusing the SMTPServer parameter. Optionally, a sender IP address can be specified using theEmailSender parameter.

30



Parameter: SMTPServers <string>

Changes the IP Addresses and optional port numbers in the list of SMTP Servers used for e-mailmessages with event notifications from the group. A maximum of three SMTP Servers can bespecified in order of preference in this semicolon-delimited list enclosed in quotation marks.SMTPServers can be IPv4 or IPv6 for the Set-EqlGroupConfiguration cmdlet. A port can bespecified with each address. For IPv4 addresses, the port number should be separated from theIP address using a colon (:). For IPv6 addresses, the port number should be separated from the IPaddress using a space. If a port is not specified, port 125 is used.


Parameter: NTPServers <string>

Changes the IP Addresses and optional port numbers in the list of Network Time ProtocolServers used for setting a consistent time on all group members. A maximum of three NTPServers can be specified in order of preference in this semicolon-delimited list enclosed inquotation marks. NTPServers can be IPv4 or IPv6 for the Set-EqlGroupConfiguration cmdlet.A port can be specified with each address. For IPv4 addresses, the port number should beseparated from the IP address using a colon (:). For IPv6 addresses, the port number should beseparated from the IP address using a space. If a port is not specified, port 123 is used.


Parameter: EmailSender <string>

Changes the email address used as the sender of notification email messages. An SMTP serverIP Address must also be specified using the SMTPServer parameter. Optionally, a semicolon-delimited list of up to 5 destination email addresses can be specified using theEmailRecipientList parameter.


Parameter: EmailRecipientList <string>

31


Changes the email addresses used as the destination of e-mail messages with event notificationsfrom the group. An SMTP server IP Address must also be specified using the SMTPServerparameter. Optionally, a sender email address can be specified using the EmailSenderparameter.


Parameter: EmailNotification <string>

Changes whether e-mail notification of events is enabled or disabled for the group. Enter(e)nabled or $true to send e-mail notification of events. Enter (d)isabled or $false to disable e-mail notification of events.


Parameter: FTPService <string>

Changes whether the FTP server running on the group is enabled or disabled. Enter (e)nabled or$true to enable the FTP server. Enter (d)isabled or $false to prevent FTP file transfers to andfrom the group.


Parameter: SendInfoMessages <string>

Changes whether informational messages are sent to the console or Group Manager GUI. Enter(e)nabled to send informational messages or (d)isabled to not send informational messages.


Parameter: UseLocalChapForIscsi <string>

Changes whether local CHAP accounts are used to authenticate iSCSI initiator access tovolumes and snapshots. Enter (e)nabled or $true to use local CHAP. Enter (d)isabled or $false touse external RADIUS authentication servers.

Required?: falsePosition?: namedDefault value?: disabled

32


Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: GroupLocation <string>

Changes the physical location information of the group (up to a maximum of 63 characters).Enter the parameter without a value to set the location to "default."


Parameter: Credential <System.Management.Automation.PSCredential>

Changes the password required for adding members to the PS Series group to the passwordcontained in a PSCredential object. The password must be between 3 and 16 alphanumericcharacters and is case-sensitive. The username value from the PSCredential object is ignored.The MembershipPassword parameter can be used instead of the Credential parameter.

Required?: falsePosition?: namedDefault value?:Accept pipeline input?: falseAccept wildcard characters?: false

Parameter: MembershipPassword <string>

Changes the password required for adding members to a group. The password must be between3 and 16 alphanumeric characters and is case-sensitive. The Credential parameter can be usedinstead of the MembershipPassword parameter.


Parameter: SyslogNotification <string>

Changes whether event logging to remote syslog servers is enabled.Enter (e)nabled or $trueremote event logging. Enter (d)isabled or $false to disable it. To use syslog notification, youmust also specify IP addresses for the syslog servers using the SyslogServers parameter.


Parameter: SyslogServers <string>

Changes the list of IP Addresses and optional port information that identifies the remote serversused to log events. The servers must be configured to accept remote log files. This list is orderedby preference and should be enclosed in quotation marks. Port 514 is used. A different port

33


number cannot be set for the Syslog Servers. The IP addresses can be IPv4 or IPv6. Up to threeaddresses can be entered. If more than three are entered, the extra addresses are ignored. Toremove all addresses, enter an empty string ("").


Parameter: RadiusIscsiAuthentication <string>

Changes whether RADIUS authentication for host access to volumes is enabled. Enter (e)nabledor $true to use RADIUS authentication or (d)isabled or $false to disable it. To use RADIUSauthentication, you must also specify IP addresses for the RADIUS Servers with theRadiusAuthenticationServers parameter.


Parameter: RadiusLoginAuthentication <string>

Changes whether RADIUS authentication for group administration accounts is enabled. Enter(e)nabled or $true to use RADIUS authentication or (d)isabled or $false to disable it. To useRADIUS authentication, you must also specify IP addresses for the RADIUS Servers with theRadiusAuthenticationServers parameter.


Parameter: RadiusAuthenticationServers <string>

Changes the list of IP addresses and optional port information that identify the servers used toauthenticate host access of volumes through CHAP, group administration accounts, or Microsoftservice access to the group. The servers are contacted in the order specified. The list should beenclosed in quotation marks. A port can be specified with each address. For IPv4 addresses, theport number should be separated from the IP address using a colon (:). For IPv6 addresses, theport number should be separated from the IP address using a space. If a port is not specified, thedefault RADIUS server port 1812 is used. The IP Addresses can be IPv4 or IPv6. Up to threeaddresses can be entered. If more than three are entered, the extra addresses are ignored. Toremove all addresses, enter an empty string (""). If you use this parameter and the serversrequire passwords, then you must also enter the RadiusAuthenticationSecrets parameter.


34


Parameter: RadiusAuthenticationSecrets <string>

Changes the list of secrets (passwords) for the RADIUS authentication servers specified for theRadiusAuthenticationServers parameter and specified in the same order. One to three secretsare specified (63 characters each maximum length) separated by commas and no spaces.


Parameter: RadiusAuthenticationTimeoutSeconds <int>

Changes the number of seconds to wait for a response from a RADIUS authentication serverbefore timing out.

Required?: falsePosition?: namedDefault value?: 2Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: RadiusAuthenticationRetryCount <int>

Changes the number of times that the group will try to contact a RADIUS authentication serverbefore trying the next server in the list.


Parameter: RadiusUserAccounting <string>

Changes whether tracking of group administration accounts authenticated with RADIUS byRADIUS accounting servers is enabled. Enter (e)nabled or $true to track authentication byRADIUS accounting servers. Enter (d)isabled or $false to disable tracking. To use RADIUSaccounting, you must also specify IP addresses for the RADIUS accounting servers using theRadiusAccountingServers parameter.


Parameter: RadiusAccountingServers <string>

Changes the list of IP addresses and optional port information that identify the accountingservers used to track RADIUS authentication of group administration accounts. The list shouldbe enclosed in quotation marks. These servers are contacted in the order specified. A port canbe specified with each address. For IPv4 addresses, the port number should be separated fromthe IP address using a colon (:). For IPv6 addresses, the port number should be separated from

35


the IP address using a space. If a port is not specified, the default RADIUS server port 1812 isused. The IP Addresses can be IPv4 or IPv6. Up to three addresses can be entered. If more thanthree are entered, the extra addresses are ignored. To remove all addresses, enter an emptystring (""). If you use this parameter and the servers require passwords, then you must also enterthe RadiusAccountingSecrets parameter.


Parameter: RadiusAccountingSecrets <string>

Changes the list of secrets (passwords) for the RADIUS accounting servers specified for theRadiusAccountingServers parameter and specified in the same order. One to three secrets arespecified (63 characters each maximum length) separated by commas and no spaces.


Parameter: RadiusAccountingTimeoutSeconds <int>

Changes the number of seconds to wait for a response from a RADIUS accounting server beforetiming out.


Parameter: RadiusAccountingRetryCount <int>

Changes the number of times that the group will try to contact a RADIUS accounting serverbefore trying the next server in the list.


Parameter: LDAPLoginAuthentication <string>

Changes whether LDAP login authentication is enabled. Enter (e)nabled or $true to enableLDAP authentication or enter (d)isabled or $false to disable it. To use LDAP authentication atleast one LDAP Server configuration entry must exist on the PS Series group. Use theNew-EqlLDAPServer cmdlet to add a new configuration entry.

Required?: falsePosition?: named

36


Default value?: disabledAccept pipeline input?: trueAccept wildcard characters?: false


Specifies that the cmdlet should return an EQL_PSGROUP_SPEC object for the changed group onsuccessful completion.


Examples

Example 1

This command will enable informational messages to be sent to the Group Manager connected tothe PS Series group to which a connection exists in the current PowerShell runspace. Thecommand will use [email protected] as the sender for any email notifications sentby the group. Since the PassThru parameter is specified, it will also list all of the values (exceptfor passwords) in the EQL_PSGROUP_SPEC object for the group reflecting the state after thecommand executes.

C:\PS>Set-EqlGroupConfiguration -SendInfoMessages yes [email protected] -PassThru

Example 2

This command retrieves the group configuration settings for GroupA and copies them to GroupB.

C:\PS>Get-EqlGroupConfiguration -GroupName GroupA | Set-EqlGroupConfiguration-GroupName GroupB

Related Commands


• Get-EqlGroupConfiguration cmdlet

• New-EqlLDAPServer cmdlet

• Get-EqlLDAPServer cmdlet

Get-EqlMember cmdletRetrieves the current configuration settings for PS Series group member arrays.

37


SyntaxGet-EqlMember [-GroupName <string>] [-GroupAddress <string>][-MemberName <string>] [<CommonParameters>]

Command Description

The Get-EqlMember cmdlet retrieves the current configuration settings for a specified array thatis a member of a PS Series group to which a connection exists in the current PowerShellrunspace. If a member name is not specified, this cmdlet retrieves configuration settings for allmembers of the array. If you are connected to more than one group, you can specify the targetgroup using either the GroupName or GroupAddress parameter. Use the Get-EqlNetInterfacecmdlet to get the network interface settings for the array.

Note: If the member array is offline, many of the configuration settings and statisticsmay not be available.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC

You can pipe objects from Get-EqlMember to other cmdlets, such as Set-EqlMember. Pipe theobjects through format-list to filter out parameters that you do not want to use.






Required?: falsePosition?: namedDefault value?: none

38






Examples

Example 1

This command retrieves the configuration information for Member1 in a PSObject that containsthe values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC.

C:\PS>Get-EqlMember -MemberName Member1

When you execute the Get-EqlMember cmdlet for Member1, a list of Member1 configurationsettings and their values is output to the console. Sample output is as follows:

MemberName : Member1MemberDescription : This is a member configured for RAID5ModelNumber : 70-0202SerialNumber : VM000c29db26ab3ServiceTag : VIM26ABProductFamily : PS6000ChassisType : 1603ControllerCount : 2DiskCount : 16CacheSizeMB : 249CacheMode : write_backChassisFlags : {isAccelerated}FirmwareVersion : Storage Array Firmware V5.0.2 (R138185)DefaultGateway : 10.127.0.1StoragePoolName : defaultRaidType : raid5OnlineStatus : onlineRAIDStatus : okTotalSpaceMB : 8640FreeSpaceMB : 7740VolumeUsedSpaceMB : 900SnapshotUsedSpaceMB : 0ReplicaUsedSpaceMB : 0ISCSIConnectionCount : 0

Example 2

This command retrieves the configuration information for all members of a group in a PSObjectcollection that contains the values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC.

C:\PS>Get-EqlGroupMember

39


Related Commands


• Set-EqlMember cmdlet

• Remove-EqlMember cmdlet

• Get-EqlNetInterface cmdlet

• Set-EqlNetInterface cmdlet

Set-EqlMember cmdletModify configuration settings for an array that is a member of a PS Series Group.

Note: The Group Management gateway must be IPv4 for this cmdlet.

Command SyntaxSet-EqlMember [-GroupName <string>] [-GroupAddress <string>]-MemberName <string> [-NewMemberName <string>][-MemberDescription <string>] [-StoragePoolName <string>][-RaidType <string>] [-DefaultGateway <string>][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Set-EqlMember cmdlet modifies the current configuration settings for an array that is amember of a PS Series group to which a connection exists in the current PowerShell runspace. Ifyou are connected to more than one group, you can specify the target group using either theGroupName or GroupAddress parameter. Use the Set-EqlNetInterface cmdlet to configure thenetwork interfaces for a member.

Note: Changing the RAID configuration to another type is initiated by this cmdlet andmay take a long time to complete. The member may be periodically taken offline duringthe process.

Inputs

None.

Outputs

If the PassThru parameter is not specified, a string acknowledging the successful completion ofthe cmdlet action is returned.

Otherwise, an Interop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC object is returned.

40

../../../../../Content/API1/Remove-GroupMember_cmdlet.htm



You can pipe objects from one Set-EqlMember to another Set-EqlMember cmdlet. Pipe theobjects through format-list to filter out parameters that you do not want to use.









Required?: truePosition?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: NewMemberName <string>

Changes the name of the specified group member. This name is case-sensitive.


Parameter: MemberDescription <string>

Changes the description for the specified group member. This name is case-sensitive.

Required?:false

41


Position?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: StoragePoolName <string>

Changes the pool to which the specified group member belongs. This name is case-sensitive.


Parameter: RaidType <string>

Changes the RAID configuration of the member. The type is specified using one of the followingvalues: raid5, raid5_nospares, raid6, raid6_nospares, raid6_accelerated, raid10, raid10_nospares, raid50, raid50_nospares. Not all RAID types are valid for every PS Series array.Specifying an unavailable RAID type will cause this command to fail. Refer to the technicaldocumentation for your array to determine what values are allowed.

There are limitations on which RAID configurations can be converted into other RAID types.The following conversions are supported:

• RAID10 to RAID50, RAID6, or RAID5

• RAID50 to RAID6 or RAID5

• RAID6 to RAID5

RAID6-Accelerated cannot be converted to any other type.


Parameter: DefaultGateway <string>

Changes the IPv4 Address used for the default gateway and applies it to all of the configuredinterfaces on the member except the management network interface. Specify the parameterwithout a value to delete the default gateway.



Specifies that the cmdlet should return an EQL_MEMBER_SPEC object for the changed groupmember on successful completion.

42



Example

This command changes the name of the storage pool in which the member is located and causesthe member to be moved to the specified pool.

C:\PS>Set-EqlMember -MemberName Member1 -StoragePoolName PoolB -PassThru

Related Commands



• Restart-EqlMember cmdlet

• Stop-EqlMember cmdlet

Get-EqlNetInterface cmdletRetrieves the current network interface settings for PS Series group member arrays.

Command SyntaxGet-EqlNetInterface [-GroupName <string>] [-GroupAddress <string>][-MemberName <string>] [-InterfaceName <string>] [<CommonParameters>]

Command Description

The Get-EqlNetInterface cmdlet retrieves the specified network interface for a specified arraythat is a member of a PS Series group to which a connection exists in the current PowerShellrunspace. If a network interface name is not specified, this cmdlet returns all of the networkinterfaces for the specified member array.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE

You can pipe objects from Get-EqlNetInterface to other cmdlets, such asSet-EqlNetInterface. Pipe the objects through format-list to filter out parameters that you donot want to use.

43






Specifies the IP address of a PS Series group for which a session exists in this PowerShellrunspace. This parameter can be either IPv4 or IPv6. Either this parameter or the GroupNameparameter can be used to identify a group for this cmdlet.





Parameter: InterfaceName <string>

Specifies the name of a network interface for a member of a PS Series group that identifies thenetwork interface to which this cmdlet applies. This name is case-sensitive.


Examples

Example 1

This command retrieves the configuration information for eth0 to Member1 in a PSObject thatcontains the values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE.

C:\PS>Get-EqlNetInterface -MemberName Member1 -InterfaceName eth0

44


Sample output is as follows:MemberName : Member1InterfaceName : eth0Description : eth0 descriptionIpAddress : 10.100.100.6SubnetMask : 255.255.0.0Status : upUseForManagementOnly : disabledSupportsManagement : yesDesiredStatus : up

Example 2

This command retrieves the configuration information for all of the network interfaces to thespecified member of a group in a PSObject collection that contains the values from anInterop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE.

C:\PS>Get-EqlNetInterface

Related Commands


• Set-EqlNetInterface cmdlet


• Remove-EqlMember cmdlet

Set-EqlNetInterface cmdletChanges the configuration of the specified network interface to a PS Series group member array.

Command SyntaxSet-EqlNetInterface [-GroupName <string>] [-GroupAddress <string>]-MemberName <string> -InterfaceName <string>[-Description [<string>]] [-IPAddress <string>] [-SubnetMask [<string>]][-DesiredStatus <string>] [-UseForManagementOnly <string>][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Set-EqlNetInterface cmdlet changes the specified network interface for a specified arraythat is a member of a PS Series group to which a connection exists in the current PowerShellrunspace.

Note: Management network IP addresses are IPv4 only and use the highest number portavailable on an array (eth2 or eth3, depending on the array type). Other than themanagement port, the other interface ports can be either IPv4 or IPv6.

45




Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE

You can pipe objects from Set-EqlNetInterface to another Set-EqlNetInterface cmdlet. Pipethe objects through format-list to filter out parameters that you do not want to use.








Specifies the name of a member of a PS Series Array Group that identifies the member to whichthis cmdlet applies. This name is case-sensitive.


Parameter: InterfaceName <string>

Specifies the name of a network interface for a member of a PS Series group that identifies thenetwork interface to which this cmdlet applies. This name is case-sensitive.

Required?: true

46



Parameter: Description [<string>]

Changes the description (up to a maximum of 127 alphanumeric characters) of the networkinterface. If the description contains spaces, surround it with quotes. Enter the parameter with anempty string ("") to delete the description.


Parameter: IPAddress <string>

Changes the IP Address for the network interface to the member. Enter the parameter with anempty string ("") to remove the IP Address.


Parameter: SubnetMask <string>

Changes the subnet mask for the network interface to the member. Can only be used if theIPAddress is IPv4. Enter the parameter with an empty string ("") to remove the subnet mask.


Parameter: DesiredStatus <string>

Changes whether the network interface is enabled or disabled for I/O traffic. Enter (u)p toenable the interface for use, or (d)own to disable it.


Parameter: UseForManagementOnly <string>

Changes whether the network interface is restricted to management only traffic. Enter (e)nabledto restrict the network interface to management traffic only, or (d)isabled to allow managementand data I/O traffic on the network interface. IPAddress must be an IPv4 IP Address to restrictthe network interface to management traffic only. Only the highest numbered interface available

47


(eth2 or eth3 in most configurations) for the member can be configured for management-onlytraffic.



Specifies that the cmdlet should return an EQL_MEMBER_NETWORK_INTERFACE object for thechanged group member interface on successful completion.


Examples

Example 1

This command changes the IPAddress for eth1 to Member1 to 10.100.100.5.

C:\PS>Set-EqlNetInterface -MemberName Member1 -InterfaceName eth1 -IPAddress10.100.100.5

Example 2

This command clears the description of eth1 to Member1 and outputs a PSObject that containsthe values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE foreth1 of Member1.

C:\PS>Set-EqlNetInterface -MemberName Member1 -InterfaceName eth1 -Description “”-PassThru

Related Commands


• Get-EqlNetInterface cmdlet


Get-EqlLDAPServer cmdletRetrieves identifying and status information for a named LDAP server or for every LDAP serverin a PS Series group.

48


SyntaxGet-EqlLDAPServer [-GroupName <string>] [-GroupAddress <string>][-ServerIPAddress <string>] [<CommonParameters>]

Command Description

The Get-EqlLDAPServer cmdlet retrieves the configuration information for a LDAP Serverspecified by IP address on a PS Series group to which a connection exists in the currentPowerShell runspace. If a LDAP server IP address is not specified, data is returned for everyLDAP server configured for the group.

Inputs

None. You cannot pipe objects to Get-EqlLDAPServer.

Outputs

Interop.EqlPsaMgmtAPI.EQL_LDAP_SERVER_SPEC

This command outputs an array of PSObjects containing the identifying information for thenamed LDAP server or all LDAP servers configured in the group.







Parameter: ServerIPAddress <string>

49


Specifies the IP address of a LDAP Server on a PS Series group that identifies the LDAP Serverto which this cmdlet applies. This parameter can be either IPv4 or IPv6.


Examples

Example 1

This command will return a PSObject containing the following configuration information forLDAP Server with IP Address 10.100.100.100:

C:\PS>Get-EqlLDAPServer -ServerIpAddress 10.100.100.100

Sample output is as follows:ServerIPAddress : 10.100.100.100SecureProtocol : no_protocolPort : 389BaseDistinguishedName : DC=MyDomain,DC=MyCompany,DC=comAnonymousAccess : disabledBindDistinguishedName : ****************BindPassword : ****************

Example 2

This command will return a PSObject containing the configuration information for every LDAPserver configured in the current group.

C:\PS>Get-EqlLDAPServer

Related Commands



• Set-EqlLDAPServer cmdlet

• Remove-EqlLDAPServer cmdlet

New-EqlLDAPServer cmdletCreates a new LDAP server in a PS Series group.

50


SyntaxNew-EqlLDAPServer [-GroupName <string>] [-GroupAddress <string>]-ServerIPAddress <string> -BaseDistinguishedName <string>[-BindDistinguishedName <string>][-BindCredential <System.Management.Automation.PSCredential>][-BindPassword <string>] [-AnonymousAccess <string>] [-SecureProtocol <string>][-Port <uint32>][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The New-EqlLDAPServer cmdlet creates a LDAP Server configuration entry with the specifiedIP address on a PS Series group to which a connection exists in the current PowerShellrunspace. The group is registered with the specified LDAP server. Up to three LDAP serverscan be configured for a PS Series group.

Inputs

None. You cannot pipe objects to New-EqlLDAPServer.

OutputsInterop.EqlPsaMgmtAPI.EQL_LDAP_SERVER_SPEC

Returns a string acknowledging the successful completion of the cmdlet action or anInterop.EqlPsaMgmtAPI.EQL_LDAP_SERVER_SPEC object if the PassThru parameter is present.


Specifies the name of a PS Series group for which a session exists in this PowerShell runspace.Either this parameter or the GroupAddress parameter can be used to identify a group for thiscmdlet. The cmdlet will execute on the specified group.





51





Parameter: BaseDistinguishedName <string>

Specifies the base distinguished name (511 characters maximum) for a LDAP Server on a PSSeries group. The distinguished name must be enclosed with quotation marks.


Parameter: BindDistinguishedName <string>

Specifies the bind distinguished name (511 characters maximum) for a LDAP Server on a PSSeries group. The distinguished name must be enclosed with quotation marks. IfAnonymousAccess is disabled, the BindDistinguishedName and BindPassword orBindCredential parameters must be specified.


Parameter: BindCredential <System.Management.Automation.PSCredential>

Specifies a PSCredential object containing the password (63 alphanumeric characters maximum)used with the Bind Distinguished Name of the LDAP Server.


Parameter: BindPassword <string>

Specifies the password used with the bind distinguished name. The BindCredential parametercan be used instead of the BindPassword parameter.


52


Parameter: AnonymousAccess <string>

Specifies whether anonymous access is enabled or disabled for the LDAP server. Enter (y)es or$true to enable anonymous access. Enter (n)o or $false to disable anonymous access. Ifanonymous access is disabled, the BindDistinguishedName and BindPassword orBindCredential parameters must be specified.

anonymous access.


Parameter: SecureProtocol <string>

Specifies the secure protocol used when accessing the LDAP server. Enter (T)LS or (S)SL forthe secure protocol. Otherwise, enter (n)o_protocol.

Required?: falsePosition?: namedDefault value?: no_protocolAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: Port <uint32>

Specifies the port used when accessing the LDAP server.



Specifies that the cmdlet should return an EQL_LDAP_SERVER_SPEC object for the changed groupmember on successful completion.


Examples

Example 1

This command creates a new LDAP server configuration entry and enables anonymous accessto the server. The default values are used for all other parameters.

53


C:\PS>New-EqlLDAPServer -ServerIPAddress 10.100.100.100 -BaseDistinguishedName"DC=MyDomain,DC=MyCompany,DC=com" -AnonymousAccess yes

Example 2

This command creates a new LDAP server configuration entry with a bind distinguished nameand bind password. The bind parameters are required because the value of AnonymousAccess isnot changed from no (default) to yes.

C:\PS>New-EqlLDAPServer -ServerIPAddress 10.100.100.100 -BaseDistinguishedName"DC=MyDomain,DC=MyCompany,DC=com"-BindDistinguishedName "CN=MyAdm in,O=MyOrganization,C=MyCountry" -BindPasswordpassword -PassThru

Related Commands





Remove-EqlLDAPServer cmdletDeletes a specified LDAP server in a PS Series group and moves its member arrays to thedefault LDAP server.

SyntaxRemove-EqlLDAPServer [-GroupName <string>] [-GroupAddress <string>]-ServerIPAddress <string> [-Force[<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlLDAPServer cmdlet deletes the LDAP server specified by IP address of a PSSeries group to which a connection exists in the current PowerShell runspace.

Inputs

None. You cannot pipe objects to Remove-EqlLDAPServer.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action.

54



Specifies the name of a PS Series group for which a session was created in this PowerShellrunspace. The GroupAddress parameter can be used instead of this parameter. The cmdlet willexecute on the specified group.









Specifies that the cmdlet should bypass the confirmation prompt and delete the LDAP serverconfiguration.


Examples

Example 1

This command will display a confirmation prompt to the console and remove the configurationfor the specified LDAP Server if confirmed.

C:\PS>Remove-EqlLDAPServer -ServerIPAddress 10.100.100.100

55


Example 2

This command will remove the specified LDAP server configuration. It will not prompt forconfirmation because -Force is specified.

C:\PS>Remove-EqlLDAPServer -ServerIPAddress 10.100.100.100 -Force

Related Commands





Set-EqlLDAPServer cmdletChanges the name and description of a specified LDAP server in a PS Series group.

SyntaxSet-EqlLDAPServer [-GroupName <string>] [-GroupAddress <string>]-ServerIPAddress <string> [-NewServerIPAddress <string>][-BaseDistinguishedName <string>] [-BindDistinguishedName <string>][-BindCredential <System.Management.Automation.PSCredential>][-BindPassword <string>] [-AnonymousAccess <string>] [-SecureProtocol <string>][-Port <uint32>][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

This cmdlet changes the name and description of LDAP server specified by name on a PS Seriesgroup to which a connection exists in the current PowerShell runspace.

Inputs

None. You cannot pipe objects to Set-EqlLDAPServer.

Outputs

Interop.EqlPsaMgmtAPI.EQL_LDAP_SERVER_SPEC

Returns a string acknowledging the successful completion of the cmdlet action or anInterop.EqlPsaMgmtAPI.EQL_LDAP_SERVER_SPEC object if the PassThru parameter ispresent.

56



Specifies the name of a PS Series group for which a session exists in this PowerShell runspace.Either this parameter or the GroupAddress parameter can be used to identify a group for thiscmdlet. The cmdlet will execute on the specified group.








Parameter: NewServerIPAddress <string>

Changes the IP address for the specified LDAP Server on a PS Series group. This parameter canbe either IPv4 or IPv6. If this IP address is for a different LDAP server, then you must also entera new BaseDistinguishedName and if required, new credentials.


Parameter: BaseDistinguishedName <string>

Changes the base distinguished name (511 characters maximum) for a LDAP Server on a PSSeries group. The distinguished name must be enclosed with quotation marks.

Required?: false

57



Parameter: BindDistinguishedName <string>

Changes the bind distinguished name (511 characters maximum) for a LDAP Server on a PSSeries group. The distinguished name must be enclosed with quotation marks. IfAnonymousAccess is disabled, the BindDistinguishedName and BindPassword orBindCredential parameters must be specified.


Parameter: BindCredential <System.Management.Automation.PSCredential>

Specifies a PSCredential object containing the password (63 alphanumeric characters maximum)used with the Bind Distinguished Name of the LDAP Server.


Parameter: BindPassword <string>

Changes the password used with the bind distinguished name. The BindCredential parametercan be used instead of the BindPassword parameter.


Parameter: AnonymousAccess <string>

Changes whether anonymous access is enabled or disabled for the LDAP server. Enter (y)es or$true to enable anonymous access. Enter (n)o or $false to disable anonymous access. Ifanonymous access is disabled, the BindDistinguishedName and BindPassword orBindCredential parameters must be specified.


Parameter: SecureProtocol <string>

58


Changes the secure protocol used when accessing the LDAP server. Enter (T)LS or (S)SL forthe secure protocol. Otherwise, enter (n)o_protocol.

Required?: falsePosition?: namedDefault value?: no_protocolAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: Port <uint32>

Specifies the port used when accessing the LDAP server.



Specifies that the cmdlet should return an EQL_LDAP_SERVER_SPEC object for the changed groupmember on successful completion.


Example

This command will change the IP Address used to access the LDAP server from 10.100.100.100to 10.100.100.200.

C:\PS>Set-EqlLDAPServer -ServerIPAddress 10.100.100.100 -NewServerIPAddress10.100.100.200

Related Commands





Pool Configuration cmdletsThe pool configuration cmdlets allow you to manage the pools defined for a group or to definenew pools. You will need to use the Set-EqlMember cmdlet to add storage capacity for a pool.

59


New-EqlPool cmdletCreates a new pool in a PS group.

Command SyntaxNew-EqlPool [-GroupName <string>] [-GroupAddress <string>]-StoragePoolName <string> [-PoolDescription <string>] [<CommonParameters>]

Command Description

The New-EqlPool cmdlet creates a pool with the specified by name on a PS Series group towhich a connection exists in the current PowerShell runspace. If you are connected to more thanone group, you can specify the target group using either the GroupName or GroupAddressparameter. Use the Set-EqlMember cmdlet to add arrays to a pool.

Inputs

None. You cannot pipe objects to New-EqlPool.

Outputs









60


Specifies the name (up to a maximum of 63 characters) for a new pool on a PS Series group.This name is case-sensitive and must be unique. The name must begin with a letter or number,and can contain letters, numbers, and hyphens.


Parameter: PoolDescription <string>

Specifies the description (up to a maximum of 127 characters) for a pool on a PS Series group. Ifthe description contains spaces, surround it with quotes.


Example

This command creates a new pool named PoolB. Use the New-EqlMember cmdlet to add storagespace to the pool.

C:\PS>New-EqlPool -StoragePoolName PoolB

Related Commands


• Set-EqlPool cmdlet

• Get-EqlPool cmdlet

• Merge-EqlPool cmdlet

• Remove-EqlPool cmdlet


Get-EqlPool cmdletRetrieves identifying and status information for a named pool or for every pool in a PS Seriesgroup.

Command SyntaxGet-EqlPool [-GroupName <string>] [-GroupAddress <string>][-StoragePoolName <string>] [<CommonParameters>]

61


Command Description

The Get-EqlPool cmdlet retrieves the identifying and status information for a pool, specified bythe pool name, on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. If a pool name is not specified, data isreturned for every pool in the group. The StoragePoolName in the output of this command can beused to identify a pool for volume and member cmdlets.

Inputs

None. You cannot pipe objects to Get-EqlPool.

Outputs

Interop.EqlPsaMgmtAPI.EQL_POOL_SPEC. This command outputs an array of PSObjectscontaining the identifying information and statistics for the named pool or all pools in the group.








Specifies the name of a pool on a PS Series group. If this parameter is not specified, the cmdletwill get information for all pools on the group.


62



Examples

Example 1

This command will return a PSObject containing the identifying information and statistics forPoolB.

C:\PS>Get-EqlPool -StoragePoolName PoolB

When you execute the Get-EqlPool cmdlet for PoolB, a list of PoolB's statistics and their valuesis output to the console. Sample output is as follows:

StoragePoolName : PoolBOnlineMemberCount : 2InUseMemberCount : 2TotalSpaceMB : 5191500FreeSpaceMB : 477675UsedSpaceMB : 2480730ThinProvisionFreeSpaceMB : 4776750ISCSIConnectionCount : 90VolumeSubscribedMB : 4003575VolumeAllocatedMB : 2276130VolumeCount : 97OnlineVolumeCount : 84InUseVolumeCount : 22SnapshotReservedMB : 1617690SnapshotReservedAvailableMB : 1609050SnapshotSpaceUsedMB : 8640SnapshotCount : 55OnlineSnapshotCount : 2InUseSnapshotCount : 0

Example 2

This command will return a PSObject containing the identifying information and statistics forevery pool in the current group.

C:\PS>Get-EqlPool

Related Commands


• New-EqlVolume cmdlet

• Set-EqlVolume cmdlet


63


Set-EqlPool cmdletChanges the name and description of a specified pool in a PS Series group.

Command SyntaxSet-EqlPool [-GroupName <string>] [-GroupAddress <string>] -StoragePoolName<string> [-NewStoragePoolName <string>] [-PoolDescription [<string>]][<CommonParameters>]

Command Description

The Set-EqlPool cmdlet changes the name and description of pool specified by name on a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_POOL_SPEC

This command outputs an array of PSObjects containing the identifying information and statisticsfor the named pool or all pools in the group.







64


Default value?: noneAccept pipeline input?: trueAccept wildcard characters?: false


Specifies the name of a pool on a PS Series group that identifies the pool to which this cmdletapplies. This name is case-sensitive.


Parameter: NewStoragePoolName <string>

Specifies a new name (63 characters maximum) for a pool on a PS Series group. This name iscase-sensitive and must be unique. The name must begin with a letter or number and can containletters, numbers, and hyphens.


Parameter: PoolDescription [<string>]

Changes the description (127 characters maximum) for a pool on a PS Series group. If thedescription contains spaces, surround it with quotes. Enter the parameter name without a valueto delete a description.

Required?:falsePosition?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Example

This command will change the name of the pool to PoolB2.

C:\PS>Set-EqlPool -StoragePoolName PoolB -NewStoragePoolName PoolB2

Related Commands


• New-EqlPool cmdlet




65


Merge-EqlPool cmdletMoves the members and volumes from a source pool in a PS Series group to another pool anddeletes the source pool.

Command SyntaxMerge-EqlPool [-GroupName <string>] [-GroupAddress <string>]-StoragePoolName <string> -DestinationStoragePoolName <string>[-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Merge-EqlPool cmdlet moves the members and volumes from a source pool specified byname on a PS Series group to which a connection exists in the current PowerShell runspace, toanother pool specified by name in the same group. If you are connected to more than one group,you can specify the target group using either the GroupName or GroupAddress parameter. Thesource pool is deleted after the merge is completed. This cmdlet will display a prompt to theconsole to confirm the merge. The -Force parameter can be used to suppress this prompt forscripts. The default pool cannot be specified as the source pool.

Inputs

None. You cannot pipe objects to Merge-EqlPool.

Outputs







Required?: false

66




Specifies the name of a pool on a PS Series group that identifies the pool to which this cmdletapplies. This name is case-sensitive. The default pool cannot be specified for this parameter.


Parameter: DestinationStoragePoolName <string>

Specifies the name of the destination pool on a PS Series group that identifies the pool to whichthe source pool will be merged. This name is case sensitive.



Specifies that the cmdlet should bypass the confirmation prompt and merge the pool.


Examples

Example 1

This command will display a confirmation prompt to the console, merge the members andvolumes from PoolB to PoolA if confirmed, and delete PoolB.

C:\PS>Merge-EqlPool -StoragePoolName PoolB -DestinationStoragePoolName PoolA

Example 2

This command will merge member arrays and volumes from PoolB to PoolA and delete PoolB. Itwill not prompt for confirmation because -Force is specified.

C:\PS>Merge-EqlPool -StoragePoolName PoolB -DestinationStoragePoolName PoolA-Force

67


Related Commands






Remove-EqlPool cmdletDeletes a specified pool in a PS group and moves its member arrays to the default pool.

Command SyntaxRemove-EqlPool [-GroupName <string>] [-GroupAddress <string>]-StoragePoolName <string> [-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlPool cmdlet deletes the pool specified by name from a PS Series group to whicha connection exists in the current PowerShell runspace. If you are connected to more than onegroup, you can specify the target group using either the GroupName or GroupAddress parameter.The array members in the pool are immediately moved to the default pool. Deletion of thedefault pool is not permitted. This cmdlet will display a prompt to the console to confirm thedeletion. The Force parameter can be used to suppress this prompt for scripts.

Inputs

None. You cannot pipe objects to Get-EqlPool.

Outputs





68







Specifies the name of a pool on a PS Series group that identifies the pool to which this cmdletapplies. This name is case-sensitive. Deletion of the default pool is not permitted.



Specifies that the cmdlet should bypass the confirmation prompt and delete the pool.


Example

Example 1

This command will display a confirmation prompt to the console, remove PoolB if confirmed,and move all of its member arrays to the default pool.

C:\PS>Remove-EqlPool -StoragePoolName PoolB

Example 2

This command will remove PoolB and move all of its member arrays to the default pool. It willnot prompt for confirmation because -Force is specified.

C:\PS>Remove-EqlPool -StoragePoolName PoolB -Force

Related Commands


69






Local CHAP Account cmdletsThese cmdlets are used to manage the local CHAP user accounts for a group. These accountscan be used to create volume ACLs for hosts to establish connections to volumes and snapshotsrequiring CHAP credentials.

New-EqlChapUser cmdletCreates and adds a local CHAP user to the specified group.

Command SyntaxNew-EqlChapUser [-GroupName <string>] [-GroupAddress <string>][-Credential <System.Management.Automation.PSCredential>][-Username <string> -Password <string>][<CommonParameters>]

Command Description

The New-EqlChapUser cmdlet creates a CHAP user with access to the PS Series group to whicha connection exists in the current PowerShell runspace. If you are connected to more than onegroup, you can specify the target group using either the GroupName or GroupAddress parameter.The CHAP user can be specified using either the Credential parameter or the Username andPassword parameters. Use the Get-EqlChapUser cmdlet to list user names for all existing localCHAP accounts defined for the group.

Inputs

None.

Outputs




70






Parameter: Credential [{System.Management.Automation.PSCredential]}

Specifies a local CHAP user name (63 characters maximum) and valid password (3-16alphanumeric characters) in a PSCredential object for the local CHAP user. The username andpassword are case-sensitive. The Username and Password parameters can be used instead ofthe Credential parameter.

Required?: true, unless Username and Password are specified.Position?: namedDefault value?: noneAccept pipeline input?: falseAccept wildcard characters?: false


Specifies a local CHAP username (63 characters maximum) to add for the group.

Required?: true, unless Credential is specified.Position?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false


Specifies a valid password (3-16 alphanumeric characters) for the local CHAP user. TheCredential parameter can be used instead of the Password parameter.

Required?: true, unless Credential is specified.Position?: namedDefault value?:Accept pipeline input?:Accept wildcard characters?: false

71


Examples

Example 1

This command adds a local CHAP user with the username and password from the PSCredentialobject created by the PowerShell Get-Credential cmdlet.

C:\PS> New-EqlChapUser -Credential (Get-Credential)

Example 2

This command adds a local CHAP user named "chapuser" with the password "chapsecret" to thelocal CHAP users for the group.

C:\PS>New-EqlChapUser -UserName chapuser -password chapsecret

Related Commands


• Set-EqlChapUser cmdlet

• Get-EqlChapUser cmdlet

• Remove-EqlChapUser cmdlet

• New-EqlVolumeACL cmdlet

Get-EqlChapUser cmdletRetrieves the names of local CHAP user accounts defined for a group.

SyntaxGet-EqlChapUser [-GroupName <string>] [-GroupAddress <string>][<CommonParameters>]

Command Description

The Get-EqlChapUser cmdlet retrieves the usernames of the local CHAP accounts for a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. Use the New-EqlChapUser to add a local CHAP user and password toa group and Remove-EqlChapUser to delete an existing local CHAP user in a group.

Inputs

None.

72


Outputs

String. You can pipe objects from Get-EqlChapUser to other cmdlets, such as Set-EqlChapUser.







Example

This command retrieves all of the CHAP usernames for the group.

C:\PS>Get-EqlChapUser

Related Commands


• New-EqlChapUser cmdlet



Set-EqlChapUser cmdletChanges the password for the specified local CHAP user.

73


Command SyntaxSet-EqlChapUser [-GroupName <string>] [-GroupAddress <string>]-UserName <string> [-Credential <System.Management.Automation.PSCredential>][-Password <string>] [<CommonParameters>]

Command Description

The Set-EqlChapUser cmdlet changes the password for the specified local CHAP user on a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. Use the Get-EqlChapUser cmdlet to retrieve the names of the localCHAP users on the group.

Inputs

None.

Outputs








Parameter: UserName <string>

Specifies the name of a CHAP user account on a PS Series group that identifies the CHAP userto which this cmdlet applies.

74



Parameter: Credential [<System.Management.Automation.PSCredential>]

Changes the password for the local CHAP user to the value in a PSCredential object. Theusername value in the PSCredential object is ignored. The new password must be 3-16alphanumeric characters and is case sensitive. The Password parameter can be used instead ofthe Credential parameter.

Required?: true, unless Password is specified.Position?: namedDefault value?:Accept pipeline input?: falseAccept wildcard characters?: false


Changes the password for the local CHAP user. The new password must be 3-16 alphanumericcharacters and is case-sensitive. The Credential parameter can be used instead of thePassword parameter.

Required?: true, unless Credential is specified.Position?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Examples

Example 1

This command displays a dialog for entry of a password and changes the password for chapuserto the password value entered in the PSCredential object.

C:\PS>Set-ChapUser -Username chapuser -Credential (Get-Credential)

Example 2

This command changes the password for chapuser to chapsecret.

C:\PS>Set-EqlChapUser -UserName chapuser -Password chapsecret

Related Commands





75


Remove-EqlChapUser cmdletRemoves the specified local CHAP user from a PS Series group.

Command SyntaxRemove-EqlChapUser [-GroupName <string>] [-GroupAddress <string>]-UserName <string> [-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlChapUser cmdlet removes the local CHAP user identified by name from a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. Use the Get-EqlChapUser cmdlet to get the names of CHAP usersdefined for the group.

Inputs

None.

Outputs








76


Parameter: UserName <string>

Specifies the name of a local CHAP user on a PS Series group that identifies the local CHAPuser to which this cmdlet applies. This name is case-sensitive.



Specifies that the cmdlet should bypass the confirmation prompt and delete the local CHAPaccount.


Example

This command removes the local CHAP user chapuser from the group.

C:\PS>Remove-EqlChapUser -UserName chapuser

Related Commands





77

6 Volume Administration Cmdlets

Basic cmdletsThese cmdlets allow you to manage volume creation and configuration of volumes on PS Seriesgroups and for controlling access to the volumes using access control lists (ACLs).

New-EqlVolume cmdletCreates a new volume on a PS Series group.

Command SyntaxNew-EqlVolume [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -VolumeSizeMB <uint>[-SnapshotReservePercent <uint>] [-StoragePoolName <string>][-DiskSpeedPreference <string>] [-AccessType <string>][-DriveTypePreference <string>] [-LoadBalance <string>] [-iSCSIAlias [<string>]][-OnlineStatus <string>] [-RAIDTypePreference <string>][-AllowMultipleInitiators <string>] [-VolumeDescription [<string>]][-SnapshotReserveWarnPercent <uint>] [-SnapshotDeletionPolicy <string>][-ThinProvision] [-ThinProvisionMinReservePercent <uint>][-ThinProvisionWarningPercent <uint>] [-ThinProvisionMaxGrowPercent <uint>][-VolumeAdministrator <string>] [-PassThru [<SwitchParameter>]][{Common Parameters}]

Command Description

The New-EqlVolume cmdlet creates a volume on a PS Series group to which a connection existsin the current PowerShell runspace with the name, size in MB, and snapshot reserve specified.Additional options for configuring the volume, such as thin provisioning, can be specified atcreation time. If you are connected to more than one group, you can specify the target groupusing either the GroupName or GroupAddress parameter. If an optional parameter is not specified,the value will be set to the default values configured for the group. The Get-EqlGroupDefaultscmdlet can be used to review these default values. The Set-EqlGroupDefaults cmdlet can beused to change them. Access control lists (ACLs) can be created and added to this volume usingthe New-EqlVolumeACL cmdlet. Schedules can be created for this volume using theNew-EqlSchedule cmdlet. Initial values set at creation time can be changed later using theSet-EqlVolume cmdlet. To delete this volume use the Remove-EqlVolume cmdlet.

InputsInterop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC

79

PowerShell Tools Reference Guide 6 Volume Administration Cmdlets

You can pipe objects from Get-EqlVolume to New-EqlVolume.

Outputs

If the PassThru parameter is present, this cmdlet returns an Interop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC object.

It also returns a string acknowledging the successful completion of the cmdlet action.


Specifies the name of a PS Series group for which a session exists in this PowerShell runspace.Either this parameter or the GroupAddress parameter can be used to identify a PS Series groupfor this cmdlet.





Parameter: VolumeName <string>

Specifies the name for the volume to be created on a PS Series group. This name must be uniqueon the PS Group and is case-sensitive.


Parameter: VolumeSizeMB <uint>

Specifies the number of MB for the size of the volume to be created.

Required?: truePosition?: namedDefault value?: noneAccept pipeline input?: true

80




Specifies the percent of the volume size that should be set aside for snapshot reserve.



Specifies the name of the pool in which the new volume should be created. If this is notspecified, the volume will be created in the default pool.

Required?: falsePosition?: namedDefault value?: defaultAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: DiskSpeedPreference <string>

Specifies the preferred speed for selecting a drive in the group on which to create the newvolume. If specifying a preference, enter 5400, 7200, 10000, or 15000 for the preferred driveRPM level. Otherwise, skip this parameter or enter 0 or (n)o_disk_speed_preference.

Required?: falsePosition?: namedDefault value?: no_disk_speed_preferenceAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: AccessType <string>

Specifies the type of access to the new volume. Enter (r)ead_only or read_(w)rite for the accesstype.

Required?: falsePosition?: namedDefault value?: read_writeAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: DriveTypePreference <string>

Specifies the preferred drive type when selecting a drive on which to create the new volume. Ifspecifying a preference, enter SAS or SATA for the drive type. Otherwise, skip this parameteror enter (n)o_drive_type_preference.

Required?: falsePosition?: namedDefault value?: no_drive_type_preferenceAccept pipeline input?: true

81



Parameter: LoadBalance <string>

Specifies whether load balancing should be enabled or disabled for the new volume. Enter (y)esor $true to enable load balancing. Enter (n)o or $false to disable load balancing.

Required?: falsePosition?: namedDefault value?: yesAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: iSCSIAlias [<string>]

Specifies an alias for the iSCSI identifier used for the volume.


Parameter: OnlineStatus <string>

Specifies whether the new volume should be set online or offline. Enter (on)line or $true to set itonline or (off)line or $false to set it offline.

Required?: falsePosition?: namedDefault value?: onlineAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: RAIDTypePreference <string>

Specifies the preferred RAID type when selecting a drive on which to create the new volume. Ifspecifying a preference for the RAID type, enter 5 for RAID5, 6 for RAID6, 10 for RAID10, or50 for RAID50. Otherwise, skip this parameter or enter 0 or (n)o_raid_type_preference.

Required?: falsePosition?: namedDefault value?: no_raid_type_preferenceAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: AllowMultipleInitiators <string>

Specifies whether to allow iSCSI connections from more than one initiator for the new volume.Enter (y)es or $true to allow multiple initiator access. Enter (n)o or $false to not allow sharing ofthe volume.

Required?: falsePosition?: namedDefault value?: noAccept pipeline input?: true

82



Parameter: VolumeDescription [<string>]

Specifies a description of the volume (up to a maximum of 255 characters).



Specifies the percent of the snapshot reserve that can be used before a low space warning isissued.



Specifies the policy to apply when the snapshot reserve is insufficient to create snapshots of thenew volume. Enter (m)ake_volume_offline or (d)elete_oldest for the policy.

Required?: falsePosition?: namedDefault value?: delete_oldestAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ThinProvision <string>

Specifies whether the new volume should be thin provisioned. Enter (y)es or $true to thinprovision the new volume. Enter (n)o or $false to allocate space for the full requested size of thenew volume.

Required?: falsePosition?: namedDefault value?: noAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ThinProvisionMinReservePercent <uint>

Specifies the percent of the requested volume size to reserve for the new volume when it iscreated (minimum 10 percent).


83



Specifies the percent of the requested volume size that can be used before a warning is issued.



Specifies the percent of the requested volume size to which the new volume can grow before thetotal size specified for the volume must be increased.


Parameter: VolumeAdministrator <string>

Sets the name of the Volume Administrator that will own this volume. This name is casesensitive. If the name specified is not a volume admin, the command will fail.



Specifies that the cmdlet should return an EQL_VOLUME_SPEC object for the new volume onsuccessful completion.

Required?: falsePosition?: namedDefault value?: falseAccept pipeline input? falseAccept wildcard characters?: false

Examples

Example 1

This command creates a 10GB (10000MB) volume named MyVolume on the current PS Groupin this runspace with a snapshot reserve of 20GB (200 percent of the volume size) with thedefault values for all optional parameters.

C:\PS>New-EqlVolume -VolumeName MyVolume -VolumeSizeMB 10000-SnapshotReservePercent 200

84


Example 2

This command creates a 10GB (2 GB initial size), writable, thin-provisioned volume namedMyVolume on the current PS Series group in this runspace. The snapshot reserve is 4GB (200percent of the initial volume size), and for all other optional parameters, the default value will beset.

C:\PS>New-EqlVolume -VolumeName MyVolume -VolumeSizeMB 10000-SnapshotReservePercent 200 -ThinProvision yes -ThinProvisonMinReservePercent 20-AccessType read_write

Example 3

This command creates a volume named MyVolume2 on the current PS Group in this runspacewith the same settings as MyVolume1.

C:\PS>Get-EqlVolume -VolumeName MyVolume1 | New-EqlVolume -VolumeName MyVolume2

Related Commands


• Get-EqlVolume cmdlet


• Remove-EqlVolume cmdlet



• Get-EqlVolumeACL cmdlet

• Remove-EqlVolumeACL cmdlet

Get-EqlVolume cmdletRetrieves the configuration and current statistics for one or more volumes on a PS Series group.

Command SyntaxGet-EqlVolume [-GroupName <string>] [-GroupAddress <string>][-VolumeName <string>] [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-StoragePoolName <string>][-AccessType <string>][-OnlineStatus <string>][-AllowMultipleInitiators <string>][-ThinProvision <string>] [-TemplateVolume <string>] [-ThinClone <string>][-NASVolume <string>] [-ISCSITargetName <string>] [-PSVID <string>][-PSVIDAsGuid <string>] [<CommonParameters>]

85


Command Description

The Get-EqlVolume cmdlet retrieves the configuration and statistics for a volume identified byname on a PS Series group to which a connection exists in the current PowerShell runspace. Ifyou are connected to more than one group, you can specify the target group using either theGroupName or GroupAddress parameter. The name specified can contain wildcards to retrieve allvolumes with names that match the wildcard pattern. The list of volumes can also be filteredusing one or more of the following parameters: StoragePoolName, AccessType, OnlineStatus,AllowMultipleInitiators, ThinProvision, TemplateVolume, and ThinClone. It can also befiltered using the ISCSITargetName, PSVID, and PSVIDAsGuid parameters which can containwildcards. If more than one filter criterion is specified, volumes must match all of the specifiedcriteria. If neither a volume name nor filter parameters are specified, this command will retrievethe information for all volumes on the current or specified PS Series group.

If a volume name is not specified, this command will retrieve the information for all volumes ona PS Series group to which the connected administrative user has access. The informationretrieved by this command can be piped into other cmdlets that act on volumes, such asNew-EqlVolume, New-EqlVolumeACL or New-EqlReplica. Use Get-EqlVolumeACL to retrieveaccess control lists for a volume.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC.

You can pipe objects from Get-EqlVolume to other cmdlets, such as Set-EqlVolume. Pipe theobjects through format-list to filter out parameters that you do not want to use.






86




Specifies the name of a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This name is case-sensitive. The name can contain wildcard characters (* and ?)to retrieve the information for all volumes that match the wildcard pattern. Wildcard matching isnot case-sensitive.

Required?: falsePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: true

Parameter: MemberIndex <uint>

Specifies the member index that is used with the volume index to uniquely identify a volume.


Parameter: VolumeIndex <uint>

Specifies the volume index that is used with the member index to uniquely identify a volume.


Parameter: UseIndex [<SwitchParameter>]

Specifies that the cmdlet should use the MemberIndex and VolumeIndex parameter values toidentify a volume instead of the volume name. This is a faster method for getting access to thevolume.



Filters the list of volumes to only include volumes in the specified storage pool.

Required?: false

87




Filters the list of volumes to only include volumes that match the specified AccessType value:(r)ead_only or read_(w)rite.



Filters the list of volumes to only include volumes that match the specified OnlineStatus value:Enter (on)line or $true to get volumes that allow multiple initiators. Enter (n)o or $false toexclude volumes that allow multiple initiators.



Filters the list of volumes to only include volumes that match the specified value. Enter (y)es or$true to allow multiple initiator access. Enter (n)o or $false to not allow sharing of the volume.



Filters the list of volumes to only include volumes that match the specified ThinProvision value:Enter (y)es or $true to get thin provisioned volumes. Enter (n)o or $false to exclude thinprovisioned volumes.


Parameter: TemplateVolume <string>

Filters the list of volumes to only include volumes that match the specified TemplateVolumevalue: Enter (y)es $true to get template volumes. Enter (n)o or $false to exclude templatevolumes.

88



Parameter: ThinClone <string>

Filters the list of volumes to only include volumes that match the specified ThinClone value:Enter (y)es $true to get thin clones. Enter (n)o or $false to exclude thin clones.


Parameter: NASVolume <string>

Filters the list of volumes to only include volumes that match the specified NASVolume value:Enter (y)es or $true to get NAS volumes. Enter (n)o or $false to exclude NAS volumes.


Parameter: ISCSITargetName <string>

Specifies the iSCSI target name for a volume on a PS Series group that identifies the volume towhich this cmdlet applies. This name is not case-sensitive. The name can contain wildcardcharacters (* and ?) to retrieve the information for all volumes that match the wildcard pattern.


Parameter: PSVID <string>

Specifies the PSVID for a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This PSVID is not case-sensitive. The PSVID can contain wildcard characters(* and ?) to retrieve the information for all volumes that match the wildcard pattern.


Parameter: PSVIDAsGuid <string>

Specifies the PSVID formatted as a GUID for a volume on a PS Series group that identifies thevolume to which this cmdlet applies. This GUID is not case-sensitive. The GUID can contain

89


wildcard characters (* and ?) to retrieve the information for all volumes that match the wildcardpattern.


Examples

Example 1

This command retrieves the configuration and current statistics for MyVolume.

C:\PS>Get-EqlVolume -VolumeName MyVolume

When you execute the Get-EqlVolume cmdlet for MyVolume, a list of MyVolume's properties,statistics, and values is output to the console. Sample output is as follows:

VolumeName : MyVolumeMemberIndex : 1073788292VolumeIndex : 2VolumeSizeMB : 100DiskSpeedPreference : no_disk_speed_preferenceStoragePoolName : defaultAccessType : read_writeDriveTypePreference : no_drive_type_preferenceLoadBalance : yesiSCSIAlias :ThinProvision : noThinProvisionMinReservePercent : 0ThinProvisionWarningPercent : 0ThinProvisionMaxGrowPercent : 0OnlineStatus : onlineVolumeDescription :RaidTypePreference : no_raid_type_preferenceAllowMultipleInitiators : noSnapshotDeletionPolicy : delete_oldestSnapshotReservePercent : 100SnapshotReserveWarnPercent : 80VolumeAdministrator : MyVolumeAdminPSVID : 6-090A06-8407663B8-62C1548A8C10F23EPSVIDAsGuid : 68A09060-7640-B863-62C1-548A8C10F23EISCSITargetName : iqn.2001-05.com.equallogic:0-8a0906-b86376406-3ef2108c8a54c162-MyVolumeDynamicThinReserveMB : 0TemplateVolume : noThinClone : noNASVolume: noCloneSourcePsvid : 00000000-0000-0000-0000-000000000000AllocatedMB : 0SnapshotReserveAvailableMB : 105OperationalStatus : availableSnapshotReserveMB : 105SnapshotCount : 3ISCSIConnectionCount : 0SpannedMemberCount : 1ReplicaCount : 0

90


NextReplicationTransactionMB : 0ReplicaReserveInUseMB : 105

Example 2

This command gets the configuration and current statistics for every volume on a PS Seriesgroup.

C:\PS>Get-EqlVolume

Example 3

This command gets the configuration and current statistics for every volume on a PS Seriesgroup, and then pipes the output to the PowerShell Sort-Object cmdlet, which then pipes thesorted data to the PowerShell Format-Table cmdlet. The below command outputs a table sortedby VolumeSizeMB in descending order, and shows the VolumeName, VolumeSize, andAccessType for each volume on the PS Series group.

C:\PS>Get-EqlVolume | Sort-object volumesizeMB -descending | format-table-autosize volumeName, volumesizeMB, accessType

The previous command outputs the following table:

VolumeName VolumeSizeMB AccessType

---------------------- ------------------- --------------AcceleratorTest 1572864 read_write

AcceleratorTest2 307200 read_write

AcceleratorTest3 307200 read_write

gh-rhel6-v1 122880 read_write

gh-v1 81920 read_write

am-vol5 51200 read_write


COMPUTE-6 40000 read_write









COMPUTE-3-BASE 40000 read_only






COMPUTE-2-BASE 40000 read_only

91


VolumeName VolumeSizeMB AccessType

---------------------- ------------------- --------------FIRST-BASE-BASE 40000 read_write


wintest 20480 read_write

wintest2 20480 read_write

Volume1-PD 20480 read_write

Example 4

This command gets the member and volume indices for every volume on a PS Series group,pipes the output to the New-EqlSnapshot cmdlet to create a new snapshot for every volume. TheUseIndex parameter causes the New-EqlSnapshot cmdlet to identify the volume using theMemberIndex and VolumeIndex parameters piped from the Get-EqlVolume cmdlet. This resultsin significantly faster execution on arrays that have many volumes.

C:\PS>Get-EqlVolume | New-EqlSnapshot -UseIndex

Example 5

This command gets the configuration and current statistics for every volume which has a namethat begins with "MyVol" on the PS Series group named MyGroup.

C:\PS>Get-EqlVolume -VolumeName MyVol* -GroupName MyGroup

Example 6

This command gets the configuration and current statistics for every thin-provisioned volume onthe PS Series group at IP Address 10.100.100.10.

C:\PS>Get-EqlVolume -GroupAddress 10.100.100.10 -ThinProvision yes

Related Commands








• Get-EqlVolumeConnection cmdlet

92


Get-EqlVolumeConnection cmdletRetrieves configuration and statistics for iSCSI connections to a volume.

SyntaxGet-EqlVolumeConnection [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex [<uint>]] [-VolumeIndex [<uint>]][-UseIndex [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Get-EqlVolumeConnection cmdlet retrieves the configuration and statistics for all iSCSIconnections to a volume identified by name on a PS Series group to which a connection exists inthe current PowerShell runspace.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_ISCSI_CONNECTION_SPEC

You can pipe objects from the Get-EqlVolume cmdlets to the Get-EqlVolumeConnection cmdletto get a list for all or a subset of volumes on a group. Specify the UseIndex parameter to makethis more efficient on a group with a large number of volumes.






Required?: false

93




Specifies the name of a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This name is case-sensitive.

Required?: truePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: true


Specifies the member index that is used with the volume index to uniquely identify a volume. Ifyou specify a member index, you must also specify a volume index.

Required?: true, if Useindex is specified.Position?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false


Specifies the volume index that is used with the member index to uniquely identify a volume. Ifyou specify a volume index, you must also specify a member index.

Required?: true, if UseIndex is specified.Position?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false




Examples

Example 1

This command gets the configuration and current statistics for every connection to MyVolume.

C:\PS>Get-EqlVolumeConnection -VolumeName MyVolume

94


Sample output is as follows:TargetName : MyVolumeInitiatorAddress : 10.100.100.10InterfaceMember : MemberAInterfacePort : eth1InterfaceIPAddress : 10.100.100.11ConnectionTime : 18d 22h 48mMBRead : 34765MBWritten : 14236

Example 2

This command gets the configuration and current statistics for every connection to every volumeon a PS Series group. The UseIndex parameter causes the Get-EqlVolumeConnection cmdlet toidentify the volumes using the MemberIndex and VolumeIndex parameters piped from theGet-EqlVolume cmdlet. This results in significantly faster execution on groups that have manyvolumes.

C:\PS>Get-EqlVolume | Get-EqlVolumeConnection -UseIndex

Related Commands



• Get-EqlSnapshotConnection cmdlet

Set-EqlVolume cmdletChanges the settings of a volume on a PS Series group.

Command SyntaxSet-EqlVolume [-GroupName <string>] [-GroupAddress <string>] -VolumeName <string>[-NewVolumeName <string>] [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]][-VolumeSizeMB <uint>][-SnapshotReservePercent <uint>] [-StoragePoolName <string>][-AccessType <string>] [-LoadBalance <string>] [-iSCSIAlias [<string>]][-OnlineStatus <string>] [-RAIDTypePreference <string>][-AllowMultipleInitiators <string>] [-VolumeDescription [<string>]][-SnapshotReserveWarnPercent <uint>] [-SnapshotDeletionPolicy <string>][-ThinProvision <string>] [-ThinProvisionMinReservePercent <uint>][-ThinProvisionWarningPercent <uint>] [-ThinProvisionMaxGrowPercent <uint>][-VolumeAdministrator <string>] [-PassThru [<SwitchParameter>]][<CommonParameters>]

Command Description

The Set-EqlVolume cmdlet modifies the configuration of a volume identified by name on a PSSeries group to which a connection exists in the current PowerShell runspace. If you are

95


connected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. One or more parameters, such as the AccessType, VolumeName,VolumeSizeMB, or ThinProvision parameters, can be specified in a single call toSet-EqlVolume. Use the New-EqlVolumeACL and Remove-EqlVolumeACL cmdlets to modifyaccess control lists for a volume. To delete a volume, use the Remove-EqlVolume cmdlet.

InputsInterop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC

You can pipe objects from Get-EqlVolume to Set-EqlVolume. Pipe the objects throughformat-list to filter out parameters that you do not want to set.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC object if the PassThru parameter is present.









Required?: truePosition?: namedDefault value?: noneAccept pipeline input?: true

96



Parameter: NewVolumeName <string>

Changes the name for an existing volume. This name must be unique on the PS Group and iscase-sensitive.











Parameter: VolumeSizeMB <uint>

Changes the number of MB specified for the size of the volume.



Changes the percent of the volume size set aside for snapshot reserve.

97




Specifies the name of a new pool to which the volume should be moved. The name iscase-sensitive.



Changes the type of access to the volume. Enter (r)ead_only or read_(w)rite for the access type.The volume must be offline to change the AccessType. Use the OnlineStatus parameter to setthe volume offline, if necessary.


Parameter: LoadBalance <string>

Changes whether load balancing is enabled or disabled for the volume. Enter (y)es or $true toenable load balancing. Enter (n)o or $false to disable load balancing.

Required?: falsePosition?: namedDefault value?: yesAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: iSCSIAlias <string>

Changes the alias for the iSCSI identifier used for the volume. Enter an empty string ("") for theparameter value.



Changes whether the volume is online or offline. Enter (on)line or $true to set it online. Enter(off)line or $false to set it offline.

98


Required?: falsePosition?: namedDefault value?: onlineAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: RAIDTypePreference <string>

Changes the preferred RAID type when selecting a drive to which to move the volume. Ifspecifying a preference for RAID type, enter 5 for RAID5, 6 for RAID6, 10 for RAID10, or 50for RAID50. Otherwise, enter 0 or (n)o_raid_type_preference to clear a previous value.

Required?: falsePosition?: namedDefault value?: no_raid_type_preferenceAccept pipeline input?: trueAccept wildcard characters?: false


Changes whether to allow iSCSI connections from more than one initiator for the volume. Enter(y)es or $true to allow multiple initiator access. Enter (n)o or $false to not allow sharing of thevolume.


Parameter: VolumeDescription <string>

Changes the description of the volume (up to a maximum of 255 characters). Enter an emptystring ("") for the parameter value.



Changes the percent of the snapshot reserve that can be used before a low space warning isissued.



Changes the policy to apply when the snapshot reserve is insufficient to create snapshots of thevolume. Enter (m)ake_volume_offline or (d)elete_oldest for the policy.

99




Changes whether the new volume is thin provisioned. Enter (y)es or $true to thin provision thevolume. Enter (n)o or $false to allocate space for the full requested size of the volume.


Parameter: ThinProvisionMinReservePercent <uint>

Changes the percent of the requested volume size to reserve for the volume if it is thinprovisioned (minimum 10 percent).



Changes the percent of the requested volume size that can be used before a warning is issued ifit is thin provisioned.



Changes the percent of the requested volume size to which the volume can grow before the totalsize of the volume must be increased if it is thin provisioned.


Parameter: VolumeAdministrator <string>

Changes the name of the Volume Administrator that owns this volume. This name is casesensitive. If the name specified is not a volume admin, the command will fail. Enter an emptystring ("") to clear the current value.

100




Specifies that the cmdlet should return an EQL_VOLUME_SPEC object for the changed volume onsuccessful completion.


Examples

Example 1

This command renames MyVolume to MyBiggerVolume, sets the size to 20GB (20000MB), setsthe access to read-only, and places the volume offline. The volume must be set offline to changethe AccessType.

C:\PS>Set-EqlVolume -VolumeName MyVolume -NewVolumeName MyBiggerVolume-VolumeSizeMB 20000 -AccessType read_only -OnlineStatus offline

Example 2

This command changes MyVolume to thin-provisioned volume with a minimum size of 20percent of the original volume size and makes the volume writable.

C:\PS>Set-EqlVolume -VolumeName MyVolume -ThinProvision yes-ThinProvisionMinReservePercent 20 -AccessType read_write

Related Commands









101


Remove-EqlVolume cmdletDeletes a specified volume and its snapshots, schedules, and ACLs from a PS Series group.

Command SyntaxRemove-EqlVolume [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]][-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlVolume cmdlet deletes a volume identified by name and all of its snapshots,schedules, and ACLs from a PS Series group. Use Set-EqlVolume to take the volume offlinebefore trying to delete it. If you are connected to more than one group, you can specify the targetgroup using either the GroupName or GroupAddress parameter. This cmdlet will display a promptto the console to confirm the deletion. The -Force parameter can be used to suppress this promptfor scripts. Use the Remove-EqlVolumeACL to delete access control lists for a volume. UseRemove-EqlSnapshot to delete snapshots of a volume.

Inputs

None.

Outputs








102
















Specifies that the cmdlet should bypass the confirmation prompt and delete the volume.


103


Examples

Example 1

This command displays a dialog requesting confirmation, and if confirmed, deletes MyVolume,all of its ACLs, all of its schedules, and all of its snapshots.

C:\PS>Remove-EqlVolume -VolumeName MyVolume

Example 2

This command deletes MyVolume, all of its ACLs, all of its schedules, and all of its snapshotswithout asking for confirmation.

C:\PS>Remove-EqlVolume -VolumeName MyVolume -Force

Related Commands









• Remove-EqlReplica cmdlet

New-EqlVolumeACL cmdletCreates and adds an access control list to the specified volume.

Command SyntaxNew-EqlVolumeACL [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-InitiatorName <string>][-InitiatorIpAddress <string>] [-InitiatorIpMask <string>] [-Username <string>]-AclTargetType <string> [<CommonParameters>]

104


Command Description

The New-EqlVolumeACL cmdlet creates an ACLs for a volume identified by name on a PS Seriesgroup. If you are connected to more than one group, you can specify the target group using eitherthe GroupName or GroupAddress parameter. Each ACL consists of at least one of the following:InitiatorName, Username (CHAP user), and InitiatorIpAddress/InitiatorIpMask. The new ACLwill also apply to any existing or new snapshots of the volume if the AclTargetType is set tosnapshots_only or volumes_and_snapshots. Use the Get-EqlVolumeACL cmdlet to list the accesscontrol lists for a volume. Use the Remove-EqlVolumeACL cmdlet to delete one or more ACLsfrom a volume.

InputsInterop.EqlPsaMgmtAPI.EQL_ACL_SPEC

The output of Get-EqlVolumeACL for a volume can be piped to New-EqlVolumeACL to copy theACLs from one volume to another.

Outputs










105












Parameter: InitiatorName <string>

Specifies the IQN of an iSCSI initiator which is being granted access to the specified volume.

Required? falsePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: InitiatorIpAddress <string>

Specifies the IP Address of a host machine which is being granted access to the specifiedvolume. This parameter must be IPv4. Asterisks can be used to specify a subnet. If asterisks areused in the IP Address, do not use the InitiatorIPMask parameter.

Required? falsePosition?: named

106


Default value?: 0.0.0.0Accept pipeline input?: trueAccept wildcard characters?: true

Parameter: InitiatorIpMask <string>

Specifies the IP Address Mask to be used with the InitiatorIpAddress parameter to identify asubnet which is being granted access to the specified volume. This parameter must be IPv4. Ifyou use asterisks in the InitiatorIPAddress to indicate a subnet, do not use this parameter.

Required? falsePosition?: namedDefault value?: 255.255.255.255Accept pipeline input?: trueAccept wildcard characters?: false


Specifies a CHAP username which is being granted access to the specified volume.

Required? falsePosition?: namedDefault value?: noneAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: AclTargetType <string>

Specifies whether access is granted to volumes, snapshots, or both. Enter (v)olume_only,(s)napshot_only, or volume_(a)nd_snapshot to indicate the access granted.


Examples

Example 1

This command grants volume only access to MyVolume to the host machine withiqn.1991-05.com.microsoft:mycomputer.mydomain.com.

C:\PS>New-EqlVolumeACL -VolumeName MyVolume -InitiatorNameiqn.1991-05.com.microsoft:mycomputer.mydomain.com -ACLTargetType volume_only

Example 2

Both of the following two commands grant access to MyVolume and its snapshots to hostmachines in the 10.100.100.1/255.255.255.0 subnet.

C:\PS>New-EqlVolumeACL -VolumeName MyVolume -InitiatorIpAddress 10.100.100.1-InitiatorIpMask 255.255.255.0 -ACLTargetType volume_and_snapshot

107


C:\PS>New-EqlVolumeACL -VolumeName MyVolume -InitiatorIpAddress 10.100.100.*-ACLTargetType volume_and_snapshot

Example 3

This command copies the access control lists from MyVolume1 to MyVolume2.

C:\PS>Get-EqlVolumeACL -VolumeName MyVolume1 | New-EqlVolumeACL -VolumeNameMyVolume2

Example 4

This command grants access to MyVolume and its snapshots to host machines in the10.100.100.1/255.255.255.0 subnet using the * as a wildcard in the IP Address to indicate thesubnet.

C:\PS>New-EqlVolumeACL -VolumeName MyVolume -InitiatorIpAddress 10.100.100.*-ACLTargetType volume_and_snapshot

Example 5

This command gets the member and volume indices for every volume on a PS Series group,pipes the output to the New-EqlVolumeACL cmdlet to add an ACL that provides access to thevolumes and their snapshots to any host in the 10.200.*.* subnet. The UseIndex parametercauses the New-EqlVolumeACL cmdlet to identify the volume using the MemberIndex andVolumeIndex parameters piped from the Get-EqlVolume cmdlet. This results in significantlyfaster execution on arrays that have many volumes.

C:\PS>Get-EqlVolume | New-EqlVolumeACL -UseIndex -InitiatorIpAddress 10.200.*.*-ACLTargetType volumes_and_snapshots

Related Commands







Get-EqlVolumeACL cmdletRetrieves the ACLs for the specified volume.

Command SyntaxGet-EqlVolumeACL [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>]

108


[-UseIndex [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Get-EqlVolumeACL cmdlet retrieves all of the ACLs for a volume identified by name on aPS Series group. If you are connected to more than one group, you can specify the target groupusing either the GroupName or GroupAddress parameter. Each ACL consists of at least one of thefollowing: InitiatorName, Username (CHAP user), and InitiatorIpAddress. The informationretrieved by this command can be piped into the New-EqlVolumeACL command to copy the accesscontrol lists from one volume to another. Use the New-EqlVolumeACL to add an access control listto a volume. Use the Remove-EqlVolumeACL cmdlet to delete one or more ACLs from a volume.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_ACL_SPEC.

You can pipe objects from Get-EqlVolumeACL to other cmdlets, such as Set-EqlVolumeACL. Pipethe objects through format-list to filter out parameters that you do not want to set.









109












Example

This command gets all of the ACLs for MyVolume.

C:\PS>Get-EqlVolumeACL -VolumeName MyVolume

Sample output is as follows:Index : 1VolumeName : MyVolumeInitiatorName :Username : chapuserInitiatorIpAddress : 10.100.100.10InitiatorIpMask : 255.255.255.0AclTargetType : volume_and_snapshot

Related Commands


110







Remove-EqlVolumeACL cmdletRemoves one or all ACLs from the specified volume.

Command SyntaxRemove-EqlVolumeACL [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -AclIndex <uint> [<CommonParameters>]

Command Description

The Remove-EqlVolumeACL cmdlet removes the ACL with the specified index from a volumeidentified by name on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. If an index is not specified, all ACLs areremoved from the volume. Use the Get-EqlVolumeACL cmdlet to get the index for each of theACLs on a volume.

Inputs

None.

Outputs

Returns a string acknowledging successful completion of the cmdlet action.




111

















Parameter: AclIndex <uint>

112


Specifies the index of the ACL to be removed from the specified volume. If no index isspecified, all ACLs are removed from the volume.


Example

This command removes the ACL with an ACLIndex of 1 from MyVolume.

C:\PS>Remove-EqlVolumeACL -VolumeName MyVolume -AclIndex 1

Related Commands






Advanced Volume Administration cmdletsThe advanced volume administration cmdlets allow you to make clones and replicas of avolume, as well as for managing template volumes and thin clones.

New-EqlVolumeClone cmdletCreates a clone of the specified volume on a PS Series group.

Command SyntaxNew-EqlVolumeClone [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -CloneName <string>[-StoragePoolName <string>] [-CloneDescription <string>] [<CommonParameters>]

Command Description

The New-EqlVolumeClone cmdlet creates a clone of a volume identified by name on a PS Seriesgroup to which a connection exists in the current PowerShell runspace. If you are connected tomore than one group, you can specify the target group using either the GroupName orGroupAddress parameter. The clone can be created in a specified pool. Additional actions canbe performed on the newly created clone using volume cmdlets.

113


Inputs

None.

Outputs














114








Parameter: CloneName <string>

Specifies the name to be used for the clone.



Specifies the name of the pool in which the clone should be created.


Parameter: CloneDescription <string>

Specifies a description of the clone.


115


Examples

Example 1

This command creates a clone of MyVolume named MyVolumeClone with the same settings asMyVolume.

C:\PS>New-EqlVolumeClone -VolumeName MyVolume -CloneName MyVolumeClone

Example 2

This command creates a clone of MyVolume named MyVolumeClone in MyPool with the samesettings as MyVolume.

C:\PS>New-EqlVolumeClone -VolumeName MyVolume -CloneName MyVolumeClone-StoragePoolName MyPool

Related Commands








• Set-EqlSnapshot cmdlet

• Get-EqlSnapshot cmdlet

• Remove-EqlSnapshot cmdlet

ConvertTo-EqlTemplateVolume cmdletConverts a volume on a PS Series group to a template volume.

Command SyntaxConvertTo-EqlTemplateVolume [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-TimeoutSeconds <int>] [<CommonParameters>]

116


Command Description

The ConvertTo-EqlTemplateVolume cmdlet changes the volume identified by name on a PSSeries group to a template volume that can be used for creating thin clones. If you are connectedto more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. The specified volume will be taken offline, set to read-only access,and thin provisioned as part of the conversion. This conversion is an asynchronous operation.Use the Get-EqlVolume cmdlet to verify that the TemplateVolume property equals yes beforetrying to use the template volume to create thin clones. Use theConvertFrom-EqlTemplateVolume cmdlet to convert a TemplateVolume back to a normalvolume.

Inputs

None.

Outputs










Required?: true

117












Parameter: TimeoutSeconds <int>

Specifies the number of seconds to wait while the volume is prepared for conversion.


Examples

Example 1

This command converts MyVolume to a template volume. MyVolume is offline, read-only andthin-provisioned after the conversion is completed.

C:\PS>ConvertTo-EqlTemplateVolume -VolumeName MyVolume

118


Example 2

This command converts MyVolume to a template volume. MyVolume is offline, read-only andthin-provisioned after the conversion is completed. If the conversion is not completed in 300seconds, the cmdlet reports an error.

C:\PS>ConvertTo-EqlTemplateVolume -VolumeName MyVolume -TimeoutSeconds 300

Related Commands



• ConvertFrom-EqlTemplateVolume cmdlet

• New-EqlThinClone cmdlet

ConvertFrom-EqlTemplateVolume cmdletConverts a template volume to a regular volume on a PS Series Group.

Command SyntaxConvertFrom-EqlTemplateVolume [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [<CommonParameters>]

Command Description

The ConvertFrom-EqlTemplateVolume cmdlet changes the template volume identified by nameon a PS Series group to a regular volume. If you are connected to more than one group, you canspecify the target group using either the GroupName or GroupAddress parameter. If any thinclones created from the template are still attached to the template volume, this cmdlet will fail.Use the ConvertFrom-EqlThinClone cmdlet for each attached clone to detach it before usingthis cmdlet. Use the Set-EqlVolume cmdlet to change the AccessType, OnlineStatus, andThinProvision properties to revert the changes made when the original volume was converted toa template volume.

Inputs

None.

Outputs



119








Specifies the name of a template volume on a PS Series group that identifies the volume towhich this cmdlet applies. This name is case-sensitive.









120




Example

This command changes the template volume MyVolume back to a regular volume. MyVolume isleft offline, read-only and thin-provisioned after the conversion is completed.

C:\PS>ConvertFrom-EqlTemplateVolume -VolumeName MyVolume

Related Commands



• ConvertTo-EqlTemplateVolume cmdlet

• ConvertFrom-EqlThinClone cmdlet

New-EqlThinClone cmdletCreates a thin clone of the specified template volume.

Command SyntaxNew-EqlThinClone [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -CloneName <string>[-CloneDescription <string>] [<CommonParameters>]

Command Description

The New-EqlThinClone cmdlet creates a clone of a template volume identified by name on a PSSeries group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. Additional actions can be performed on the newly created thin cloneusing volume cmdlets. Use the ConvertFrom-EqlThinClone cmdlet to detach the thin clone fromits template.

Inputs

None.

121


Outputs









Specifies the name of a template volume on a PS Series group that identifies the templatevolume to which this cmdlet applies. This name is case-sensitive.







122







Specifies the name to be used for the thin clone. This name must be unique in the PS Group andis case-sensitive.


Parameter: CloneDescription <string>

Specifies a description of the thin clone.


Example

This command creates a thin clone of MyTemplateVolume named MyThinClone.

C:\PS>New-EqlThinClone -VolumeName MyTemplateVolume -CloneName MyThinClone

Related Commands






123


• New-EqlSnapshot cmdlet




ConvertFrom-EqlThinClone cmdletDetaches a thin clone from its template volume.

Command SyntaxConvertFrom-EqlThinClone [-GroupName <string>] [-GroupAddress <string>]-CloneName <string> [<CommonParameters>]

Command Description

The ConvertFrom-EqlThinClone cmdlet detaches a thin clone from its template volume. If youare connected to more than one group, you can specify the target group using either theGroupName or GroupAddress parameter.

Inputs

None.

Outputs







124




Specifies the name of the thin clone to be detached. This name is case-sensitive.


Example

This command detaches the thin clone named MyThinClone from its template volume.

C:\PS>ConvertFrom-EqlThinClone -CloneName MyThinClone

Related Commands





• ConvertFrom-EqlTemplateVolume cmdlet

• New-EqlThinClone cmdlet

125

7 Snapshot Cmdlets

New-EqlSnapshot cmdletCreates a snapshot of the specified volume.

Note: Snapshots created by the PowerShell Tools are crash consistent, and notapplication consistent. To create application consistent snapshots, use the Auto-SnapshotManager/Microsoft Edition (ASM/ME) console or the ASM CLI. The ASM CLI is a setof commands that you can execute at the Windows command prompt instead of using theASM/ME GUI for Smart Copy operations. See the Auto-Snapshot Manager User Guidefor more information.

Command SyntaxNew-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-SnapshotDescription <string>][-AccessType <string>] [-OnlineStatus <string>][-AllowMultipleInitiators <string>] [-PassThru [<SwitchParameter>]][<CommonParameters>]

Command Description

The New-EqlSnapshot cmdlet creates a snapshot of a volume identified by name on a PS Seriesgroup to which a connection exists in the current PowerShell runspace. If you are connected tomore than one group, you can specify the target group using either the GroupName orGroupAddress parameter. The snapshot can be created with a specified access type, onlinestatus, multiple initiator access, and description. Use the Get-EqlVolume cmdlet to list thesnapshot reserve available for a volume. Use the Set-EqlSnapshot cmdlet to change or set anyof the optional parameters that were not set at creation time.

InputsInterop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC

The output of Get-EqlSnapshot for any volume can be piped to New-EqlSnapshot to copy thesnapshot parameters from one volume to another.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC object if the PassThru parameter is present.

127

PowerShell Tools Reference Guide 7 Snapshot Cmdlets
















128





Parameter: SnapshotDescription <string>

Specifies a description of the snapshot.



Specifies whether the snapshot allows read-only or read-write access.

Required?: falsePosition?: namedDefault value?: read-writeAccept pipeline input?: trueAccept wildcard characters?: false


Specifies whether the snapshot is created and set online or offline. Enter (on)line or $true to setit online or (off)line or $false to set it offline.

Required?: falsePosition?: namedDefault value?: offlineAccept pipeline input?: trueAccept wildcard characters?: false


Specifies whether multiple initiators will be allowed to connect to the snapshot at the same time.Enter (y)es or $true to enable multiple initiator access. Enter (n)o or $false to disable it.



129


Specifies that the cmdlet should return an EQL_SNAPSHOT_SPEC object for the new snapshot onsuccessful completion.


Examples

Example 1

This command creates a snapshot of MyVolume with the default settings (read-write, offline,not-shared).

C:\PS>New-EqlSnapshot -VolumeName MyVolume

Example 2

This command creates a read-only snapshot of MyVolume that is online and allows connectionsfrom multiple initiators.

C:\PS>New-EqlSnapshot -VolumeName MyVolume -AllowMultipleInitiators yes-OnlineStatus online -AccessType read_only

Example 3

This command gets the member and volume indices for every volume on a PS Series group,pipes the output to the New-EqlSnapshot cmdlet to create a new snapshot for every volume. TheUseIndex parameter causes the New-EqlSnapshot cmdlet to identify the volume using theMemberIndex and VolumeIndex parameters piped from the Get-EqlVolume cmdlet. This resultsin significantly faster execution on arrays that have many volumes.

C:\PS>Get-EqlVolume | New-EqlSnapshot -UseIndex

Related Commands









130


Get-EqlSnapshot cmdletRetrieves information for one or more snapshots of the specified volume.

Command SyntaxGet-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-SnapshotName <string>] [<CommonParameters>]

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC

You can pipe objects from Get-EqlSnapshot to other cmdlets, such as New-EqlSnapshot orRemove-EqlSnapshot. If you are connected to more than one group, you can specify the targetgroup using either the GroupName or GroupAddress parameter. Pipe the objects throughformat-list to filter out parameters that you do not want to set.

Command Description

The Get-EqlSnapshot cmdlet retrieves the specified snapshot of a volume identified by name ona PS Series group to which a connection exists in the current PowerShell runspace. If a snapshotname is not specified, the information for all snapshots of the specified volume is retrieved. Theinformation retrieved by this command can be piped into the New-EqlSnapshot command to copythe snapshot parameters from one volume snapshot to another.






131















Parameter: SnapshotName <string>

Specifies the name of the snapshot of the specified volume to which this cmdlet applies. Thisname is case-sensitive.


132



Examples

Example 1

This command retrieves information for all snapshots of MyVolume.

C:\PS>Get-EqlSnapshot -VolumeName MyVolume

Example 2

This command retrieves the information for MyVolume-2010-06-10-08:00:00.1234.

C:\PS>Get-EqlSnapshot -VolumeName MyVolume -SnapshotNameMyVolume-2010-06-10-08:00:00.1234

This command outputs a PSObject with the values from anInterop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC. The following is the output:

SnapshotName : MyVolume-2010-06-10-08:00:00.1234volumeName : MyVolumeISCSITargetName : iqn.2001-05.com.equallogic:0-290c06-711c90f74-012000000294cd92-MyVolume-2010-06-10-08:00:00.1234iSCSIAlias : MyVolume-2010-06-10-08:00:00.1234AccessType : read_writeSnapshotDescription :AllowMultipleInitiators : noOnlineStatus : onlineSnapshotSizeMB : 200SnapshotPsvid : 6-0C0904-2F7901C71-92CD940200002001SnapshotPsvidAsGuid : 4290C060-90F7-711C-92CD-940200002001CreationTimeStamp : 06/10/10 08:00:00

Related Commands









• Get-EqlSnapshotConnection cmdlet

133


Get-EqlSnapshotConnection cmdletRetrieves configuration and statistics for iSCSI connections to a snapshot.

SyntaxGet-EqlSnapshotConnection [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -SnapshotName <string> [<CommonParameters>]

Command Description

The Get-EqlSnapshotConnection cmdlet retrieves the configuration and statistics for all iSCSIconnections to a snapshot identified by name on a PS Series group to which a connection existsin the current PowerShell runspace.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_ISCSI_CONNECTION_SPEC

You can pipe objects from the Get-EqlSnapshot cmdlet to the Get-EqlSnapshotConnectioncmdlet to get a list of connections for all snapshots of a volume on a group.







134







Specifies the member index that is used with the volume index to uniquely identify a volume. Ifyou specify a member index, you must also specify a volume index.



Specifies the volume index that is used with the member index to uniquely identify a volume. Ifyou specify a volume index, you must also specify a member index.






Specifies the name of a snapshot on a PS Series group that identifies the snapshot to which thiscmdlet applies. This name is case-sensitive.

Required?: truePosition?: named

135


Default value?: noneAccept pipeline input?: trueAccept wildcard characters?: true

Examples

Example 1

This command gets the configuration and current statistics for every connection to MyVolume.

C:\PS>Get-EqlSnapshotConnection -VolumeName MyVolume-SnapshotName MyVolume-2010-06-10-08:00:00.1234

Sample output is as follows:TargetName : MyVolume-2010-06-10-08:00:00.1234InitiatorAddress : 10.100.100.10InterfaceMember : MemberAInterfacePort : eth1InterfaceIPAddress : 10.100.100.11ConnectionTime : 18d 22h 48mMBRead : 34765MBWritten : 14236

Example 2

This command gets the configuration and current statistics for every connection to everysnapshot of MyVolume on the PS Series group.

C:\PS>Get-EqlSnapshot -VolumeName MyVolume | Get-EqlSnapshotConnection

Related Commands





Set-EqlSnapshot cmdletChanges the settings on a snapshot of the specified volume.

Command SyntaxSet-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -SnapshotName <string> [-NewSnapshotName <string>][-iSCSIAlias <string>] [-SnapshotDescription [<string>]]

136


[-AccessType <string>] [-OnlineStatus <string>][-AllowMultipleInitiators <string>] [-PassThru [<SwitchParameter>]][<CommonParameters>]

Command Description

The Set-EqlSnapshot cmdlet changes settings for a snapshot of a volume identified by name ona PS Series group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. The snapshot name, iSCSI target alias, access type, online status,multiple initiator access, and description can be changed with this cmdlet. Use theGet-EqlVolume cmdlet to list the snapshot reserve available for a volume. Use theSet-EqlSnapshot cmdlet to change or set any of the optional parameters that were not set atcreation time.

Inputs

Interop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC

The output of Get-EqlSnapshot for any volume can be piped to Set-EqlSnapshot to copy thesnapshot parameters from one snapshot to another.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC object if the PassThru parameter is present.







137


















Parameter: NewSnapshotName <string>

138


Changes the name of the snapshot of the specified volume. This name must be unique for thevolume and is case-sensitive.


Parameter: iSCSIAlias <string>

Changes the iSCSIAlias of the snapshot of the specified volume.


Parameter: SnapshotDescription [<string>]

Changes the description of the snapshot.



Changes whether the snapshot allows read-only or read-write access. The snapshot must beoffline to change its access type. Use the OnlineStatus parameter to set the snapshot offline, ifnecessary.

Required?: falsePosition?: namedDefault value?: read-writeAccept pipeline input?: trueAccept wildcard characters?: false


Changes whether the snapshot is online or offline.



Changes whether multiple initiators are allowed to connect to the snapshot at the same time.Enter (y)es or $true to enable multiple initiator access. Enter (n)o or $false to disable it.

139




Specifies that the cmdlet should return an EQL_SNAPSHOT_SPEC object for the changed snapshoton successful completion.


Example

This command changes the settings of the snapshot named MyVolume-2010-06-10-08:00:00.1234of MyVolume to read-write and online.

C:\PS>Set-EqlSnapshot -VolumeName MyVolume-SnapshotName MyVolume-2010-06-10-08:00:00.1234 -OnlineStatus online-AccessType read_write

Related Commands








Restore-EqlSnapshot cmdletRestores a volume from a snapshot of the specified volume.

Caution: If you use this cmdlet to restore from a snapshot that was created through theASM/ME console or the ASM CLI, the restore will not be performed in anapplication-aware manner. Therefore, before performing the restore operation, youshould perform all necessary actions (for example, taking an SQL databases offline,or putting clustered volumes in maintenance mode) using the appropriate cmdletsprovided for SQL or failover clusters.

140


Command SyntaxRestore-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -SnapshotName <string> [<CommonParameters>]

Command Description

The Restore-EqlSnapshot cmdlet restores a volume, identified by name, from a specifiedsnapshot of that volume. If you are connected to more than one group, you can specify the targetgroup using either the GroupName or GroupAddress parameter. The volume must reside on a PSSeries group to which a connection exists in the current PowerShell runspace. Both the volumeand its snapshot will be taken offline, if they are online when the cmdlet is invoked. Both will berestored to their original online state after the restore action completes. If you want to leaveeither the volume or snapshot offline after the command completes, use the Set-EqlVolume orSet-EqlSnapshot cmdlet to set the online status to offline before using theRestore-EqlSnapshot cmdlet.

Inputs

None. The output of Get-EqlSnapshot for any volume can be piped through a filter to select asnapshot to pipe to Restore-EqlSnapshot from which to restore a volume.

Outputs








141


















142


Examples

This command restores MyVolume from the snapshot MyVolume-2010-06-30-12:00:00.1

C:\PS>Restore-EqlSnapshot -VolumeName MyVolume -SnapshotNameMyVolume-2010-06-30-12:00:00.1

Related Commands





Remove-EqlSnapshot cmdletRemoves one or more of the snapshots of the specified volume.

Command SyntaxRemove-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-SnapshotName <string>][-SelectOldest {<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlSnapshot cmdlet removes the snapshot with the specified name of a volumeidentified by name on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. If a snapshot name is not specified, allsnapshots of the volume are removed. Use the Get-EqlSnapshot cmdlet to get the name for eachof the snapshots of a volume. The SelectOldest parameter can be specified instead thesnapshot name to remove the oldest snapshot for the volume. If neither a snapshot name norSelectOldest is specified, all snapshots of the volume are removed.

Inputs

None.

Outputs


143

















144






Specifies the name of the snapshot of the specified volume to which this cmdlet applies. Thisname is case-sensitive. If this parameter is not specified, all snapshots of the volume will bedeleted. If this parameter is specified, the SelectOldest parameter must not be used.


Parameter: SelectOldest [<SwitchParameter>]

Specifies that the cmdlet should select the oldest snapshot for removal. If this parameter isspecified, the SnapshotName parameter must not be used.


Examples

Example 1

This command deletes all of the snapshots of MyVolume.

C:\PS>Remove-EqlSnapshot -VolumeName MyVolume

Example 2

This command deletes the snapshot named MyVolume-2010-06-10-08:00:00.1234.

C:\PS>Remove-EqlSnapshot -VolumeName MyVolume -SnapshotNameMyVolume-2010-06-10-08:00:00.1234

Related Commands



145





New-EqlSnapshotClone cmdletCreates a clone of the specified snapshot of a volume on a PS Series group.

Command SyntaxNew-EqlSnapshotClone [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -SnapshotName <string> -CloneName <string>[<CommonParameters>]

Command Description

The New-EqlSnapshotClone cmdlet creates a clone of a snapshot identified by name of a volumeidentified by name on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. Additional actions can be performed on thenewly created clone using volume cmdlets. For example, you can use the New-EqlVolumeACLcmdlet to set ACLs on the clone.

Inputs

None. You cannot pipe objects to New-EqlSnapshotClone.

Outputs






146

















Specifies the name of a snapshot on a PS Series group that identifies the snapshot to which thiscmdlet applies. This name is case-sensitive.

147




Specifies the name to be used for the clone.


Example

This command creates a clone of snapshot MyVolume-2010-01-01-00:00:00.1 namedMySnapshotClone with the same settings as MyVolume.

C:\PS>New-EqlSnapshotClone -VolumeName MyVolume -SnapshotNameMyVolume-2010-01-01-00:00:00.1 -CloneName MySnapshotClone

Related Commands











148

8 Replication Cmdlets

Replication Configuration cmdletsThese cmdlets are used to manage replication partnerships between groups and to configurereplication for volumes.

New-EqlReplicationPartner cmdletCreates a replication partnership between two PS Series Groups.

Command SyntaxNew-EqlReplicationPartner [-GroupName <string>] [-GroupAddress <string>]-PartnerName <string> -PartnerIPAddress <string> [-InboundCredential<System.Management.Automation.PSCredential>][-InboundPassword <string>] [-PartnerDescription <string>] [-ContactName <string>][-ContactEmailAddress <string>] [-ContactPhone <string>] [-ContactMobile <string>][-OutboundCredential <System.Management.Automation.PSCredential>][-OutboundPassword <string>] [-DelegatedSpaceMB <uint>][-ReplicationStatus <string>] [-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The New-EqlReplicationPartner cmdlet creates a replication partnership between a PS Seriesgroup to which a connection exists in the current PowerShell runspace and another PS SeriesGroup. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. To complete the creation of the partnership,you must connect to the partner group and execute this cmdlet specifying the first group as thepartner.

Inputs

None.

Outputs


Otherwise, an Interop.EqlPsaMgmtAPI.EQL_PARTNER_SPEC object is returned.

You can pipe objects from New-EqlReplicationPartner to Set-EqlReplicationPartner. Pipethe objects through format-list to filter out parameters that you do not want to use.

149

PowerShell Tools Reference Guide 8 Replication Cmdlets







Parameter: PartnerName <string>

Specifies the name of the group to which replication will be performed from a PS Series group.This name is case-sensitive.


Parameter: PartnerIPAddress <string>

Specifies the IP Address for the group to which replication will done. This address can be IPv4or IPv6.


Parameter: InboundCredential <System.Management.Automation.PSCredential>

Specifies a PSCredential object containing the password (16 alphanumeric characters maximum)for access by the PS Series group specified as the value for the PartnerName parameter. TheInboundPassword parameter can be used instead of the InboundCredential parameter.

Required?:true, unless InboundPassword is specified.

150



Parameter: InboundPassword <string>

Specifies the password (16 alphanumeric characters maximum) for access by the PS Seriesgroup specified as the value for the PartnerName parameter. The InboundCredentialparameter can be used instead of the InboundPassword parameter.

Required?: true, unless InboundCredential is specified.Position?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: PartnerDescription <string>

Specifies a description for the replication site.


Parameter: ContactName <string>

Specifies a contact name for the replication site.


Parameter: ContactEmailAddress <string>

Specifies an email address for the contact at the replication site.


Parameter: ContactPhone <string>

Specifies a phone number for the contact at the replication site.


Parameter: ContactMobile <string>

151


Specifies a mobile number for the contact at the replication site.


Parameter: OutboundCredential <System.Management.Automation.PSCredential>

Specifies a PSCredential object containing the password (16 alphanumeric characters maximum)for access to the PS Series group specified as the value for the PartnerName parameter. TheOutboundPassword parameter can be used instead of the OutboundCredential parameter.

Required?: true, unless OutboundPassword is specified.Position?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: OutboundPassword <string>

Specifies the password (16 alphanumeric characters maximum) for access to the PS Seriesgroup specified as the value for the PartnerName parameter. The OutboundCredentialparameter can be used instead of the OutboundPassword parameter.

Required?: true, unless OutboundCredential is specified.Position?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: DelegatedSpaceMB <uint>

Specifies the number of MB set aside on the outbound group for inbound replication from thereplication site.


Parameter: ReplicationStatus <string>

Specifies whether the replication partnership is enabled for use when it is created. Enter(e)nabled to enable replication, or (d)isabled to disable replication.



152


Specifies that the cmdlet should return an EQL_PARTNER_SPEC object for the new replicationpartnership on successful completion.


Example

This command, executed when connected to GroupA, will create a replication partnership withGroupB using IP address 10.100.100.10. The outbound password password2 will be used forauthentication for access to GroupB. The inbound password password1 will be used forauthentication for access by GroupB. 10GB of space will be delegated for storing partner replicasets. Since the PassThru parameter is specified, it will also list all of the values in the EQL_PARTNER_SPEC object, except for passwords, for the new partnership. To complete the creation ofthe partnership, you must also connect to GroupB and execute this command, specifying GroupAfor PartnerName, GroupA's IP Address for PartnerIPAddress, password2 for InboundPassword,and password1 for OutboundPassword.

C:\PS>New-EqlReplicationPartner -PartnerName GroupB -PartnerIPAddress10.100.100.10 -InboundPassword password1 -OutboundPassword password2 -DelegatedSpaceMB 10000 -ReplicationStatus enabled -PassThru

Related Commands


• Get-EqlReplicationPartner cmdlet

• Set-EqlReplicationPartner cmdlet

• Remove-EqlReplicationPartner cmdlet

Get-EqlReplicationPartner cmdletRetrieves the definition of a specified replication partnership or all replication partnerships for agroup.

Command SyntaxGet-EqlReplicationPartner [-GroupName <string>] [-GroupAddress <string>][-PartnerName <string>] [<CommonParameters>]

Command Description

The Get-EqlReplicationPartner cmdlet retrieves the definition for a replication partnershipbetween a group identified by name and a PS Series group to which a connection exists in thecurrent PowerShell runspace. If you are connected to more than one group, you can specify thetarget group using either the GroupName or GroupAddress parameter. If a partner name is not

153


specified, then this cmdlet retrieves the definitions for all replication partnerships on a PS Seriesgroup to which the connection exists in the current PowerShell runspace.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC

You can pipe objects from Get-EqlReplicationPartner to other cmdlets, such asNew-EqlReplicationPartner. Pipe the objects through format-list to filter out parameters thatyou do not want to use.








Specifies the name of the group to which replication is performed from a PS Series group toidentify the partnership to which this cmdlet applies. This name is case-sensitive.


154


Example

This command will return a PSObject containing all of the values in the EQL_PARTNER_SPECobject, except for passwords, for the partnership with GroupB.

C:\PS>Get-EqlReplicationPartner -PartnerName GroupB

Sample output is as follows:PartnerName : GroupBPartnerIPAddress : 10.100.100.10PartnerDescription : Test ConfigurationContactName : MyContactContactEmailAddress : [email protected] : 222-555-3434ContactMobile : 111-555-1212PrimaryGroup : GroupADelegatedSpaceMB : 80000StoragePoolName : PoolBReplicationStatus : enabledInboundPassword : ****************OutboundPassword : ****************

Related Commands


• New-EqlReplicationPartner cmdlet



Set-EqlReplicationPartner cmdletChanges the definition of a replication partnership between two PS Series groups.

Command SyntaxSet-EqlReplicationPartner [-GroupName <string>] [-GroupAddress <string>]-PartnerName <string> [-NewPartnerName <string>] [-PartnerIPAddress <string>][-InboundCredential {System.Management.Automation.PSCredential}][-InboundPassword <string>] [-PartnerDescription [<string>]][-ContactName <string>] [-ContactEmailAddress <string>][-ContactPhone <string>] [-ContactMobile <string>][-OutboundCredential <System.Management.Automation.PSCredential>][-OutboundPassword <string>] [-DelegatedSpaceMB <uint>][-ReplicationStatus <string>] [-PassThru [<SwitchParameter>]] [<CommonParameters>]

155


Command Description

The Set-EqlReplicationPartner cmdlet changes a replication partnership between a PS Seriesgroup to which a connection exists in the current PowerShell runspace and another PS Seriesgroup. If you are connected to more than one group, you can specify the target group using eitherthe GroupName or GroupAddress parameter.

Inputs

None.

Outputs


Otherwise, an Interop.EqlPsaMgmtAPI.EQL_PARTNER_SPEC object is returned.

You can pipe objects from Get-EqlReplicationPartner to Set-EqlReplicationPartner tocopy settings from one replication partner to another. Pipe the objects through format-list to filterout parameters that you do not want to use.








Specifies the name of the group to which replication will be performed from a PS Series group toidentify the partnership to which this cmdlet applies. This name is case-sensitive.

156



Parameter: NewPartnerName <string>

Specifies a new name for the group to which replication will be performed from a PS Seriesgroup. This name is case-sensitive. This parameter should only be used if the replicationpartner's group name has changed.


Parameter: PartnerIPAddress <string>

Changes the IP Address used to connect to the group to which replication will done. Thisaddress can be IPv4 or IPv6.

Required?:falsePosition?: namedDefault value?:Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: InboundCredential <System.Management.Automation.PSCredential>

Changes the password using a PSCredential object containing the new password (16alphanumeric characters maximum) for access by the PS Series group specified as the value forthe PartnerName parameter. The InboundPassword parameter can be used instead of theInboundCredential parameter.


Parameter: InboundPassword <string>

Changes the password (16 alphanumeric characters maximum) for access by the PS Series groupspecified as the value for the PartnerName parameter. The InboundCredential parameter canbe used instead of the InboundPassword parameter.


Parameter: PartnerDescription <string>

157


Changes the description for the replication partnership. If the description contains spaces,surround it with quotation marks.


Parameter: ContactName <string>

Changes the contact name for the replication site.


Parameter: ContactEmailAddress <string>

Changes the email address for the contact at the replication site.


Parameter: ContactPhone <string>

Changes the phone number for the contact at the replication site.


Parameter: ContactMobile <string>

Changes the mobile phone number for the contact at the replication site.


Parameter: OutboundCredential <System.Management.Automation.PSCredential>

Changes the password using a PSCredential object containing the new password (16alphanumeric characters maximum) for access to the PS Series group specified as the value forthe PartnerName parameter. The OutboundPassword parameter can be used instead of theOutboundCredential parameter.

158



Parameter: OutboundPassword <string>

Changes the password (16 alphanumeric characters maximum) for access to the PS Series groupspecified as the value for the PartnerNameparameter. The OutboundCredential parameter canbe used instead of the OutboundPassword parameter.


Parameter: DelegatedSpaceMB <uint>

Changes the number of MB set aside on the outbound group for inbound replication from thereplication site.


Parameter: ReplicationStatus <string>

Changes whether the replication partnership is enabled for use when it is created. Enter(e)nabled to enable replication, or enter (d)isabled to disable replication.



Specifies that the cmdlet should return an EQL_PARTNER_SPEC object for the changed replicationpartnership on successful completion.


Example

This command will change the replication partnership between GroupB and the group to which aconnection exists in the current PowerShell runspace. The inbound password used forauthentication for access by GroupB will be changed to password3. The space delegated for

159


storing partner replica sets will be increased to 20GB. Since the PassThru parameter isspecified, it will also list all of the values (except for passwords) in the EQL_PARTNER_SPECobject for the partnership with the new values for changes made. For values that apply to bothsides of the partnership, execute the Set-EqlReplicationPartner cmdlet on the partner group tokeep them synchronized.

C:\PS>Set-EqlReplicationPartner -PartnerName GroupB -InboundPassword password3-DelegatedSpaceMB 20000 -PassThru

Related Commands





Remove-EqlReplicationPartner cmdletBreaks the relationship between a PS Series group and its replication partner.

Command SyntaxRemove-EqlReplicationPartner [-GroupName <string>] [-GroupAddress <string>]-PartnerName <string> [-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Remove-EqlReplicationPartner cmdlet deletes a replication partnership between a PSSeries group to which a connection exists in the current PowerShell runspace and anotherspecified PS Series group. If you are connected to more than one group, you can specify thetarget group using either the GroupName or GroupAddress parameter. This cmdlet will display aprompt to the console to confirm the deletion. The -Force parameter can be used to suppress thisprompt for scripts.

Inputs

None.

Outputs



160








Specifies the name of the group with which a replication partnership exists to identify thepartnership to which this cmdlet applies. This name is case-sensitive.



Specifies that the cmdlet should bypass the confirmation prompt and delete the partnership.


Example

Example 1

This command will prompt for confirmation and delete the replication partnership betweenGroupB and the group to which a connection exists in the current PowerShell runspace.

C:\PS>Remove-EqlReplicationPartner -PartnerName GroupB

161


Example 2

This command will delete the replication partnership between GroupB and the group to which aconnection exists in the current PowerShell runspace without prompting for confirmation.

C:\PS>Remove-EqlReplicationPartner -PartnerName GroupB -Force

Related Commands





New-EqlReplicaSet cmdletConfigures replication of a volume to a replication site.

Command SyntaxNew-EqlReplicaSet [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -ReplicationSite <string> [-PartnerReservePercent <uint>][-LocalReservePercent <uint>] [-BorrowLocalFreeSpace <string>][-KeepLocalFailback <string>] [-CreateReplica [<SwitchParameter>]][-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The New-EqlReplicaSet cmdlet configures replication of a volume on a PS Series group towhich a connection exists in the current PowerShell runspace to a specified replication site. Ifyou are connected to more than one group, you can specify the target group using either theGroupName or GroupAddress parameter. The volume and replication site are specified by name.Use the New-EqlReplicationPartner cmdlet to configure the partnership with the replicationsite before using this cmdlet.

Inputs

None.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action , or anInterop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC object if the PassThru parameter is present.


162










Parameter: ReplicationSite <string>

Specifies the name of a PS Group that identifies the replication partner to which this cmdletapplies. This name is case-sensitive.


Parameter: PartnerReservePercent <uint>

Specifies the portion of delegated space allocated for storing the replica set specified as apercent of the replica volume reserve. The minimum value is 105 percent.

Required?:falsePosition?: namedDefault value?: 200Accept pipeline input?: trueAccept wildcard characters?: false

Parameter: LocalReservePercent <uint>

163


Specifies the local replication reserve, which is used during replication and optionally for storingthe failback snapshot. It is specified as a percent of the volume reserve. The minimum value is 5percent.


Parameter: BorrowLocalFreeSpace <string>

Specifies whether to temporarily use free pool space if the local reserve space is insufficient.Enter (e)nabled to allow the temporary use of local free space, enter (d)isabled to prevent it.


Parameter: KeepLocalFailback <string>

Specifies whether a failback snapshot is kept in the local replication reserve. Enter (e)nabled tokeep a failback snapshot, enter (d)isabled to not keep a local failback snapshot.


Parameter: CreateReplica [<SwitchParameter>]

Specifies that the cmdlet should launch creation of the initial replica after the replica set isconfigured.



Specifies that the cmdlet should return an EQL_REPLICA_SET_SPEC object for the new replica seton successful completion.


164


Examples

Example 1

This command configures replication of MyVolume to PSGroupB, enables the option to keep alocal failback snapshot, and sets the local reserve space to 100 percent of volume reserve.

C:\PS>New-EqlReplicaSet -VolumeName MyVolume -ReplicationSite PSGroupB-KeepLocalFailback enabled -LocalReservePercent 100

Example 2

This command configures replication of MyVolume to PSGroupB and launches creation of theinitial replica.

C:\PS>New-EqlReplicaSet -VolumeName MyVolume -ReplicationSite PSGroupB-CreateReplica

Related Commands


• New-EqlReplica cmdlet

• Set-EqlReplicaSet cmdlet

• Get-EqlReplicaSet cmdlet

• Remove-EqlReplicaSet cmdlet

• Suspend-EqlReplication cmdlet

• Resume-EqlReplication cmdlet

• ConvertTo-EqlPromotedReplicaSet cmdlet

• ConvertTo-EqlDemotedReplicaSet cmdlet

Get-EqlReplicaSet cmdletRetrieves information for a replica set for a volume on the specified replication site.

Command SyntaxGet-EqlReplicaSet [-GroupName <string>] [-GroupAddress <string>][-VolumeName <string>] [-ReplicationSite <string>] [<CommonParameters>]

Command Description

The Get-EqlReplicaSet cmdlet retrieves information for a replica set identified by volumename and replication partner name on a PS Series group to which a connection exists. If you are

165


connected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. If volume name and replication partner name are not specified, itretrieves information for all of the outbound replica sets for the PS Series group.

Inputs

None.

Outputs

Returns a collection of PSObjects for an Interop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC. Theoutput of the Get-EqlReplicaSet cmdlet can be piped to other cmdlets, such asSet-EqlReplicaSet.








Specifies the name of a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This name is case-sensitive. If this parameter is specified, the ReplicationSiteparameter must also be specified.



166


Specifies the name of a PS Series group that identifies the replication partner to which thiscmdlet applies. This name is case-sensitive. If this parameter is specified, the VolumeNameparameter must also be specified.


Examples

Example 1

This command retrieves the configuration of all of the replica sets on this group.

C:\PS>Get-EqlReplicaSet

Sample output of the above cmdlet is as follows:volumeName : MyVolumeReplicationSite : PSGroupBPartnerReservePercent : 200LocalReservePercent : 100BorrowLocalFreeSpace : enabledKeepLocalFailback : disabledReplicaCount : 2AdminStatus : enabled

Example 2

This command retrieves the configuration of the replica set of MyVolume from PSGroupB.

C:\PS>Get-EqlReplicaSet -VolumeName MyVolume -ReplicationSite PSGroupB

Related Commands



• New-EqlReplicaSet cmdlet







• Get-EqlInboundReplicaSet cmdlet

167


Set-EqlReplicaSet cmdletChanges settings for a replica set of a volume on the specified replication site.

Command SyntaxSet-EqlReplicaSet [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -ReplicationSite <string> [-PartnerReservePercent <uint>][-LocalReservePercent <uint>] [-BorrowLocalFreeSpace <string>][-KeepLocalFailback <string>] [-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Set-EqlReplicaSet cmdlet changes settings for a replica set identified by volume name andreplication site on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter.

Inputs

None.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC object if the PassThru parameter is present.







168







Specifies the name of a PS Series group that identifies the replication site to which this cmdletapplies. This name is case-sensitive.


Parameter: PartnerReservePercent <uint>

Changes the portion of delegated space allocated for storing the replica set specified as apercent of the replica volume reserve. The minimum value is 105 percent.


Parameter: LocalReservePercent <uint>

Changes the local replication reserve which is used during replication and optionally for storingthe failback snapshot. It is specified as a percent of the volume reserve. The minimum value is 5percent.


Parameter: BorrowLocalFreeSpace <string>

Changes whether to temporarily use free pool space if the local reserve space is insufficient.Enter (e)nabled to allow the temporary use of local free space, or enter (d)isabled to prevent it.

Required?:falsePosition?: namedDefault value?: enabled

169



Parameter: KeepLocalFailback <string>

Changes whether a failback snapshot is kept in the local replication reserve. Enter (e)nabled tokeep a failback snapshot, or enter (d)isabled if you do not want to keep a local failback snapshot.

Required?:falsePosition?: namedDefault value?: disabledAccept pipeline input?: trueAccept wildcard characters?: false


Specifies that the cmdlet should return an EQL_REPLICA_SET_SPEC object for the changed replicaset on successful completion.

Required?:falsePosition?: namedDefault value?: falseAccept pipeline input?: falseAccept wildcard characters?: false

Example

This command enables the option to keep a local failback snapshot and changes the local reservespace to 100 percent of volume reserve when replicating MyVolume to PSGroupB.

C:\PS>Set-EqlReplicaSet -VolumeName MyVolume -ReplicationSite PSGroupB-KeepLocalFailback enabled -LocalReservePercent 100

Related Commands









Remove-EqlReplicaSet cmdletDeletes the replica set for a volume on the specified replication site.

170


Command SyntaxRemove-EqlReplicaSet [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -ReplicationSite <string> [-Force] [<CommonParameters>]

Command Description

The Remove-EqlReplicaSet cmdlet deletes a replica set on a PS Series group to which aconnection exists that was created for the volume identified by name on the specified replicationsite. If you are connected to more than one group, you can specify the target group using eitherthe GroupName or GroupAddress parameter. Replication of the volume to the replication site isdisabled by the deletion of the replica set.

Inputs

None.

Outputs










171




Specifies the name of a PS Series group that identifies the replication site to which this cmdletapplies. This name is case-sensitive.



Specifies that the cmdlet should bypass the confirmation prompt and delete the replica set.


Example

This command displays a prompt requesting confirmation, and if the user confirms the action, itremoves the replica set of MyVolume from PSGroupB.

C:\PS>Remove-EqlReplicaSet -VolumeName MyVolume -ReplicationSite PSGroupB

Related Commands







Replication Management cmdletsThese cmdlets are used to manage replication of volumes to specific replication sites. Thereplications of the volumes must be previously configured using the Replication Configurationcmdlets.

172


New-EqlReplica cmdletCreates a replica of the specified volume on a PS Series group.

Command SyntaxNew-EqlReplica [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -ReplicationSite <string>[-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The New-EqlReplica cmdlet creates a replica of a volume identified by name on a PS Seriesgroup. If you are connected to more than one group, you can specify the target group using eitherthe GroupName or GroupAddress parameter. The volume must be configured for replication. Usethe New-ReplicationPartner cmdlet to create a replication partnership between this group andanother group. Use the New-ReplicaSet cmdlet to configure a specific volume for replication toa replication partner. Additional actions can be performed on the newly created replica usingreplica cmdlets.

Inputs

None.

Outputs







Required?: false

173




Specifies the name of a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This name is case-sensitive. The volume must be configured for replication.Replication is a time-consuming process and the replica will not be available for useimmediately after the cmdlet completes.












Specifies the name of a PS Series group that has been configured as the replication partner forthe specified volume.

Required?: true

174




Specifies that the cmdlet should return an EQL_REPLICA_SPEC object for the new replica onsuccessful completion.


Example

This command creates a replica of MyVolume on MyPartnerGroup.

C:\PS>New-EqlReplica -VolumeName MyVolume -ReplicationSite MyPartnerGroup

Related Commands












Get-EqlReplica cmdletRetrieves a list of replicas for a specified volume.

SyntaxGet-EqlReplica [-GroupName <string>] [-GroupAddress <string>] -VolumeName <string>-ReplicationSite <string> [-ReplicaName <string>] [<CommonParameters>]

175


Command Description

The Get-EqlReplica cmdlet retrieves information for the replicas available in a replica setidentified by volume name and replication site on a PS Series group to which a connectionexists. The ReplicaName value for a replica can be used for the ReplicaName parameter of theRemove-EqlReplica cmdlet to identify which replica to delete. The AdminStatus value for areplica can be used to determine whether other actions can be performed on the replica.

Inputs

None.

Outputs

An Interop.EqlPsaMgmtAPI.EQL_REPLICA_SPEC object or a string.

Returns an array of PSObjects containing the information for the replicas in the specified replicaset or a string indicating that no replicas were found.





Specifies the IP address of a PS Series group for which a session was created from thisPowerShell runspace. This parameter can be either IPv4 or IPv6. Either this parameter or theGroupName parameter can be used to identify a group for this cmdlet. The cmdlet will execute onthe specified group.



Specifies the name of a volume on a PS Series group that is used with the ReplicationSiteparameter to identify the replica set that contains the replicas to which this cmdlet applies. Thisname is case-sensitive.

176




Specifies the name of a PS Series group that is used with the VolumeName parameter to identifythe replica set that contains the replicas to which this cmdlet applies. This name is case-sensitive.


Parameter: ReplicaName <string>

Specifies the name of a replica on a PS Series group that identifies the replica to which thiscmdlet applies. This name is case-sensitive.


Example 1

This command returns the information for all of the replicas in the replica set for MyVolume onPSGroupB.

C:\PS>Get-EqlReplica -VolumeName MyVolume -ReplicationSite PSGroupB | format-list

The following is sample output for the four replicas in the specified replica set:

VolumeName : MyVolumeReplicationSite : PSGroupBReplicaName : MyVolume.1-2010-06-21-08:24:36.27164AdminStatus : replica_completed




177


Related Commands







• Get-EqlInboundReplica cmdlet


Remove-EqlReplica cmdletDeletes a replica from a replica set.

SyntaxRemove-EqlReplica [-GroupName <string>] [-GroupAddress <string>][-VolumeName <string>] -ReplicationSite <string> -ReplicaName <string>[-SelectOldest [<SwitchParameter>]] [-Force [<SwitchParameter>]][<CommonParameters>]

Command Description

The Remove-EqlReplica cmdlet deletes a replica identified by name from a replica set identifiedby volume name and replication site on a PS Series group to which a connection exists.

Inputs

None.

Outputs



178








Specifies the name of a volume on a PS Series group that is used with the ReplicationSiteparameter to identify the replica set that contains the replica to which this cmdlet applies. Thisname is case-sensitive.



Specifies the name of a PS Series group that is used with the VolumeName parameter to identifythe replica set that contains the replica to which this cmdlet applies. This name is case-sensitive.



Specifies the name of a replica in a replicaset on a PS Series group that identifies the replica towhich this cmdlet applies. This name is case-sensitive.

Required?: true, unsless SelectOldest is specified.Position?: namedDefault value?: noneAccept pipeline input?: true

179




Specifies that the cmdlet should bypass the confirmation prompt and delete the replica.


Parameter: SelectOldest [<SwitchParameter>]

Specifies that the cmdlet should select the oldest replica in the replica set for removal. If thisparameter is specified, the ReplicaName parameter must not be used.


Example

This command prompts for confirmation and if the user confirms the action, removes the replicaMyVolume.1-2011-01-01-00:00:00.100 from the replicaset for MyVolume on PSGroupB.

C:\PS>Remove-EqlReplica -VolumeName MyVolume -ReplicationSite PSGroupB-ReplicaName MyVolume.1-2011-01-01-00:00:00.100

Related Commands






Suspend-EqlReplication cmdletSuspends replication of a volume to the specified replication partner. UseResume-EqlReplication to resume replication of the suspended replica set.

Command SyntaxSuspend-EqlReplication [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -ReplicationSite <string> [<CommonParameters>]

180


Command Description

The Suspend-EqlReplication cmdlet suspends replication of a volume identified by name froma PS Series group to which a connection exists in the current PowerShell runspace to thespecified replication site. If you are connected to more than one group, you can specify thetarget group using either the GroupName or GroupAddress parameter.

Inputs

None.

Outputs












181


Specifies the name of a PS Series group that identifies the replication partner to which thiscmdlet applies. This name is case-sensitive.


Example

This command suspends replication of MyVolume to PSGroupB.

C:\PS>Suspend-EqlReplication -VolumeName MyVolume -ReplicationSite PSGroupB

Related Commands









Resume-EqlReplication cmdletResumes replication of a volume to the specified replication site.

Command SyntaxResume-EqlReplication [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> -ReplicationSite <string> [<CommonParameters>]

Command Description

The Resume-EqlReplication cmdlet resumes replication of a volume identified by name from aPS Series group to which a connection exists in the current PowerShell runspace to the specifiedreplication site. If you are connected to more than one group, you can specify the target groupusing either the GroupName or GroupAddress parameter.

Inputs

None.

182


Outputs














Example

This command resumes replication of MyVolume to PSGroupB.

183


C:\PS>Resume-EqlReplication -VolumeName MyVolume -ReplicationSite PSGroupB

Related Commands









ConvertTo-EqlPromotedReplicaSet cmdletPromotes a replica set to a volume.

Command SyntaxConvertTo-EqlPromotedReplicaSet [-GroupName <string>] [-GroupAddress <string>]-ReplicaSetName <string> -SourceSite <string> [<CommonParameters>]

Command Description

The ConvertTo-EqlPromotedReplicaSet cmdlet promotes a replica set on a PS Series group towhich a connection exists in the current PowerShell runspace to a volume. If you are connectedto more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. The group to which the connection exists must be the group to whichthe original volume is replicated. The source site parameter is the name of the PS Series groupwhere the original volume is located.

Inputs

None.

Outputs



184







Parameter: ReplicaSetName <string>

Specifies the name of a replica set on the PS Series group to which a connection exists in thisPowerShell runspace that identifies the replica set to which this cmdlet applies. This name iscase-sensitive.


Parameter: SourceSite <string>



Example

This command promotes a replica set created from MyVolume on PSGroupB to a volume wheninvoked on the replication partner of PSGroupB.

C:\PS>ConvertTo-EqlPromotedReplicaSet -VolumeName MyVolume -FromSite PSGroupB

Related Commands


185







ConvertTo-EqlDemotedReplicaSet cmdletDemotes a promoted replica set to a normal replica set.

Command SyntaxConvertTo-EqlDemotedReplicaSet [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [<CommonParameters>]

Command Description

The ConvertTo-EqlDemotedReplicaSet cmdlet demotes a promoted replica set for a volume to anormal replica set. If you are connected to more than one group, you can specify the target groupusing either the GroupName or GroupAddress parameter. The converted volume is identified byname, and should reside on a PS Series group to which a connection exists in the currentPowerShell runspace.

Inputs

None.

Outputs






186





Specifies the name of a volume on a PS Series group that identifies the volume to which thiscmdlet applies. This name is case-sensitive and is for a volume that is a promoted replica set.


Example

This command demotes a promoted replica set named MyVolume to a normal replica set.MyVolume must reside on a PS Series group to which a connection exists in the currentPowerShell runspace.

C:\PS>ConvertTo-EqlDemotedReplicaSet -VolumeName MyVolume

Related Commands







Get-EqlInboundReplica cmdletRetrieves a list of replicas for a specified inbound replica set.

Command SyntaxGet-EqlInboundReplica [-GroupName <string>] [-GroupAddress <string>]-ReplicaSetName <string> [-ReplicaName <string>] [<CommonParameters>]

187


Command Description

This cmdlet retrieves information for the replicas available in an inbound replica set identifiedby replica set name on a PS Series group to which a connection exists.

Inputs

None.

Outputs

Interop.EqlPsaMgmtAPI.EQL_INBOUND_REPLICA_SPEC or string

Returns an array of PSObjects containing the information for the replicas in the specified replicaset or a string indicating that no replicas were found.








Specifies the name of an inbound replica set on a PS Series group that identifies the replica setcontaining the replicas to which this cmdlet applies. This name is case-sensitive.



188


Specifies the name of an inbound replica on a PS Series group that identifies the replica to whichthis cmdlet applies. This name is case-sensitive.


Example

This command returns the information for all of the replicas in the inbound replica setMyVolume.3.

C:\PS>Get-EqlInboundReplica -ReplicaSetName MyVolume.3 | format-list

The following is sample output for the four replicas in the specified inbound replica set:ReplicaSetName : MyVolume.3VolumeName : MyVolumeReplicationSite : GroupBReplicaName : MyVolume.3 -2010-04-13-12:54:58.5

ReplicaSetName : MyVolume.3VolumeName : MyVolumeReplicationSite : GroupBReplicaName : MyVolume.3 -2010-04-13-13:00:04.6



Related Commands



• Get-EqlReplica cmdlet





Get-EqlInboundReplicaSet cmdletRetrieves information for a specified replica set or all replica sets replicated from another group.

189


Command SyntaxGet-EqlInboundReplicaSet [-GroupName <string>] [-GroupAddress <string>][-ReplicaSetName <string>] [<CommonParameters>]

Command Description

This cmdlet retrieves information for a replica set identified by name on a PS Series group towhich a connection exists. If a name is not specified, it retrieves information for all of theinbound replica sets for the PS Series group.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_INBOUND_REPLICA_SET_SPEC

Returns a PSObject for an Interop.EqlPsaMgmtAPI.EQL_INBOUND_REPLICA_SET_SPEC. Theoutput of the Get-EqlInboundReplicaSet cmdlet can be piped to other cmdlets such as the Get-EqlInboundReplica cmdlet.








Specifies the name of an inbound replica set on a PS Series group that identifies the replica setcontaining the replicas to which this cmdlet applies. This name is case-sensitive.

190



Example

This command retrieves the following configuration information for the replica set ofMyVolume.2 on the current PS Series group:

C:\PS>Get-EqlInboundReplicaSet -ReplicaSetName MyVolume.2

The following is sample output for the above command:ReplicaSetName : MyVolume.2ReplicationSite : PSGroupBReplicaCount : 4

Related Commands


• Get-EqlInboundReplica cmdlet










191

9 Schedule Cmdlets

These cmdlets are used for managing schedules for creating snapshots and replicas of volumes.

New-EqlSchedule cmdletCreates a schedule for taking snapshots or replicas of the specified volume.

Command SyntaxNew-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -ScheduleName <string> [-ScheduleType <string>][-ReplicationSite <string>] [-StartDate {DateTime}] [-StartTime {DateTime}][-EndDate {DateTime}] [-EndTime {DateTime}] [-OnlineStatus <string>][-AccessType <string>] [-ScheduleStatus <string>] [-KeepCount <string>][-TimeFrequency <string>] [-PassThru [<SwitchParameter>]] [<CommonParameters>]

Command Description

The New-EqlSchedule cmdlet creates a schedule for taking snapshots or replicas of a volume.The volume is identified by name, and must reside on a PS Series group to which a connectionexists in the current PowerShell runspace. If you are connected to more than one group, you canspecify the target group using either the GroupName or GroupAddress parameter. If a replicationsite is specified, the schedule creates replicas. Otherwise, it creates snapshots. Use theSet-EqlSchedule cmdlet to change or set any of the optional parameters that were not set atcreation time.

InputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

The output of Get-EqlSchedule for any volume can be piped to New-EqlSchedule to copy theschedule parameters from one volume to another.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC object if the PassThru parameter is present.



193

PowerShell Tools Reference Guide 9 Schedule Cmdlets
















Required?: false

194


Position?: namedDefault value?: falseAccept pipeline input?: falseAccept wildcard characters?: false

Parameter: ScheduleName <string>

Specifies the name to use when referring to the schedule. This name must be unique for thevolume and is case-sensitive.


Parameter: ScheduleType <string>

Specifies the type of schedule to create. Enter (o)nce to create a schedule that runs once,(h)ourly or (d)aily to create a recurring schedule.

Required?: falsePosition?: namedDefault value?: onceAccept pipeline input?: trueAccept wildcard characters?: false


Specifies the name of the replication partner for the schedule to use to create replicas for thenamed volume. If a replication partner is not specified, then the schedule creates snapshots. Thereplication partnership must be configured on this group and the volume must be configured forreplication to that partner. Otherwise, this cmdlet will fail.


Parameter: StartDate {DateTime}

Specifies the date that the schedule will start running.


Parameter: StartTime {DateTime}

Specifies the time of day that the schedule will start running.


195



Parameter: EndDate {DateTime}

Specifies the date that the schedule will stop running.


Parameter: EndTime {DateTime}

Specifies the time of day that the schedule will stop running.



Specifies whether the snapshot that is created by the schedule will be online or offline. Enter(on)line or $true to set it online or (off)line or $false to set it offline.



Specifies whether the snapshot that is created by the schedule will be read-only or read-write.


Parameter: ScheduleStatus <string>

Specifies whether the schedule is created in an enabled or disabled state. Enter (e)nabled tocreate an enabled schedule or (d)isabled to create a disabled schedule.


Parameter: KeepCount <string>

196


Specifies the maximum number of snapshots or replicas created by this schedule that should bekept on the PS Group before the deletion policy is applied.


Parameter: TimeFrequency <string>

Specifies the number of minutes between runs in the time interval during which the schedule isconfigured to run. For example, enter 60 to run the schedule every hour.



Specifies that the cmdlet should return an EQL_SCHEDULE_SPEC object for the new schedule onsuccessful completion.


Examples

Example 1

This command creates a schedule for creating read-write, offline snapshots of MyVolume everyday starting on 6/1/2010 every 15 minutes between 6 PM and 11 PM.

C:\PS>New-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule -ScheduleTypedaily -StartDate 6/1/2010 -StartTime 6:00PM -EndTime 11:00PM -TimeFrequency 15-AccessType read_write -OnlineStatus offline

Example 2

This command creates a schedule for creating read-only, offline replicas of MyVolume onPSGroup2 every day starting on 6/1/2010 between 6 PM and 11 PM. This schedule will not rununtil it is enabled.

C:\PS>New-EqlSchedule -VolumeName MyVolume -ScheduleName MyReplicaSchedule-ScheduleType hourly -ReplicationSite PSGroup2 -StartDate 6/1/2010 -StartTime6:00P M -EndTime 11:00PM -AccessType read_only -OnlineStatus offline-ScheduleStatus disabled

197


Related Commands





• Set-EqlSchedule cmdlet

• Get-EqlSchedule cmdlet

• Remove-EqlSchedule cmdlet

Get-EqlSchedule cmdletRetrieves information for one or more schedules for the specified volume.

Command SyntaxGet-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-ScheduleName <string>] [<CommonParameters>]

Command Description

The Get-EqlSchedule cmdlet retrieves the specified schedule for a volume identified by nameon a PS Series group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter. If a schedule name is not specified, the information for all schedulesfor the specified volume is retrieved. The information retrieved by this command can be pipedinto the New-EqlSchedule command to copy the schedule parameters from one volume toanother.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

You can pipe objects from Get-EqlSchedule to other cmdlets, such as New-EqlSchedule orRemove-EqlSchedule. Pipe the objects through format-list to filter out parameters that you do notwant to set.

198

















199






Specifies the name of the schedule of the specified volume to which this cmdlet applies. Thisname is case-sensitive.


Examples

Example 1

This command gets information for all schedules for MyVolume.

C:\PS>Get-EqlSchedule -VolumeName MyVolume

Example 2

This command gets the information for MySchedule.

C:\PS>Get-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule

Sample output is as follows:ScheduleName : MyScheduleVolumeName : MyVolumeScheduleStatus : enabledScheduleType : hourlyStartDate : 06/21/10StartTime :EndDate :EndTime :RepeatFactor : 1TimeFrequency : 60KeepCount : 10AccessType : read_writeOnlineStatus : offlineReplicationSite :

Related Commands


200




• New-EqlSchedule cmdlet


Set-EqlSchedule cmdletChanges the schedule of the specified volume.

Command SyntaxSet-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] -ScheduleName <string> [-NewScheduleName <string>][-ScheduleType <string>] [-ReplicationSite [<string>]] [-StartDate <DateTime>][-StartTime <DateTime>] [-EndDate <DateTime>] [-EndTime <DateTime>][-OnlineStatus <string>] [-AccessType <string>] [-ScheduleStatus <string>][-KeepCount <string>] [-TimeFrequency <string>] [-PassThru [<SwitchParameter>]][<CommonParameters>]

Command Description

The Set-EqlSchedule cmdlet changes settings for a schedule of a volume identified by name ona PS Series group to which a connection exists in the current PowerShell runspace. If you areconnected to more than one group, you can specify the target group using either the GroupName orGroupAddress parameter.

InputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

The output of Get-EqlSchedule for any volume can be piped to Set-EqlSchedule to copy theschedule parameters from one volume to another.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action, or anInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC object if the PassThru parameter is present.



201

















Required?: false

202


Position?: namedDefault value?: falseAccept pipeline input?: falseAccept wildcard characters?: false


Specifies the name of the schedule for the specified volume to which this cmdlet applies. Thisname is case-sensitive.


Parameter: NewScheduleName <string>

Changes the name of the schedule for the specified volume. This name must be unique for thevolume and is case-sensitive.


Parameter: ScheduleType <string>

Changes the type of schedule. Enter (o)nce for a schedule that runs once; (h)ourly or (d)aily fora recurring schedule.

Required?: falsePosition?: namedDefault value?: onceAccept pipeline input?: trueAccept wildcard characters?: false

Parameter: ReplicationSite [<string>]

Changes the name of the replication partner for the schedule to create replicas of the namedvolume. If a replication site is not specified, then the schedule creates snapshots. If replicationof the specified volume to the named site is not configured, this cmdlet will fail.


Parameter: StartDate <DateTime>

Changes the date that the schedule will start running.


203



Parameter: StartTime <DateTime>

Changes the time of day that the schedule will start running.


Parameter: EndDate <DateTime>

Changes the date that the schedule will stop running.


Parameter: EndTime <DateTime>

Changes the time of day that the schedule will stop running.



Changes whether snapshots created by the schedule are online or offline. Enter (on)line or $trueto set it online or (off)line or $false to set it offline.



Changes whether the snapshots created by the schedule are created with read_only or read_write access.


Parameter: ScheduleStatus <string>

204


Changes whether the schedule is in an enabled or disabled state. Enter (e)nabled to enable theschedule or (d)isabled to disable the schedule.


Parameter: KeepCount <string>

Changes the maximum number of snapshots or replicas created by this schedule that should bekept on the group before the deletion policy is applied.


Parameter: TimeFrequency <string>

Changes the number of minutes between runs in the time interval during which the schedule isconfigured to run. For example, enter 60 to run the schedule every hour.

Required?: falsePosition?: namedDefault value?: 5false Accept pipeline input? trueAccept wildcard characters?: false


Specifies that the cmdlet should return an EQL_SCHEDULE_SPEC object for the changed scheduleon successful completion.

Required?: falsePosition?: namedDefault value?:false Accept pipeline input? falseAccept wildcard characters?: false

Examples

Example 1

This command changes MySchedule to run between 5:00 AM and 3:00 PM.

C:\PS>Set-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule -StartTime5:00AM -EndTime 3:00pm

Example 2

This command changes MySchedule to create read-only snapshots of MyVolume that are onlineand enables the schedule.

205


C:\PS>Set-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule-OnlineStatus online -AccessType read_only -ScheduleStatus enabled

Related Commands







• Remove-EqlSchedule cmdlet

Remove-EqlSchedule cmdletRemoves one or more of the schedules for the specified volume.

Command SyntaxRemove-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]-VolumeName <string> [-MemberIndex <uint>] [-VolumeIndex <uint>][-UseIndex [<SwitchParameter>]] [-ScheduleName <string>] [<CommonParameters>]

Command Description

The Remove-EqlSchedule cmdlet deletes the schedule with the specified name from a volumeidentified by name on a PS Series group to which a connection exists in the current PowerShellrunspace. If you are connected to more than one group, you can specify the target group usingeither the GroupName or GroupAddress parameter. If a schedule name is not specified, allschedules are removed from the volume. Use the Get-EqlSchedule cmdlet to get the name foreach of the schedules for a volume.

Inputs

None.

Outputs



206

















207





Specifies the name of the schedule of the specified volume to which this cmdlet applies. Thisname is case-sensitive.


Examples

Example 1

This command deletes all of the schedules for the volume named MyVolume.

C:\PS>Remove-EqlSchedule -VolumeName MyVolume

Example 2

This command deletes the schedule named MySchedule from the volume named MyVolume.

C:\PS>Remove-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule

Related Commands







208

Contacting DellDell provides several online and telephone-based support and service options. Availability variesby country and product, and some services might not be available in your area.

For customers in the United States, call 800-945-3355.

Note: If you do not have access to an Internet connection, contact information is printedon your invoice, packing slip, bill, or Dell product catalog.

Use the following procedure to contact Dell for sales, technical support, or customer serviceissues:

1. Visit support.dell.com or the Dell support URL specified in information provided with theDell product.

2. Select your locale. Use the locale menu or click on the link that specifies your country orregion.

3. Select the required service. Click the “Contact Us” link, or select the Dell support servicefrom the list of services provided.

4. Choose your preferred method of contacting Dell support, such as e-mail or telephone.

Online ServicesYou can learn about Dell products and services using the following procedure:

1. Visit www.dell.com (or the URL specified in any Dell product information).

2. Use the locale menu or click on the link that specifies your country or region.

209

http://support.dell.com/

http://www.dell.com/

110-6098-En-R2 HIT Power Shell Tools Reference Guide V4.0 Web

Documents

Transcript of 110-6098-En-R2 HIT Power Shell Tools Reference Guide V4.0 Web