PowerShellModule_UserGuide

PowerShell ToolsUser Guide

Version 3.5

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 respective

owners.

Information in this document is subject to change without notice.

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

January 2011

Part Number: 110-6065-EN-R3

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 3

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 10

4 Group Administration cmdlets 13

Group Configuration cmdlets 13

Get-EqlGroupID cmdlet 13

Get-EqlGroupDefaults cmdlet 14

Set-EqlGroupDefaults cmdlet 16

Get-EqlGroupConfiguration cmdlet 19

Set-EqlGroupConfiguration cmdlet 21

Get-EqlMember cmdlet 28

Set-EqlMember cmdlet 29

Get-EqlNetInterface cmdlet 32

Set-EqlNetInterface cmdlet 34

Pool Configuration cmdlets 37

New-EqlPool cmdlet 37

Get-EqlPool cmdlet 39

Set-EqlPool cmdlet 41

iii

PowerShell Tools User Guide Contents

Merge-EqlPool cmdlet 43

Remove-EqlPool cmdlet 45

Local CHAP Account cmdlets 47

New-EqlChapUser cmdlet 47

Get-EqlChapUser cmdlet 49

Set-EqlChapUser cmdlet 51

Remove-EqlChapUser cmdlet 53

5 Volume Administration Cmdlets 55

Basic cmdlets 55

New-EqlVolume cmdlet 55

Get-EqlVolume cmdlet 61

Set-EqlVolume cmdlet 65

Remove-EqlVolume cmdlet 71

New-EqlVolumeACL cmdlet 74

Get-EqlVolumeACL cmdlet 78

Remove-EqlVolumeACL cmdlet 80

Advanced Volume Administration cmdlets 83

New-EqlVolumeClone cmdlet 83

ConvertTo-EqlTemplateVolume cmdlet 86

ConvertFrom-EqlTemplateVolume cmdlet 89

New-EqlThinClone cmdlet 91

ConvertFrom-EqlThinClone cmdlet 93

New-EqlReplica cmdlet 95

6 Snapshot Cmdlets 99

New-EqlSnapshot cmdlet 99

Get-EqlSnapshot cmdlet 103

Set-EqlSnapshot cmdlet 106

Restore-EqlSnapshot cmdlet 110

iv

PowerShell Tools User Guide Contents

Remove-EqlSnapshot cmdlet 112

New-EqlSnapshotClone cmdlet 115

7 Replication Cmdlets 119

Replication Configuration cmdlets 119

New-EqlReplicationPartner cmdlet 119

Get-EqlReplicationPartner cmdlet 123

Set-EqlReplicationPartner cmdlet 125

Remove-EqlReplicationPartner cmdlet 130

New-EqlReplicaSet cmdlet 131

Get-EqlReplicaSet cmdlet 135

Set-EqlReplicaSet cmdlet 137

Remove-EqlReplicaSet cmdlet 140

Replication Management cmdlets 142

Suspend-EqlReplication cmdlet 142

Resume-EqlReplication cmdlet 144

ConvertTo-EqlPromotedReplicaSet cmdlet 146

ConvertTo-EqlDemotedReplicaSet cmdlet 147

8 Schedule Cmdlets 151

New-EqlSchedule cmdlet 151

Get-EqlSchedule cmdlet 156

Set-EqlSchedule cmdlet 158

Remove-EqlSchedule cmdlet 164

v

PrefaceThis guide provides installation and usage information about the PowerShell Tools.

AudienceThe PowerShell Tools documentation is designed for administrators responsible for managing a

PS Series group. Administrators are not required to have extensive network or storage system

experience. However, it is helpful to understand:

• Windows PowerShell 2.0 cmdlet usage and scripting.

• Windows, Windows cluster, and Windows Server operating environment administration.

• iSCSI initiator operation

• Basic networking concepts

• Current network environment

• Application disk storage requirements

In addition, administrators may find it useful to understand the basic concepts for:

• Network topologies

• RAID configurations

• Disk storage management

Note: Although the PowerShell Tools documentation provides examples of using PSSeries storage arrays in some common network configurations, detailed information about

setting up a network is beyond its scope.

OrganizationThe organization of this guide is as follows:

Chapter 1, Introduction to the PowerShell Tools— provides an overview of the types of

PowerShell cmdlets available, and general information regarding inputs, outputs, and common

parameters.

Chapter 2, Installation— describes how to install the PowerShell interface.

Chapter 3, Session cmdlets— describes cmdlets that deal with creating or terminating a

session to a PS Series group.

Chapter 4, Group Administration cmdlets— describes cmdlets that configure groups, pools,

and local CHAP accounts.

Chapter 5, Volume Administration Cmdlets— describes cmdlets that manage volumes in a

PS Series group.

vii

PowerShell Tools User Guide Preface

Chapter 6, Snapshot Cmdlets— describes cmdlets that help you create, delete, and manage

snapshots.

Chapter 7, Replication Cmdlets— describes cmdlets that help you configure and manage

replication replication between two groups.

Chapter 8, Schedule Cmdlets— describes all the cmdlets that deal with creating and

modifying schedules for taking snapshots and replicas of a volume.

PowerShell Tools DocumentationDocumentation for the PowerShell Tools for Microsoft® Windows® systems is available.

Dell provides the following user information for the PowerShell Tools:

• Release Notes. This guide is available in PDF format for printing or display using a PDF

viewer.

• PowerShell Tools User Guide. This guide is available in PDF format for printing or display

using a PDF viewer.

• Online Help. This help follows the standard PowerShell conventions for console output for

specific commands, using the PowerShell Get-Help cmdlet or the -? parameter to get help

for any PowerShell Tools cmdlet. Enter Get-Command -Module EqlPSTools to get a list of

all the cmdlets.

Overview of EqualLogic SoftwareThank you for your interest in EqualLogic™ PS Series storage products. We hope you will find

them intuitive and simple to configure and manage.

PS Series arrays optimize resources by automating performance and network load balancing.

Additionally, PS Series arrays offer all-inclusive array management software, host software, and

free firmware updates. The features and products described next are available at no additional

cost.

PS Series Software• Firmware - Installed on each array, PS Series firmware allows you to manage your storage

environment and provides capabilities such as volume snapshots, cloning, and replication to

ensure data hosted on the arrays is protected in the event of an error or disaster.

– Group Manager GUI: Provides a graphical user interface for managing a group.

– Group Manager CLI: Provides a command line interface for managing a group.

• Manual Transfer Utility (MTU) – Runs on Windows and Linux systems and enables you to

use physical media to securely transfer large amounts of data to a replication partner,

facilitating replication and preventing network congestion.

Host Software for Windows• Host Integration Tools:

viii


– Remote Setup Wizard (RSW): Initializes new PS Series arrays, configures host

connections to PS Series groups, and configures and manages multipathing.

– Multipath I/O Device Specific Module (MPIO DSM): Includes a connection

awareness-module that understands PS Series network load balancing and facilitates

host connections to PS Series volumes.

– VSS and VDS Provider Services: Allows 3rd party backup software vendors to perform

off-host backups.

– Auto-Snapshot Manager/Microsoft Edition (ASM/ME): ASM/ME is a VSS requesting

application that uses PS Series snapshots, cloning, and replication to provide

point-in-time protection of critical data for supported applications, including SQL Server,

Exchange Server, Hyper-V, and NTFS file shares.

• SAN HeadQuarters (SANHQ): Provides centralized monitoring, historical performance

trending, and event reporting for multiple PS Series groups.

Host Software for VMware• Storage Adapter for Site Recovery Manager (SRM): Allows SRM to understand and

recognize PS Series replication for full SRM integration.

• Auto-Snapshot Manager/VMware Edition (ASM/VE): Integrates with VMware Virtual

Center and PS Series snapshots to allow administrators to enable Smart Copy protection of

Virtual Center folders, datastores, and virtual machines.

• Multipathing Extension Module (MEM) for VMware ESX: Provides enhancements to

existing VMware multipathing functionality.

Current Customers Please Note: You may not be running the latest versions of the tools and

software listed above. If you are under a valid warranty or support agreement for your PS Series

array, you are entitled to obtain the latest updates and new releases as they become available.

Related DocumentationFor detailed information about PS Series arrays, groups, volumes, array software, and host

software, see the following documentation:

ix


Technical Support and Customer ServiceDell's support service is available to answer your questions about PS Series SAN arrays. If you

have an Express Service Code, have it ready when you call. The code helps Dell's

automated-support telephone system direct your call more efficiently.

Contacting Dell

Dell provides several online and telephone-based support and service options. Availability varies

by 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 printed on

your invoice, packing slip, bill, or Dell product catalog.

x


Use the following procedure to contact Dell for sales, technical support, or customer service

issues:

1. Visit support.dell.com or the Dell support URL specified in information provided with the

Dell product.

2. Select your locale. Use the locale menu or click on the link that specifies your country or

region.

3. Select the required service. Click the "Contact Us" link, or select the Dell support service

from the list of services provided.

4. Choose your preferred method of contacting Dell support, such as e-mail or telephone.

Online Services

You 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.

xi

1 Introduction to the PowerShell Tools

The PowerShell Tools provide a powerful, comprehensive set of PowerShell cmdlets for

managing 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 Windows

platforms (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 following

categories:

• Session cmdlets — A session is a connection to a PS Series group. The session cmdlets

create or terminate a session to a group. A connection to a group is required to use cmdlets

in any of the other categories.

• Group administration cmdlets — The Group Administration cmdlets are divided into the

following subcategories:

– Group Configuration: These cmdlets allow you to perform operations such as retrieving

or changing group default settings, and changing configuration settings for an array that

belongs to a group.

– Pool Configuration: These cmdlets allow you to perform operations such as creating a

new 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 adding

or removing a CHAP user to a group, changing a password, and retrieving all the CHAP

usernames for a PS Series group.

• Volume administration cmdlets — Volume Administration cmdlets help manage the volumes

in 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 on

a PS Series group, managing access control lists (ACLs) for a volume and its snapshots,

retrieving or changing configuration information for volumes on a group, or deleting a

volume and all its snapshots, schedules and access control lists (ACLs) from a group.

– Advanced: These cmdlets allow you to perform operations such as creating a replica or

clone of a volume, converting a volume to a template volume, creating a thin clone from

a template volume, converting a template volume to a regular volume, or detaching a thin

clone volume from its template volume.

• Snapshot management cmdlets — The Snapshot Management cmdlets allow you to perform

operations such as creating a new snapshot, deleting a snapshot, retrieving or changing

settings for a snapshot, restoring a volume from a snapshot, and cloning a snapshot.

1

PowerShell Tools User Guide 1 Introduction to the PowerShell Tools

Snapshots created by the PowerShell Tools are crash consistent, and not application

consistent. To create application consistent snapshots, use the Auto-Snapshot Manager-

Microsoft Edition (ASM/ME) console or the ASM CLI. The ASM CLI is a set of commands

that you can execute at the Windows command prompt instead of using the ASM/ME GUI

for Smart Copy operations. See the Auto-Snapshot Manager User Guide for moreinformation.

• Replication cmdlets — The Replication cmdlets are divided into the following

subcategories:

– Replication Configuration: These cmdlets allow you to perform operations such as

setting up replication between two PS Series groups, retrieving or changing the definition

of a replication partnership between two groups, canceling a replication partnership

between two groups, configuring replication of a volume to a replication site, retrieving

or changing settings for a replica set of a volume, and deleting a replica set for a

volume.

– Replication Management: These cmdlets allow you to perform operations such as

suspending or resuming replication of a volume, promoting a replica set to a volume, and

demoting a replica set to a normal replica set.

• Schedule cmdlets — The Schedule cmdlets allow you to perform operations such as creating

or removing a schedule for taking snapshots or replicas of a specified volume, and changing

or 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 is

listed within the angle brackets) should be used. For example,

<string> means that a character string should be used in the cmdlet

syntax and <int> means that an integer should be used.

[parameter]Brackets indicate that the parameter within them is an optional

parameter.

> 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.

For each parameter, the following five properties are listed:

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

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

parameters are used.

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

• Whether or not the parameter accepts pipeline input.

2


• Whether or not the parameter accepts wildcard characters. Currently, no parameters accept

wildcard characters.

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 values

can be piped to cmdlets from other sources, such as an XML file that uses parameter names for

element names. A specific object from a cmdlet can be fed as an input to another cmdlet. For

example, the output of the Get-VolumeACL cmdlet (an Interop.EqlPsaMgmtAPI.EQL_ACL_SPEC

object) 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 acknowledging

the successful completion of the cmdlet. Cmdlets with the new and set verbs will return an

object if PassThru parameter is specified. If PassThru is not specified, a string acknowledging

the successful completion of the cmdlet will be returned. The get cmdlets return an object for a

specific item. For example, Get-Volume will return an EQL_VOLUME_SPEC for a volume specified

by name. If a name is not specified, Get-Volume will return a collection of objects of the

appropriate type to which the connected user has access. Regardless of the cmdlet, all names

used to identify objects on a PS Series group are case-sensitive and must be unique.

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 an

array has a lot of volumes, or if cmdlets are being executed in a loop, specifying these

parameters provides an efficient way to uniquely identify volumes. The values for these

parameters can be obtained for one or more volumes by executing the Get-EqlVolume cmdlet

and piping them to other cmdlets, such as New-EqlSnapshot or 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, and New-EqlReplica.

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. For

3


more information, type get-help about_commonparameters. For further documentation on these

parameters, see the Microsoft Windows PoweShell documentation.

Getting Help on the PowerShell cmdletsThe PowerShell Tools allow you to get help for using the cmdlets in the same way that you get

help for standard PowerShell operations. You can get a complete list of cmdlets, or you can get

help 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 PowerShell

Get-Help cmdlet and specify the cmdlet name, such as New-EqlSnapshot, followed by the

parameter-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 components

included in the installation kit.

Requirements for Using the PowerShell Interface• PowerShell 2.0 is required.

Note: To verify the PowerShell version you are using, you can launch a Windows

command prompt and enter powershell host. You can also launch the PowerShell

console and enter host.

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

supported Windows operating systems.

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

versions 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 existing

administrative account (you can reuse the same password) on the PS Series group. This only

needs 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 User 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 HIT

PowerShell Tools to launch the PowerShell 2.0 console and automatically load the

EqlPSTools 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, operable

program, 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 and

execute 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 the

cmdlets.

6

3 Session cmdlets

You must be connected to a PS Series Group to execute any of the cmdlets that require access to

a PS Series group. You can use the Connect-EqlGroup and Disconnect-EqlGroup cmdlets to

manage 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 the GroupName and GroupAddress parameters. If those parameters are not

specified, the cmdlet will execute on the current group and not the group on which you want the

cmdlets to execute. The current 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 PS

Series group and makes it the current group. The group must be specified by its IP address. The

administrator name and password must be specified using either the -Credential parameter or

the Username and Password parameters. Any subsequent cmdlets in the current PowerShell

runspace will perform actions on this group until the Disconnect-EqlGroup cmdlet is executed

for this group, or until Connect-EqlGroup is used to connect to another group, or a group is

specified for the cmdlet using either the GroupName or GroupAddress parameter.

Note: Using the same administration account username with different passwords toconnect to more than one group is not supported. For example, if you are connected to one

group as an administrative user, and then try to connect to another group using the same

username but a different password, the connection to the second group will fail with error

-29421. To work around this issue, connect to the second group with a different

administrative username or reset the password to be the same as on the first group. To

change the account credentials, connect to the group using the Group Manager and click

on the Administration tab.

Inputs

None. You cannot pipe objects to Connect-EqlGroup.

7

PowerShell Tools User Guide 3 Session cmdlets

Outputs

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

string 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 name

and password. This parameter can be either IPv4 or IPv6.

Required?: true

Position?: named

Default value?: none

Accept pipeline input?: true

Accept wildcard characters?: false

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

Specifies a PSCredential object containing the name and password of an administrative user

with access to the specified PS Series group. Refer to the PowerShell documentation for

PSCredential for alternative methods for initializing the PSCredential object. The Password and

Username parameters can be used instead of the Credential parameter.

Required?: true, unless Username and Password are specified.

Position?: named


Accept pipeline input?: false


Parameter: Username <string>

Specifies the name 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?: named




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.


Position?: named




Parameter: SMTPTimeoutSeconds <uint>

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

8


Required?: false

Position?: named

Default value?: 60



Parameter: SMTPRetryAttempts <uint>

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

Required?: false

Position?: named

Default value?: 1



Notes

Under some circumstances, especially the first time, you may get the following error when

trying to connect to a PS Series Group:

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

This error can be cause 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 runnning the minimum required firmware revision

4.2 or later.

4. Reset the admin account password using the Group Manager to force the reinitialization and

clear 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 a

username and password, and create a session to the PS Series group using 10.100.100.10. All

subsequent 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 has

access to the group and mypassword is valid. All subsequent cmdlets in the current PowerShell

runspace will execute on the specified group.

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

mypassword

9


Related Commands

• Disconnect-EqlGroup cmdlet

Disconnect-EqlGroup cmdletTerminates the session to a PS Series group to which a connection exists in the current

PowerShell runspace.

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

[<CommonParameters>]

Command Description

The Disconnect-EqlGroup cmdlet terminates a session to a PS Series group to which a

connection exists in the current PowerShell runspace identified by the group name or its IP

address. If you are connected to more than one group, you can specify the target group using

either the GroupName or GroupAddress parameter. Any subsequent cmdlets will fail unless a

connection to another group exists, or until the 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 PowerShell

runspace. The GroupAddress parameter can be used instead of the GroupName parameter.

Required?: true, unless GroupAddress is specified

Position?: named




Parameter: GroupAddress <string>

Specifies the IP address of a PS Series group for which a session was created from this

PowerShell runspace. This parameter can be either IPv4 or IPv6. If this parameter is used, the

GroupName parameter is not necessary.

10


Required?: true, unless GroupAddress is specified

Position?: named




Examples

Example 1

This command will terminate the session to MyGroup. All subsequent cmdlets will fail until a

new connection is created.

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. All

subsequent 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 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 a

connection exists in the current PowerShell runspace. If you are connected to more than one

group, 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 GroupName parameter can be used to identify a group for this

cmdlet.

Required?: false

Position?: named





13

PowerShell Tools User Guide 4 Group Administration cmdlets

Specifies the IP address of a PS Series group for which a session was exists in this PowerShell

runspace. This parameter can be either IPv4 or IPv6. Either this parameter or the GroupName

parameter can be used to identify a Group for this cmdlet.

Required?: false

Position?: named




Example

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

current PowerShell runspace.

C:\PS>Get-EqlGroupID

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 Series

group to which a connection exists in the current PowerShell runspace. If you are connected to

more than one group, you can specify the target group using either the GroupName or

GroupAddress parameter. These defaults include snapshot reserve percent, snapshot warning

percent, snapshot space recovery policy, thin provisioning warning percent, thin provisioning set

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 specified when

the New-Volume cmdlet is executed.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_PSGROUP_DEFAULT_SPEC

14


You can pipe objects from Get-EqlGroupDefaults to other cmdlets, such as

Set-EqlGroupDefaults. Pipe the objects through format-list to filter out parameters that you do

not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Examples

Example 1

This command will return the default values used for the PS Series group to which a connection

exists in the current PowerShell runspace.

C:\PS>Get-EqlGroupDefaults

When you execute the Get-GroupDefaults cmdlet, the names of the defaults and their values

are output to the console. See the following for sample output:

UseVolumeNameForiSCSIAlias : yes

ISCSITargetNamePrefix : iqn.2001-05.com.mycompany

ThinProvisionWarningPercent : 60

ThinProvisionMaxGrowPercent : 100

SnapshotDeletionPolicy : delete_oldest

SnapshotReservePercent : 100

SnapshotReserveWarnPercent : 90

Example 2

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

15


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

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 Series



GroupAddress parameter. These defaults include snapshot reserve percent, snapshot warning

percent, snapshot space recovery policy, thin provisioning warning perecent, thin provisioning

set 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 specified

when 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 to

copy the defaults from one group to another. Pipe the objects through format-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 an

Interop.EqlPsaMgmtAPI.EQL_PSGROUP_DEFAULT_SPEC object if the PassThru parameter is

present.


16




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Parameter: SnapshotReservePercent <uint>

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

Required?: false

Position?: named

Default value?:



Parameter: UseVolumeNameForiSCSIAlias <string>

Changes whether to use the volume name as the default iSCSI alias. Enter (y)es to use the

volume name or (n)o to not create a default iSCSI alias.

Required?: false

Position?: named

Default value?:



Parameter: ISCSITargetNamePrefix [<string>]

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

Required?:true

Position?: named

Default value?:



Parameter: SnapshotReserveWarnPercent <uint>

Changes the default percent for the snapshot reserve that can be used before a low space

warning is issued.

17


Required?: false

Position?: named

Default value?:



Parameter: SnapshotDeletionPolicy <string>

Changes the default policy to apply when the snapshot reserve is insufficient to create snapshots

of the volume. Enter (m)ake_volume_offline, (d)elete_oldest, or (s)top_snapshots for the policy.

Required?: false

Position?: named

Default value?:



Parameter: ThinProvisionWarningPercent <uint>

Changes the default percent of the requested volume size that can be used before a warning is

issued. This only applies to thin provisioned volumes.

Required?: false

Position?: named

Default value?:



Parameter: ThinProvisionMaxGrowPercent <uint>

Changes the default percent of the requested volume size to which the volume can grow, before

the total size of the volume must be increased if it is thin provisioned.

Required?: false

Position?: named

Default value?:



Parameter: PassThru [<SwitchParameter>]

Specifies that the cmdlet should return an EQL_PSGROUP_DEFAULT_SPEC object for the changed

defaults on successful completion.

Required?: false

Position?: named

Default value?: false



Examples

Example 1

This command will change the threshhold for thin provisioning warning events to 80 percent and

the maximum grow percent to 95 percent for the group to which a connection exists in the

18


current 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 -GroupName

GroupB

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 PS

Series group to which a connection exists in the current PowerShell runspace. If you are

connected to more than one group, you can specify the target group using either the GroupName or

GroupAddress parameter.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_PSGROUP_SPEC

You can pipe objects from Get-EqlGroupConfiguration to other cmdlets, such as

Set-EqlGroupConfiguration. Pipe the objects through format-list to filter out parameters that

you do not want to use.


19




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Examples

Example 1

This command will return the current configuration settings for the PS Series group to which a

connection exists in the current PowerShell runspace.

C:\PS>Get-EqlGroupConfiguration

When you execute the Get-EqlGroupConfiguration cmdlet, the names of the settings and their

values is output to the console. See the following for sample output:groupName : GroupB

groupAddress : 10.100.100.5

ClientAccessSSH : enabled

ClientAccessTelnet : enabled

WebAccess : enabled

WebAccessNoEncrypt : enabled

ConnectionBalancing : enabled

PerformanceBalancing : enabled

GroupDate : 11/14/10

GroupTime : 06:34:06

GroupTimeZone : VAL_eqlGroupTimeZone_america_New_York

GroupDescription : This is the database group for North America

UseCHAPForDiscovery : disabled

EmailHomeContact :

SMTPServers : 10.100.100.1;10.100.100.2:80

EmailSender : [email protected]

EmailSenderDomain : myCompany.com

EmailSenderName : emailSender

EmailRecipientList :

[email protected];[email protected]

EmailNotification : disabled

FTPService : enabled

UseLocalChapForIscsi : enabled

GroupLocation : default

MembershipPassword : ****************

20


SyslogNotification : disabled

NTPServers : 10.100.100.3:123;10.100.100.4

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>]

[-MembershipPassword [<string>]] [-SyslogNotification <string>]


Command Description

The Set-EqlGroupConfiguration cmdlet modifies the current configuration settings for a PS




Inputs

None.

Outputs

string or Interop.EqlPsaMgmtAPI.EQL_PSGROUP_SPEC

21


You can pipe objects from Get-EqlGroupConfiguration to Set-EqlGroupConfiguration if you

want to copy the settings from one group to another. Pipe the objects through format-list to filter

out parameters that you do not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Parameter: ClientAccessSSH <string>

Changes whether the SSH service on the group is enabled or disabled. Enter (e)nabled to enable

the service and allow SSH access to the group and its member arrays or (d)isabled to disable the

service.

Required?: false

Position?: named

Default value?: enabled



Parameter: ClientAccessTelnet <string>

Changes whether the Telnet service on the group is enabled or disabled. Enter (e)nabled to

enable the service and allow Telnet access to the group and its member arrays or (d)isabled to

disable the service.

Required?: false

Position?: named




Parameter: WebAccess <string>

22


Changes whether the use of standard HTTP Web connections (through port 80) to the Group

Manager GUI is enabled or disabled. Enter (e)nabled to enable the standard HTTP Web

connections to the Group Manager GUI, or(d)isabled to disable standard HTTP Web

connections.

Required?:false

Position?: named




Parameter: WebAccessNoEncrypt <string>

Changes whether the SSL encryption is required for access on the standard HTTP Web

connection to the Group Mnager GUI. Enter (e)nabled to require SSL encryption, or enter

(d)isabled so that SSL encryption is not required.

Required?: false

Position?: named

Default value?: disabled



Parameter: ConnectionBalancing <string>

Changes whether iSCSI connection load balancing across group members is enabled or disabled.

Enter (e)nabled to enable iSCSI connection load balancing or (d)isabled to disable it.

Required?: false

Position?: named




Parameter: PerformanceBalancing <string>

Changes whether performance load balancing based on optimal RAID level for a volume is

enabled or disabled. Enter (e)nabled to enable performance load balancing or (d)isabled to

disable it.

Required?: false

Position?: named




Parameter: GroupDescription <string>

Changes the description of the group (up to a maximum of 63 characters). Enter the parameter

without a value to remove a group description. If the description contains spaces, surround it

with quotation marks.

Required?: false

Position?: named

23


Default value?:



Parameter: UseCHAPForDiscovery <string>

Changes whether the requirement for iSCSI initiators trying to discover targets to provide CHAP

credentials is enabled or disabled. Enter (e)nabled to require the use of CHAP for discovery or

(d)isabled to disable the requirement.

Required?: false

Position?: named




Parameter: EmailHomeContact [<string>]

Changes the local IP Address used as a destination for sending notifications of firmware updates

and hardware failures. If an address is specified, the E-Mail Home feature is enabled to send

the notifications to Dell Customer Support. An SMTP server IP Address must also be specified

using the SMTPServer parameter. Optionally, a sender IP address can be specified using the

EmailSender parameter.

Required?: false

Position?: named

Default value?:



Parameter: SMTPServers <string>

Changes the IP Addresses and optional port numbers in the list of SMTP Servers used for e-mail

messages with event notifications from the group. A maximum of three SMTP Servers can be

specified in order of preference in this semicolon delimited list. SMTPServers can be IPv4 or

IPv6 for the Set-EqlGroupConfiguration cmdlet.

Required?: false

Position?: named

Default value?:



Parameter: NTPServers <string>

Changes the IP Addresses and optional port numbers in the list of Network Time Protocol

Servers used for setting a consistent time on all group members. A maximum of three NTP

Servers can be specified in order of preference in this semicolon delimited list. NTPServers can

be IPv4 or IPv6 for the Set-EqlGroupConfiguration cmdlet.

Required?: false

24


Position?: named

Default value?:



Parameter: EmailSender <string>

Changes the email address used as the sender of notification email messages. An SMTP server

IP 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 the

EmailRecipientList parameter.

Required?: false

Position?: named

Default value?:



Parameter: EmailRecipientList <string>

Changes the email addresses used as the destination of e-mail messages with event notifications

from the group. An SMTP server IP Address must also be specified using the SMTPServer

parameter. Optionally, a sender email address can be specified using the EmailSender

parameter.

Required?: false

Position?: named

Default value?:



Parameter: EmailNotification <string>

Changes whether e-mail notification of events is enabled or disabled for the group. Enter

(e)nabled to send e-mail notification of events or (d)isabled to disable e-mail notification of

events.

Required?: false

Position?: named




Parameter: FTPService <string>

Changes whether the FTP server running on the group is enabled or disabled. Enter (e)nabled to

enable the FTP server or (d)isabled to prevent FTP file transfers to and from the group.

Required?: false

Position?: named




Parameter: SendInfoMessages <string>

25


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.

Required?: false

Position?: named




Parameter: UseLocalChapForIscsi <string>

Changes whether local CHAP accounts are used to authenticate iSCSI initiator access to

volumes and snapshots. Enter (e)nabled to use local CHAP or (d)isabled to use external

RADIUS authentication servers.

Required?: false

Position?: named




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."

Required?: false

Position?: named

Default value?:



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

Changes the password required for adding members to the PS Series group to the password

contained in a PSCredential object. The password must be between 3 and 16 alphanumeric

characters 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?: true, unless MembershipPassword is specified.

Position?: named

Default value?:



Parameter: MembershipPassword <string>

Changes the password required for adding members to a group. The password must be between

3 and 16 alphanumeric characters and is case-sensitive. The Credential parameter can be used

instead of the MembershipPassword parameter.


Position?: named

Default value?:


26



Parameter: SyslogNotification <string>

Changes whether event logging to remote syslog servers is enabled. Enter (e)nabled remote

event logging or (d)isabled to disable it. To use syslog notification, you must also specify IP

addresses for the syslog servers using the Group Manager.

Required?: false

Position?: named





Specifies that the cmdlet should return an EQL_PSGROUP_SPEC object for the new volume on

successful completion.

Required?: false

Position?: named




Examples

Example 1

This command will enable informational messages to be sent to the Group Manager connected to

the PS Series group to which a connection exists in the current PowerShell runspace. The

command will use [email protected] as the sender for any email notifications sent

by the group. Since the PassThru parameter is specified, it will also list all of the values (except

for passwords) in the EQL_PSGROUP_SPEC object for the group reflecting the state after the

command executes.

C:\PS>Set-EqlGroupConfiguration -SendInfoMessages yes -EmailSender

[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

27


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

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

[-MemberName <string>] [<CommonParameters>]

Command Description

The Get-EqlMember cmdlet retrieves the current configuration settings for a specified array that

is a member of a PS Series group to which a connection exists in the current PowerShell

runspace. If a member name is not specified, this cmdlet retrieves configuration settings for all

members of the array. If you are connected to more than one group, you can specify the target

group using either the GroupName or GroupAddress parameter.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC

You can pipe objects from Get-EqlMember to other cmdlets, such as Set-EqlMember. Pipe the

objects through format-list to filter out parameters that you do not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named

28





Parameter: MemberName <string>

Specifies the name of a member of a PS Series group that identifies the member to which this

cmdlet applies. This name is case-sensitive.

Required?: false

Position?: named




Examples

Example 1

This command retrieves the configuration information for Member1 in a PSObject that contains

the 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 configuration

settings and their values is output to the console. Sample output is as follows:MemberName : Member1

MemberDescription : This is a member configured for RAID5

FirmwareVersion : Storage Array Firmware V5.0.2 (R138185)

StoragePoolName : default

RaidType : raid5

Example 2

This command retrieves the configuration information for all members of a group in a PSObject

collection that contains the values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_SPEC.

C:\PS>Get-EqlGroupMember

Related Commands


• Set-EqlMember cmdlet

• Remove-EqlMember 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.

29

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



Command SyntaxSet-EqlMember [-GroupName <string>] [-GroupAddress <string>]

-MemberName <string> [-NewMemberName <string>]

[-MemberDescription <string>] [-StoragePoolName <string>]

[-RaidType <string>] [-DefaultGateway <string>]


Command Description

The Set-EqlMember cmdlet modifies the current configuration settings for an array that is a

member of a PS Series group to which a connection exists in the current PowerShell runspace. If

you are connected to more than one group, you can specify the target group using either the

GroupName or GroupAddress parameter. Use the Set-EqlNetInterface cmdlet to configure the

network interfaces for a member.

Inputs

None.

Outputs

If the PassThru parameter is not specified, a string acknowledging the successful completion of

the cmdlet action is returned.

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

You can pipe objects from Set-EqlMember to other Set-EqlMember cmdlets. Pipe the objects

through format-list to filter out parameters that you do not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

30


Position?: named




Parameter: MemberName <string>

Specifies the name of a member of a PS Series group that identifies the member to which this


Required?: true

Position?: named

Default value?:



Parameter: NewMemberName <string>

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

Required?: false

Position?: named

Default value?:



Parameter: MemberDescription <string>

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

Required?:false

Position?: named

Default value?:



Parameter: StoragePoolName <string>

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

Required?: false

Position?: named

Default value?:



Parameter: RaidType <string>

Changes the RAID configuration of the member. The type is specified using one of the following

values: raid5, raid5_nospares, raid6, raid6_nospares, raid6_accelerated, raid10, raid10_

nospares, raid50, raid50_nospares. Not all RAID types are valid for every RAID type.

Specifying an unavailable RAID type will cause this command to fail. Refer to the technical

documentation 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:

31


• RAID10 to RAID50, RAID6, or RAID5

• RAID50 to RAID6 or RAID5

• RAID6 to RAID5

RAID6-Accelerated cannot be converted to any other type.

Required?: false

Position?: named

Default value?:



Parameter: DefaultGateway <string>

Changes the IPv4 Address used for the default gateway and applies it to all of the configured

interfaces on the member except the management network interface. Specify the parameter

without a value to delete the default gateway.

Required?: false

Position?: named

Default value?:




Specifies that the cmdlet should return an EQL_MEMBER_SPEC object for the group member

on successful completion.

Required?: false

Position?: named




Example

This command changes the name of the storage pool in which the member is located and causes

the member to be moved to the specified pool.

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

Related Commands


• Get-EqlMember cmdlet

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

32


Command SyntaxGet-EqlNetworkInterface [-MemberName <string>] [-InterfaceName <string>]


Command Description

The Get-EqlNetInterface cmdlet retrieves the specified network interface for a specified array

that is a member of a PS Series group to which a connection exists in the current PowerShell

runspace. If a network interface name is not specified, this cmdlet returns all of the network

interfaces for the specified member array.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE

You can pipe objects from Get-EqlNetInterface to other cmdlets, such as

Set-EqlNetInterface. Pipe the objects through format-list to filter out parameters that you do

not want to use.

Command ParametersParameter: MemberName <string>

Specifies the name of a member of a PS Series Array Group that identifies the member to which

this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named

Default value?:



Parameter: InterfaceName <string>

Specifies the name of a network interface for a member of a PS Series group that identifies the

network interface to which this cmdlet applies. This name is case-sensitive.

Required?: false

Position?: named

Default value?:



33


Examples

Example 1

This command retrieves the configuration information for eth0 to Member1 in a PSObject that

contains the values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_

INTERFACE.

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

Sample output is as follows:MemberName : Member1

InterfaceName : eth0

Description : eth0 description

IpAddress : 10.100.100.6

SubnetMask : 255.255.0.0

Status : up

UseForManagementOnly : disabled

SupportsManagement : yes

Example 2

This command retrieves the configuration information for all of the network interfaces to the

specified member of a group in a PSObject collection that contains the values from an

Interop.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 -MemberName <string> -InterfaceName <string>

[-Description [<string>]] [-IPAddress <string>] [-SubnetMask [<string>]]


Command Description

The Set-EqlNetInterface cmdlet changes the specified network interface for a specified array

that is a member of a PS Series group to which a connection exists in the current PowerShell

34




runspace.

Note: Management network IP addresses are IPv4 only and use the highest number port

available on an array (eth2 or eth3, depending on the array type). Other than the

management port, the other interface ports can be either IPv4 or IPv6.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE

You can pipe objects from Set-EqlNetInterface to other cmdlets, such as

Set-EqlNetInterface. Pipe the objects through format-list to filter out parameters that you do

not want to use.

Command ParametersParameter: MemberName <string>

Specifies the name of a member of a PS Series Array Group that identifies the member to which

this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named

Default value?:



Parameter: InterfaceName <string>

Specifies the name of a network interface for a member of a PS Series group that identifies the

network interface to which this cmdlet applies. This name is case-sensitive.

Required?: false

Position?: named

Default value?:



Parameter: Description [<string>]

Changes the description (up to a maximum of 127 alphanumeric characters) of the network

interface. If the description contains spaces, surround it with quotes. Enter the parameter with an

empty string ("") to delete the description.

Required?: false

Position?: named

Default value?:



35


Parameter: IPAddress <string>

Changes the IP Address for the network interface to the member. Enter the parameter with an

empty string ("") to remove the IP Address.

Required?: false

Position?: named

Default value?:



Parameter: SubnetMask <string>

Changes the subnet mask for the network interface to the member. Can only be used if the

IPAddress is IPv4. Enter the parameter with an empty string ("") to remove the subnet mask.

Required?: false

Position?: named

Default value?:




Specifies that the cmdlet should return an EQL_MEMBER_NETWORK_INTERFACE object

for the group member on successful completion.

Required?: false

Position?: named




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 -IPAddress

10.100.100.5

Example 2

This command clears the description of eth1 to Member1 outputs a PSObject that contains the

values from an Interop.EqlPsaMgmtAPI.EQL_MEMBER_NETWORK_INTERFACE for

Member1.

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

-PassThru

Related Commands


36


• Get-EqlNetInterface cmdlet


Pool Configuration cmdletsThe pool configuration cmdlets allow you to manage the pools defined for a group or to define

new pools. You will need to use the Set-EqlMember cmdlet to add storage capacity for a pool.

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 to

which a connection exists in the current PowerShell runspace. If you are connected to more than

one group, you can specify the target group using either the GroupName or GroupAddress

parameter. Use the Set-EqlMember cmdlet to add arrays to a pool.

Inputs

None. You cannot pipe objects to New-EqlPool.

Outputs

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




cmdlet.

Required?: false

Position?: named





37





Required?: false

Position?: named





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.

Required?: true

Position?: named




Parameter: PoolDescription <string>

Specifies the description (up to a maximum of 127 characters) for a pool on a PS Series group. If

the description contains spaces, surround it with quotes.

Required?: false

Position?: named




Example

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

space to the pool.

C:\PS>New-EqlPool -StoragePoolName PoolB

Related Commands


• Set-EqlPool cmdlet

• Get-EqlPool cmdlet

• Merge-EqlPool cmdlet

• Remove-EqlPool cmdlet


38


Get-EqlPool cmdletRetrieves identifying and status info for a named pool or for every pool in a PS Series group.

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

[-StoragePoolName <string>] [<CommonParameters>]

Command Description

The Get-EqlPool cmdlet retrieves the identifying and status information for a pool, specified by

the pool name, on a PS Series group to which a connection exists in the current PowerShell

runspace. If you are connected to more than one group, you can specify the target group using

either the GroupName or GroupAddress parameter. If a pool name is not specified, data is

returned for every pool in the group. The StoragePoolName in the output of this command can be

used 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 PSObjects

containing the identifying information and statistics for the named pool or all pools in the group.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named


39





Specifies the name of a pool on a PS Series group. If this parameter is not specified, the cmdlet

will get information for all pools on the group.

Required?: false

Position?: named




Examples

Example 1

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

PoolB.

C:\PS>Get-EqlPool -StoragePoolName PoolB

When you execute the Get-EqlPool cmdlet for PoolB, a list of PoolB's statistics and their values

is output to the console. Sample output is as follows:

StoragePoolName : PoolB

OnlineMemberCount : 2

InUseMemberCount : 2

TotalSpaceMB : 5191500

FreeSpaceMB : 477675

UsedSpaceMB : 2480730

ThinProvisionFreeSpaceMB : 4776750

ISCSIConnectionCount : 90

VolumeSubscribedMB : 4003575

VolumeAllocatedMB : 2276130

VolumeCount : 97

OnlineVolumeCount : 84

InUseVolumeCount : 22

SnapshotReservedMB : 1617690

SnapshotReservedAvailableMB : 1609050

SnapshotSpaceUsedMB : 8640

SnapshotCount : 55

OnlineSnapshotCount : 2

InUseSnapshotCount : 0

Example 2

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

every pool in the current group.

C:\PS>Get-EqlPool

40


Related Commands


• New-EqlVolume cmdlet

• Set-EqlVolume cmdlet


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>]]


Command Description

The Set-EqlPool cmdlet changes the name and description of pool specified by name on a PS




Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_POOL_SPEC

This command outputs an array of PSObjects containing the identifying information and statistics

for the named pool or all pools in the group.




cmdlet.

Required?: false

Position?: named



41







Required?: false

Position?: named





Specifies the name of a pool on a PS Series group that identifies the pool to which this cmdlet

applies. This name is case-sensitive.

Required?: false

Position?: named

Default value?:



Parameter: NewStoragePoolName <string>

Specifies a new name (63 characters maximum) for a 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.

Required?: false

Position?: named

Default value?:



Parameter: PoolDescription [<string>]

Changes the description (127 characters maximum) for a pool on a PS Series group. If the

description contains spaces, surround it with quotes. Enter the parameter name without a value

to delete a description.

Required?:false

Position?: named

Default value?:



Example

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

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

42


Related Commands


• New-EqlPool cmdlet




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

deletes the source pool.

Command SyntaxMerge-EqlPool [-GroupName <string>] [-GroupAddress <string>]

-StoragePoolName <string> -DestinationPool <string>

[-Force [<SwitchParameter>]] [<CommonParameters>]

Command Description

The Merge-EqlPool cmdlet moves the members and volumes from a source pool specified by

name on a PS Series group to which a connection exists in the current PowerShell runspace, to

another 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. The

source pool is deleted after the merge is completed. This cmdlet will display a prompt to the

console to confirm the merge. The -Force parameter can be used to suppress this prompt for

scripts. The default pool cannot be specified as the source pool.

Inputs

None. You cannot pipe objects to Merge-EqlPool.

Outputs





cmdlet.

43


Required?: false

Position?: named








Required?: false

Position?: named






applies. This name is case-sensitive. The default pool cannot be specified for this parameter.

Required?: true

Position?: named




Parameter: DestinationPool <string>

Specifies the name of the destination pool on a PS Series group that identifies the pool to which

the source pool will be merged. This name is case sensitive.

Required?: true

Position?: named




Parameter: Force [<SwitchParameter>]

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

Required?: false

Position?: named




44


Examples

Example 1

This command will display a confirmation prompt to the console, merge the members and

volumes from PoolB to PoolA if confirmed, and delete PoolB.

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

Example 2

This command will merge member arrays and volumes from PoolB to PoolA and delete PoolB. It

will not prompt for confirmation because -Force is specified.

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

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 which

a connection exists in the current PowerShell runspace. If you are connected to more than one


The array members in the pool are immediately moved to the default pool. Deletion of the

default pool is not permitted. This cmdlet will display a prompt to the console to confirm the

deletion. The -Force parameter can be used to suppress this prompt for scripts.

Inputs

None. You cannot pipe objects to Get-EqlPool.

45


Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named






applies. This name is case-sensitive. Deletion of the default pool is not permitted.

Required?: true

Position?: named

Default value?:




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

Required?: false

Position?: named




46


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 will

not prompt for confirmation because -Force is specified.

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

Related Commands






Local CHAP Account cmdletsThese cmdlets are used to manage the local CHAP user accounts for a group. These accounts

can be used to create volume ACLs for hosts to establish connections to volumes and snapshots

requiring 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 which

a connection exists in the current PowerShell runspace. If you are connected to more than one


47


The CHAP user can be specified using either the Credential parameter or the Username and

Password parameters. Use the Get-EqlChapUser cmdlet to list user names for all existing local

CHAP accounts defined for the group.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




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

Specifies a local CHAP user name (63 characters maximum) and valid password (3-16

alphanumeric characters) in a PSCredential object for the local CHAP user. The username and

password are case-sensitive. The Username and Password parameters can be used instead of

the Credential parameter.

Required?: true, unless Username and Password are specified.

Position?: named





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

48



Position?: named





Specifies a valid password (3-16 alphanumeric characters) for the local CHAP user. The

Credential parameter can be used instead of the Password parameter.


Position?: named

Default value?:

Accept pipeline input?:


Examples

Example 1

This command adds a local CHAP user with the username and password from the PSCredential

object 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 the

local 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>]


49


Command Description

The Get-EqlChapUser cmdlet retrieves the usernames of the local CHAP accounts for a PS



GroupAddress parameter. Use the New-EqlChapUser to add a local CHAP user and password to

a group and Remove-EqlChapUser to delete an existing local CHAP user in a group.

Inputs

None.

Outputs

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




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Example

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

C:\PS>Get-EqlChapUser

Related Commands


• New-EqlChapUser cmdlet

50




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

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 PS



GroupAddress parameter. Use the Get-EqlChapUser cmdlet to retrieve the names of the local

CHAP users on the group.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








51


Required?: false

Position?: named




Parameter: UserName <string>

Specifies the name of a CHAP user account on a PS Series group that identifies the CHAP user

to which this cmdlet applies.

Required?: true

Position?: named

Default value?:



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

Changes the password for the local CHAP user to the value in a PSCredential object. The

username value in the PSCredential object is ignored. The new password must be 3-16

alphanumeric characters and is case sensitive. The Password parameter can be used instead of

the Credential parameter.

Required?: true, unless Password is specified.

Position?: named

Default value?:




Changes the password for the local CHAP user. The new password must be 3-16 alphanumeric

characters and is case-sensitive. The Credential parameter can be used instead of the

Password parameter.


Position?: named

Default value?:



Examples

Example 1

This command displays a dialog for entry of a password and changes the password for chapuser

to 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

52


Related Commands





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 PS



GroupAddress parameter. Use the Get-EqlChapUser cmdlet to get the names of CHAP users

defined for the group.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named





53





Required?: false

Position?: named




Parameter: UserName <string>

Specifies the name of a local CHAP user on a PS Series group that identifies the local CHAP

user to which this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named

Default value?:




Specifies that the cmdlet should bypass the confirmation prompt and delete the local CHAP

account.

Required?: false

Position?: named




Example

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

C:\PS>Remove-EqlChapUser -UserName chapuser

Related Commands





54

5 Volume Administration Cmdlets

Basic cmdletsThese cmdlets allow you to manage volume creation and configuration of volumes on PS Series

groups 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>]]


[-ThinProvision] [-ThinProvisionMinReservePercent <uint>]

[-ThinProvisionWarningPercent <uint>] [-ThinProvisionMaxGrowPercent <uint>]

[-PassThru [<SwitchParameter>]] [{Common Parameters}]

Command Description

The New-EqlVolume cmdlet creates a volume on a PS Series group to which a connection exists

in 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 at

creation time. If you are connected to more than one group, you can specify the target group

using 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-EqlGroupDefaults

cmdlet can be used to review these default values. The Set-EqlGroupDefaults cmdlet can be

used to change them. Access control lists (ACLs) can be created and added to this volume using

the New-EqlVolumeACL cmdlet. Schedules can be created for this volume using the

New-EqlSchedule cmdlet. Initial values set at creation time can be changed later using the

Set-EqlVolume cmdlet. To delete this volume use the Remove-EqlVolume cmdlet.

InputsInterop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC

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

55

PowerShell Tools User Guide 5 Volume Administration Cmdlets

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.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




Parameter: VolumeName <string>

Specifies the name for the volume to be created on a PS Series group. This name must be unique

on the PS Group and is case-sensitive.

Required?: true

Position?: named




Parameter: VolumeSizeMB <uint>

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

Required?: true

Position?: named





56


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

Required?: false

Position?: named

Default value?: 100




Specifies the name of the pool in which the new volume should be created. If this is not

specified, the volume will be created in the default pool.

Required?: false

Position?: named

Default value?: default



Parameter: DiskSpeedPreference <string>

Specifies the preferred speed for selecting a drive in the group on which to create the new

volume. If specifying a preference, enter 5400, 7200, 10000, or 15000 for the preferred drive

RPM level. Otherwise, skip this parameter or enter 0 or (n)o_disk_speed_preference.

Required?: false

Position?: named

Default value?: no_disk_speed_preference



Parameter: AccessType <string>

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

type.

Required?: false

Position?: named

Default value?: read_write



Parameter: DriveTypePreference <string>

Specifies the preferred drive type when selecting a drive on which to create the new volume. If

specifying a preference, enter SAS or SATA for the drive type. Otherwise, skip this parameter

or enter (n)o_drive_type_preference.

Required?: false

Position?: named

Default value?: no_drive_type_preference



Parameter: LoadBalance <string>

57


Specifies whether load balancing should be enabled or disabled for the new volume. Enter (y)es

to enable or (n)o to disable load balancing.

Required?: false

Position?: named

Default value?: yes



Parameter: iSCSIAlias [<string>]

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

Required?: false

Position?: named




Parameter: OnlineStatus <string>

Specifies whether the new volume should be set online or offline. Enter (on)line to set it online

or (off)line to set it offline.

Required?: false

Position?: named

Default value?: online



Parameter: RAIDTypePreference <string>

Specifies the preferred RAID type when selecting a drive on which to create the new volume. If

specifying a preference for the RAID type, enter 5 for RAID5, 6 for RAID6, 10 for RAID10, or

50 for RAID50. Otherwise, skip this parameter or enter 0 or (n)o_raid_type_preference.

Required?: false

Position?: named

Default value?: no_raid_type_preference



Parameter: AllowMultipleInitiators <string>

Specifies whether to allow iSCSI connections from more than one initiator for the new volume.

Enter (y)es to allow or (n)o to not allow sharing of the volume.

Required?: false

Position?: named

Default value?: no



Parameter: VolumeDescription [<string>]

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

58


Required?: false

Position?: named





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

issued.

Required?: false

Position?: named

Default value?: 80




Specifies the policy to apply when the snapshot reserve is insufficient to create snapshots of the

new volume. Enter (m)ake_volume_offline, (d)elete_oldest, or (s)top_snapshots for the policy.

Required?: false

Position?: named

Default value?: delete_oldest



Parameter: ThinProvision <string>

Specifies whether the new volume should be thin provisioned. Enter (y)es to thin provision the

new volume or (n)o to allocate space for the full requested size of the new volume.

Required?: false

Position?: named

Default value?: no



Parameter: ThinProvisionMinReservePercent <uint>

Specifies the percent of the requested volume size to reserve for the new volume when it is

created (minimum 10 percent).

Required?: false

Position?: named

Default value?: 10




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

Required?: false

Position?: named

59


Default value?: 60




Specifies the percent of the requested volume size to which the new volume can grow before the

total size specified for the volume must be increased.

Required?: false

Position?: named

Default value?: 100




Specifies that the cmdlet should return an EQL_VOLUME_SPEC object for the new volume on

successful completion.

Required?: false

Position?: named


Accept pipeline input? false


Examples

Example 1

This command creates a 10GB (10000MB) volume named MyVolume on the current PS Group

in this runspace with a snapshot reserve of 20GB (200 percent of the volume size) with the

default values for all optional parameters.

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

-SnapshotReservePercent 200

Example 2

This command creates a 10GB (2 GB initial size), writable, thin-provisioned volume named

MyVolume on the current PS Series group in this runspace. The snapshot reserve is 4GB (200

percent of the initial volume size), and for all other optional parameters, the defaul value will be

set.

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 runspace

with the same settings as MyVolume1.

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

60


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>]][<CommonParameters>]

Command Description

The Get-EqlVolume cmdlet retrieves the configuration and statistics for a volume identified by

name on a PS Series group to which a connection exists in the current PowerShell runspace. If


GroupName or GroupAddress parameter. If a volume name is not specified, this command will

retrieve the information for all volumes on a PS Series group to which the connected

administrative user has access. The information retrieved by this command can be piped into

other cmdlets that act on volumes, such as New-EqlVolume, New-EqlVolumeACL or

New-EqlReplica. Use Get-EqlVolumeACL to retrieve access 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 the

objects through format-list to filter out parameters that you do not want to use.

61





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





Specifies the name of a volume on a PS Series group that identifies the volume to which this


Required?: false

Position?: named




Parameter: MemberIndex <uint>

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

Required?: false

Position?: named

Default value?:



Parameter: VolumeIndex <uint>

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

Required?: false

Position?: named

Default value?:



62


Parameter: UseIndex [<SwitchParameter>]

Specifies that the cmdlet should use the MemberIndex and VolumeIndex parameter values to

identify a volume instead of the volume name. This is a faster method for getting access to the

volume.

Required?: false

Position?: named




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 : MyVolume

VolumeSizeMB : 100

DiskSpeedPreference : no_disk_speed_preference

StoragePoolName : default

AccessType : read_write

DriveTypePreference : no_drive_type_preference

LoadBalance : yes

iSCSIAlias :

ThinProvision : no

ThinProvisionMinReservePercent : 0

ThinProvisionWarningPercent : 0

ThinProvisionMaxGrowPercent : 0

OnlineStatus : online

VolumeDescription :

RaidTypePreference : no_raid_type_preference

AllowMultipleInitiators : no

SnapshotDeletionPolicy : delete_oldest

SnapshotReservePercent : 100

SnapshotReserveWarnPercent : 80

PSVID : 6-090A06-8407663B8-62C1548A8C10F23E

PSVIDAsGuid : 68A09060-7640-B863-62C1-548A8C10F23E

ISCSITargetName : iqn.2001-05.com.equallogic:0-8a0906-b86376406-

3ef2108c8a54c162-MyVolume

DynamicThinReserveMB : 0

TemplateVolume : no

ThinClone : no

CloneSourcePsvid : 00000000-0000-0000-0000-000000000000

AllocatedMB : 0

SnapshotReserveAvailableMB : 105

OperationalStatus : available

SnapshotReserveMB : 105

SnapshotCount : 3

ISCSIConnectionCount : 0

SpannedMemberCount : 1

ReplicaCount : 0

63


NextReplicationTransactionMB : 0

ReplicaReserveInUseMB : 105

Example 2

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

group.

C:\PS>Get-EqlVolume

Example 3

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

group, and then pipes the output to the PowerShell Sort-Object cmdlet, which then pipes the

sorted data to the PowerShell Format-Table cmdlet. The below command outputs a table sorted

by VolumeSizeMB in descending order, and shows the VolumeName, VolumeSize, and

AccessType for each volume on the PS Series group.

C:\PS>Get-EqlVolume | Sort-object volumesizeMB -descending | format-table

-autosize volumeName, volumesizeMB, accessType

The above 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

64


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. The

UseIndex parameter causes the New-EqlSnapshot cmdlet to identify the volume using the

MemberIndex and VolumeIndex parameters piped from the Get-EqlVolume cmdlet. This results

in significantly faster execution on arrays that have many volumes.

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

Related Commands








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>]]


[-ThinProvision <string>] [-ThinProvisionMinReservePercent <uint>]

65


[-ThinProvisionWarningPercent <uint>] [-ThinProvisionMaxGrowPercent <uint>]


Command Description

The Set-EqlVolume cmdlet modifies the configuration of a volume identified by name on a PS



GroupAddress parameter. One or more parameters, such as the AccessType, VolumeName,

VolumeSizeMB, or ThinProvision parameter, can be specified in a single call to Set-EqlVolume.

Use the New-EqlVolumeACL and Remove-EqlVolumeACL cmdlets to modify access 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 through

format-list to filter out parameters that you do not want to set.

Outputs


Interop.EqlPsaMgmtAPI.EQL_VOLUME_SPEC object if the PassThru parameter is present.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





66




Required?: true

Position?: named




Parameter: NewVolumeName <string>

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

case-sensitive.

Required?: false

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Parameter: VolumeSizeMB <uint>

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

67


Required?: false

Position?: named





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

Required?: false

Position?: named

Default value?: 100




Specifies the name of a new pool to which the volume should be moved. The name is

case-sensitive.

Required?: false

Position?: named





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 set

the volume offline, if necessary.

Required?: false

Position?: named




Parameter: LoadBalance <string>

Changes whether load balancing is enabled or disabled for the volume. Enter (y)es to enable or

(n)o to disable load balancing.

Required?: false

Position?: named

Default value?: yes



Parameter: iSCSIAlias [<string>]

Changes the alias for the iSCSI identifier used for the volume. Enter the parameter without a

value to clear the alias.

Required?: false

68


Position?: named





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

it offline.

Required?: false

Position?: named

Default value?: online



Parameter: RAIDTypePreference <string>

Changes the preferred RAID type when selecting a drive to which to move the volume. If

specifying a preference for RAID type, enter 5 for RAID5, 6 for RAID6, 10 for RAID10, or 50

for RAID50. Otherwise, enter 0 or (n)o_raid_type_preference to clear a previous value.

Required?: false

Position?: named

Default value?: no_raid_type_preference




Changes whether to allow iSCSI connections from more than one initiator for the volume. Enter

(y)es to allow or (n)o to not allow sharing of the volume.

Required?: false

Position?: named




Parameter: VolumeDescription [<string>]

Changes the description of the volume (up to a maximum of 255 characters). Use this parameter

without a value to clear the description.

Required?: false

Position?: named





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

issued.

Required?: false

69


Position?: named

Default value?: 100




Changes the policy to apply when the snapshot reserve is insufficient to create snapshots of the

volume. Enter (m)ake_volume_offline, (d)elete_oldest, or (s)top_snapshots for the policy.

Required?: false

Position?: named




Parameter: ThinProvision <string>

Changes whether the new volume is thin provisioned. Enter (y)es to thin provision the volume or

(n)o to allocate space for the full requested size of the volume.

Required?: false

Position?: named




Parameter: ThinProvisionMinReservePercent <uint>

Changes the percent of the requested volume size to reserve for the volume if it is thin

provisioned (minimum 10 percent).

Required?: false

Position?: named

Default value?: 10




Changes the percent of the requested volume size that can be used before a warning is issued if

it is thin provisioned.

Required?: false

Position?: named

Default value?: 60




Changes the percent of the requested volume size to which the volume can grow before the total

size of the volume must be increased if it is thin provisioned.

Required?: false

Position?: named

70


Default value?: 100




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

on successful completion.Required?: false

Position?: named




Examples

Example 1

This command renames MyVolume to MyBiggerVolume, sets the size to 20GB (20000MB), sets

the access to read-only, and places the volume offline. The volume must be set offline to change

the AccessType.

C:\PS>Set-EqlVolume -VolumeName MyVolume -NewVolumeName MyBiggerVolume

-VolumeSizeMB 20000 -AccessType read_only -OnlineStatus offline

Example 2

This command change MyVolume to thin-provisioned volume with a minimum size of 20 percent

of the original volume size and makes the volume writable.

C:\PS>Set-EqlVolume -VolumeName MyVolume -ThinProvision yes

-ThinProvisonMinReservePercent 20 -AccessType read_write

Related Commands









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

71


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. If you are connected to more than one group, you

can specify the target group using either the GroupName or GroupAddress parameter. This cmdlet

will display a prompt to the console to confirm the deletion. The -Force parameter can be used

to suppress this prompt for scripts. Use the Remove-EqlVolumeACL to delete access control lists

for a volume. Use Remove-EqlSnapshot to delete snapshots of a volume.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





72




Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named





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

Required?: false

Position?: named




73


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 snapshots

without asking for confirmation.

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

Related Commands








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

Command SyntaxNew-EqlVolumeACL [-GroupName <string>] [-GroupAddress <string>]


[-UseIndex [<SwitchParameter>]] [-InitiatorName <string>]

[-InitiatorIpAddress <string>] [-InitiatorIpMask <string>] [-Username <string>]

-AclTargetType <string> [<CommonParameters>]

Command Description

The New-EqlVolumeACL cmdlet creates an ACLs for a volume identified by name on a PS Series

group. If you are connected to more than one group, you can specify the target group using either

the GroupName or GroupAddress parameter. Each ACL consists of at least one of the following:

InitiatorName, Username (CHAP user), and InitiatorIpAddress/InitiatorIpMask. The new ACL

will also apply to any existing or new snapshots of the volume if the AclTargetType is set to

74


snapshots_only or volumes_and_snapshots. Use the Get-EqlVolumeACL cmdlet to list the access

control lists for a volume. Use the Remove-EqlVolumeACL cmdlet to delete one or more ACLs

from a volume.

InputsInterop.EqlPsaMgmtAPI.EQL_ACL_SPEC

The output of Get-EqlVolumeACL for a volume can be piped to New-EqlVolumeACL to copy the

ACLs from one volume to another.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






75


Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Parameter: InitiatorName <string>

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

Required? false

Position?: named




Parameter: InitiatorIpAddress <string>

Specifies the IP Address of a host machine which is being granted access to the specified

volume. This parameter must be IPv4. Asterisks can be used to specify a subnet. If asterisks are

used in the IP Address, do not use the InitiatorIPMask parameter.

Required? false

Position?: named

Default value?: 0.0.0.0


Accept wildcard characters?: true

Parameter: InitiatorIpMask <string>

Specifies the IP Address Mask to be used with the InitiatorIpAddress to identify a subnet which

is being granted access to the specified volume. This parameter must be IPv4. If you use

asterisks in the InitiatorIPAddress to indicate a subnet, do not use this parameter.

76


Required? false

Position?: named

Default value?: 255.255.255.255




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

Required? false

Position?: named




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.

Required?: true

Position?: named




Examples

Example 1

This command grants volume only access to MyVolume to the host machine with

iqn.1991-05.com.microsoft:mycomputer.mydomain.com.

C:\PS>New-EqlVolumeACL -VolumeName MyVolume -InitiatorName

iqn.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 host

machines 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

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 -VolumeName

MyVolume2

77


Example 4

This command grants access to MyVolume and its snapshots to host machines in the

10.100.100.1/255.255.255.0 subnet using the * as a wildcard in the IP Address to indicate the

subnet.

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

-ACLTargetType volume_and_snapshot

Example 5


pipes the output to the New-EqlVolumeACL cmdlet to add an ACL that provides access to the

volumes and their snapshots to any host in the 10.200.*.* subnet. The UseIndex parameter

causes the New-EqlVolumeACL cmdlet to identify the volume using the MemberIndex and

VolumeIndex parameters piped from the Get-EqlVolume cmdlet. This results in significantly

faster 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>]


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

Command Description

The Get-EqlVolumeACL cmdlet retrieves all of the ACLs for a volume identified by name on a

PS Series group. If you are connected to more than one group, you can specify the target group

using either the GroupName or GroupAddress parameter. Each ACL consists of at least one of the

following: InitiatorName, Username (CHAP user), and InitiatorIpAddress. The information

78


retrieved by this command can be piped into the New-EqlVolumeACL command to copy the access

control lists from one volume to another. Use the New-EqlVolumeACL to add an access control list

to 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. Pipe

the objects through format-list to filter out parameters that you do not want to set.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






79


Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Example

This command gets all of the ACLs for MyVolume.

C:\PS>Get-EqlVolumeACL -VolumeName MyVolume

Related Commands







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

80


Command SyntaxRemove-EqlVolumeACL [-GroupName <string>] [-GroupAddress <string>]


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

Command Description

The Remove-EqlVolumeACL cmdlet removes the ACL with the specified index from a volume

identified by name on a PS Series group to which a connection exists in the current PowerShell


either the GroupName or GroupAddress parameter. If an index is not specified, all ACLs are

removed from the volume. Use the Get-EqlVolumeACL cmdlet to get the index for each of the

ACLs on a volume.

Inputs

None.

Outputs

Returns a string acknowledging successful completion of the cmdlet action.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





81




Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Parameter: AclIndex <uint>

Specifies the index of the ACL to be removed from the specified volume. If no index is

specified, all ACLs are removed from the volume.

Required?: true

Position?: named

Default value?:



Example

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

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

82


Related Commands






Advanced Volume Administration cmdletsThe advanced volume administration cmdlets allow you to make clones and replicas of a

volume, 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>]


[-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 Series



GroupAddress parameter. The clone can be created in a specified pool. Additional actions can

be performed on the newly created clone using volume cmdlets.

Inputs

None.

Outputs



83




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named






cmdlet applies. This name is case-sensitive.Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:




84




volume.

Required?: false

Position?: named




Parameter: CloneName <string>

Specifies the name to be used for the clone.

Required?: true

Position?: named





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

Required?: false

Position?: named




Parameter: CloneDescription <string>

Specifies a description of the clone.

Required?: false

Position?: named




Examples

Example 1

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

MyVolume.

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

Example 2

This command creates a clone of MyVolume named MyVolumeClone in MyPool with the same

settings as MyVolume.

85


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>]


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

Command Description

The ConvertTo-EqlTemplateVolume cmdlet changes the volume identified by name on a PS

Series group to a template volume that can be used for creating thin clones. If you are connected

to more than one group, you can specify the target group using either the GroupName or

GroupAddress 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 before

trying to use the template volume to create thin clones. Use the

ConvertFrom-EqlTemplateVolume cmdlet to convert a TemplateVolume back to a normal

volume.

Inputs

None.

86


Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





87


Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Parameter: TimeoutSeconds <int>

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

Required?: false

Position?: named

Default value?: 0



Examples

Example 1

This command converts MyVolume to a template volume. MyVolume is offline, read-only and

thin-provisioned after the conversion is completed.

C:\PS>ConvertTo-EqlTemplateVolume -VolumeName MyVolume

Example 2

This command converts MyVolume to a template volume. MyVolume is offline, read-only and

thin-provisioned after the conversion is completed. If the conversion is not completed in 300

seconds, the cmdlet reports an error.

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

Related Commands



• ConvertFrom-EqlTemplateVolume cmdlet

• New-EqlThinClone cmdlet

88


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

Command SyntaxConvertFrom-EqlTemplateVolume [-GroupName <string>] [-GroupAddress <string>]


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

Command Description

The ConvertFrom-EqlTemplateVolume cmdlet changes the template volume identified by name

on a PS Series group to a regular volume. If you are connected to more than one group, you can

specify the target group using either the GroupName or GroupAddress parameter. If any thin

clones 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 using

this cmdlet. Use the Set-EqlVolume cmdlet to change the AccessType, OnlineStatus, and

ThinProvision properties to revert the changes made when the original volume was converted to

a template volume.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

89


Position?: named





Specifies the name of a template volume on a PS Series group that identifies the volume to

which this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Example

This command changes the template volume MyVolume back to a regular volume. MyVolume is

left offline, read-only and thin-provisioned after the conversion is completed.

C:\PS>ConvertFrom-EqlTemplateVolume -VolumeName MyVolume

90


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>]


[-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 PS



GroupAddress parameter. Additional actions can be performed on the newly created thin clone

using volume cmdlets. Use the ConvertFrom-EqlThinClone cmdlet to detach the thin clone from

its template.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named



91







Required?: false

Position?: named





Specifies the name of a template volume on a PS Series group that identifies the template

volume to which this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




92



Specifies the name to be used for the thin clone. This name must be unique in the PS Group and

is case-sensitive.

Required?: true

Position?: named




Parameter: CloneDescription <string>

Specifies a description of the thin clone.

Required?: false

Position?: named




Example

This command creates a thin clone of MyTemplateVolume named MyThinClone.

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

Related Commands






• New-EqlSnapshot cmdlet




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

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

-CloneName <string> [<CommonParameters>]

93


Command Description

The ConvertFrom-EqlThinClone cmdlet detaches a thin clone from its template volume. If you

are connected to more than one group, you can specify the target group using either the

GroupName or GroupAddress parameter.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





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

Required?: true

Position?: named




Example

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

94


C:\PS>ConvertFrom-EqlThinClone -CloneName MyThinClone

Related Commands





• ConvertFrom-EqlTemplateVolume cmdlet

• New-EqlThinClone cmdlet

New-EqlReplica cmdletCreates a replica of the specified volume on a PS Series group.

Command SyntaxNew-EqlReplica [-GroupName <string>] [-GroupAddress <string>]


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

Command Description

The New-EqlReplica cmdlet creates a replica of a volume identified by name on a PS Series


the GroupName or GroupAddress parameter. The volume must be configured for replication. Use

the New-ReplicationPartner cmdlet to create a replication partnership between this group and

another group. Use the New-ReplicaSet cmdlet to configure a specific volume for replication to

a replication partner. Additional actions can be performed on the newly created replica using

replica cmdlets.

Inputs

None.

Outputs



95




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named






cmdlet 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 use

immediately after the cmdlet completes.

Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:




96




volume.

Required?: false

Position?: named




Parameter: ReplicationSite <string>

Specifies the name of a PS Series group that has been configured as the replication partner for

the specified volume.

Required?: true

Position?: named




Example

This command creates a replica of MyVolume on MyPartnerGroup.

C:\PS>New-EqlReplica -VolumeName MyVolume -ReplicationSite MyPartnerGroup

Related Commands



• Suspend-EqlReplication cmdlet

• Resume-EqlReplication cmdlet

• ConvertTo-EqlPromotedReplicaSet cmdlet

• ConvertTo-EqlDemotedReplicaSet cmdlet

• Remove-EqlReplicaSet cmdlet

• New-EqlReplicationPartner cmdlet

• Get-EqlReplicationPartner cmdlet

• New-EqlReplicaSet cmdlet

• Get-EqlReplicaSet cmdlet

97

6 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-Snapshot

Manager-Microsoft Edition (ASM/ME) console or the ASM CLI. The ASM CLI is a set

of commands that you can execute at the Windows command prompt instead of using the

ASM/ME GUI for Smart Copy operations. See the Auto-Snapshot Manager User Guide

for more information.

Command SyntaxNew-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]


[-UseIndex [<SwitchParameter>]] [-SnapshotDescription <string>]

[-AccessType <string>] [-OnlineStatus <string>]

[-AllowMultipleInitiators <string>] [-PassThru [<SwitchParameter>]]


Command Description

The New-EqlSnapshot cmdlet creates a snapshot of a volume identified by name on a PS Series



GroupAddress parameter. The snapshot can be created with a specified access type, online

status, multiple initiator access, and description. Use the Get-EqlVolume cmdlet to list the

snapshot reserve available for a volume. Use the Set-EqlSnapshot cmdlet to change or set any

of 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 the

snapshot parameters from one volume to another.

Outputs


Interop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC object if the PassThru parameter is present.

99

PowerShell Tools User Guide 6 Snapshot Cmdlets




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:



100





volume.

Required?: false

Position?: named




Parameter: SnapshotDescription <string>

Specifies a description of the snapshot.

Required?: false

Position?: named





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

Required?: false

Position?: named

Default value?: read-write




Specifies whether the snapshot is created and set online or offline.

Required?: false

Position?: named

Default value?: offline




Specifies whether multiple initiators will be allowed to connect to the snapshot at the same time.

Enter (y)es to enable multiple initiator access or (n)o to disable it.

Required?: false

Position?: named

Default value?: no




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


101


Required?: false

Position?: named




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 connections

from multiple initiators.

C:\PS>New-EqlSnapshot -VolumeName MyVolume -AllowMultipleInitiators yes

-OnlineStatus online -AccessType read_only

Example 3


pipes the output to the New-EqlSnapshot cmdlet to create a new snapshot for every volume. The

UseIndex parameter causes the New-EqlSnapshot cmdlet to identify the volume using the

MemberIndex and VolumeIndex parameters piped from the Get-EqlVolume cmdlet. This results

in significantly faster execution on arrays that have many volumes.

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

Related Commands









102


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

Command SyntaxGet-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]


[-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 or

Remove-EqlSnapshot. If you are connected to more than one group, you can specify the target

group using either the GroupName or GroupAddress parameter. Pipe the objects through

format-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 on

a PS Series group to which a connection exists in the current PowerShell runspace. If a snapshot

name is not specified, the information for all snapshots of the specified volume is retrieved. The

information retrieved by this command can be piped into the New-EqlSnapshot command to copy

the snapshot parameters from one volume snapshot to another.




cmdlet.

Required?: false

Position?: named








103


Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




Parameter: SnapshotName <string>

Specifies the name of the snapshot of the specified volume to which this cmdlet applies. This

name is case-sensitive.

Required?: false

Position?: named

104





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 -SnapshotName

MyVolume-2010-06-10-08:00:00.1234

This command outputs a PSObject with the values from an

Interop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC. The following is the output:

SnapshotName : MyVolume-2010-06-10-08:00:00.1234

volumeName : MyVolume

ISCSITargetName : iqn.2001-05.com.equallogic:0-290c06-711c90f74-

012000000294cd92-MyVolume-2010-06-10-08:00:00.1234

iSCSIAlias : MyVolume-2010-06-10-08:00:00.1234

AccessType : read_write

SnapshotDescription :

AllowMultipleInitiators : no

OnlineStatus : online

SnapshotSizeMB : 200

SnapshotPsvid : 6-0C0904-2F7901C71-92CD940200002001

SnapshotPsvidAsGuid : 4290C060-90F7-711C-92CD-940200002001

CreationTimeStamp : 06/10/10 08:00:00

Related Commands









105


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

Command SyntaxSet-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]


[-UseIndex [<SwitchParameter>]] -SnapshotName <string> [-NewSnapshotName <string>]

[-iSCSIAlias <string>] [-SnapshotDescription [<string>]]

[-AccessType <string>] [-OnlineStatus <string>]

[-AllowMultipleInitiators <string>] [-PassThru [<SwitchParameter>]]


Command Description

The Set-EqlSnapshot cmdlet changes settings for a snapshot of a volume identified by name on

a PS Series group to which a connection exists in the current PowerShell runspace. If you are


GroupAddress parameter. The snapshot name, iSCSI target alias, access type, online status,

multiple initiator access, and description can be changed with this cmdlet. Use the

Get-EqlVolume cmdlet to list the snapshot reserve available for a volume. Use the

Set-EqlSnapshot cmdlet to change or set any of the optional parameters that were not set at

creation time.

Inputs

Interop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC

The output of Get-EqlSnapshot for any volume can be piped to Set-EqlSnapshot to copy the

snapshot parameters from one snapshot to another.

Outputs


Interop.EqlPsaMgmtAPI.EQL_SNAPSHOT_SPEC object if the PassThru parameter is present.




cmdlet.

Required?: false

Position?: named



106







Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named




107





Required?: true

Position?: named




Parameter: NewSnapshotName <string>

Changes the name of the snapshot of the specified volume. This name must be unique for the

volume and is case-sensitive.

Required?: false

Position?: named




Parameter: iSCSIAlias <string>

Changes the iSCSIAlias of the snapshot of the specified volume.

Required?: false

Position?: named




Parameter: SnapshotDescription [<string>]

Changes the description of the snapshot.

Required?: false

Position?: named





Changes whether the snapshot allows read-only or read-write access. The snapshot must be

offline to change its access type. Use the OnlineStatus parameter to set the snapshot offline, if

necessary.

Required?: false

Position?: named

Default value?: read-write




Changes whether the snapshot is online or offline.

108


Required?: false

Position?: named





Changes whether multiple initiators are allowed to connect to the snapshot at the same time.

Enter (y)es to enable multiple initiator access or (n)o to disable it.

Required?: false

Position?: named

Default value?: no




Specifies that the cmdlet should return an EQL_SNAPSHOT_SPEC object for the changed

snapshot on successful completion.

Required?: false

Position?: named




Example

This command changes the settings of the snapshot named MyVolume-2010-06-10-08:00:00.1234

of 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








109


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 the

ASM/ME console or the ASM CLI, the restore will not be performed in an

application-aware manner. Therefore, before performing the restore operation, you

should perform all necessary actions (for example, taking an SQL databases offline,

or putting clustered volumes in maintenance mode) using the appropriate cmdlets

provided for SQL or failover clusters.

Command SyntaxRestore-EqlSnapshot [-GroupName <string>] [-GroupAddress <string>]


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

Command Description

The Restore-EqlSnapshot cmdlet restores a volume, identified by name, from a specified

snapshot of that volume. If you are connected to more than one group, you can specify the target

group using either the GroupName or GroupAddress parameter. The volume must reside on a PS

Series group to which a connection exists in the current PowerShell runspace. Both the volume

and its snapshot will be taken offline, if they are online when the cmdlet is invoked. Both will be

restored to their original online state after the restore action completes. If you want to leave

either the volume or snapshot offline after the command completes, use the Set-EqlVolume or

Set-EqlSnapshot cmdlet to set the online status to offline before using the

Restore-EqlSnapshot cmdlet.

Inputs

None. The output of Get-EqlSnapshot for any volume can be piped through a filter to select a

snapshot to pipe to Restore-EqlSnapshot from which to restore a volume.

Outputs





cmdlet.

Required?: false

Position?: named


110








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named



111






Required?: true

Position?: named




Examples

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

C:\PS>Restore-EqlSnapshot -VolumeName MyVolume -SnapshotName

MyVolume-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>]


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

Command Description

The Remove-EqlSnapshot cmdlet removes the snapshot with the specified name of a volume



either the GroupName or GroupAddress parameter. If a snapshot name is not specified, all

snapshots of the volume are removed. Use the Get-EqlSnapshot cmdlet to get the name for each

of the snapshots of a volume.

Inputs

None.

112


Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





113


Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named






name is case-sensitive. If this parameter is not specified, all snapshots of the volume will be

deleted.

Required?: false

Position?: named




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 -SnapshotName

MyVolume-2010-06-10-08:00:00.1234

Related Commands






114


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

Command SyntaxNew-EqlSnapshotClone [-GroupName <string>] [-GroupAddress <string>]


[-UseIndex [<SwitchParameter>]] -SnapshotName <string> -CloneName <string>


Command Description

The New-EqlSnapshotClone cmdlet creates a clone of a snapshot identified by name of a volume



either the GroupName or GroupAddress parameter. Additional actions can be performed on the

newly created clone using volume cmdlets. For example, you can use the New-EqlVolumeACL

cmdlet to set ACLs on the clone.

Inputs

None. You cannot pipe objects to New-EqlSnapshotClone.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named

115








Required?: true

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named





Specifies the name of a snapshot on a PS Series group that identifies the snapshot to which this


Required?: false

Position?: named

Default value?:


116




Specifies the name to be used for the clone.

Required?: true

Position?: named

Default value?:



Example

This command creates a clone of snapshot MyVolume-2010-01-01-00:00:00.1 named

MySnapshotClone with the same settings as MyVolume.

C:\PS>New-EqlSnapshotClone -VolumeName MyVolume -SnapshotName

MyVolume-2010-01-01-00:00:00.1 -CloneName MySnapshotClone

Related Commands











117

7 Replication Cmdlets

Replication Configuration cmdletsThese cmdlets are used to manage replication partnerships between groups and to configure

replication 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 Series

group to which a connection exists in the current PowerShell runspace and another PS Series

Group. If you are connected to more than one group, you can specify the target group using

either 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 the

partner.

Inputs

None.

Outputs



Otherwise, an Interop.EqlPsaMgmtAPI.EQL_PARTNER_SPECobject is returned.

You can pipe objects from New-EqlReplicationPartner to Set-EqlReplicationPartner. Pipe

the objects through format-list to filter out parameters that you do not want to use.

119

PowerShell Tools User Guide 7 Replication Cmdlets




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named




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.

Required?: true

Position?: named




Parameter: PartnerIPAddress <string>

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

or IPv6.

Required?: true

Position?: named




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. The

InboundPassword parameter can be used instead of the InboundCredential parameter.

Required?:true, unless InboundPassword is specified.

120


Position?: named

Default value?:



Parameter: InboundPassword <string>

Specifies the password (16 alphanumeric characters maximum) for access by the PS Series

group specified as the value for the PartnerName parameter. The InboundCredential

parameter can be used instead of the InboundPassword parameter.

Required?: true, unless InboundCredential is specified.

Position?: named

Default value?:



Parameter: PartnerDescription <string>

Specifies a description for the replication site.

Required?: false

Position?: named

Default value?:



Parameter: ContactName <string>

Specifies a contact name for the replication site.

Required?: false

Position?: named

Default value?:



Parameter: ContactEmailAddress <string>

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

Required?: false

Position?: named

Default value?:



Parameter: ContactPhone <string>

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

Required?: false

Position?: named

Default value?:



Parameter: ContactMobile <string>

121


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

Required?: false

Position?: named

Default value?:



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. The

OutboundPassword parameter can be used instead of the OutboundCredentialparameter.

Required?: true, unless OutboundPassword is specified.

Position?: named

Default value?:



Parameter: OutboundPassword <string>

Specifies the password (16 alphanumeric characters maximum) for access to the PS Series

group specified as the value for the PartnerNameparameter. The OutboundCredential parameter

can be used instead of the OutboundPasswordparameter.

Required?: true, unless OutboundCredential is specified.

Position?: named

Default value?:



Parameter: DelegatedSpaceMB <uint>

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

replication site.

Required?: false

Position?: named

Default value?: 0



Parameter: ReplicationStatus <string>

Specifies whether the replication partnership is enabled for use when it is created. Enter

(e)nabled to enable replication, (d)isabled disable replication.

Required?: false

Position?: named





122


Specifies that the cmdlet should return an EQL_PARTNER_SPEC object for the group member


Required?: false

Position?: named




Example

This command, executed when connected to GroupA, will create a replication partnership with

GroupB using IP address 10.100.100.10. The outbound password password2 will be used for

authentication for access to GroupB. The inbound password password1 will be used for

authentication for access by GroupB. 10GB of space will be delegated for storing partner replica

sets. 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 of the partnership, you must also connect to GroupB and execute this command,

specifying GroupA for PartnerName, GroupA's IP Address for PartnerIPAddress, password2 for

InboundPassword, and password1 for OutboundPassword.

C:\PS>New-EqlReplicationPartner -PartnerName GroupB -PartnerIPAddress

10.100.100.10 -InboundPassword password1 -OutboundPassword password2 -Delegate

dSpaceMB 10000 -ReplicationStatus enabled -PassThru

Related Commands



• Set-EqlReplicationPartner cmdlet

• Remove-EqlReplicationPartner cmdlet

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

group.

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

[-PartnerName <string>] [<CommonParameters>]

Command Description

The Get-EqlReplicationPartner cmdlet retrieves the definition for a replication partnership

between a group identified by name and a PS Series group to which a connection exists in the

current PowerShell runspace. If you are connected to more than one group, you can specify the

target group using either the GroupName or GroupAddress parameter. If a partner name is not

123


specified, then this cmdlet retrieves the definitions for all replication partnerships on a PS Series

group 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 as

New-EqlReplicationPartner. Pipe the objects through format-list to filter out parameters that

you do not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





Specifies the name of the group to which replication is performed from a PS Series group to

identify the partnership to which this cmdlet applies. This name is case-sensitive.

Required?: false

Position?: named




124


Example

This command will return a PSObject containing all of the values in the EQL_PARTNER_SPEC

object, except for passwords, for the partnership with GroupB.

C:\PS>Get-EqlReplicationPartner -PartnerName GroupB

Related Commands





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>]

Command Description

The Set-EqlReplicationPartner cmdlet changes a replication partnership between a PS Series

group to which a connection exists in the current PowerShell runspace and another PS Series


the GroupName or GroupAddress parameter.

Inputs

None.

Outputs



125


Otherwise, an Interop.EqlPsaMgmtAPI.EQL_PARTNER_SPECobject is returned.

You can pipe objects from Get-EqlReplicationPartner to Set-EqlReplicationPartner to

copy settings from one replication partner to another. Pipe the objects through format-list to filter

out parameters that you do not want to use.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named





Specifies the name of the group to which replication will be performed from a PS Series group to

identify the partnership to which this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named

Default value?:



Parameter: NewPartnerName <string>

Specifies a new name for the group to which replication will be performed from a PS Series

group. This name is case-sensitive. This parameter should only be used if the replication

partner's group name has changed.

Required?: false

Position?: named

Default value?:



126


Parameter: PartnerIPAddress <string>

Changes the IP Address used to connect to the group to which replication will done. This

address can be IPv4 or IPv6.

Required?:false

Position?: named

Default value?:



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

Changes the password using a PSCredential object containing the new password (16

alphanumeric characters maximum) for access by the PS Series group specified as the value for

the PartnerName parameter. The InboundPassword parameter can be used instead of the

InboundCredentialparameter.

Required?: false

Position?: named

Default value?:



Parameter: InboundPassword <string>

Changes the password (16 alphanumeric characters maximum) for access by the PS Series group

specified as the value for the PartnerNameparameter. The InboundCredential parameter can be

used instead of the InboundPassword parameter.

Required?: false

Position?: named

Default value?:



Parameter: PartnerDescription <string>

Changes the description for the replication partnership. If the description contains spaces,

surround it with quotation marks.

Required?: false

Position?: named

Default value?:



Parameter: ContactName <string>

Changes the contact name for the replication site.

Required?: false

Position?: named

Default value?:



127


Parameter: ContactEmailAddress <string>

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

Required?: false

Position?: named

Default value?:



Parameter: ContactPhone <string>

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

Required?: false

Position?: named

Default value?:



Parameter: ContactMobile <string>

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

Required?: false

Position?: named

Default value?:



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

Changes the password using a PSCredential object containing the new password (16

alphanumeric characters maximum) for access to the PS Series group specified as the value for

the PartnerName parameter. The OutboundPassword parameter can be used instead of the

OutboundCredential parameter.

Required?: false

Position?: named

Default value?:



Parameter: OutboundPassword <string>

Changes the password (16 alphanumeric characters maximum) for access to the PS Series group

specified as the value for the PartnerNameparameter. The OutboundCredential parameter can

be used instead of the OutboundPassword parameter.

Required?: false

Position?: named

Default value?:



Parameter: DelegatedSpaceMB <uint>

128


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

replication site.

Required?: false

Position?: named

Default value?: 0



Parameter: ReplicationStatus <string>

Changes whether the replication partnership is enabled for use when it is created. Enter

(e)nabled to enable replication, (d)isabled disable replication.

Required?: false

Position?: named





Specifies that the cmdlet should return an EQL_PARTNER_SPEC object for the replication

partnership on successful completion.

Required?: false

Position?: named




Example

This command will change the replication partnership between GroupB and the group to which a

connection exists in the current PowerShell runspace. The inbound password used for

authentication for access by GroupB will be changed to password3. The space delegated for

storing partner replica sets will be increased to 20GB. Since the PassThru parameter is

specified, it will also list all of the values (except for passwords) in the EQL_PARTNER_SPEC

object for the partnership with the new values for changes made. For values that apply to both

sides of the partnership, execute the Set-EqlReplicationPartner cmdlet on the partner group to

keep them synchronized.

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

-DelegatedSpaceMB 20000 -PassThru

Related Commands





129


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 PS

Series group to which a connection exists in the current PowerShell runspace and another

specified PS Series group. If you are connected to more than one group, you can specify the

target group using either the GroupName or GroupAddress parameter. This cmdlet will display a

prompt to the console to confirm the deletion. The -Force parameter can be used to suppress this

prompt for scripts.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named



130




Specifies the name of the group with which a replication partnership exists to identify the

partnership to which this cmdlet applies. This name is case-sensitive.

Required?: true

Position?: named

Default value?:




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

Required?: false

Position?: named




Example

Example 1

This command will prompt for confirmation and delete the replication partnership between

GroupB and the group to which a connection exists in the current PowerShell runspace.

C:\PS>Remove-EqlReplicationPartner -PartnerName GroupB

Example 2

This command will delete the replication partnership between GroupB and the group to which a

connection 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.

131


Command SyntaxNew-EqlReplicaSet [-GroupName <string>] [-GroupAddress <string>]

-VolumeName <string> -ReplicationSite <string> [-PartnerReservePercent <uint>]

[-LocalReservePercent <uint>] [-BorrowLocalFreeSpace <string>]

[-KeepLocalFailback <string>] [-CreateReplica [<SwitchParameter>]]


Command Description

The New-EqlReplicaSet cmdlet configures replication of a volume on a PS Series group to

which a connection exists in the current PowerShell runspace to a specified replication site. If


GroupName or GroupAddress parameter. The volume and replication site are specified by name.

Use the New-EqlReplicationPartner cmdlet to configure the partnership with the replication

site before using this cmdlet.

Inputs

None.

Outputs

Returns a string acknowledging the successful completion of the cmdlet action , or an

Interop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC object if the PassThru parameter is

present.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named



132






Required?: true

Position?: named





Specifies the name of a PS Group that identifies the replication partner to which this cmdlet


Required?: true

Position?: named




Parameter: PartnerReservePercent <uint>

Specifies the portion of delegated space allocated for storing the replica set specified as a

percent of the replica volume reserve. The minimum value is 105 percent.

Required?:false

Position?: named

Default value?: 200



Parameter: LocalReservePercent <uint>

Specifies the local replication reserve, which is used during replication and optionally for storing

the failback snapshot. It is specified as a percent of the volume reserve. The minimum value is 5

percent.

Required?: false

Position?: named

Default value?: 100



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.

Required?: false

Position?: named



133



Parameter: KeepLocalFailback <string>

Specifies whether a failback snapshot is kept in the local replication reserve. Enter (e)nabled to

keep a failback snapshot, enter (d)isabled to not keep a local failback snapshot.

Required?: false

Position?: named




Parameter: CreateReplica [<SwitchParameter>]

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

configured.

Required?: false

Position?: named





Specifies that the cmdlet should return an EQL_REPLICA_SET_SPEC object for the new replica set


Required?: false

Position?: named




Examples

Example 1

This command configures replication of MyVolume to PSGroupB, enables the option to keep a

local 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 the

initial replica.

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

-CreateReplica

134


Related Commands


• New-EqlReplica cmdlet

• Set-EqlReplicaSet 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 volume

name and replication partner name on a PS Series group to which a connection exists. If you are


GroupAddress parameter. If volume name and replication partner name are not specified,

information for all replica sets configured on the group will be returned.

Inputs

None.

Outputs

Returns a collection of PSObjects for an Interop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC.

The output of the Get-EqlReplicaSet cmdlet can be piped to other cmdlets, such as

Set-EqlReplicaSet.


135




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: false, unless PartnerName is specified.

Position?: named





Specifies the name of a PS Series group that identifies the replication partner to which this


Required?: false, unless VolumeName is specified.

Position?: named




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 : MyVolume

ReplicationSite : PSGroupB

PartnerReservePercent : 200

136


LocalReservePercent : 100

BorrowLocalFreeSpace : enabled

KeepLocalFailback : disabled

ReplicaCount : 2

AdminStatus : 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




• Set-EqlReplicaSet cmdlet






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 and

replication site on a PS Series group to which a connection exists in the current PowerShell


either the GroupName or GroupAddress parameter.

Inputs

None.

137


Outputs


Interop.EqlPsaMgmtAPI.EQL_REPLICA_SET_SPEC object if the PassThru parameter is

present.




cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named

Default value?:




Specifies the name of a PS Series group that identifies the replication site to which this cmdlet


Required?: true

Position?: named

Default value?:



Parameter: PartnerReservePercent <uint>

138


Changes the portion of delegated space allocated for storing the replica set specified as a

percent of the replica volume reserve. The minimum value is 105 percent.

Required?:false

Position?: named

Default value?: 200



Parameter: LocalReservePercent <uint>

Changes the local replication reserve which is used during replication and optionally for storing

the failback snapshot. It is specified as a percent of the volume reserve. The minimum value is 5

percent.

Required?:false

Position?: named

Default value?: 100



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?:false

Position?: named




Parameter: KeepLocalFailback <string>

Changes whether a failback snapshot is kept in the local replication reserve. Enter (e)nabled to

keep a failback snapshot, or enter (d)isabled if you do not want to keep a local failback snapshot.

Required?:false

Position?: named





Specifies that the cmdlet should return an EQL_REPLICA_SET_SPEC object for the changed

replica set on successful completion.

Required?:false

Position?: named




139


Example

This command enables the option to keep a local failback snapshot and changes the local reserve

space 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.

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 a

connection exists that was created for the volume identified by name on the specified replication

site. If you are connected to more than one group, you can specify the target group using either

the GroupName or GroupAddress parameter. Replication of the volume to the replication site is

disabled by the deletion of the replica set.

Inputs

None.

Outputs


140





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named





Specifies the name of a PS Series group that identifies the replication site to which this cmdlet


Required?: true

Position?: named





Specifies that the cmdlet should bypass the confirmation prompt and delete the replica set.

Required?: false

Position?: named


141




Example

This command displays a prompt requesting confirmation, and if the user confirms the action, it

removes 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. The

replications of the volumes must be previously configured using the Replication Configuration

cmdlets.

Suspend-EqlReplication cmdletSuspends replication of a volume to the specified replication partner. Use

Resume-EqlReplication to resume replication of the suspended replica set.

Command SyntaxSuspend-EqlReplication [-GroupName <string>] [-GroupAddress <string>]

-VolumeName <string> -ReplicationSite <string> [<CommonParameters>]

Command Description

The Suspend-EqlReplication cmdlet suspends replication of a volume identified by name from

a PS Series group to which a connection exists in the current PowerShell runspace to the

specified replication site. If you are connected to more than one group, you can specify the

target group using either the GroupName or GroupAddress parameter.

Inputs

None.

142


Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named







Required?: true

Position?: named




Example

This command suspends replication of MyVolume to PSGroupB.

143


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 a

PS Series group to which a connection exists in the current PowerShell runspace to the specified

Replication Site. If you are connected to more than one group, you can specify the target group

using either the GroupName or GroupAddress parameter.

Inputs

None.

Outputs





cmdlet.

144


Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named







Required?: true

Position?: named




Example

This command resumes replication of MyVolume to PSGroupB.

C:\PS>Resume-EqlReplication -VolumeName MyVolume -ReplicationSite PSGroupB

Related Commands






145





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 to

which a connection exists in the current PowerShell runspace to a volume. If you are connected

to more than one group, you can specify the target group using either the GroupName or

GroupAddress parameter. The group to which the connection exists must be the group to which

the original volume is replicated. The source site parameter is the name of the PS Series group

where the original volume is located.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








146


Required?: false

Position?: named




Parameter: ReplicaSetName <string>

Specifies the name of a replica set on the PS Series group to which a connection exists in this

PowerShell runspace that identifies the replica set to which this cmdlet applies. This name is

case-sensitive.

Required?: true

Position?: named




Parameter: SourceSite <string>



Required?: true

Position?: named




Example

This command promotes a replica set created from MyVolume on PSGroupB to a volume when

invoked on the replication partner of PSGroupB.

C:\PS>ConvertTo-EqlPromotedReplicaSet -VolumeName MyVolume -FromSite PSGroupB

Related Commands







ConvertTo-EqlDemotedReplicaSet cmdletDemotes a promoted replica set to a normal replica set.

147


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 a

normal replica set. If you are connected to more than one group, you can specify the target group

using either the GroupName or GroupAddress parameter. The converted volume is identified by

name, and should reside on a PS Series group to which a connection exists in the current


Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named






cmdlet applies. This name is case-sensitive and is for a volume that is a promoted replica set.

148


Required?: true

Position?: named




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 current


C:\PS>ConvertTo-EqlDemotedReplicaSet -VolumeName MyVolume

Related Commands







149

8 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>]


[-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 connection

exists in the current PowerShell runspace. If you are connected to more than one group, you can

specify the target group using either the GroupName or GroupAddress parameter. If a replication

site is specified, the schedule creates replicas. Otherwise, it creates snapshots. Use the

Set-EqlSchedule cmdlet to change or set any of the optional parameters that were not set at

creation time.

InputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

The output of Get-EqlSchedule for any volume can be piped to New-EqlSchedule to copy the

schedule parameters from one volume to another.

Outputs


Interop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC object if the PassThru parameter is present.




cmdlet.

151

PowerShell Tools User Guide 8 Schedule Cmdlets

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

152


Position?: named




Parameter: ScheduleName <string>

Specifies the name to use when referring to the schedule. This name must be unique for the


Required?: true

Position?: named




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?: false

Position?: named

Default value?: once




Specifies the name of the replication partner for the schedule to use to create replicas for the

named volume. If a replication partner is not specified, then the schedule creates snapshots. The

replication partnership must be configured on this group and the volume must be configured for

replication to that partner. Otherwise, this cmdlet will fail.

Required?: false

Position?: named




Parameter: StartDate {DateTime}

Specifies the date that the schedule will start running.

Required?: false

Position?: named




Parameter: StartTime {DateTime}

Specifies the time of day that the schedule will start running.

Required?: false

Position?: named

153





Parameter: EndDate {DateTime}

Specifies the date that the schedule will stop running.

Required?: false

Position?: named




Parameter: EndTime {DateTime}

Specifies the time of day that the schedule will stop running.

Required?: false

Position?: named





Specifies whether the snapshot that is created by the schedule will be online or offline.

Required?: false

Position?: named





Specifies whether the snapshot that is created by the schedule will be read-only or read-write.

Required?: false

Position?: named




Parameter: ScheduleStatus <string>

Specifies whether the schedule is created in an enabled or disabled state. Enter (e)nabled to

create an enabled schedule or (d)isabled to create a disabled schedule.

Required?: false

Position?: named




Parameter: KeepCount <string>

154


Specifies the maximum number of snapshots or replicas created by this schedule that should be

kept on the PS Group before the deletion policy is applied.

Required?: false

Position?: named

Default value?: 10



Parameter: TimeFrequency <string>

Specifies the number of minutes between runs in the time interval during which the schedule is

configured to run. For example, enter 60 to run the schedule every hour.

Required?: false

Position?: named

Default value?: 5




Specifies that the cmdlet should return an EQL_SCHEDULE_SPEC object for the new schedule


Required?: false

Position?: named




Examples

Example 1

This command creates a schedule for creating read-write, offline snapshots of MyVolume every

day starting on 6/1/2020 every 15 minutes between 6 PM and 11 PM.

C:\PS>New-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule -ScheduleType

daily -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 on

PSGroup2 every day starting on 6/1/2020 between 6 PM and 11 PM. This schedule will not run

until it is enabled.

C:\PS>New-EqlSchedule -VolumeName MyVolume -ScheduleName MyReplicaSchedule

-ScheduleType hourly -ReplicationSite PSGroup2 -StartDate 6/1/2010 -StartTime

6:00P M -EndTime 11:00PM -AccessType read_only -OnlineStatus offline

-ScheduleStatus disabled

155


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>]


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

Command Description

The Get-EqlSchedule cmdlet retrieves the specified schedule for a volume identified by name

on a PS Series group to which a connection exists in the current PowerShell runspace. If you are


GroupAddress parameter. If a schedule name is not specified, the information for all schedules

for the specified volume is retrieved. The information retrieved by this command can be piped

into the New-EqlSchedule command to copy the schedule parameters from one volume to

another.

Inputs

None.

OutputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

You can pipe objects from Get-EqlSchedule to other cmdlets, such as New-EqlSchedule or

Remove-EqlSchedule. Pipe the objects through format-list to filter out parameters that you do not

want to set.

156





cmdlet.

Required?: false

Position?: named








Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:



157





volume.

Required?: false

Position?: named





Specifies the name of the schedule of the specified volume to which this cmdlet applies. This


Required?: false

Position?: named




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

Related Commands




• New-EqlSchedule cmdlet


Set-EqlSchedule cmdletChanges the schedule of the specified volume.

158


Command SyntaxSet-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]


[-UseIndex [<SwitchParameter>]] -ScheduleName <string> [-NewScheduleName <string>]

[-ScheduleType <string>] [-ReplicationSite [<string>]] [-StartDate]

[-StartTime {DateTime}] [-EndDate {DateTime}] [-EndTime {DateTime}]

[-OnlineStatus <string>] [-AccessType <string>] [-ScheduleStatus <string>]

[-KeepCount <string>] [-TimeFrequency <string>] [-PassThru [<SwitchParameter>]]


Command Description

The Set-EqlSchedule cmdlet changes settings for a schedule of a volume identified by name on

a PS Series group to which a connection exists in the current PowerShell runspace. If you are



InputsInterop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC

The output of Get-EqlSchedule for any volume can be piped to Set-EqlSchedule to copy the

schedule parameters from one volume to another.

Outputs


Interop.EqlPsaMgmtAPI.EQL_SCHEDULE_SPEC object if the PassThru parameter is present.




cmdlet.

Required?: false

Position?: named








Required?: false

159


Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named





Specifies the name of the schedule for the specified volume to which this cmdlet applies. This


Required?: true

Position?: named


160




Parameter: NewScheduleName <string>

Changes the name of the schedule for the specified volume. This name must be unique for the


Required?: false

Position?: named




Parameter: ScheduleType <string>

Changes the type of schedule. Enter (o)nce for a schedule that runs once; (h)ourly or (d)aily for

a recurring schedule.

Required?: false

Position?: named

Default value?: once



Parameter: ReplicationSite [<string>]

Changes the name of the replication partner for the schedule to create replicas of the named

volume. If a replication site is not specified, then the schedule creates snapshots. If replication

of the specified volume to the named site is not configured, this cmdlet will fail.

Required?: false

Position?: named




Parameter: StartDate {DateTime}

Changes the date that the schedule will start running.

Required?: false

Position?: named




Parameter: StartTime {DateTime}

Changes the time of day that the schedule will start running.

Required?: false

Position?: named




161


Parameter: EndDate {DateTime}

Changes the date that the schedule will stop running.

Required?: false

Position?: named




Parameter: EndTime {DateTime}

Changes the time of day that the schedule will stop running.

Required?: false

Position?: named





Changes whether snapshots created by the schedule are online or offline.

Required?: false

Position?: named





Changes whether the snapshots created by the schedule are created with read_only or read_

write access.

Required?: false

Position?: named




Parameter: ScheduleStatus <string>

Changes whether the schedule in an enabled or disabled state. Enter (e)nabled to enable the

schedule or (d)isabled to disable the schedule.

Required?: false

Position?: named




Parameter: KeepCount <string>

Changes the maximum number of snapshots or replicas created by this schedule that should be

kept on the group before the deletion policy is applied.

162


Required?: false

Position?: named

Default value?: 10



Parameter: TimeFrequency <string>

Changes the number of minutes between runs in the time interval during which the schedule is

configured to run. For example, enter 60 to run the schedule every hour.Required?: false

Position?: named

Default value?: 5




Specifies that the cmdlet should return an EQL_SCHEDULE_SPEC object for the changed

schedule on successful completion.

Required?: false

Position?: named

Default value?:

false Accept pipeline input? 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 -StartTime

5:00AM -EndTime 3:00pm

Example 2

This command changes MySchedule to create read-only snapshots of MyVolume that are online

and enables the schedule.

C:\PS>Set-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule -OnlineStatus

online -AccessType read_only -ScheduleStatus enabled

Related Commands






163



• Remove-EqlSchedule cmdlet

Remove-EqlSchedule cmdletRemoves one or more of the schedules for the specified volume.

Command SyntaxRemove-EqlSchedule [-GroupName <string>] [-GroupAddress <string>]


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

Command Description

The Remove-EqlSchedule cmdlet deletes the schedule with the specified name from a volume



either the GroupName or GroupAddress parameter. If a schedule name is not specified, all

schedules are removed from the volume. Use the Get-EqlSchedule cmdlet to get the name for

each of the schedules for a volume.

Inputs

None.

Outputs





cmdlet.

Required?: false

Position?: named








164


Required?: false

Position?: named







Required?: true

Position?: named






Required?: false

Position?: named

Default value?:





Required?: false

Position?: named

Default value?:






volume.

Required?: false

Position?: named





Specifies the name of the schedule of the specified volume to which this cmdlet applies. This


Required?: false

Position?: named

165





Examples

Example 1

This command deletes all of the schedules for MyVolume.

C:\PS>Remove-EqlSchedule -VolumeName MyVolume

Example 2

This command deletes the schedule named MySchedule from volume MyVolume.

C:\PS>Remove-EqlSchedule -VolumeName MyVolume -ScheduleName MySchedule

Related Commands







166

Documents

PowerShellModule_UserGuide