HPE 3PAR StoreServ Storage PowerShell Toolkit 2.2 User Guide Store Serv Power Shell

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 368

DownloadHPE 3PAR StoreServ Storage PowerShell Toolkit 2.2 User Guide Store Serv Power Shell
Open PDF In BrowserView PDF
HPE 3PAR StoreServ Storage
PowerShell Toolkit 2.2 User Guide

Abstract
This document contains detailed instructions on the HPE 3PAR StoreServ Storage
PowerShell Toolkit 2.2 installation, features, and PowerShell cmdlets.

Part Number: 831005-004
Published: January 2019
Edition: 1

©

Copyright 2015, 2019 Hewlett Packard Enterprise Development LP

Notices
The information contained herein is subject to change without notice. The only warranties for Hewlett
Packard Enterprise products and services are set forth in the express warranty statements accompanying
such products and services. Nothing herein should be construed as constituting an additional warranty.
Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained
herein.
Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession,
use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer
Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government
under vendor's standard commercial license.
Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard
Enterprise has no control over and is not responsible for information outside the Hewlett Packard
Enterprise website.

Acknowledgments
Intel®, Itanium®, Pentium®, Xeon®, Intel Inside®, and the Intel Inside logo are trademarks of Intel
Corporation in the U.S. and other countries.
Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries.
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Java® and Oracle® are registered trademarks of Oracle and/or its affiliates.
UNIX® is a registered trademark of The Open Group.

Contents
Introduction........................................................................................... 11
Overview of HPE 3PAR PowerShell Toolkit................................................................................ 11
Features of HPE 3PAR PowerShell Toolkit................................................................................. 11
New features in HPE 3PAR PowerShell Toolkit 2.2.................................................................... 11
Product support...........................................................................................................................12

HPE 3PAR Web Services API 1.6.3...................................................... 14
Starting and configuring the WSAPI server ............................................................................... 14
Starting the WSAPI server .............................................................................................. 14
Configuring the WSAPI server ........................................................................................ 14

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit............16
Supported Host operating systems and HPE 3PAR PowerShell versions..................................16
Supported HPE 3PAR StoreServ Storage Platforms.................................................................. 16
Importing HPE 3PAR StoreServ Storage PowerShell Toolkit......................................................16
Installation of POSH SSH module.............................................................................................. 17
Using session variable................................................................................................................ 18

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference............ 20
Cmdlets help............................................................................................................................... 20
Connection management cmdlet................................................................................................ 20
CPG management cmdlet...........................................................................................................20
Disk Enclosure management cmdlets.........................................................................................21
Federation cmdlets..................................................................................................................... 21
FBO cmdlets............................................................................................................................... 22
Help cmdlet................................................................................................................................. 22
Host and Host Set management cmdlets................................................................................... 22
Node subsystem management cmdlet........................................................................................22
Performance management cmdlets............................................................................................ 23
Physical copy management cmdlets...........................................................................................24
Port management cmdlets.......................................................................................................... 24
Replication cmdlets.....................................................................................................................25
Software version cmdlet..............................................................................................................26
Sparing cmdlets.......................................................................................................................... 27
System management cmdlets.....................................................................................................27
System Reporter cmdlets............................................................................................................27
Task management cmdlet........................................................................................................... 29
User management cmdlets......................................................................................................... 29
VASA cmdlets............................................................................................................................. 29
Virtual Copy (Snapshot) Management cmdlets...........................................................................30
Virtual LUN management cmdlets.............................................................................................. 30
Virtual Volume and Virtual Volume Set Management cmdlets.................................................... 30

HPE 3PAR PowerShell ToolKit CLI cmdlets........................................32
Add cmdlets................................................................................................................................ 32

3

Add-3parRcopytarget....................................................................................................... 32
Add-3parRcopyVV........................................................................................................... 32
Add-3parVV......................................................................................................................33
Approve cmdlets......................................................................................................................... 34
Approve-3parPD...............................................................................................................34
Approve-3parRCopyLink..................................................................................................34
Compress cmdlets...................................................................................................................... 35
Compress-3parVV............................................................................................................35
Close cmdlets..............................................................................................................................36
Close-3PARConnection....................................................................................................37
Disable cmdlets...........................................................................................................................37
Disable-3ParRcopylink.....................................................................................................37
Disable-3ParRcopytarget................................................................................................. 38
Disable-3ParRcopyVV......................................................................................................38
Find cmdlets................................................................................................................................39
Find-3parCage................................................................................................................. 39
Get cmdlets.................................................................................................................................40
Get-ConnectedSession.................................................................................................... 40
Get-3parCPG................................................................................................................... 40
Get-3parVV...................................................................................................................... 42
Get-3parVVSet.................................................................................................................42
Get-3parHost....................................................................................................................43
Get-3parHostSet.............................................................................................................. 44
Get-3parHostPorts........................................................................................................... 45
Get-3parSpace.................................................................................................................47
Get-3parSystemInformation............................................................................................. 48
Get-3parVLUN..................................................................................................................49
Get-3parFCPorts..............................................................................................................49
Get-3parFCPortsToCSV...................................................................................................50
Get-3parVVList.................................................................................................................50
Get-3parTask....................................................................................................................53
Get-3parCmdList..............................................................................................................54
Get-3parVersion............................................................................................................... 55
Get-3parCage...................................................................................................................55
Get-3parHistChunklet.......................................................................................................56
Get-3parHistLD................................................................................................................ 57
Get-3parHistPD................................................................................................................59
Get-3parHistPort.............................................................................................................. 60
Get-3parHistRCopyVV..................................................................................................... 62
Get-3parHistVLUN........................................................................................................... 64
Get-3parHistVV................................................................................................................ 65
Get-3parPD...................................................................................................................... 67
Get-3parRCopy................................................................................................................ 69
Get-3parSpace.................................................................................................................70
Get-3parSpare..................................................................................................................71
Get-3parSR...................................................................................................................... 71
Get-3parSRAlertCrit......................................................................................................... 71
Get-3parSRAOMoves...................................................................................................... 72
Get-3parSRCPGSpace.................................................................................................... 73
Get-3parSRHistLD........................................................................................................... 75
Get-3parSRHistPD...........................................................................................................76
Get-3parSRHistPort......................................................................................................... 78
Get-3parSRHistVLUN...................................................................................................... 80
Get-3parSRLDSpace....................................................................................................... 82
Get-3parSRPDSpace.......................................................................................................84
Get-3parSRStatCache..................................................................................................... 86
Get-3parSRStatCMP........................................................................................................87

4

Get-3parSRStatCPU........................................................................................................ 88
Get-3parSRStatLD........................................................................................................... 89
Get-3parSRStatPD...........................................................................................................90
Get-3parSRStatPort......................................................................................................... 92
Get-3parSRStatVLUN...................................................................................................... 94
Get-3parSRVVSpace....................................................................................................... 96
Get-3parStatChunklet...................................................................................................... 98
Get-3parStatCMP.............................................................................................................99
Get-3parStatCPU........................................................................................................... 100
Get-3parStatLD.............................................................................................................. 101
Get-3parStatLink............................................................................................................ 102
Get-3parStatPD..............................................................................................................102
Get-3parStatPort............................................................................................................ 103
Get-3parStatRCopy........................................................................................................105
Get-3parStatRCVV.........................................................................................................106
Get-3parStatVlun........................................................................................................... 107
Get-3parStatVV..............................................................................................................109
Get-3parSystem............................................................................................................. 110
Get-3parTask.................................................................................................................. 111
Get-3parUserConnection................................................................................................112
Get-3ParVVolSC.............................................................................................................112
Invoke cmdlets.......................................................................................................................... 113
Invoke-3parCLICmd....................................................................................................... 113
Import cmdlets...........................................................................................................................113
Import-3parVV................................................................................................................ 113
Join cmdlets.............................................................................................................................. 115
Join-3parFed.................................................................................................................. 115
New cmdlets..............................................................................................................................116
New-3parCPG................................................................................................................ 116
New-3parFed..................................................................................................................117
New-3parVV................................................................................................................... 118
New-3parVVSet..............................................................................................................119
New-3parHost................................................................................................................ 120
New-3parHostSet...........................................................................................................121
New-3parVLUN.............................................................................................................. 122
New-3parVVCopy...........................................................................................................123
New-3parGroupVVCopy................................................................................................ 125
New-3parSnapVolume................................................................................................... 126
New-3parGroupSnapVolume......................................................................................... 128
New-3parRCopyGroup...................................................................................................128
New-3parRCopyTarget...................................................................................................129
New-3parSRAlertCrit......................................................................................................130
New-3parSpare.............................................................................................................. 133
New-3parRCopyGroupCPG...........................................................................................134
New-3ParPoshSshConnection.......................................................................................135
New-3parCLIConnection................................................................................................136
Ping cmdlets..............................................................................................................................136
Ping-3parRCIPPorts.......................................................................................................137
Push cmdlets.............................................................................................................................137
Push-3parVVCopy......................................................................................................... 137
Push-3parGroupSnapVolume........................................................................................ 138
Push-3parSnapVolume.................................................................................................. 139
Push-3parChunklet........................................................................................................ 139
Push-3parChunkletToSpare........................................................................................... 140
Push-3parPD..................................................................................................................141
Push-3parPDToSpare.................................................................................................... 142
Push-3parRelocPD........................................................................................................ 143

5

Remove cmdlets....................................................................................................................... 143
Remove-3parCPG..........................................................................................................143
Remove-3parVVSet....................................................................................................... 144
Remove-3parVV.............................................................................................................145
Remove-3parHostSet.....................................................................................................146
Remove-3parHost.......................................................................................................... 146
Remove-3parVLUN........................................................................................................147
Remove-3parRCopyGroup............................................................................................ 148
Remove-3parRCopyTarget............................................................................................ 149
Remove-3parRCopyTargetFromGroup.......................................................................... 149
Remove-3parRCopyVVFromGroup............................................................................... 150
Remove-3parSpare........................................................................................................150
Remove-3parFed........................................................................................................... 151
Remove-3parSRAlertCrit................................................................................................151
Set cmdlets............................................................................................................................... 152
Set-3parVV.....................................................................................................................152
Set-3parHostPorts..........................................................................................................153
Set-3parFCPorts............................................................................................................ 154
Set-3parFed................................................................................................................... 154
Set-3parHost.................................................................................................................. 156
Set-3parCage.................................................................................................................157
Set-3parPD.....................................................................................................................157
Set-3parPoshSshConnectionPasswordFile................................................................... 158
Set-3parPoshSshConnectionUsingPasswordFile.......................................................... 159
Set-3parRCopyGroupPeriod.......................................................................................... 159
Set-3parRCopyGroupPol............................................................................................... 160
Set-3parRCopyTarget.................................................................................................... 162
Set-3parRCopyTargetName...........................................................................................163
Set-3parRCopyTargetPol............................................................................................... 163
Set-3parRCopyTargetWitness........................................................................................164
Set-3parSRAlertCrit........................................................................................................165
Set-3parstatch................................................................................................................166
Set-3parStatpdch........................................................................................................... 166
Set-3parPassword..........................................................................................................167
Set-3ParVVolSC.............................................................................................................167
Show cmdlets............................................................................................................................168
Show-3parFed................................................................................................................168
Show-3parISCSISession................................................................................................169
Show 3pariSCSISessionStatistics..................................................................................169
Show-3pariSCSIStatistics.............................................................................................. 170
Show-3parPeer.............................................................................................................. 171
Show-3parPortARP........................................................................................................171
Show-3parPortISNS.......................................................................................................172
Show-3ParRcopyTransport............................................................................................ 172
Show-3parSRStatIscsi................................................................................................... 173
Show-3parSRSTATISCSISession.................................................................................. 174
Show-3ParVVolum......................................................................................................... 175
Start cmdlets............................................................................................................................. 176
Start-3parFSNDMP........................................................................................................ 176
Start-3parSR.................................................................................................................. 177
Start-3parRCopyGroup.................................................................................................. 177
Start-3parRcopy............................................................................................................. 178
Stop cmdlets............................................................................................................................. 178
Stop-3parRCopyGroup.................................................................................................. 178
Stop-3parRCopy............................................................................................................ 179
Stop-3parSR...................................................................................................................179
Stop-3parFSNDMP........................................................................................................ 179

6

Sync cmdlets.............................................................................................................................180
Sync-3parRCopy............................................................................................................180
Sync-Recover3ParDRRcopyGroup................................................................................180
Test cmdlets.............................................................................................................................. 182
Test-3parRcopyLink....................................................................................................... 182
Test-3parVV....................................................................................................................183
Test-3parPD................................................................................................................... 184
Update cmdlets......................................................................................................................... 185
Update-3parVV.............................................................................................................. 185
Starting and configuring the WSAPI server cmdlets................................................................. 186
Start-3parWsapi............................................................................................................. 186
Stop-3parWsapi..............................................................................................................186
Set-3PARWsapi..............................................................................................................187
Get-3parWsapi............................................................................................................... 188
Get-3parWsapiSession.................................................................................................. 189
Remove-3PARWsapiSession.........................................................................................190

HPE 3PAR PowerShell Toolkit WSAPI cmdlets quick reference ....192
Connection cmdlets.................................................................................................................. 192
System events cmdlets............................................................................................................. 192
CPG cmdlets.............................................................................................................................192
Storage volumes cmdlets..........................................................................................................192
File Persona cmdlets................................................................................................................ 193
Host management cmdlets....................................................................................................... 194
Host sets and virtual volume sets cmdlets................................................................................194
Ports and switches cmdlets...................................................................................................... 195
Virtual LUNs cmdlets.................................................................................................................195
Copy operations Cmdlets..........................................................................................................196
Remote Copy Cmdlets..............................................................................................................196
System information queries and management cmdlets............................................................ 198
Flash cache operations cmdlets............................................................................................... 198
Available space cmdlets............................................................................................................198
WSAPI user and role information cmdlets................................................................................ 198
AO configuration information cmdlets....................................................................................... 198
HPE 3PAR System Reporter cmdlets....................................................................................... 199

HPE 3PAR PowerShell ToolKit WSAPI Cmdlets............................... 200
Add Cmdlet............................................................................................................................... 200
Add-3PARTargetToRCopyGroup_WSAPI...................................................................... 200
Add-3PARVVToRCopyGroup_WSAPI........................................................................... 201
Add-Rem3PARHostWWN_WSAPI.................................................................................202
Close-3PARWSAPIConnection.................................................................................................204
Compress-3PARVV_WSAPI..................................................................................................... 204
Get cmdlets...............................................................................................................................206
Get-3PARAOConfiguration_WSAPI............................................................................... 206
Get-3PARCacheMemoryStatisticsDataReports_WSAPI................................................207
Get-3PARCapacity_WSAPI............................................................................................210
Get-3parCmdList_WSAPI.............................................................................................. 210
Get-3PARCpg_WSAPI................................................................................................... 211
Get-3PARCPGSpaceDataReports_WSAPI................................................................... 212
Get-3PARCPGStatisticalDataReports_WSAPI.............................................................. 215
Get-3PARCPUStatisticalDataReports_WSAPI.............................................................. 217
Get-3PARDirPermission_WSAPI................................................................................... 218
Get-3PAREventLogs_WSAPI.........................................................................................219

7

Get-3PARFCSwitches_WSAPI...................................................................................... 220
Get-3PARFilePersonaQuota_WSAPI.............................................................................220
Get-3PARFileServices_WSAPI...................................................................................... 222
Get-3PARFileShare_WSAPI.......................................................................................... 222
Get-3PARFileStore_WSAPI........................................................................................... 223
Get-3PARFileStoreSnapshot_WSAPI............................................................................ 224
Get-3PARFlashCache_WSAPI...................................................................................... 225
Get-3PARFPG_WSAPI.................................................................................................. 226
Get-3PARFPGReclamationTasks_WSAPI..................................................................... 227
Get-3PARHost_WSAPI.................................................................................................. 228
Get-3PARHostPersona_WSAPI.....................................................................................229
Get-3PARHostSet_WSAPI.............................................................................................230
Get-3PARHostWithFilter_WSAPI................................................................................... 231
Get-3PARiSCSIVLANs_WSAPI..................................................................................... 232
Get-3PARPDCapacityReports_WSAPI.......................................................................... 233
Get-3PARPDSpaceReports_WSAPI..............................................................................235
Get-3PARPDStatisticsReports_WSAPI..........................................................................238
Get-3PARQoSStatisticalReports_WSAPI...................................................................... 240
Get-3PARPort_WSAPI................................................................................................... 244
Get-3PARPortDevices_WSAPI...................................................................................... 245
Get-3PARPortDeviceTDZ_WSAPI................................................................................. 246
Get-3PARPortStatisticsReports_WSAPI........................................................................ 247
Get-3PARRCopyGroup_WSAPI.....................................................................................249
Get-3PARRCopyGroupTarget_WSAPI...........................................................................250
Get-3PARRCopyVolumeStatisticalReports_WSAPI.......................................................251
Get-3PARRCStatisticalReports_WSAPI........................................................................ 254
Get-3PARRCopyGroupVV_WSAPI................................................................................257
Get-3PARRCopyInfo_WSAPI.........................................................................................258
Get-3PARRCopyLink_WSAPI........................................................................................ 259
Get-3PARRCopyTarget_WSAPI.....................................................................................259
Get-3PARRoles_WSAPI................................................................................................ 260
Get-3PARSystem_WSAPI..............................................................................................261
Get-3PARTask_WSAPI.................................................................................................. 261
Get-3PARUsers_WSAPI................................................................................................ 262
Get-3PARVersion_WSAPI..............................................................................................263
Get-3PARVFS_WSAPI...................................................................................................264
Get-3PARVLun_WSAPI................................................................................................. 265
Get-3PARVLUNStatisticsReports_WSAPI..................................................................... 266
Get-3PARVLunUsingFilters_WSAPI.............................................................................. 268
Get-3PARVV_WSAPI.....................................................................................................270
Get-3PARVVSet_WSAPI............................................................................................... 272
Get-3parVVSpaceDistribution_WSAPI.......................................................................... 273
Get-3PARVVSpaceReports_WSAPI.............................................................................. 274
Get-3PARWSAPIConfigInfo........................................................................................... 276
Group-3PARFilePersonaQuota_WSAPI................................................................................... 277
Move cmdlets............................................................................................................................278
Move-3PARVirtualCopy_WSAPI.................................................................................... 278
Move-3PARVVSetVirtualCopy_WSAPI..........................................................................279
New cmdlets..............................................................................................................................280
New-3PARCpg_WSAPI..................................................................................................280
New-3PARFilePersonaQuota_WSAPI........................................................................... 283
New-3PARFileShares_WSAPI....................................................................................... 284
New-3PARFileStore_WSAPI..........................................................................................286
New-3PARFileStoreSnapshot_WSAPI...........................................................................287
New-3PARFlashCache_WSAPI..................................................................................... 288
New-3PARFPG_WSAPI.................................................................................................289
New-3PARHost_WSAPI.................................................................................................290

8

New-3PARHostSet_WSAPI .......................................................................................... 292
New-3PARISCSIVlan_WSAPI........................................................................................294
New-3PARRCopyGroup_WSAPI................................................................................... 295
New-3PARRCopyTarget_WSAPI................................................................................... 296
New-3PARSnapRCGroupVV_WSAPI............................................................................297
New-3PARVFS_WSAPI................................................................................................. 298
New-3PARVLun_WSAPI................................................................................................300
New-3PARVV_WSAPI................................................................................................... 301
New-3PARVVListGroupSnapshot_WSAPI.....................................................................304
New-3PARVVPhysicalCopy_WSAPI..............................................................................305
New-3PARVVSet_WSAPI.............................................................................................. 307
New-3PARVVSetPhysicalCopy_WSAPI........................................................................ 308
New-3PARVVSetSnapshot_WSAPI...............................................................................309
New-3PARVVSnapshot_WSAPI.................................................................................... 311
New-3PARWSAPIConnection........................................................................................ 312
Open-3PARSSE_WSAPI.......................................................................................................... 313
Remove cmdlets....................................................................................................................... 314
Remove-3PARCpg_WSAPI........................................................................................... 314
Remove-3PARFilePersonaQuota_WSAPI..................................................................... 315
Remove-3PARFileShare_WSAPI...................................................................................316
Remove-3PARFileStore_WSAPI....................................................................................317
Remove-3PARFileStoreSnapshot_WSAPI.................................................................... 317
Remove-3PARFlashCache_WSAPI...............................................................................318
Remove-3PARFPG_WSAPI...........................................................................................319
Remove-3PARHost_WSAPI...........................................................................................320
Remove-3PARHostSet_WSAPI..................................................................................... 320
Remove-3PARISCSIVlan_WSAPI................................................................................. 321
Remove-3PARRCopyGroup_WSAPI............................................................................. 322
Remove-3PARTargetFromRCopyGroup_WSAPI...........................................................323
Remove-3PARVFS_WSAPI........................................................................................... 324
Remove-3PARVLun_WSAPI..........................................................................................325
Remove-3PARVV_WSAPI............................................................................................. 326
Remove-3PARVVFromRCopyGroup_WSAPI................................................................327
Remove-3PARVVSet_WSAPI........................................................................................328
Reset-3PARISCSIPort_WSAPI.................................................................................................329
Reset-3PARPhysicalCopy_WSAPI........................................................................................... 329
Reset-3PARVVSetPhysicalCopy_WSAPI.................................................................................330
Resize-Grow3PARVV_WSAPI..................................................................................................331
Restore-3PARRCopyGroup_WSAPI.........................................................................................332
Restore-3PARFilePersonaQuota_WSAPI.................................................................................333
.................................................................................................................................................. 334
Set-3PARFlashCache_WSAPI..................................................................................................334
Set-3PARISCSIPort_WSAPI.....................................................................................................335
Set-3PARISCSIVlan_WSAPI.................................................................................................... 336
Set-3PARVVSetFlashCachePolicy_WSAPI..............................................................................337
Start-3PARRCopyGroup_WSAPI..............................................................................................338
Stop cmdlets............................................................................................................................. 339
Stop-3PAROngoingTask.................................................................................................339
Stop-3PARPhysicalCopy_WSAPI.................................................................................. 340
Stop-3PARRCopyGroup_WSAPI................................................................................... 341
Stop-3PARVVSetPhysicalCopy_WSAPI........................................................................ 342
Sync-3PARRCopyGroup_WSAPI............................................................................................. 343
Update cmdlet...........................................................................................................................344
Update-3PARCpg_WSAPI............................................................................................. 344
Update-3PARFilePersonaQuota_WSAPI.......................................................................347
Update-3PARFileStore_WSAPI..................................................................................... 349
Update-3PARHost_WSAPI............................................................................................ 350

9

Update-3PARHostSet_WSAPI....................................................................................... 352
Update-3PARRCopyGroup_WSAPI...............................................................................353
Update-3PARRCopyGroupTarget_WSAPI.....................................................................355
Update-3PARRCopyTarget_WSAPI...............................................................................357
Update-3PARSystem_WSAPI........................................................................................358
Update-3PARVV_WSAPI............................................................................................... 360
Update-3PARVVOrVVSets_WSAPI............................................................................... 363
Update-3PARVVSet_WSAPI..........................................................................................364

Support and other resources.............................................................366
Accessing Hewlett Packard Enterprise Support....................................................................... 366
Accessing updates....................................................................................................................366
Customer self repair..................................................................................................................367
Remote support........................................................................................................................ 367
Warranty information.................................................................................................................367
Regulatory information..............................................................................................................368
Documentation feedback.......................................................................................................... 368

10

Introduction
Overview of HPE 3PAR PowerShell Toolkit
The HPE 3PAR StoreServ Storage PowerShell Toolkit supports cmdlets, which are wrappers around the
native HPE 3PAR StoreServ Storage CLI commands or HPE 3PAR StoreServ Storage Web Services API
(WSAPI).

Features of HPE 3PAR PowerShell Toolkit
HPE 3PAR StoreServ Storage PowerShell Toolkit v2.2 works with PowerShell v3.0 and later, upto
PowerShell v5.1.
It can be used in following two ways:
1. With Native HPE 3PAR StoreServ Storage CLI command.
When you run the cmdlets, the following actions take place:
a. A secure connection to the HPE 3PAR StoreServ Storage is established over Secure Shell.
b. The native HPE 3PAR StoreServ Storage CLI command and parameters are formed based on the
PowerShell cmdlet and parameters.
c. The native HPE 3PAR StoreServ Storage CLI command is executed.
d. The output of the cmdlets is returned as PowerShell objects. This output can be piped to other
PowerShell cmdlets for further processing.
2. With HPE 3PAR Web Service API.
When you run the cmdlets, the following actions take place:
a. A secure connection using HPE 3PAR Web Service API is established as a session key
(credential). Unused session keys expire after 15 minutes.
b. The HPE 3PAR Web Service API and parameters are formed based on the PowerShell cmdlet and
parameters.
c. WSAPI uses the HTTPS protocol to enable programmatic management of 3PAR storage servers,
and provides client access to web services at specified HTTPS locations. Clients communicate with
the WSAPI server using HTTPS methods and data structures represented with JSON.
d. The output of the cmdlets is returned as PowerShell objects. This output can be piped to other
PowerShell cmdlets for search.

New features in HPE 3PAR PowerShell Toolkit 2.2
•

Support for HPE 3PAR StoreServ Storage Operating System 3.3.1(MU1, MU2, MU3 & MU4) with CLIbased cmdlets.

•

Support for HPE 3PAR StoreServ Storage Operating System 3.3.1(MU1, MU2 & MU3) with WSAPIbased cmdlets.

•

Support for Windows 2019.

•

HPE 3PAR Web Service API v1 (1.6.3) support for the following:

Introduction

11

◦

CRUD operations on CPG, Volume, host, host sets, VV sets, VLUN, FPG/VFS/File Shares,
Remote Copy Group and so on.

◦

Querying and filtering system events and tasks.

◦

Configuring and querying ports.

◦

Querying system capacity.

◦

Creating physical copy of volume/VV set and resynchronizing these volumes.

◦

SR reports - Statistical data reports for CPG, PD, ports, VLUN, QoS & Remote Copy volumes and
so on.

◦

Querying WSAPI users and roles.

•

Support for PowerShell (POSH) SSH module to establish SSH connections to the storage system.

•

Support latest PowerShell 5.1.

•

Session Management (using session variable).

•

Support for all parameters in existing cmdlets.

Product support
HPE 3PAR StoreServ Storage PowerShell Toolkit supports PowerShell 3.0 and later. This Toolkit provides
cmdlets to manage the following operations:

12

•

Views and manages Common Provisioning Group (CPG).

•

Views and manages VVols.

•

Views and manages Virtual Volume sets.

•

Views and manages Hosts.

•

Views and manages Host sets.

•

Views and manages Virtual Logical Unit Number (vLUN).

•

Views and manages Physical copy.

•

Views and manages Virtual copy (Snapshots).

•

Views and manages ports.

•

Views and manages tasks.

•

Views and manages Disk Enclosure.

•

Views and manages Performance Management.

•

Views and manages Spares.

•

Supports for HPE 3PAR Web Services API.

•

Supports for System Reporter cmdlets.

•

Supports for Remote Copy cmdlets.

•

Supports for Compression-related cmdlets.

•

Supports for Asynchronous streaming replication.

•

Supports for Deduplication-related cmdlets.

Introduction

•

Supports for Storage Federation related cmdlets.

•

Supports for Smart SAN Enhancements (iSCSI) related cmdlets.

Introduction

13

HPE 3PAR Web Services API 1.6.3
The Web Services API (WSAPI) provides a more flexible and powerful way to perform storage
management tasks than the HPE 3PAR Command Line Interface (CLI) or the HPE 3PAR OS
Management Console software. Use WSAPI to automate your management tasks for hosts, ports,
volumes, and more.
WSAPI uses the HTTPS protocol to enable programmatic management of 3PAR storage servers, and
provides client access to web services at specified HTTPS locations. Clients communicate with the
WSAPI server using HTTPS methods and data structures represented with JSON.
You can use WSAPI with a series of HTTP or HTTPS requests to automate and manage many tasks. For
security reasons, Hewlett Packard Enterprise recommends using HTTPS.
Because HTTP/1.0 does not support chunked transfer encoding, the WSAPI server does not support
HTTP/1.0. If an HTTP/1.0 request comes in, the WSAPI server generates the following error message,
indicating an unsupported HTTP version: UNSUP_HTTP

Starting and configuring the WSAPI server
WSAPI uses HPE 3PAR CLI commands to start, configure, and modify the WSAPI server.
For more information about using the CLI, see:
•

HPE 3PAR Command Line Interface Administrator Guide

•

HPE 3PAR Command Line Interface Reference

For more information, see http://www.hpe.com/info/storage/docs/

Starting the WSAPI server
The WSAPI server does not start automatically.
Using the CLI, enter startwsapi to manually start the WSAPI server.

Configuring the WSAPI server
To configure WSAPI, enter setwsapi in the CLI.

Basic CLI commands for WSAPI server Configuration
Command

Description

removewsapisession

Removes the WSAPI user connections from the current system.

setwsapi

Sets properties of the Web Services API server, including options to
enable or disable the HTTP and HTTPS ports.

showwsapi

Displays the WSAPI server service configuration state as either
Enabled or Disabled. It displays the server current running status as
Active, Inactive, or Error. It also displays the status of the HTTP and
HTTPS ports and their port numbers. WSAPI server URL is also
displayed.
Table Continued

14

HPE 3PAR Web Services API 1.6.3

Command

Description

showwsapisession

Displays the WSAPI server sessions connection information, including
the id, node, username, role, hostname, and IP Address of the
connecting client. It also displays the session creation time and
session type.

startwsapi

Starts the Web Services API server to service HTTP and HTTPS
requests. By default, the Web Services API server is not started until
this command is issued.

statwsapi

Shows Web Services API (wsapi) server statistics.

stopwsapi

Stops the Web Services API server from servicing HTTP and HTTPS
requests.

NOTE: The HPE 3PAR StoreServ Storage PowerShell Toolkit also has the cmdlets for starting and
configuring the WSAPI server, so user have a choice to Start and configure the WSAPI server either from
CLI or from PowerShell Toolkit.
Following are the HPE 3PAR StoreServ Storage PowerShell Toolkit Cmdlets for starting and configuring
the WSAPI server:
•

Stop-3parWsapi

•

Start-3parWsapi

•

Get-3parWsapi

•

Get-3parWsapiSession

•

Set-3PARWsapi

•

Remove-3PARWsapiSession

HPE 3PAR Web Services API 1.6.3

15

Importing HPE 3PAR StoreServ Storage
PowerShell Toolkit
Supported Host operating systems and HPE 3PAR
PowerShell versions
HPE 3PAR StoreServ Storage PowerShell Toolkit works with HPE 3PAR PowerShell Toolkit 3.0 and later.
You can use this Toolkit in the following environments:
•

Windows 2019

•

Windows Server 2016

•

Windows Server 2012 R2

•

Windows Server 2012

•

Windows Server 2008 R2 SP1

•

Windows Server 2008 R2

•

Windows Server 2008 SP1

•

Windows 10

•

Windows 8

•

Windows 7 SP1

•

Windows 7

Supported HPE 3PAR StoreServ Storage Platforms
Supported HPE 3PAR StoreServ Storage platforms are:
HPE 3PAR StoreServ 7000, 8000, 10000, and 20000 series.
Supported firmware for HPE 3PAR StoreServ Storage are:
•

3.3.1 (MU1, MU2, MU3 & MU4)
NOTE: Only CLI-based cmdlets are qualified with 3.3.1 MU4 and WSAPI-based cmdlets are qualified
until 3.3.1 MU3.

•

3.3.1 (MU1, MU2, and MU3)

•

3.2.2 (including all MUs)

•

3.2.1 (including all MUs)

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit
Prerequisites

16

•

Ensure that PowerShell v3.0 or later and .NET Framework 4.0 or later is available on your system.

•

Ensure one among the following software is installed for establishing a Secure Shell connection:

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit

◦

HPE 3PAR StoreServ CLI client

◦

Open-source POSH SSH Module

NOTE: The HPE 3PAR StoreServ Storage PowerShell Toolkit is provided as a compressed package.
Procedure
1. Unzip the package and copy the folder HPE3PARPSToolkit to a location. For example, C:\Home
\Projects\HPE3PARPSToolkit
2. Install the HPE 3PAR StoreServ Storage CLI software, to use HPE 3PAR StoreServ Storage CLI to
establish a secure connection.
3. Install the POSH SSH module, to use POSH SSH module to establish a secure connection.
For more information on installing the POSH SSH module, see Installation of POSH SSH module.
4. Configure WSAPI server to establish a secure connection for HPE 3PAR Web Service API Cmdlets.
For more information on installing WASAPI server module, see Starting and configuring the WSAPI
server .
5. Open an interactive PowerShell console.
6. Navigate to the location where HPE3PARPSToolkit is saves.
For example, PS C:>cd C:\Home\PSToolkit\HPE3PARPSToolkit and press Enter.
7. Import the HPE3PARPSToolkit v2.2 to the supported Windows host that contains two modules:
•

HPE3PARPSToolkit-CLI: Support HPE 3PAR StoreServ CLI client and POSH SSH Module.

•

HPE3PARPSToolkit-WSAPI: Support HPE 3PAR Web Service API Cmdlets.

You can import either one or both the modules.
Example: Importing a single module
PS C:\Home\PSToolkit\HPE3PARPSToolkit> Import-Module .\HPE3PARPSToolkitCLI.psm1
Example: Importing both modules
PS C:\Home\PSToolkit\HPE3PARPSToolkit> Import-Module .\HPE3PARPSToolkitCLI.psm1
PS C:\Home\PSToolkit\HPE3PARPSToolkit> Import-Module .\HPE3PARPSToolkitWSAPI.psm1
8. Navigate to the location where HPE3PARPSToolkit is saved to view the log file.
For example, HPE3PARPSToolkit location is C:\Home\PSToolkit\HPE3PARPSToolkit then the
log life location is C:\Home\PSToolkit\Log.

Installation of POSH SSH module
POSH SSH module is hosted on GitHub at: http://github.com/darkoperator/Posh-SSH

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit

17

Prerequisites
PowerShell 3.0 and .NET Framework 4.0
Procedure
Run the command: iex (New-Object Net.WebClient).DownloadString("https://
gist.github.com/darkoperator/6152630/raw/
c67de4f7cd780ba367cccbc2593f38d18ce6df89/instposhsshdev")
This command downloads and installs the latest version of Posh-SSH. After the download is complete
and the module is copied, the available commands are listed.
For more information, see http://www.powershellmagazine.com/2014/07/03/posh-ssh-open-sourcessh-powershell-module/

Using session variable
You can use session variable for session management in HPE 3PAR StoreServ Storage PowerShell
Toolkit 2.2. You can use different sessions and execute cmdlets on one or multiple HPE 3PAR StoreServ
Storage devices using same or different user credentials.
Procedure
1. Create the connection object to the array, save the connection object into a variable.
2. Create the sessions as required on same or different arrays. For each session, save the connection
object into a variable.
NOTE: Create multiple sessions to one array with different credentials. Creating multiple sessions to
same array using same credentials is not allowed.
3. Run the cmdlets using required connection object.
$Connection1 = New-3ParPoshSshConnection -SANIPAddress 1.2.3.4 -SANUserName
ABC
Creates session to 1.2.3.4
$Connection2 = New-3ParPoshSshConnection -SANIPAddress 1.1.1.1 -SANUserName
ZYX
Creates session to 1.1.1.1
Get-3parVersion -SANConnection $Connection1
Cmdlet is run on array 1.2.3.4.
Get-3parVersion -SANConnection $Connection2
Cmdlet is run on array 1.1.1.1.
4. Run the WASAPI cmdlets using required connection object.
$Connection1 = 3PARWSAPIConnection -SANIPAddress 1.2.3.4 -SANUserName ABC
Creates session to 1.2.3.4
$Connection2 = New-3PARWSAPIConnection -SANIPAddress 1.1.1.1 -SANUserName
ZYX
Creates session to 1.1.1.1
Get-3parVersion_WASAPI -SANConnection $Connection1
Cmdlet is run on array 1.2.3.4.

18

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit

Get-3parVersion_WASAPI -SANConnection $Connection2
Cmdlet is run on array 1.1.1.1

Importing HPE 3PAR StoreServ Storage PowerShell Toolkit

19

HPE 3PAR PowerShell ToolKit CLI cmdlets
quick reference
Cmdlets help
Symbol

Meaning

[]

Indicates optional items.

<>

Indicates a value that you define.

|

Separates mutually exclusive choices. Type one of
the choices.

•

To get list of cmdlets offered by HPE 3PAR StoreServ Storage PowerShell Toolkit, run:
PS C:\> Get-3parCmdList

•

To get cmdlet specific help, run:
PS C:\> Get-Help 

•

To get cmdlet specific help using the -full option, run:
PS C:\> Get-Help  -full

NOTE: Toolkit command and parameter names are case insensitive, but parameter values are case
sensitive.

Connection management cmdlet
cmdlet

Description

For details, see

New-3ParPoshSshConnection

Builds a SAN connection object using
Posh SSH connection.

New-3ParPoshSshConnec
tion

New-3parCLIConnection

Builds a SAN connection object using
HPE 3PAR CLI.

New-3parCLIConnection

Set-3parPoshSshConnectionPa Creates an encrypted password file on
sswordFile
client machine.

Set-3parPoshSshConnect
ionPasswordFile

Set-3parPoshSshConnectionUs Creates a SAN Connection object using
ingPasswordFile
Encrypted password file.

Set-3parPoshSshConnect
ionUsingPasswordFile

CPG management cmdlet

20

cmdlet

Description

For details, see

New-3parCPG

Creates a new CPG.

New-3parCPG

Get-3parCPG

Displays a list of CPGs.

Get-3parCPG

Remove-3parCPG

Removes a CPG.

Remove-3parCPG

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

Disk Enclosure management cmdlets
cmdlet

Description

For details, see

Approve-3parPD

Creates physical disk definitions
to enable the use of disks.

Approve-3parPD

Test-3parPD

Executes surface scans or
diagnostics on physical disks.

Test-3parPD

Find-3parCage

Allows system administrators to
locate a drive cage, drive
magazine, or port in the system
using the device blinking LEDs.

Find-3parCage

Set-3parCage

Enables service personnel to set
or modify parameters for a drive
cage.

Set-3parCage

Set-3parPD

Marks a PD as allocatable or non Set-3parPD
allocatable for LDs.

Get-3parCage

Displays information about drive
cages.

Get-3parCage

Get-3parPD

Displays configuration
information about the PDs
(physical disks) on a system.

Get-3parPD

cmdlet

Description

For details, see

Join-3parFed

Makes the StoreServ system a
member of the Federation
identified by the specified name
and UUID.

Join-3parFed

New-3parFed

Generates a UUID for the named New-3parFed
Federation and makes the
StoreServ system a member of
that Federation.

Remove-3parFed

Removes the StoreServ system
from Federation membership.

Set-3parFed

Modifies name, comment, or key/ Set-3parFed
value attributes of the Federation
of which the StoreServ system is
member.

Show-3parFed

Displays the name, UUID, and
comment of the Federation of
which the StoreServ system is
member.

Federation cmdlets

Remove-3parFed

Show-3parFed

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

21

FBO cmdlets
cmdlet

Description

For details, see

Start-3parFSNDMP

Starts both NDMP service
and ISCSI service.

Start-3parFSNDMP

Stop-3parFSNDMP

Stops both NDMP service
and ISCSI service.

Stop-3parFSNDMP

Help cmdlet
cmdlet

Description

For details, see

Get-3parCmdList

Gets a list of HPE 3PAR
StoreServ PowerShell cmdlets.

Get-3parCmdList

Get-Help/Help

Displays help for respective
command.

Help cmdlet

Host and Host Set management cmdlets
cmdlet

Description

For details, see

New-3parHost

Creates a new host.

New-3parHost

Get-3parHost

Lists all hosts.

Get-3parHost

New-3parHostSet

Creates a new host set.

New-3parHostSet

Get-3parHostSet

Gets a list of host set information. Get-3parHostSet

Remove-3parHostSet

Removes a host set or remove
hosts from an existing set.

Remove-3parHostSet

Remove-3parHost

Creates a new host.

Remove-3parHost

Set-3parHost

Adds WWN or iSCSI name to an
existing host.

Set-3parHost

Node subsystem management cmdlet
cmdlet

Description

For details, see

Get-3parSystem

Displays the HPE 3PAR
StoreServ Storage system
information.

Get-3parSystem

Ping-3parRCIPPorts

Verifies that the Servers Are
Connected.

Ping-3parRCIPPorts

Show-3parISCSISession

Displays the iSCSI sessions.

Show-3parISCSISession

Show-3pariSCSISessionStatistics Displays the iSCSI session
statistics.

Show
3pariSCSISessionStatistics

Show-3pariSCSIStatistics

Show-3pariSCSIStatistics

Displays the iSCSI statistics.

Table Continued

22

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

Show-3parPortARP

Displays the ARP table for iSCSI
ports in the system.

Show-3parPortARP

Show-3parPortISNS

Displays iSNS host information
for iSCSI ports in the system.

Show-3parPortISNS

Performance management cmdlets
cmdlet

Description

For details, see

Compress-3parVV

Changes the properties of a
virtual volume.

Compress-3parVV

Get-3parHistChunklet

Displays a histogram of service
times in a timed loop for
individual chunklets.

Get-3parHistChunklet

Get-3parHistLD

Displays a histogram of service
Get-3parHistLD
times for LDs (Logical Disks) in a
timed loop.

Get-3parHistPD

Displays a histogram of service
times for Physical Disks (PDs).

Get-3parHistPD

Get-3parHistPort

Displays a histogram of service
times for ports within the system.

Get-3parHistPort

Get-3parHistRCopyVV

Displays a histogram of total
Remote-copy service times and
backup system remote-copy
service times in a timed loop.

Get-3parHistRCopyVV

Get-3parHistVLUN

Displays VLUN (Virtual Volume
Logical Unit Number) service
time histograms.

Get-3parHistVLUN

Get-3parHistVV

Displays Virtual Volume (VV)
service time histograms in a
timed loop.

Get-3parHistVV

Get-3parStatChunklet

Displays chunklet statistics in a
timed loop.

Get-3parStatChunklet

Get-3parStatCMP

Displays CMP (Cache Memory
Page) statistics by node or by
Virtual Volume.

Get-3parStatCMP

Get-3parStatCPU

Displays CPU statistics for all
nodes.

Get-3parStatCPU

Get-3parStatLD

Displays read/write (I/O) statistics Get-3parStatLD
for LDs in a timed loop.

Get-3parStatLink

Displays statistics for link
utilization for all nodes in a timed
loop.

Get-3parStatLink

Get-3parStatPD

Displays the read/write (I/O)
statistics for physical disks in a
timed loop.

Get-3parStatPD

Table Continued

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

23

Get-3parStatPort

Displays read/write (I/O) statistics Get-3parStatPort
for ports.

Get-3parStatRCVV

Displays statistics for remotecopy volumes in a timed loop.

Get-3parStatRCVV

Get-3parStatVLUN

Displays statistics for VVs and
LUN host attachments.

Get-3parStatVlun

Get-3parStatVV

Displays statistics for VVs.

Get-3parStatVV

Set-3parstatch

Sets the statistics collection
Set-3parstatch
mode for all in-use chunklets on a
Physical Disk (PD).

Set-3parStatpdch

Starts and stops the statistics
collection mode for chunklets.

Set-3parStatpdch

Physical copy management cmdlets
cmdlet

Description

For details, see

New-3parVVCopy

Creates a full physical copy of a
virtual volume or a read/write
virtual copy on another virtual
volume.

New-3parVVCopy

New-3parGroupVVCopy

Creates consistent group of
physical copies of a list of virtual
volumes.

New-3parGroupVVCopy

Push-3parVVCopy

Promotes a physical copy back to Push-3parVVCopy
a regular base volume.

Port management cmdlets

24

cmdlet

Description

For details, see

Get-3parFCPorts

Sends a query HPE 3PAR
StoreServ to get FC ports.

Get-3parFCPorts

Get-3parFCPortsToCSV

Sends a query HPE 3PAR
StoreServ to get FC ports.

Get-3parFCPortsToCSV

Set-3parFCPorts

Configures HPE 3PAR StoreServ Set-3parFCPorts
FC ports.

Get-3parHostPorts

Sends a query HPE 3PAR
StoreServ to get all ports
includingtargets,disks, and RCIP
ports.

Get-3parHostPorts

Set-3parHostPorts

Configures settings of the HPE
3PAR StoreServ array.

Set-3parHostPorts

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

Replication cmdlets
cmdlet

Description

For details, see

Add-3parRcopytarget

Adds a target to a remote-copy
volume group.

Add-3parRcopytarget

Add-3parRcopyVV

Adds an existing virtual volume to Add-3parRcopyVV
an existing remote copy volume
group.

Approve-3parRCopyLink

Adds one or more links
(connections) to a remote-copy
target system.

Approve-3parRCopyLink

Disable-3ParRcopylink

Removes one or more links.

Disable-3ParRcopylink

Disable-3ParRcopytarget

Removes a remote copy target
from a remote copy volume
group.

Disable-3ParRcopytarget

Disable-3ParRcopyVV

Removes a virtual volume from a Disable-3ParRcopyVV
remote copy volume Group.

Get-3parRCopy

Displays remote-copy
configuration information.

Get-3parRCopy

Get-3parStatRCopy

Displays statistics for remotecopy volume groups.

Get-3parStatRCopy

New-3parRCopyGroup

Command creates a remote-copy New-3parRCopyGroup
volume group.

New-3parRCopyGroupCPG

Command creates a remote-copy New-3parRCopyGroupCPG
volume group.

New-3parRCopyTarget

Command creates a remote-copy New-3parRCopyTarget
target definition.

Remove-3parRCopyTargetFrom
Group

Removes a remote-copy target
from a remote-copy volume
group.

Remove-3parRCopyVVFromGro
up

Removes a virtual volume from a Remove-3parRCopyVVFromGr
remote-copy volume group.
oup

Remove-3parRCopyGroup

Removes a remote-copy volume
group or multiple remote-copy
groups that match a given
pattern.

Remove-3parRCopyTarget

Removes target designation from Remove-3parRCopyTarget
a remote-copy system and
removes all links affiliated with
that target definition.

Set-3parRCopyGroupPeriod

Sets a resynchronization period
for volume groups in
asynchronous periodic mode.

Remove-3parRCopyTargetFro
mGroup

Remove-3parRCopyGroup

Set-3parRCopyGroupPeriod

Table Continued

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

25

Set-3parRCopyGroupPol

Sets the policy of the remotecopy volume group for dealing
with I/O failure and error
handling.

Set-3parRCopyGroupPol

Set-3parRCopyTargetName

Changes the name of the
indicated target.

Set-3parRCopyTargetName

Set-3parRCopyTarget

Changes the name of the
indicated target using the  specifier.

Set-3parRCopyTarget

Set-3parRCopyTargetPol

Sets the policy for the specified
target using the 
specifier.

Set-3parRCopyTargetPol

Set-3parRCopyTargetWitness

Changes the name of the
indicated target.

Set-3parRCopyTargetWitness

Show-3ParRcopyTransport

Shows status and information
about end-to-end transport for
Remote Copy in the system.

Show-3ParRcopyTransport

Start-3parRcopy

Starts the Remote Copy Service.

Start-3parRcopy

Start-3parRCopyGroup

Enables remote copy for the
specified remote-copy volume
group.

Start-3parRCopyGroup

Stop-3parRCopy

Disables the remote-copy
functionality for any started
remote-copy.

Stop-3parRCopy

Stop-3parRCopyGroup

Stops the remote-copy
functionality for the specified
remote-copy volume group.

Stop-3parRCopyGroup

Sync-3parRCopy

Synchronizes remote-copy
volume groups.

Sync-3parRCopy

SyncRecover3ParDRRcopyGroup

Performs data synchronization
and recovery operation.

SyncRecover3ParDRRcopyGroup

Test-3parRcopyLink

Performs a connectivity, latency,
and throughput test between two
connected HPE 3PAR storage
systems.

Test-3parRcopyLink

Software version cmdlet

26

cmdlet

Description

For details, see

Get-3parVersion

Gets HPE 3PAR StoreServ
Storage system software version
information.

Get-3parVersion

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

Sparing cmdlets
cmdlet

Description

For details, see

New-3parSpare

Allocates chunklet resources as
spares.

New-3parSpare

Push-3parChunklet

Moves a list of chunklets from
one physical disk to another.

Push-3parChunklet

Push-3parChunkletToSpare

Moves data from specified PDs to Push-3parChunkletToSpare
a temporary location selected by
the system.

Push-3parPD

Moves data from specified PDs to Push-3parPD
a temporary location selected by
the system.

Push-3parPDToSpare

Moves data from specified PDs to Push-3parPDToSpare
a temporary location selected by
the system.

Push-3parRelocPD

Moves chunklets that were on a
physical disk to the target of
relocation.

Push-3parRelocPD

Remove-3parSpare

Removes chunklets from the
spare chunklet list.

Remove-3parSpare

Get-3parSpare

Displays information about
chunklets in the system that are
reserved for spares.

Get-3parSpare

System management cmdlets
cmdlet

Description

For details, see

Get-3parSR

Displays the amount of space
Get-3parSR
consumed by the various System
Reporter databases on the
System Reporter volume.

Start-3parSR

Starts 3par System reporter.

Start-3parSR

Stop-3parSR

Stops 3par System reporter.

Stop-3parSR

System Reporter cmdlets
cmdlet

Description

For details, see

Get-3parSpace

Displays estimated free space for Get-3parSpace
logical disk creation.

Get-3parSystemInformation

Command displays the 3PAR
Storage system information.

Get-3parSystemInformation
Table Continued

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

27

Get-3parSRAlertCrit

Displays the criteria that System
Reporter evaluates to determine
if a performance alert should be
generated.

Get-3parSRAlertCrit

Get-3parSRAOMoves

Displays the space that AO has
moved between tiers.

Get-3parSRAOMoves

Get-3parSRCPGSpace

Displays historical space data
reports for common provisioning
groups (CPGs).

Get-3parSRCPGSpace

Get-3parSRHistLD

Displays historical histogram
performance data reports for
logical disks.

Get-3parSRHistLD

Get-3parSRHistPD

Displays historical histogram
performance data reports for
physical disks.

Get-3parSRHistPD

Get-3parSRHistPort

Displays historical histogram
performance data reports for
ports.

Get-3parSRHistPort

Get-3parSRHistVLUN

Displays historical histogram
performance data reports for
VLUNs.

Get-3parSRHistVLUN

Get-3parSRLDSpace

Displays historical space data
reports for LDs.

Get-3parSRLDSpace

Get-3parSRPDSpace

Displays historical space data
reports for PDs.

Get-3parSRPDSpace

Get-3parSRStatCache

Displays historical performance
data reports for flash cache and
data cache.

Get-3parSRStatCache

Get-3parSRStatCMP

Displays historical performance
data reports for cache memory.

Get-3parSRStatCMP

Get-3parSRStatCPU

Displays historical performance
data reports for CPUs.

Get-3parStatCPU

Get-3parSRStatLD

Displays historical performance
data reports for logical disks.

Get-3parSRStatLD

Get-3parSRStatPD

Displays system reporter
performance reports for PDs.

Get-3parSRStatPD

Get-3parSRStatPort

Displays system reporter
performance reports for ports.

Get-3parSRStatPort

Get-3parSRStatVLUN

Displays historical performance
data reports for VLUNs.

Get-3parSRStatVLUN

Get-3parSRVVSpace

Displays historical performance
data reports for VVs.

Get-3parSRVVSpace
Table Continued

28

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

New-3parSRAlertCrit

Creates a criterion that System
Reporter evaluates to determine
if a performance alert should be
generated.

New-3parSRAlertCrit

Remove-3parSRAlertCrit

Removes a criterion that System
Reporter evaluates to determine
if a performance alert should be
generated.

Remove-3parSRAlertCrit

Set-3parSRAlertCrit

Enables or disables a System
Reporter alert criterion.

Set-3parSRAlertCrit

Show-3parSRStatIscsi

Displays historical performance
data reports for iSCSI ports.

Show-3parSRStatIscsi

Show-3parSRSTATISCSISession Displays historical performance
data reports for iSCSI sessions.

Show-3parSRSTATISCSISessio
n

Task management cmdlet
cmdlet

Description

For details, see

Get-3parTask

Displays tasks information.

Get-3parTask

User management cmdlets
cmdlet

Description

For details, see

Close-3PARConnection

Session Management Command
to close the connection.

Close-3PARConnection

Get-3parUserConnection

Displays information about users
who are currently connected.

Get-3parUserConnection

Get-ConnectedSession

Display Current session detail.

Get-ConnectedSession

cmdlet

Description

For details, see

Get-3ParVVolSC

Displays VVol storage containers, Get-3ParVVolSC
used to contain VMware Volumes
for Virtual Machines (VVols).

Set-3ParVVolSC

Create and remove storage
containers for VMware Virtual
Volumes (VVols).

Set-3ParVVolSC

Show-3ParVVolum

Displays information about all
virtual machines (VVol-based) or
a specific virtual machine in a
system.

Show-3ParVVolum

VASA cmdlets

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

29

Virtual Copy (Snapshot) Management cmdlets
cmdlet

Description

For details, see

New-3parSnapVolume

Creates a point in time
(snapshot) copy of a virtual
volume.

New-3parSnapVolume

Push-3parGroupSnapVolume

Copies the differences of
snapshots back to their base
volumes.

Push-3parGroupSnapVolume

Push-3parSnapVolume

Copies the differences of a
Push-3parSnapVolume
snapshot back to its base
volume, allowing you to revert the
base volume to an earlier point in
time.

Virtual LUN management cmdlets
cmdlet

Description

For details, see

New-3parVLUN

Creates a new vLUN and
presents it to a host.

New-3parVLUN

Get-3parVLUN

Gets a list of LUNs that are
exported or presented to hosts.

Get-3parVLUN

Remove-3parVLUN

Unpresents virtual volumes.

Remove-3parVLUN

Virtual Volume and Virtual Volume Set Management
cmdlets
cmdlet

Description

For details, see

Add-3parVV

Creates and admits remotely
Add-3parVV
exported virtual volume
definitions to enable the migration
of these volumes.

Get-3parVV

Gets a list of virtual volumes per
domain and CPG.

Get-3parVV

Get-3parVVSet

Gets a list of virtual volume sets
defined on the storage system
and their members.

Get-3parVVSet

Get-3parVVList

Gets a list of virtual volumes.

Get-3parVVList

Import-3parVV

Starts migrating the data from a
remote LUN to the local HPE
3PAR Storage System.

Import-3parVV

New-3parVV

Creates a virtual volume.

New-3parVV

New-3parVVSet

Creates a new volume set.

New-3parVVSet
Table Continued

30

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

Show-3parPeer

Displays the arrays connected
through the host ports or peer
ports over the same fabric.

Show-3parPeer

Set-3parVV

Updates a snapshot virtual
volume with a new snapshot.

Set-3parVV

Remove-3parVVSet

Removes a virtual volume set or
removes virtual volumes from an
existing set.

Remove-3parVVSet

Remove-3parVV

Deletes a virtual volume.

Remove-3parVV

Test-3parVV

Command executes validity
checks of VV administration
information.

Test-3parVV

Update-3parVV

Increases the size of a virtual
volume.

Update-3parVV

HPE 3PAR PowerShell ToolKit CLI cmdlets quick reference

31

HPE 3PAR PowerShell ToolKit CLI cmdlets
Add cmdlets
For more details execute Get-Help "Command Name" with Full Option.

Add-3parRcopytarget
Syntax
Add-3parRcopytarget [-Target_name]  [-Mode]  [-Group_name]
 [[-SANConnection] ] []
Description
Adds a target to a remote-copy volume group.
Parameters
Target_name
Specifies the name of the target that is created with the creatercopytarget command.
Mode
Specifies the mode of the target as synchronous (sync), asynchronous periodic (periodic), or
asynchronous streaming (async).
Group_name
Specifies the name of the existing remote copy volume group created with the creatercopygroup
command to which the target is added.
Example
C:\PS>Add-3parRcopytarget -Target_name XYZ -Mode sync -Group_name TEST
Admits physical disks.

Add-3parRcopyVV
Syntax
Add-3parRcopyVV [[-Pat]] [[-CreateVV]] [[-NoWWN]] [[-NoSync]] [SourceVolumeName]  [[-Snapname] ] [-Group_name]  [Target_name]  [-TargetVolumeName]  [[-SANConnection]
] []
Description
Adds an existing virtual volume to an existing remote copy volume group.
Parameters
Pat
Specifies that the  is treated as a glob-style pattern and that all remote copy volumes
matching the specified pattern are admitted to the remote copy group.
Createvv
Specifies that the secondary volumes should be created automatically.

32

HPE 3PAR PowerShell ToolKit CLI cmdlets

NoWNN
When used with -CreateVV, it ensures a different WWN is used on the secondary volume. Without
this option -CreateVV will use the same WWN for both primary and secondary volumes.
NoSync
Specifies that the volume should skip the initial sync.
SourceVolumeName
Specifies the name of the existing virtual volume to be admitted to an existing remote copy volume
group that was created with the creatercopygroup command.
Snapname
An optional read-only snapshot  can be specified along with the virtual volume name
.
Group_name
Specifies the name of the existing remote copy volume group created with the creatercopygroup
command, to which the volume will be added.
Target_name
The target name associated with this group, as set with the creatercopygroup command. The
target is created with the creatercopytarget command.
TargetVolumeName
The target name associated with this group, as set with the creatercopygroup command.
Examples
C:\PS> Add-3parRcopyVV -SourceVolumeName XXXX -Group_name ZZZZ -Target_name TestTarget -TargetVolumeName YYYY
C:\PS> Add-3parRcopyVV -SourceVolumeName XXXX -Snapname snp -Group_name ZZZZ -Target_name TestTarget -TargetVolumeName YYYY
C:\PS> Add-3parRcopyVV -SourceVolumeName XXXX -Snapname snp -Group_name AS_TEST -Target_name CHIMERA03 -TargetVolumeName YYYY

C:\PS> Add-3parRcopyVV -Pat -SourceVolumeName XXXX -Group_name ZZZZ -Target_name TestTarget -TargetVolumeName YYYY
C:\PS> Add-3parRcopyVV -CreateVV -SourceVolumeName XXXX -Group_name ZZZZ -Target_name TestTarget -TargetVolumeName YYYY

C:\PS> Add-3parRcopyVV -NoWWN -SourceVolumeName XXXX -Group_name ZZZZ -Target_name TestTarget -TargetVolumeName YYYY

NOTE: For More information, execute Get-Help "Command Name" with Full Option.

Add-3parVV
Syntax
Add-3parVV [[-DomainName] ] [[-VV_WWN] ] [[-VV_WWN_NewWWN]
] [[-SANConnection] ] []
Description
Creates and admits remotely exported virtual volume definitions to enable the migration of these volumes.
Parameters
DomainName
Creates the admitted volume in the specified domain.
VV_WWN
Specifies the World Wide Name (WWN) of the remote volumes to be admitted.

HPE 3PAR PowerShell ToolKit CLI cmdlets

33

VV_WWN_NewWWN
Specifies the World Wide Name (WWN) for the local copy of the remote volume.
Examples
C:\PS> Add-3parVV -VV_WWN XYZ
C:\PS> Add-3parVV -DomainName XYZ -VV_WWN XYZ
NOTE: For More information, execute Get-Help "Command Name" with Full Option.

Approve cmdlets
Approve-3parPD
Syntax
Approve-3parPD [[-Nold]] [[-NoPatch]] [[-wwn] ] [[-SANConnection]
] []
Description
Creates and admits physical disk definitions to enable the use of disks.
Parameters
Nold
Do not use the PD (as identified by the  specifier) for logical disk allocation.
Nopatch
Suppresses the check for drive table update packages for new hardware enablement.
wwn
Indicates the World-Wide Name (WWN) of the physical disk to be admitted. If WWNs are specified,
only one or more specified physical disks are admitted.
Examples
C:\PS>Approve-3parPD
Admits physical disks.
C:\PS>Approve-3parPD -wwn xxx
C:\PS>

Approve-3parPD -Nold

C:\PS> Approve-3parPD -Nold -wwn xxx
C:\PS> Approve-3parPD -NoPatch
C:\PS> Approve-3parPD -NoPatch -wwn xxx
NOTE: For More information, execute Get-Help Command Name with Full Option.

Approve-3parRCopyLink
Syntax
Approve-3parRCopyLink [[-TargetName] ] [[-N_S_P_IP] ] [[N_S_P_WWN] ] [[-SANConnection] ] []

34

HPE 3PAR PowerShell ToolKit CLI cmdlets

Description
Adds one or more links, connections, to a Remote Copy target system.
Parameters
TargetName
Specifies the name of the target to be updated.
N_S_P_IP
Specifies the node number, slot number, port Number, and IP address of the target to be created.
N_S_P_WWN
Specifies the node number, slot number, port Number, and WWN address of the target to be created.
Examples
C:\PS> Approve-3parRCopyLink

-TargetName demo1 -N_S_P_IP 1:2:1:193.1.2.11

This Example adds a link on System2 using the node, slot, and port information of node 1, slot 2, port 1 of
the Ethernet port on the primary system. The IP address 193.1.2.11 specifies the address on the target
system:
C:\PS> Approve-3parRCopyLink

-TargetName System2 -N_S_P_WWN 5:3:2:1122112211221122

This Example WWN creates an RCFC link to target System2, which connects to the local 5:3:2 (N:S:P) in
the target system.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Compress cmdlets
Compress-3parVV
Syntax
Compress-3parVV [-SUBCommand]  [-VVName]  [[-CPGName]
] [[-WaitTask]] [[-DryRun]] [[-Count] ] [[-TPVV]] [[-TDVV]]
[[-DeDup]] [[-Full]] [[-Compr]] [[-KeepVV] ] [[-Threshold] ]
[[-SliceSize] ] [[-Src_Cpg] ] [[-SANConnection] ]
[]
Description
The Compress-3parVV command is used to change the properties of a virtual volume that was created
with the Create VV command by associating it with a different CPG.
Parameters
CPGName
Indicates that only regions of the VV which are part of the specified CPG need to be tuned to the
destination USR or SNP CPG.
VVName
Specifies the name of the existing virtual volume.
WaitTask
Specifies that the command will wait for any created tasks to complete.

HPE 3PAR PowerShell ToolKit CLI cmdlets

35

DryRun
Specifies that the command is a dry run and that no logical disks or virtual volumes are tuned.
Count
Specifies the number of identical virtual volumes to tune using an integer from 1 through 999.
TPVV
Indicates that the VV should be converted to a thin provision virtual volume..
TDVV
This option is deprecated, see -DeDup.
DeDup
Indicates that the VV should be converted to a thin provision virtual volume that shares logical disk
space with other instances of this volume type. Cannot be used with the -tpvv or -full options.
Full
Indicates that the VV should be converted to a fully provisioned virtual volume.
Compr
Indicates that the VV should be converted to a compressed virtual volume.
KeepVV
Indicates that the original logical disks should be saved under a new virtual volume with the given
name
Src_Cpg
Indicates that only regions of the VV which are part of the specified CPG should be tuned to the
destination USR or SNP CPG.
Threshold
Slice threshold. Volumes above this size will be tuned in slices. must be in multiples of
128GiB. Minimum is 128GiB.Default is 16TiB. Maximum is 16TiB.
SliceSize
Size of slice to use when volume size is greater than .  must be in multiples of
128GiB. Minimum is 128GiB. Default is 2TiB. Maximum is 16TiB.
Example
C:\PS> Compress-3parVV -SUBCommand usr_cpg -CPGName xxx -VVName zzz
C:\PS> Compress-3parVV -SUBCommand usr_cpg -CPGName xxx

-DryRun -VVName zzz

C:\PS> Compress-3parVV -SUBCommand snp_cpg -CPGName xxx -VVName zzz
C:\PS> Compress-3parVV -SUBCommand restart -CPGName xxx

C:\PS> Compress-3parVV -SUBCommand rollback -CPGName xxx

-WaitTask -VVName zzz

-DryRun -VVName zzz

NOTE: For more information, execute Get-Help Command Name with Full Option.

Close cmdlets

36

HPE 3PAR PowerShell ToolKit CLI cmdlets

Close-3PARConnection
Syntax
Close-3PARConnection [[-SANConnection] ] []
Description
Closes the connection. This command is the Session Management Command to close the connection.
Examples
C:\PS> Close-3PARConnection
NOTE: For more information, execute Get-Help Command Name with Full Option.

Disable cmdlets
Disable-3ParRcopylink
Syntax
Disable-3ParRcopylink [[-RCIP]] [[-RCFC]] [[-Target_name] ] [[NSP_IP_address] ] [[-NSP_WWN] ] [[-SANConnection] ]
[]
Description
Removes one or more links.
Parameters
RCIP
Syntax for remote copy over IP (RCIP)
RCFC
Syntax for remote copy over FC (RCFC)
Target_name
The target name, as specified with the creatercopytarget command.
NSP_IP_address
The node, slot, and port information of the Ethernet port on the local system and an IP address of the
peer port on the target system.
NSP_WWN
The node, slot, and port information of the Fibre Channel port on the local system and World Wide
Name (WWN) of the peer port on the target system.
Examples
C:\PS> Disable-3ParRcopylink -RCIP -Target_name test -NSP_IP_address 1.1.1.1
C:\PS> Disable-3ParRcopylink -RCFC -Target_name test -NSP_WWN 1245
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

HPE 3PAR PowerShell ToolKit CLI cmdlets

37

Disable-3ParRcopytarget
Syntax
Disable-3ParRcopytarget [[-Target_name] ] [[-Group_name] ]
[[-SANConnection] ] []
Description
Removes a remote copy target from a remote copy volume group.
Parameters
Target_name
The name of the target to be removed.
Group_name
The name of the group that currently includes the target.
Examples
C:\PS> Disable-3ParRcopytarget -Target_name Test -Group_name Test2
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Disable-3ParRcopyVV
Syntax
Disable-3ParRcopyVV [[-option] ] [[-VV_name] ] [[-Group_name]
] [[-SANConnection]] []
Description
Removes a virtual volume from a Remote Copy volume group.
Parameters
Pat
Specifies that specified patterns are treated as glob-style patterns and all Remote Copy volumes
matching the specified pattern will be dismissed from the Remote Copy group. This option must be
used if the  specifier is used.
KeepSnap
Specifies that the resync snapshot of the local volume must be retained.
RemoveVV
Removes the volumes of remote side.
VV_name
Specifies the name of the volume to be removed. Volumes are added to a group with the
admitrcopyvv command.
Group_name
Specifies the name of the group that currently includes the target.

38

HPE 3PAR PowerShell ToolKit CLI cmdlets

Examples
C:\PS> Disable-3ParRcopyVV -VV_name XYZ -Group_name XYZ
C:\PS> Disable-3ParRcopyVV -Pat -VV_name XYZ -Group_name XYZ
C:\PS> Disable-3ParRcopyVV -KeepSnap -VV_name XYZ -Group_name XYZ
C:\PS> Disable-3ParRcopyVV -RemoveVV -VV_name XYZ -Group_name XYZ
NOTE: For more information, execute Get-Help Command Name with Full Option.

Find cmdlets
Find-3parCage
Syntax
Find-3parCage [[-Time] ] [-CageName]  [[-Mag]] [[PortName] ] [[-SANConnection] ] []
Description
Allows system administrators to locate a drive cage, drive magazine, or port in the system using the
device blinking LEDs.
Parameters
Time
Specifies the number of seconds (0 - 255) the LED blinks. If time is not specified, then the default time
is 60 seconds.
CageName
Specifies the drive cage name as shown in the name column of List-3parCage command output.
Mag
Indicates the drive magazine by a number.
•

For DC1 drive cages, the valid values are 0 through 4.

•

For DC2 and DC4 drive cages, the valid values are 0 through 9.

•

For DC3 drive cages, the valid values are 0 through 15.

PortName
Indicates the port specifics. The valid values are A0|B0|A1|B1|A2|B2|A3|B3.
Examples
C:\PS>Find-3parCage -Time 30 -CageName cage0
Causes the Fibre Channel LEDs on the drive CageName cage0 to blink for 30 seconds.
C:\PS>Find-3parCage -Time 30 -CageName cage0 -Mag 3
Causes the Fibre Channel LEDs on the drive CageName cage0 to blink for 30 seconds, indicates the
drive magazine by number 3.
C:\PS>Find-3parCage -Time 30 -CageName cage0 -port_name demo1

HPE 3PAR PowerShell ToolKit CLI cmdlets

39

Causes the Fibre Channel LEDs on the drive CageName cage0 to blink for 30 seconds. If a port is
specified, the port LED oscillates between green and off.
C:\PS>Find-3parCage -CageName cage1 -Mag 2
Causes the Fibre Channel LEDs on the drive CageName cage1 to blink, indicates the drive magazine by
number 2.
NOTE: For more information, execute Get-Help "Command Name with Full Option.

Get cmdlets
NOTE: For More detail execute Get-Help "Command Name" with Full Option.

Get-ConnectedSession
Syntax
Get-ConnectedSession
Description
Displays a current session detail.
Example
C:\PS> Get-ConnectedSession
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3parCPG
Syntax
Get-3parCPG [[-ListCols]] [[-Detailed]] [[-RawSpace]] [[-Alert]] [[AlertTime]] [[-SAG]] [[-SDG]] [[-Space]] [[-History]] [[-Domain_Name]
] [[-cpgName] ] [[-SANConnection] ]
[]
Description
Displays a list of CPGs.
Parameters
cpgName
Specifies the cpg names to be listed.
ListCols
Lists the columns available to be shown in the -showcols option. (Run clihelp -col showcpg
command for help on each column).
Detailed
Displays detailed information about the CPGs.
RawSpace
Specifies that raw space used by the CPGs is displayed.

40

HPE 3PAR PowerShell ToolKit CLI cmdlets

Alert
Indicates whether alerts are posted.
Alerttime
Displays the time when alerts were posted (when applicable).
SAG
Specifies that the snapshot admin space auto-growth parameters are displayed.
SDG
Specifies that the snapshot data space auto-growth parameters are displayed.
Space
Shows the space saving of CPGs.
Hist
Specifies that the current and historical data from the CPG is displayed.
Domain_Name
Shows only CPGs that are in domains with names matching.
Examples
C:\PS> Get-3parCPG -cpgName "MyCPG"
Lists the specified CPG name "MyCPG"
C:\PS> Get-3parCPG -Detailed -cpgName "MyCPG"
Displays detailed information about the CPGs.
C:\PS> Get-3parCPG -RawSpace -cpgName "MyCPG"
Displays the specified raw space used by the CPGs.
C:\PS> Get-3parCPG -AlertTime -cpgName "MyCPG"
Show times when alerts were posted (when applicable).
C:\PS> Get-3parCPG -Domain_Name XYZ -cpgName "MyCPG"
Show time with domain name depicts.
Returns
Returns PS object if executed successfully. You can use this object to search further.
For example,
C:\PS> Get-3parCPG | Select Name,VVs:
Name

VVols

FC_cpg1

6

FC_cpg2

75

NOTE: For more information, execute Get-Help "Command Name" with Full Option.

HPE 3PAR PowerShell ToolKit CLI cmdlets

41

Get-3parVV
Syntax
Get-3parVV [[-vvName] ] [[-DomainName] ] [[-CPGName]
] [[-SANConnection] ] []
Description
Gets a list of virtual volumes per domain and CPG.
Parameters
vvName
Lists the parameterized name details.
DomainName
Lists the domain name details.
CPGName
Lists the CPG name details.
Example
Get-3parVV -vvName PassThru-Disk
Lists virtual volume PassThru-Disk.
Returns
Returns PS object if executed successfully. You can use this object to search further.
For example,
C:\PS> Get-3parVV | select name,CPG:
Name

CPG

Test_ISV_10.9.1.31_32_D2

Test_ISV_cpg2

Test_ISV_10.9.1.31_32_D3

Test_ISV_cpg2

Test_ISV_10.9.1.31_32_D4

Test_ISV_cpg2

NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3parVVSet
Syntax
Get-3parVVSet [[-Detailed]] [[-VV]] [[-Summary]] [[-vvSetName] ] [[vvName] ] [[-SANConnection] ] []
Description
Gets a list of virtual volume sets defined on the storage system and their members.

42

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
vvSetName
Specifies the name of the vvset to be listed.
Detailed
Displays detailed listing of each set.
VV
Shows VV sets that contain the supplied vvnames or patterns.
Summary
Shows VV sets with summarized output with VV sets names and number of VVs in those sets.
vvName
Specifies that the sets containing virtual volume.
Example
C:\PS> Get-3parVVSet :
ID

Name

Members

34

demoSet1

demoVolume1

42

demoSet2

demoVolume2

NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHost
Syntax
Get-3parHost [[-Domain] ] [[-D]] [[-Verb]] [[-CHAP]] [[-Descriptor]]
[[-Agent]] [[-Pathsum]] [[-Persona]] [[-Listpersona]] [[-NoName]] [[CRCError]] [[-hostName] ] [[-SANConnection] ]
[]
Description
Lists all hosts.
Parameters
D
Displays a detailed listing of host and path information.
Verb
Displays a verbose listing of all host information.
CHAP
Displays the CHAP authentication properties.
Descriptor
Displays the host descriptor information.
Agent
Displays information provided by host agent.

HPE 3PAR PowerShell ToolKit CLI cmdlets

43

Pathsum
Displays summary information about hosts and paths.
Persona
Displays the host persona settings in effect.
Listpersona
Lists the defined host personas.
NoName
Displays only host paths (WWNs and iSCSI names) that are not assigned to any host.
Domain
Displays only hosts that are in domains or domain sets.
CRCError
Displays the CRC error counts for the host or port.
hostName
Specifies new name of the host.
Examples
C:\PS>Get-3parHost
Lists all hosts.
C:\PS>Get-3parHost -hostName HV01A
Lists host HV01A.
Returns
Returns PS object if executed successfully. You can use this object to search further.
For example, C:\PS>Get-3parHost | select Name, ID :
Name

ID

--

--

10000000C9E79802

21

DemoHost1

34

NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3parHostSet
Syntax
Get-3parHostSet [[-hostSetName] ] [[-hostName] ] [[-D]] [[SANConnection] ] []
Description
Lists the host sets information.

44

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
D
Shows a more detailed listing of each set.
hostSetName
Specifies the host names that are to be listed.
hostName
Shows the host sets containing hostName.
Examples
C:\PS> Get-3parHostSet
Lists complete host set information.
C:\PS> Get-3parHostSet -hostSetName "MyVVSet"
Lists specific host set names MyVVSet.
C:\PS> Get-3parHostSet -hostName "MyHost"
Shows the host sets that are containing host MyHost.
Returns
Returns a string object.
For example, C:\PS>Get-3parHostSet -hostSetName "MyVVSet" lists specific HostSet name
"MyVVSet".
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHostPorts
Syntax
Get-3parHostPorts [[-I]] [[-PAR]] [[-RC]] [[-RCFC]] [[-RCIP]] [[-PEER]] [[ISCSI]] [[-ISCSINAME]] [[-ISCSIVLANS]] [[-FCOE]] [[-SFP]] [[-FAILED]] [[STATE]] [[-Detailed]] [[-IDS]] [[-FS]] [[-NSP] ] [[-D]] [[SANConnection] ] []
Description
Sends a query to HPE 3PAR StoreServ to get all ports including targets, disks, and RCIP ports.
Parameters
I
Shows port hardware inventory information.
C
Displays all devices that are connected to the port. Such devices include cages (for initiator ports),
hosts (for target ports), and ports from other storage system (for RCFC and peer ports).
PAR
Lists the parameter such as the configured data rate of a port and the maximum data rate that the
card supports. Also, provide information on the type of attachment (Direct Connect or Fabric
Attached) and whether the unique_nwwn and VCN capabilities are enabled.

HPE 3PAR PowerShell ToolKit CLI cmdlets

45

RC
Displays information that is specific to the Remote Copy ports.
RCFC
Displays information that is specific to the Fibre Channel Remote Copy ports.
PEER
Displays information that is specific to the Fibre Channel ports for Data Migration.
RCIP
Displays information specific to the Ethernet Remote Copy ports.
ISCSI
Displays information about iSCSI ports.
ISCSINAME
Displays iSCSI names associated with iSCSI ports.
ISCSIVLANS
Displays information about VLANs on iSCSI ports.
Fcoe
Displays information that is specific to Fibre Channel over Ethernet (FCoE) ports.
SFP
Displays information about the SFPs attached to ports.
DDM
Displays Digital Diagnostics Monitoring (DDM) readings from the SFPs if they support DDM. This
option must be used with the -sfp option.
D
Displays detailed information about the SFPs attached to ports. This option is used with the -sfp
option.
FAILED
Shows only failed ports.
STATE
Displays the detailed state information. This is the same as -s.
Detailed
Displays the detailed state information. This option is deprecated and will be removed in a
subsequent release.
IDS
Displays the identities hosted by each physical port.
FS
Displays information specific to the Ethernet File Persona ports. To see IP address, netmask and
gateway information on File Persona, run showfs -net.
NSP
Nede sloat poart

46

HPE 3PAR PowerShell ToolKit CLI cmdlets

Examples
C:\PS> Get-3parHostPorts
Lists all ports including targets, disks, and RCIP ports.
C:\PS> Get-3parHostPorts -I
C:\PS> Get-3parHostPorts -I -NSP 0:0:0
C:\PS> Get-3parHostPorts -PAR
C:\PS> Get-3parHostPorts -PAR -NSP 0:0:0
C:\PS> Get-3parHostPorts -RC
C:\PS> Get-3parHostPorts -RC -NSP 0:0:0
C:\PS> Get-3parHostPorts -RCFC
C:\PS> Get-3parHostPorts -RCFC -NSP 0:0:0
C:\PS> Get-3parHostPorts -RCIP
Returns
String object.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSpace
Syntax
Get-3parSpace [[-cpgName] ] [[-RaidType] ] [[-Cage] ]
[[-Disk] ] [[-History]][[-SSZ] ] [[-SANConnection] ]
[]
Description
Displays estimated free space for logical disk creation.
Parameters
cpgName
Specifies that logical disk creation parameters are taken from CPGs that match the specified CPG
name.
RaidType
Specifies the RAID type of the logical disk. The different types are r0 for RAID-0, r1 for RAID-1, r5 for
RAID-5, or r6 for RAID 6.
Cage
Specifies one or more drive cages.
Disk
Specifies one or more disks.
History
Specifies that free space history over time for the specified CPGs.

HPE 3PAR PowerShell ToolKit CLI cmdlets

47

SSZ
Specifies the set size in terms of chunklets.
Example
C:\PS> Get-3parSpace
C:\PS> Get-3parSpace -cpgName as -RaidType 1
C:\PS> Get-3parSpace -cpgName TEST_CPG
C:\PS> Get-3parSpace -Cage 1
C:\PS> Get-3parSpace -History
C:\PS> Get-3parSpace -SSZ 1
Returns
A string object.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSystemInformation
Syntax
Get-3parSystemInformation [[-Option] ] [[-SANConnection] ]
[]
Description
Displays the 3PAR Storage system information.
Options
-d
Displays more information about the system.
-param
Displays the system parameters.
-fan
Displays the system fan information.
-space
Displays the system capacity information in MiB.
-vvspace
Displays the system capacity information in MiB with an emphasis on VVs.
-domainspace
Displays the system capacity information broken down by domain in MiB.
-desc
Displays the system descriptor properties.
-devtype
FC|NL|SSD
Displays the system capacity information where the disks must have a device type string matching the
specified device type.

48

HPE 3PAR PowerShell ToolKit CLI cmdlets

Example input
C:\PS> Get-3parSystemInformation
C:\PS> Get-3parSystemInformation -Option d
C:\PS> Get-3parSystemInformation -Option fan
C:\PS> Get-3parSystemInformation -Option domainspace
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parVLUN
Syntax
]Get-3parVLUN [[-vvName] ] [[-PresentTo] ] [[-SANConnection]
] []
Description
Gets a list of LUNs that are exported or presented to hosts.
Parameters
vvName
Lists the details available in 3par VLUN with the vvName.
PresentTo
Lists the details available in 3par VLUN with the vvName.
Examples
C:\PS>Get-3parVLUN
Lists exported volumes.
C:\PS>Get-3parVLUN -vvName PassThru-Disk
Lists the LUN numbers and host sets of LUN PassThru-Disk.
Returns
Returns PS object if executed successfully. You can use this object to search further.
For example, C:\PS> Get-3parVLUN | select Name, ID returns:
Name

ID

----

----

Test_ISV_10.9.1.31_32_D2

50

Test_ISV_10.9.1.31_32_D3

36

NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parFCPorts
Syntax
Get-3parFCPORTS [[-SANConnection] <_SANConnection>] []

HPE 3PAR PowerShell ToolKit CLI cmdlets

49

Description
Sends a query to HPE 3PAR StoreServ to get FC ports.
Example
C:\PS> Get-3parFCPorts
Lists the FC ports available on HPE 3PAR StoreServ array.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parFCPortsToCSV
Syntax
Get-3parFCPortsToCSV [[-SANConnection] <_SANConnection>] [[-ResultFile]
] []
Description
Sends a query to HPE 3PAR StoreServ to get FC ports.
Parameters
ResultFile
Redirects the result to a specified file with an address of the file.
Example
C:\PS>Get-3parFCPortstoCSV -ResultFile C:\3PAR-FC.CSV
Saves the list of FC Ports and stores the result in a .csv file available at the default location.
Returns
String object.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parVVList
Syntax
Get-3parVVList [[-Listcols]] [[-D]] [[-Pol]] [[-Space]] [[-R]] [[-Zone]] [[G]] [[-Alert]] [[-AlertTime]] [[-CPProg]] [[-CpgAlloc]] [[-State]] [[-Hist]]
[[-RCopy]] [[-NoTree]] [[-Domain] ] [[-Expired]] [[-Retained]] [[Failed]] [[-vvName] ] [[-Type] ] [[-Prov] ] [[Pattern]] [[-CPG] ] [[-Host] ] [[-Baseid] ] [[Copyof] ] [[-Rcopygroup] ] [[-Policy] ] [[-vmName]
] [[-vmId] ] [[-vmHost] ] [[-vvolState] ] [[vvolsc] ] [[-SANConnection] ] []
Description
The Get-3parVVList command displays information about all Virtual Volumes (VVs) or a specific VV in a
system.

50

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
Listcols
List the columns available to be shown in the -showcols option that are described later.
D
Displays detailed information about the VVs.
Pol
Displays policy information about the VVs. The following columns are shown: Id Name Policies
Space
Displays Logical Disk (LD) space use by the VVs.
R
Displays raw space use by the VVs.
Zone
Displays mapping zone information for VVs.
G
Displays the SCSI geometry settings for the VVs.
Alert
Indicates whether alerts are posted on behalf of the VVs.
AlertTime
Shows times when alerts were posted (when applicable).
CPProg
Shows the physical copy and promote progress.
CpgAlloc
Shows the physical copy and promote progress.
State
Shows the detailed state information for the VVs.
Hist
Shows the history information of the VVs.
RCopy
This option appends two columns, RcopyStatus and RcopyGroup, to any of the display options that
are explained earlier.
NoTree
Do not display VV names in tree format.
Expired
Show only VVs that have expired.
Retained
Shows only VVs that have a retention time.
Failed
Shows only failed VVs.

HPE 3PAR PowerShell ToolKit CLI cmdlets

51

Domain
Shows only VVs that are in domains with names matching one or more of the specified domain_name
or patterns.
Pattern
Pattern for matching VVs.
CPG
Show only VVs whose UsrCPG or SnpCPG that matches one or more of the cpgname_or_patterns.
Prov
Show only VVs with Prov (provisioning) values that match the prov_or_pattern.
Type
Show only VVs of types that match the type_or_pattern.
Host
Show only VVs that are exported as VLUNs to hosts with names that match one or more of the
hostname_or_patterns.
Baseid
Show only VVs whose BsId column matches one more of the baseid_or_patterns.
Copyof
Show only VVs whose BsId column matches one more of the baseid_or_patterns.
Rcopygroup
Show only VVs that are in Remote Copy groups that match one or more of the
groupname_or_patterns.
Policy
Show only VVs whose policy matches one or more of the policy_or_pattern.
vmName
Show only VVs whose vmname matches one or more of the vvname_or_patterns.
vmId
Show only VVs whose vmid matches one or more of the vmids.
vmHost
Show only VVs whose vmhost matches one or more of the vmhost_or_patterns.
vvolState
Show only VVs whose vvolstate matches the specified state - bound or unbound.
vvolsc
Show only VVs whose storage container (vvset) name matches one or more of the
vvset_name_or_patterns.
vvName
Specify name of the volume. If prefixed with 'set:', the name is a volume set name.
Prov
Specify name of the Prov type (full | tpvv |tdvv |snp |cpvv).
Type
Specify name of the Prov type (base | vcopy).

52

HPE 3PAR PowerShell ToolKit CLI cmdlets

Example input
C:\PS>Get-3parVVList
Lists all the virtual volumes.
C:\PS> Get-3parVVList -vvName xyz
.
List virtual volume xyz
C:\PS> Get-3parVVList -Space -vvName xyz
Lists the virtual volume provision type as tpvv.
C:\PS> Get-3parVVList -Space -vvName xyz
List snapshot(vitual copy) volumes
Returns
Returns PS object if executed successfully. You can use this object to search further.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parTask
Syntax
Get-3parTask [[-All]] [[-Done]] [[-Failed]] [[-Active]] [[-Hours] ]
[[-Task_type] ] [[-TaskID] ] [[-SANConnection] ]
[]
Description
Displays tasks information.
Parameters
All
Displays all tasks.
Done
Displays only tasks that are successfully completed.
Failed
Displays only tasks that are unsuccessful.
Active
Displays only tasks that are currently in progress
Hours
Shows only tasks started within the past , where  is an integer from 1 through 99999.
Task_type
Shows that specified patterns are treated as glob-style patterns and all task types that matches with
the specified pattern are displayed. To see the different task types, use the showtask column help.

HPE 3PAR PowerShell ToolKit CLI cmdlets

53

TaskID
Shows detailed task status for a specified task. Tasks must be explicitly specified using their task IDs
. Multiple task IDs can be specified. This option cannot be used in conjunction with other
options.
Examples
C:\PS> Get-3parTask
Displays all tasks.
C:\PS> Get-3parTask -All
Display all tasks. Unless the -all option is specified, system tasks are not displayed.
C:\PS> Get-3parTask -Done
Display the tasks that are successfully completed.
C:\PS> Get-3parTask -Failed
Display includes only tasks that are unsuccessfully completed.
C:\PS> Get-3parTask -Active
Display includes only tasks that are currently in progress.
C:\PS> Get-3parTask -Hours 10
Show only tasks started within the past .
C:\PS> Get-3parTask -Task_type xyz
Shows that specified patterns are treated as glob-style patterns, and all task types that matches with the
specified pattern are displayed.
C:\PS> Get-3parTask -taskID 4
Show detailed task status for specified task 4.
Returns
A string object.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parCmdList
Syntax
Get-3parCmdList []
Description
Gets a list of HPE 3PAR StoreServ PowerShell cmdlets.
Examples
C:\PS>Get-3parCmdList
Lists the available HPE 3PAR StoreServ PowerShell cmdlets.

54

HPE 3PAR PowerShell ToolKit CLI cmdlets

Returns
Returns PS object if executed successfully. You can use this object to search further.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parVersion
Syntax
Get-3parVersion [[-number]] [[-build]] [[-SANConnection] ]
[]
Description
Gets HPE 3PAR StoreServ Storage system software versions.
Parameters
number
Lists only HPE 3PAR StoreServ Storage system release version numbers.
build
Lists HPE 3PAR StoreServ Storage system build levels.
Example input
C:\PS>Get-3parVersion
Gets a list of HPE 3PAR StoreServ Storage system software versions.
C:\PS>Get-3parVersion -number
Gets a list of HPE 3PAR StoreServ Storage system release version numbers only.
C:\PS>Get-3parVersion -build
Gets a list of HPE 3PAR StoreServ Storage system build levels.
Returns
Returns PS object if executed successfully. You can use this object to search further.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parCage
Syntax
Get-3parCage [[-D]] [[-E]] [[-C]] [[-SFP]] [[-DDM]] [[-I]] [[-SVC]] [[CageName] ] [[-SANConnection] ] []
Description
Displays information about drive cages.
Parameters
D
Displays detailed information about the drive cage. If this option is not used, then only summary
information about the drive cages is displayed.

HPE 3PAR PowerShell ToolKit CLI cmdlets

55

E
Displays error information.
C
Specifies to use cached information. This option displays information faster because the cage does
not need to be probed, however, some information might not be up-to-date without that probe.
SFP
Specifies information about the SFP(s) attached to a cage. Currently, additional SFP information can
only be displayed for DC2 and DC4 cages.
I
Specifies that inventory information about the drive cage is displayed. If this option is not used, then
only summary information about the drive cages is displayed.
DDm
Specifies the SFP DDM information.
SVC
Displays the inventory information with HPE serial number, spare part number, and so on. It is
supported only on HPE 3PAR StoreServ 7000 Storagesystems and HPE 3PAR 8000 series systems".
CageName
Specifies a drive cage name for which information is displayed. This specifier can be repeated to
display information for multiple cages.
Examples
C:\PS> Get-3parCage
Displays information about a drive cage of single system.
C:\PS> Get-3parCage -D -CageName cage2
Specifies that detailed information about the drive cage is displayed
C:\PS> Get-3parCage -I -CageName cage2
Specifies that inventory information about the drive cage is displayed.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistChunklet
Syntax
Get-3parHistChunklet [[-LDname] ] [[-Chunklet_num] ] [[Metric] ] [[-Iteration] ] [[-Percentage]] [[-Previous]] [[Beginning]] [[-RW]] [[-Interval] ] [[-NI]] [[-SANConnection]
] []
Description
Displays a histogram of service times in a timed loop for individual chunklets.
Parameters
LDname
Specifies the Logical Disk (LD), identified by name, from which chunklet statistics are sampled.

56

HPE 3PAR PowerShell ToolKit CLI cmdlets

Chunklet_num
Specifies that statistics are limited to only the specified chunklet, identified by number.
Metric
Selects which metric to display. Both - (Default) Display both I/O time and I/O size histograms time Display only the I/O time histogram size - Display only the I/O size histogram.
Percentage
Shows the access count in each bucket as a percentage.
Previous
Histogram displays data either from a previous sample (-prev) or from when the system was last
started(-begin).
Beginning
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin).
RW
Specifies that the display includes separate read and write data.
Interval
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
Iteration
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
NI
Specifies that histograms for only non-idle devices are displayed.
Examples
C:\PS> Get-3parHistChunklet -Iteration 1
Displays one iteration of a histogram of service.
C:\PS> Get-3parHistChunklet –LDname dildil -Iteration 1
Identified by name, from which chunklet statistics are sampled.
C:\PS> Get-3parHistChunklet -Iteration 1 -Previous
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistLD
Syntax
Get-3parHistLD [[-Iteration] ] [[-Metric] ] [[-VV_Name]
] [[-Domain] ] [[-Timecols] ] [[-Sizecols] ]
[[-Percentage]] [[-Previous]] [[-Beginning]] [[-NI]] [[-Secs] ] [[LdName] ] [[-SANConnection] ] []
Description
Displays a histogram of service times for LDs (Logical Disks) in a timed loop.

HPE 3PAR PowerShell ToolKit CLI cmdlets

57

Parameters
Timecols
For the I/O time histogram, shows the columns from the first column  through last column
. The available columns range from 0 through 31.
Sizecols
For the I/O size histogram, shows the columns from the first column () through the last column
(). Available columns range from 0 through 15.
Percentage
Shows the access count in each bucket as a percentage
Secs
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
NI
Specifies that histograms for only non-idle devices are displayed.
Iteration
Displays a histogram of service Iteration number of times.
LdName
Displays a histogram of service linked with LD_NAME.
VV_Name
Shows only logical disks that are mapped to virtual volumes with names matching any of the names
or patterns specified. Multiple volumes or patterns can be repeated using a comma-separated list.
Domain
Shows only logical disks that are in domains with names matching any of the names or patterns
specified. Multiple domain names or patterns can be repeated using a comma-separated list.
Metric
Selects which metric to display. Metrics can be one of the following:
•

both - (Default): Displays both I/O time and I/O size histograms

•

time: Displays only the I/O time histogram

•

size: Displays only the I/O size histogram

Previous
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin). If no option is specified, the histogram displays data from the beginning when the
is command executed.
Beginning
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin). If no option is specified, the histogram shows data from the beginning of the
command's execution.
Examples
C:\PS> Get-3parHistLD -Iteration 1
Displays a histogram of service Iteration number of times
C:\PS> Get-3parHistLD -LdName abcd -Iteration 1

58

HPE 3PAR PowerShell ToolKit CLI cmdlets

Displays a histogram of service linked with LD_NAME on Iteration number of times
C:\PS> Get-3parHistLD -Iteration 1 -VV_Name ZXZX
Shows only logical disks that are mapped to virtual volumes with names matching any of the names or
patterns specified.
C:\PS> Get-3parHistLD -Iteration 1 -Domain ZXZX
Shows only logical disks that are in domains with names matching any of the names or patterns specified.
C:\PS> Get-3parHistLD -Iteration 1 -Percentage
Shows the access count in each bucket as a percentage.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistPD
Syntax
Get-3parHistPD [[-Iteration] ] [[-WWN] ] [[-Nodes] ]
[[-Slots] ] [[-Ports] ] [[-Devinfo]] [[-Metric] ] [[Percentage]] [[-Previous]] [[-Beginning]] [[-FSpec] ] [[SANConnection] ] []
Description
Displays a histogram of service times for PDs in a timed loop.
Parameters
WWN
Specifies the world wide name of the PD for which service times are displayed.
Nodes
Specifies that the display is limited to specified nodes and physical disks connected to those nodes.
The node list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also
consist of a single integer. If the node list is not specified, all disks on all nodes are displayed.
Slots
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI
slots. The slot list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can
also consist of a single integer. If the slot list is not specified, all disks on all slots are displayed.
Ports
Specifies that the display is limited to specified ports and physical disks connected to those ports. The
port list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist
of a single integer. If the port list is not specified, all disks on all ports are displayed.
Percentage
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
Previous
Histogram displays data either from a previous sample(-prev) or from when the system was last
started(-begin). If no option is specified, the histogram shows data from the beginning of the
command's execution.

HPE 3PAR PowerShell ToolKit CLI cmdlets

59

Beginning
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin). If no option is specified, the histogram shows data from the beginning of the
command's execution.
Devinfo
Indicates the device disk type and speed.
Metric
Selects a metric to display.
Selects which metric to display. Metrics can be one of the following:
•

both - (Default): Display both I/O time and I/O size histograms

•

time : Display only the I/O time histogram

•

size: Display only the I/O size histogram

Iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
up-to 2147483647.
FSpec
Specifies that histograms below the threshold specified by the  argument are not displayed.
Examples
C:\PS> Get-3parHistPD

-iteration 1 -WWN abcd

Specifies the world wide name of the PD for which service times are displayed.
C:\PS> Get-3parHistPD -iteration 1
The Get-3parHistPDcommand
Displays a histogram of service iteration number of times
Histogram displays data from when the system was last started (–begin).
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistPort
Syntax
Get-3parHistPort [[-Iteration] ] [[-Both]] [[-CTL]] [[-Data]] [[Nodes] ] [[-Slots] ] [[-Ports] ] [[-Host]] [[-PEER]]
[[-Disk]] [[-RCFC]] [[-Metric] ] [[-Percentage]] [[-Previous]] [[Beginning]] [[-RW]] [[-SANConnection] ] []
Description
Displays a histogram of service times for ports within the system.

60

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
Both
•

Specifies both control and data transfers are displayed (-both)

•

Only control transfers are displayed (-ctl)

•

only data transfers are displayed (-data). If this option is not specified, only data transfers are
displayed.

CTL
•

Specifies both control and data transfers are displayed (-both)

•

Only control transfers are displayed (-ctl)

•

only data transfers are displayed (-data). If this option is not specified, only data transfers are
displayed.

Data
•

Specifies both control and data transfers are displayed (-both)

•

Only control transfers are displayed (-ctl)

•

only data transfers are displayed (-data). If this option is not specified, only data transfers are
displayed.

Nodes
both
Specifies that the display is limited to specified nodes and physical disks connected to those
nodes.
Slots
Specifies that the display is limited to specified PCI slots and physical disks connected to those
PCI slots.
Ports
Specifies that the display is limited to specified ports and physical disks connected to those ports.
Host
Specifies to display only host ports (target ports), only disk ports (initiator ports), only Fibre Channel
Remote Copy configured ports, or only Fibre Channel ports for Data Migration.
Disk
Specifies to display only host ports (target ports), only disk ports (initiator ports), only Fibre Channel
Remote Copy configured ports, or only Fibre Channel ports for Data Migration.
RCFC
Specifies to display only host ports (target ports), only disk ports (initiator ports), only Fibre Channel
Remote Copy configured ports, or only Fibre Channel ports for Data Migration.
PEER
Specifies to display only host ports (target ports), only disk ports(initiator ports), only Fibre Channel
Remote Copy configured ports, or only Fibre Channel ports for Data Migration.
Metric

HPE 3PAR PowerShell ToolKit CLI cmdlets

61

Selects which metric to display. Metrics can be one of the following:
•

both - (Default): Displays both I/O time and I/O size histograms

•

time: Displays only the I/O time histogram

•

size: Displays only the I/O size histogram

vIteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
up-to 2147483647.
Previous
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin).
Beginning
Histogram displays data either from a previous sample (-prev)or from when the system was last
started (-begin). If no option is specified, the histogram displays data from the beginning when the
command execution starts.
RW
Specifies that the display includes separate read and write data.
Examples
C:\PS> Get-3parHistPort -iteration 1
Displays a histogram of service times with option which can be one of both, ctrl, or data option.
C:\PS> Get-3parHistPort -iteration 1 -Both
Specifies that both control and data transfers are displayed (-both).
C:\PS>Get-3parHistPort -iteration 1 -Nodes nodesxyz
Specifies that the display is limited to specified nodes and physical disks connected to those nodes.
C:\PS>Get-3parHistPort –Metric both -iteration 1
Displays a histogram of service times with -metric option. Metric can be one of both, time, or size.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistRCopyVV
Syntax
Get-3parHistRCopyVV [[-ASync]] [[-Sync]] [[-Periodic]] [[-Primary]] [[Secondary]] [[-TargetSum]] [[-PortSum]] [[-GroupSum]] [[-VVSum]] [[DomainSum]] [[-Pct]] [[-Prev]] [[-VV_Name] ] [[-interval] ]
[[-domain] ] [[-group] ] [[-target] ] [[-iteration]
] [[-SANConnection] ] []
Description
Displays a histogram of total remote-copy service times and backupsystem remote-copy service times in
a timed loop.

62

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
Async
Show only volumes which are being copied in asynchronous mode.
sync
Show only volumes that are being copied in synchronous mode.
periodic
Show only volumes which are being copied in asynchronous periodic mode.
primary
Show only virtual volumes in the primary role.
secondary
Show only virtual volumes in the secondary role.
targetsum
Displays the sums for all volumes of a target.
portsum
Displays the sums for all volumes on a port.
groupsum
Displays the sums for all volumes of a volume group.
vvsum
Displays the sums for all targets and links of a virtual volume.
domainsum
Displays the sums for all volumes of a domain.
VV_Name
Displays statistics only for the specified virtual volume or volume name pattern.
interval
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
Pct
Shows the access count in each bucket as a percentage.
Prev
Specifies that the histogram displays data from a previous sample.
domain
Shows only the virtual volumes that are in domains with names that match the specified domain
name(s) or pattern(s).
target
Shows only volumes whose group is copied to the specified target name or pattern. Multiple target
names or patterns may be specified using a comma-separated list.
group
Shows only volumes whose volume group matches the specified group name or pattern of names.

HPE 3PAR PowerShell ToolKit CLI cmdlets

63

iteration
Specifies that the statistics are to stop after the indicated number of iterations using an integer from 1
through 2147483647.
Examples
C:\PS> Get-3parHistRCopyVV -iteration 1
The Get-3parHistRCopyVV command shows a histogram of total remote-copy service iteration number of
times.
C:\PS> Get-3parHistRCopyVV -iteration 1 -Sync
The Get-3parHistRCopyVV
The Get-3parHistRCopyVV command shows a histogram of total remote-copy service iteration number of
times with option sync
C:\PS> Get-3parHistRCopyVV -group groupvv_1 -iteration
C:\PS> Get-3parHistRCopyVV -iteration 1 -Periodic
C:\PS> Get-3parHistRCopyVV -iteration 1 -PortSum
C:\PS> Get-3parHistRCopyVV -target name_vv1 -iteration 1
The Get-3parHistRCopyVV command shows a histogram of total remote-copy service with specified
target name.
C:\PS> Get-3parHistRCopyVV -group groupvv_1 -iteration
The Get-3parHistRCopyVV command shows a histogram of total remote-copy service with specified
Group name.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistVLUN
Syntax
Get-3parHistVLUN [[-iteration] ] [[-domain] ] [[-host]
] [[-vvname] ] [[-lun] ] [[-Nodes] ] [[Slots] ] [[-Ports] ] [[-Percentage]] [[-Previous]] [[Beginning]] [[-Metric] ] [[-SANConnection] ]
[]
Description
Displays VLUN (Virtual Volume Logical Unit Number) service time histograms.
Parameters
domain
Displays only VLUNs with VirtualVolumes (VVs)in domains with names that match one or more
specified domain names or patterns. Multiple domain names or patterns can be repeated using a
comma-separated list.
host
Displays only VLUNsexported to the specified hosts or patterns. Multiple host names or patterns can
be repeated using a comma-separated list.

64

HPE 3PAR PowerShell ToolKit CLI cmdlets

vvname
Displays only LDs mapped to VVs that match and are of the specified names or patterns. Multiple
volume names or patterns can be repeated using a comma-separated list.
nodes
Specifies that only exports from the specified nodes are displayed. The node list is specified as a
series of integers separated by commas (1,2, and 3).
lun
Specifies that VLUNs with LUNs matching the specified LUNs or patterns are displayed. Multiple
LUNs or patterns can be repeated using a comma-separated list.
iteration
Specifies that the statistics are to stop after the indicated number of iterations, the iterations are
specified using an integer (1 - 2147483647).
slots
Specifies that the display is limited to specified PCI slots.
Ports
Specifies that the display is limited to specified ports.
Metric both|time|size
Selects a metric to display.
Percentage
Shows the access count in each bucket as a percentage.
Previous | Beginning
Histogram displays data either from a previous sample or beginning.
Iteration
Specifies that the statistics stops after the indicated number of iterations.
Examples
C:\PS> Get-3parHistVLUN -iteration 1
Get-3parHistVLUN -iteration 1 -nodes 1
Get-3parHistVLUN -iteration 1 -domain DomainName
Get-3parHistVLUN -iteration 1 –Percentage
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parHistVV
Syntax
Get-3parHistVV [[-iteration] ] [[-domain] ] [[-Metric]
] [[-Timecols] ] [[-Sizecols] ] [[-VVname] ]
[[-Percentage]] [[-Previous]] [[-RW]] [[-IntervalInSeconds] ] [[FSpace] ] [[-SANConnection] ] []
Description
Displays Virtual Volume (VV) service time histograms in a timed loop.

HPE 3PAR PowerShell ToolKit CLI cmdlets

65

Parameters
domain
Shows only the VVs that are in domains with names that match the specified domain name(s).
Metric
Selects which Metric to display. Metrics can be one of the following:
•

both - (Default): Displays both I/O time and I/O size histograms.

•

time: Displays only the I/O time histogram

•

size: Displays only the I/O size histogram

Timecols
Displays both I/O time and I/O size histograms.
time
Displays the I/O time histogram,
Sizecols
Displays only the I/O size histogram.
Percentage
Shows the access count in each bucket as a percentage.
Previous
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin).
Beginning
Histogram displays data either from a previous sample (-prev) or from when the system was last
started (-begin).
RW
Specifies that the display includes separate read and write data.
IntervalInSeconds
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
FSpace
Specifies that histograms below the threshold specified by the  argument are not displayed.
VVName
Displays Virtual Volume name.
iteration
Specifies that the statistics are to stop after the indicated number of iterations using an integer from 1
through 2147483647.
Examples
C:\PS> Get-3parHistVV -iteration 1
This Example displays Virtual Volume (VV) service time histograms service iteration number of times.
C:\PS> Get-3parHistVV

66

-iteration 1 -domain domain.com

HPE 3PAR PowerShell ToolKit CLI cmdlets

This Example Shows only the VVs that are in domains with names that match one or more specified
domain names
C:\PS> Get-3parHistVV

-iteration 1 –Metric both

This Example Selects which Metric to display.
C:\PS> Get-3parHistVV -iteration 1 -Timecols "1 2"
C:\PS>Get-3parHistVV -iteration 1 -Sizecols "1 2"
C:\PS> Get-3parHistVV –Metric both -VVname demoVV1 -iteration 1
This Example selects which Metric to display and associated with Virtual Volume name.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parPD
Syntax
Get-3parPD [[-I]] [[-E]] [[-C]] [[-StateInfo]] [[-State]] [[-Path]] [[Space]] [[-Failed]] [[-Degraded]] [[-Node] ] [[-Slots] ] [[Ports] ] [[-WWN] ] [[-Pattern]] [[-ND] ] [[-ST]
] [[-PT] ] [[-CG] ] [[-MG] ] [[-PN] ]
[[-DK] ] [[-Devtype] ] [[-RPM] ] [[-PD_ID] ]
[[-Listcols]] [[-SANConnection] ] []
Description
Displays configuration information about the PDs (physical disks) on a system.
Parameters
Listcols
List the columns available to be shown in the -showcols option described below. Run clihelp -col
showpd for help on each column).
I
Show disk inventory (inquiry) data.
E
Show disk environment and error information. Note that reading this information places a significant
load on each disk.
C
Show chunklet usage information. Any chunklet in a failed disk will be shown as "Fail".
S
Show detailed state information. This option is deprecated and will be removed in a subsequent
release.
State
Show detailed state information. This is the same as -s.
Path
Show current and saved path information for disks.
Space

HPE 3PAR PowerShell ToolKit CLI cmdlets

67

Show disk capacity usage information (in MB).
Failed
Specifies that only failed physical disks are displayed.
Degraded
Specifies that only degraded physical disks are displayed.
Pattern
Physical disks matching the specified pattern are displayed.
ND
Specifies one or more nodes. Nodes are identified by one or more integers (item).
ST
Specifies one or more PCI slots.
PT
Specifies one or more ports.
CG
Specifies one or more drive cages.
MG
Specifies one or more drive magazines
PN
Specifies one or more disk positions within a drive magazine.
DK
Specifies one or more physical disks.
Devtype
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive)to be used.
RPM
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
showpd command.
Node
Specifies that the display is limited to specified nodes and physical disks connected to those nodes.
Slots
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI
slots.
Ports
Specifies that the display is limited to specified ports and physical disks connected to those ports.
WWN
Specifies the WWN of the physical disk.
Examples
C:\PS> get-3parPD

68

HPE 3PAR PowerShell ToolKit CLI cmdlets

This example displays configuration information about all the physical disks (PDs) on a system.
C:\PS> Get-3parPD -PD_ID 5
This example displays configuration information about specific or given physical disks (PDs) on a system.
C:\PS> Get-3parPD -C
This example displays chunklet use information for all disks.
C:\PS> Get-3parPD -C -PD_ID 5
This example will display chunklet use information for all disks with the physical disk ID.
C:\PS> Get-3parPD -C -Pattern -Devtype FC
C:\PS> Get-3parPD -option p -pattern mg -patternValue 0
This example will display all the FC disks in magazine 0 of all cages.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parRCopy
Syntax
Get-3parRCopy [[-Detailed]] [[-QW]] [[-Domain] ] [[-Links]] [[Groups] ] [[-Targets] ] [[-SANConnection] ]
[]
Description
Displays Remote Copy configuration information.
Parameters
Detailed
Displays more detailed configuration information.
QW
Displays additional target-specific automatic transparent failover-related configuration, where
applicable.
Domain
Shows only Remote Copy links whose virtual volumes are in domains with names that match one or
more of the specified domain name or pattern.
Links
Specifies all Remote Copy links.
Groups
Specifies either all Remote Copy volume groups or a specific Remote Copy volume group by name or
by glob-style pattern.
Targets
Specifies either all target definitions or a specific target definition by name or by glob-style pattern.
Examples
C:\PS> Get-3parRCopy -Detailed -Links

HPE 3PAR PowerShell ToolKit CLI cmdlets

69

This Example displays details of the Remote Copy configuration and specifies all Remote Copy links.
C:\PS> Get-3parRCopy -Detailed -Domain PSTest -Targets Demovv1
This example displays details of the Remote Copy configuration and specifies all target definitions.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSpace
Syntax
Get-3parSpace [[-cpgName] ] [[-RaidType] ] [[-Cage] ]
[[-Disk] ] [[-History]][[-SSZ] ] [[-SANConnection] ]
[]
Description
Displays estimated free space for logical disk creation.
Parameters
cpgName
Specifies that logical disk creation parameters are taken from CPGs that match the specified CPG
name.
RaidType
Specifies the RAID type of the logical disk. The different types are r0 for RAID-0, r1 for RAID-1, r5 for
RAID-5, or r6 for RAID 6.
Cage
Specifies one or more drive cages.
Disk
Specifies one or more disks.
History
Specifies that free space history over time for the specified CPGs.
SSZ
Specifies the set size in terms of chunklets.
Example
C:\PS> Get-3parSpace
C:\PS> Get-3parSpace -cpgName as -RaidType 1
C:\PS> Get-3parSpace -cpgName TEST_CPG
C:\PS> Get-3parSpace -Cage 1
C:\PS> Get-3parSpace -History
C:\PS> Get-3parSpace -SSZ 1
Returns
A string object.
NOTE: For more information, execute Get-Help Command Name with Full Option.

70

HPE 3PAR PowerShell ToolKit CLI cmdlets

Get-3parSpare
Syntax
Get-3parSpare [[-used]] [[-count]] [[-SANConnection] ]
[]
Description
Displays information about chunklets in the system that are reserved for spares.
Parameters
used
Displays only used spare chunklets.
count
Specifies number of loop iteration.
Examples
C:\PS>Get-3parSpare
Displays chunklets information in the system that are reserved for spares.

Get-3parSR
Syntax
Get-3parSR [[-ldrg]] [[-Btsecs] ] [[-Etsecs] ] [[SANConnection] ] []
Description
Displays the amount of space consumed by the various System Reporter databases on the System
Reporter volume.
Parameters
Idrg
Displays the available LD region statistic samples.
Btsecs
Specifies begin time in EpocSeconds for the report.
Etsecs
Specifies end time in EpocSeconds for the report.
Examples
C:\PS>Get-3parSR
Displays the System Reporter status.

Get-3parSRAlertCrit
Syntax
Get-3parSRAlertCrit [[-Hourly]] [[-Daily]] [[-Hires]] [[-Major]] [[-Minor]]
[[-Info]] [[-Enabled]] [[-Disabled]] [[-Critical]] [[-SANConnection]
] []

HPE 3PAR PowerShell ToolKit CLI cmdlets

71

Description
Displays the criteria that System Reporter evaluates to determine if a performance alert should be
generated.
Parameters
Daily
This criterion will be evaluated on a daily basis at midnight.
Hourly
This criterion will be evaluated on an hourly basis.
Hires
This criterion will be evaluated on a high resolution (5 minute) basis. This is the default.
Major
This alert should require urgent action.
Minor
This alert should require not immediate action.
Info
This alert is informational only. This is the default.
Enabled
Displays only criteria that are enabled.
Disabled
Displays only criteria that are disabled.
Critical
Displays only criteria that have critical severity.
Examples
C:\PS> Get-3parSRAlertCrit
Displays the criteria that System Reporter evaluates to determine if a performance alert should be
generated.
C:\PS> Get-3parSRAlertCrit -Daily
Displays all the criteria evaluated on an hourly basis.
C:\PS> Get-3parSRAlertCrit -Hires
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRAOMoves
Syntax
Get-3ParSRAOMoves [[-btsecs] ] [[-etsecs] ] [[-oneline]] [[VV_name] ] [[-withvv]] [[-SANConnection] ]
[]
Description
Displays the space that AO has moved between tiers.

72

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
online
Displays data in simplified format with one line per AOCFG.
VV_name
Limits the analysis to VVs with names that match one or more.
withvv
Displays data for each vv.
Examples
C:\PS>Get-3parSRAOMoves
Displays the space that AO has moved between tiers.
C:\PS>Get-3parSRAOMoves -btsecs -7200
Displays the space moved by AO beginning 2 hours (7200 seconds) ago.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRCPGSpace
Syntax
Get-3parSRCPGSpace [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-DiskType] ]
[[-RaidType] ] [[-CpgName] ] [[-SANConnection] ]
[]
Description
Displays historical space data reports for common provisioning groups (CPGs).
Parameters
attime
Performance is shown at a particular time interval, specified by the -etsecs option, with one row per
object group described by the -groupby option. Without this option, performance is shown versus
time with a row per time interval.
btsecs
Select the begin time in seconds for the report
etsecs
Select the end time in seconds for the report.
hires
Selects high resolution samples (5 minute intervals) for the report. This is a default setting.
hourly
Selects hourly samples for the report.

HPE 3PAR PowerShell ToolKit CLI cmdlets

73

daily
Selects daily samples for the report.
Groupby
DOM_NAME
Domain name
CPGID
Common Provisioning
DISK_TYPE
Displays the disk type of the PDs used by the CPG
RAID_TYPE
Displays the RAID type of the CPG
disk_type
FC
Fast Class
NL
Nearline
SSD
Solid State Drive
raid_type
Limits the data to RAID of the specified types. Allowed types are 0, 1, 5 and 6.
Cpg_name
Displays CPGs matching either the specified CPG_name or glob-style patterns are included. This
specifier can be repeated to display information for multiple CPGs. If not specified, all CPGs are
included.
Examples
C:\PS>Get-3parSRCPGSpace
C:\PS> Get-3parSRCPGSpace -etsecs 1
C:\PS> Get-3parSRCPGSpace -btsecs 1
C:\PS> Get-3parSRCPGSpace -groupby DOM_NAME
C:\PS> Get-3parSRCPGSpace -Hourly
C:\PS> Get-3parSRCPGSpace -Daily
C:\PS> Get-3parSRCPGSpace -Hires
C:\PS> Get-3parSRCPGSpace -RaidType 0
NOTE: For more information, execute Get-Help Command Name with Full Option.

74

HPE 3PAR PowerShell ToolKit CLI cmdlets

Get-3parSRHistLD
Syntax
Get-3parSRHistLd [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-rw]] [[-groupby] ] [[-cpgName]
] [[-node] ] [[-LDName] ] [[-Metric] ] [[SANConnection] ] []
Description
Displays historical histogram performance data reports for logical disks.
Parameters
attime
Performance is shown at a particular time interval, specified by the -etsecs option, with one row per
object group described by the -groupby option. Without this option, performance is shown versus
time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report. This is a default setting.
Hourly
Selects hourly samples for the report.
Daily
Selects daily samples for the report.
rw
Specifies that the display includes separate read and write data.
Groupby
DOM_NAME
Displays domain name.
LDID
Displays logical disk ID.
LD_NAME
Displays common logical disk name.
CPG_NAME
Displays common Provisioning Group name.
NODE
Specifies the node that owns the LD.
cpgName
Limits the data to LDs in CPGs with names that match one or more of the specified names or globstyle patterns.

HPE 3PAR PowerShell ToolKit CLI cmdlets

75

node
Limits the data to the corresponding specified nodes.
LDName
Specifies that LDs matching either the specified LD_name or glob-style patterns are included. This
specifier can be repeated to display information for multiple LDs.
Metric
Selects which metric to display.
Metrics can be one of the following:
both
Displays both I/O time and I/O size histograms.
time
Displays only the I/O time histogram.
size
Displays only the I/O size histogram.
Examples
C:\PS>Get-3parSRHistLd
Displays historical histogram performance data reports for logical disks.
C:\PS>Get-3parSRHistLd -option hourly -btsecs -24h
Displays aggregate hourly histogram performance statistics for all logical disks beginning 24 hours ago.
C:\PS> Get-3parSRHistLd -Metric Both
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRHistPD
Syntax
Get-3parSRHistPD [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-rw]] [[-groupby] ] [[-diskType]
] [[-rpmSpeed] ] [[-PDID] ] [[-Metric] ] [[SANConnection] ] []
Description
Displays historical histogram performance data reports for physical disks.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.

76

HPE 3PAR PowerShell ToolKit CLI cmdlets

Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
rw
Specifies that the display includes separate read and write data.
Groupby
PDID
Specifies the physical disk ID.
PORT_N
Specifies the node number for the primary port for the PD
PORT_S
Specifies the PCI slot number for the primary port for the PD.
PORT_P
Specifies the port number for the primary port for the PD
DISK_TYPE
Specifies the disk type of the PD.
SPEED
Specifies the speed of the PD.
DiskType
Limit the data to disks of the types specified. Following are the allowed types:
FC
Fast Class
NL
Nearline
SSD
Solid State Drive
rpmSpeed
Limits the data to disks of the specified RPM. Allowed speeds are 7, 10, 15, 100 and 150.
PDID
Specifies that LDs matching either the specified LD_name or glob-style patterns are included. This
specifier can be repeated to display information for multiple LDs. If not specified, all LDs are included.
Metric
Selects which metric to display.
Metrics can be one of the following:
both
Displays both I/O time and I/O size histograms.

HPE 3PAR PowerShell ToolKit CLI cmdlets

77

time
Displays only the I/O time histogram.
size
Displays only the I/O size histogram.
Examples
C:\PS>Get-3parSRHistPD
Command displays historical histogram performance data reports for physical disks
C:\PS> Get-3parSRHistPD -Hourly -btsecs -24h
Displays aggregate hourly histogram performance statistics for all physical disks beginning 24 hours ago
C:\PS> Get-3parSRHistPD -Metric both
C:\PS> Get-3parSRHistPD -Metric both
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRHistPort
Syntax
Get-3parSRHistPort [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-rw]] [[-groupby] ] [[-portType]
] [[-Port] ] [[-Metric_Val] ] [[-SANConnection]
] []
Description
Displays historical histogram performance data reports for ports.
Parameters
attime
Performance is shown at a particular time interval, specified by the -etsecs option, with one row per
object group described by the -groupby option. Without this option, performance is shown versus
time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hourly
Selects hourly samples for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.

78

HPE 3PAR PowerShell ToolKit CLI cmdlets

Metric_Val
Selects which metric to display.
Metrics can be one of the following:
both
Displays both I/O time and I/O size histograms.
time
Displays only the I/O time histogram.
size
Displays only the I/O size histogram.
rw
Specifies that the display includes separate read and write data.
groupby
For attime reports, generates a separate row for  items. Each  must be
different and one of the following:
PORT_N
Displays the node number for the port.
PORT_S
Displays the PCI slot number for the port.
PORT_P
Displays the port number of the port.
PORT_TYPE
Displays the Port type.
GBITPS
Displays the speed of the port.
TRANS_TYPE
Displays the transaction type -ctl or data.
portType
Limits the data to port of the types specified. Allowed types are:
disk
Disk port.
host
Host Fibre channel port.
iscsi
Host ISCSI port.
free
Unused port
fs
File Persona port.

HPE 3PAR PowerShell ToolKit CLI cmdlets

79

peer
Data migration FC port.
rcip
Remote copy IP port.
rcfc
Remote copy FC port.
Port
Ports with :: that match any of the
specified[::...]patternsare included, where each of the patterns is a glob-style
pattern. If not specified, all ports are included.
Examples
C:\PS>Get-3parSRHistPort
Displays historical histogram performance data reports for ports.
C:\PS> Get-3parSRHistPort -Metric_Val size
C:\PS> Get-3parSRHistPort -Groupby PORT_N
C:\PS>Get-3parSRHistPort -option hourly -btsecs -24h -portType "host,disk" -port "0:*:* 1:*:*"

Displays aggregate hourly histogram performance statistics for disk and host ports on nodes 0 and 1 that
began 24 hours ago.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRHistVLUN
Syntax
btsecs] ] [[-etsecs] ] [[-Hourly]] [[-Daily]] [[-Hires]] [[rw]] [[-groupby] ] [[-host] ] [[-vv] ] [[-lun]
] [[-Port] ] [[-Metric_Val] ] [[-SANConnection]
] []
Description
Displays historical histogram performance data reports for VLUNs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.

80

HPE 3PAR PowerShell ToolKit CLI cmdlets

Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
rw
Specifies that the display includes separate read and write data.
Groupby
Following are the allowed options:
DOM_NAM
Displays the domain name.
VV_NAME
Displays the virtual volume name.
HOST_NAME
Displays the host name.
HOST_WWN
Specifies the host WWN for the VLUN.
LUN
Specifies LUN number for the VLUN.
PORT_N
Specifies the node number for the VLUN port.
PORT_S
Specifies the PCI slot number for the VLUN port.
PORT_P
Specifies the port number for the VLUN port.
VVSET_NAME
Specifies virtual volume set name.
HOSTSET_NAME
Specifies host set name.
host
Limits the data to hosts with names that match one or more of the specified names or glob-style
patterns. Host set name must start with set: and can also include patterns.
vv
Limit the data to hosts with names that match one or more of the specified names or glob-style
patterns.
vv
Limit the data to VVs with names that match one or more of the specified names or glob-style
patterns.

HPE 3PAR PowerShell ToolKit CLI cmdlets

81

lun
Limit the data to LUNs that match one or more of the specified LUNs or glob-style patterns.
Port
Ports with :: that match any of the
specified[::...]patternsareincluded, where each of the patterns is a glob-style
pattern. If not specified, all ports are included.
Examples
C:\PS>Get-3parSRHistVLUN
Displays historical histogram performance data reports for VLUNs.
C:\PS>Get-3parSRHistVLUN -option hourly -btsecs -24h
Displays aggregate hourly histogram performance statistics for all VLUNs that began 24 hours ago.
C:\PS>Get-3parSRHistVLUN -btsecs -2h -host "set:hostset" -vv "set:vvset*"
VV or host sets can be specified with patterns.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRLDSpace
Syntax
Get-3parSRLDSpace [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-cpgName] ]
[[-DiskType] ] [[-RaidType] ] [[-ownernode] ] [[LDname] ] [[-SANConnection] ] []
Description
Displays historical space data reports for LDs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.

82

HPE 3PAR PowerShell ToolKit CLI cmdlets

Groupby
Following are the allowed options:
DOM_NAM
Displays the domain name.
CPG_NAME
Displays the Common Provisioning Group name.
LDID
Displays the logical disk ID.
LD_NAME
Displays the logical disk name.
DISK_TYPE
Specifies the disk type of the PDs used by the LD.
RAID_TYPE
Specifies the RAID type of the LD.
SET_SIZE
Specifies the RAID set size of the LD.
STEP_SIZE
Specifies the RAID step size of the LD.
ROW_SIZE
Specifies the RAID row size of the LD.
OWNER
Specifies the owner node for the LD.
cpgName
Limits the data to LDs in CPGs with names that match one or more of the specified names or globstyle pattern.
DiskType
FC
Fast Class.
NL
Nearline.
SSD
Solid State Drive.
Raidtype
Limits the data to RAID of the specified types. Allowed types are 0, 1, 5 and 6.
Ownernode
Limits data to LDs owned by the specified nodes.
LDname
Specifies that CPGs matching either the specified CPG_name or glob-style patterns are included.

HPE 3PAR PowerShell ToolKit CLI cmdlets

83

Examples
C:\PS>Get-3parSRLDSpace
Displays historical space data reports for logical disks.
C:\PS> Get-3parSRLDSpace -groupby OWNER
C:\PS> Get-3parSRLDSpace -DiskType FC
C:\PS> Get-3parSRLDSpace -raidType 5 -Hourly -btsecs 24h -LDName fc*
Displays aggregate hourly LD space information for all RAID 5 LDs with names that match either "fc*"
patterns beginning 24 hours ago.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRPDSpace
Syntax
Get-3parSRPDSpace [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-DiskType] ]
[[-capacity]] [[-rpmspeed] ] [[-PDID] ] [[-SANConnection]
] []
Description
Displays historical space data reports for PDs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report. This is the default setting.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
Groupby
Following are the allowed options:
PDID
Displays physical disk ID.

84

HPE 3PAR PowerShell ToolKit CLI cmdlets

CAGEID
Displays CAGE ID.
CAGESIDE
Displays CAGE side.
MAG
Specifies the disk Magazine number within the cage.
DISK
Specifies the disk position within the magazine.
DISK_TYPE
Specifies the disk type of the PD.
SPEED
Specifies the disk speed.
DiskType
FC
Fast Class
NL
Nearline
SSD
Solid State Drive
capacity
Displays disk contributions to the system capacity categories: Allocated, Free, Failed, and Total.
rpmspeed
Limits the data to disks of the specified RPM. Allowed speeds are 7, 10, 15, 100 and 150.
PDID
Specifies that PDs with IDs that match either the specified PDID or glob-style patterns are included.
Examples
C:\PS>Get-3parSRPDSpace
Displays historical space data reports for physical disks (PDs).
C:\PS>Get-3parSRPDSpace -hourly -btsecs -24h
Displays aggregate hourly PD space information for all PDs beginning 24 hours ago.
C:\PS>Get-3parSRPDSpace -capacity -attime -diskType SSD
Displays current system capacity values of SSD PDs.
NOTE: For more information, execute Get-Help Command Name with Full Option.

HPE 3PAR PowerShell ToolKit CLI cmdlets

85

Get-3parSRStatCache
Syntax
Get-3parSRStatCache [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-InternalFlashCache]] [[-FmpQueue]] [[CmpQueue]] [[-Full]] [[-groupby] ] [[-Node] ] [[SANConnection] ] []
Description
Displays historical performance data reports for flash cache and data cache.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
InternalFlashcache
Lists the IOPS and bandwidth each for both read back and destaged write flash cache activity.
FmpQueue
List the FMP queue statistics. May be combined with -cmp_queue and -internal_flashcache.
CmpQueue
List the CMP queue statistics.
Full
List all the metrics for each row in a single line.
groupby
One of the following:
NODE
Displays the controller node.
Node
Only the specified node numbers are included, where each node is a number from 0 through 7.
Examples
C:\PS>Get-3parSRStatCache

86

HPE 3PAR PowerShell ToolKit CLI cmdlets

Displays historical performance data reports for flash cache and data cache.
C:\PS>Get-3parSRStatCache -option Hourly -btsecs -24h
Displays aggregate hourly performance statistics for flash cache and data cache beginning 24 hours ago.
C:\PS>Get-3parSRStatCache -option Daily -attime -groupby node
Displays daily flash cache and data cache performance aggregated by nodes.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRStatCMP
Syntax
Get-3parSRStatCMP [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-Full]] [[-Page]] [[-groupby] ] [[Node] ] [[-SANConnection] ] []
Description
Displays historical performance data reports for cache memory.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
Full
List all the metrics for each row in a single line.
Page
List the page state information.
Groupby
Specifies that for attime reports, generate a separate row for each combination of  items.
Each  must be different and one of the following:
NODE
The controller node

HPE 3PAR PowerShell ToolKit CLI cmdlets

87

Node
Displays specified node numbers, where each node is a number from 0 through 7.To display
information for multiple nodes specify , , and so on. If not specified, all
nodes are included.
Examples
C:\PS>Get-3parSRStatCMP
Displays historical performance data reports for node cache.
C:\PS>Get-3parSRStatCMP -option Hourly -btsecs -24h
Displays aggregate hourly performance statistics for node cache beginning 24 hours ago.
C:\PS>Get-3parSRStatCMP -option Daily -attime -groupby node
Displays daily node cache performance aggregated by nodes.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRStatCPU
Syntax
Get-3parSRStatCPU [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-Node] ] [[SANConnection] ] []
Description
Displays historical performance data reports for CPUs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
Groupby
For attime reports, generate a separate row for each combination of  items. Each
 must be different and one of the following:

88

HPE 3PAR PowerShell ToolKit CLI cmdlets

NODE
Specifies the controller node
CPU
Specifies the CPU within the controller node.
Node
Displays the specified node numbers, where each node is a number from 0 through 7.
Examples
C:\PS>Get-3parSRStatCPU
Displays historical performance data reports for CPUs.
C:\PS> Get-3parSRStatCPU -Groupby CPU
C:\PS> Get-3parSRStatCPU -btsecs 24h
C:\PS> Get-3parSRStatCPU -Hourly -btsecs 24h
Displays the aggregate hourly performance statistics for all CPUs beginning 24 hours ago.
C:\PS> Get-3parSRStatCPU -option daily -attime -groupby node
Displays daily node CPU performance aggregated by nodes.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRStatLD
Syntax
Get-3parSRStatLD [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-cpgName] ]
[[-Node] ] [[-LDName] ] [[-SANConnection] ]
[]
Description
Displays historical performance data reports for logical disks.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.

HPE 3PAR PowerShell ToolKit CLI cmdlets

89

Daily
Selects hourly samples for the report.
groupby
Specifies that for attime reports, generates a separate row for each combination of 
items. Each  must be different and one of the following:
DOM_NAME
Specifies the domain name
LDID
Specifies logical disk ID
LD_NAME
Specifies logical disk name
CPG_NAME
Specifies common provisioning group name
Node
Specifies the node that owns the LD
cpgName
Limits the data to LDs in CPGs with names that match one or more of the specified names or globstyle patterns.
Node
Limit the data to the corresponding to one of the specified nodes -Node 0, 1, ,2.
LDName
Specifies that LDs matching either the specified LD_name or glob-style patterns are included.
Examples
C:\PS>Get-3parSRStatLD
Displays historical performance data reports for logical disks.
C:\PS>Get-3parSRStatLD -option Hourly -btsecs -24h
Displays aggregate hourly performance statistics for all logical disks beginning 24 hours ago.
C:\PS> Get-3parSRStatLD -Groupby Node
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRStatPD
Syntax
Get-3parSRStatPD [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-diskType] ]
[[-rpmSpeed] ] [[-PDID] ] [[-SANConnection] ]
[]
Description
Displays system reporter performance reports for PDs.

90

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
attime
Displays the performance at a particular time interval, specified by the -etsecs option, with one row
per object.
btsecs
Specifies begin time in seconds for the report.
etsecs
Specifies end time in seconds for the report.
option
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects daily samples for the report.
groupby
For attime reports, generate a separate row for each combination of  items. Each
 must be different and one of the following:
PDID
Specifies the physical disk ID.
PORT_N
Specifies the node number for the primary port of the PD.
PORT_S
Specifies the PCI slot number for the primary port for the PD.
PORT_P
Specifies the port number for the primary port for the PD.
DISK_TYPE
Specifies the disk type of the PD.
SPEED
Specifies the speed of the PD.
diskType
Limits the data to disks of the types specified. Allowed types are:
FC
Fast Class
NL
Nearline
SSD
Solid State Drive

HPE 3PAR PowerShell ToolKit CLI cmdlets

91

rpmSpeed
Limits the data to disks of the specified RPM. Allowed speeds are7,10,15,100 and 150.
PDID
Specifies that PDs with IDs that match either the specified PDID or glob-style patterns are included.
This specifier can be repeated to include multiple PDIDs or patterns. If not specified, all PDs are
included.
Examples
C:\PS>Get-3parSRStatPD
System reporter performance reports for PDs.
C:\PS>Get-3parSRStatPD -Hourly -btsecs -24h
Displays aggregate hourly performance statistics for all physical disks beginning 24 hours ago.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRStatPort
Syntax
Get-3parSRStatPort [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-portType] ]
[[-port] ] [[-SANConnection] ] []
Description
Displays system reporter performance reports for ports.
Parameters
attime
Displays the performance at a particular time interval, specified by the -etsecs option, with one row
per object.
btsecs
Specifies the begin time in seconds for the report.
etsecs
Specifies the end time in seconds for the report.
option
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects daily samples for the report.
groupby
Specifies that for attime reports, generate a separate rowfor each combination of  items.
Each  must be different and one of the following:

92

HPE 3PAR PowerShell ToolKit CLI cmdlets

PORT_N
Specifies the node number for the port
PORT_S
Specifies the PCI slot number for the port
PORT_P
Specifies the port number for the port
PORT_TYPE
Specifies the type of the port
GBITPS
Specifies the speed of the port
portType
Limits the data to ports of the types specified. Allowed types are:
disk
Disk port
host
Host Fibre channel port
iscsi
Host ISCSI port
free
Unused port
fs
File Persona port
peer
Data Migration FC port
rcip
Remote copy IP port
rcfc
Remote copy FC port
port
Specifies that the ports with :: that match any of the specified
:: patterns are included, where each of the patterns is a glob-style pattern.
Examples
C:\PS>Get-3parSRStatPort
System reporter performance reports for ports.
C:\PS> Get-3parSRStatPort -portType "disk,host" -Hourly -btsecs -24h -port "0:*:* 1:*:*"

Displays aggregate hourly performance statistics for disk and host ports on nodes 0 and 1 beginning 24
hours ago.
C: \ PS> Get-3parSRStatPort -Groupby PORT_N

HPE 3PAR PowerShell ToolKit CLI cmdlets

93

NOTE: For more information, execute
Get-Help
Command Name with Full Option.

Get-3parSRStatVLUN
Syntax
Get-3parSRStatVLUN [[-attime]] [[-Summary] ] [[-btsecs] ] [[etsecs] ] [[-Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[host] ] [[-vv] ] [[-lun] ] [[-port] ] [[vLun] ] [[-vmName] ] [[-vmHost] ] [[-vvoLsc]
] [[-vmId] ] [[-SANConnection] ] []
Description
Displays historical performance data reports for VLUNs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies the begin time in seconds for the report.
etsecs
Specifies the end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.
Groupby
Specifies that for attime reports, generate a separate row for each combination of 
items. Each  must be different and one of the following:
DOM_NAME
Displays the domain name.
VV_NAME
Virtual Volume name
HOST_NAME
Displays the Host name.
LUN
Displays the LUN number for the VLUN.

94

HPE 3PAR PowerShell ToolKit CLI cmdlets

HOST_WWN
Displays the host WWN for the VLUN.
PORT_N
Displays the node number for the VLUN port.
PORT_S
Displays the PCI slot number for the VLUN port.
PORT_P
Displays the port number for the VLUN port.
VVSET_NAME
Displays the Virtual Volume set name.
HOSTSET_NAME
Displays the Host set name.
VM_NAME
Displays the Virtual Machine Name for VVol based VMs.
VM_ID
Displays the Virtual Machine Identification number for VVol based VMs.
VM_HOST
Displays the Virtual Machine host for VVol based VMs.
VVOLSC
Displays the Virtual Volume Storage Container for VVol based VMs.
host
Limits data to hosts with names that match one or more of the specified names or glob-style patterns.
vv
Limits data to VVs with names that match one or more of the specified names or glob-style patterns.
VV set name must be prefixed by set: and can also include patterns.
lun
Limits data to LUNs that match one or more of the specified LUNs or glob-style patterns.
vLun
Limit the data to VLUNs matching the specified combination of host, VV, lun, and port.
vmName
Limit the data to VMs that match one or more of the specified VM names or glob-styled patterns for
VVol based VMs.
vmId
Limit the data to VMs that match one or more of the specified VM IDs or glob-styled patterns for VVol
based VMs.
vmHost
Limit the data to VMs that match one or more of the specified VM host names or glob-styled patterns
for VVol based VMs.

HPE 3PAR PowerShell ToolKit CLI cmdlets

95

vvoLsc
Limit the data to VVol containers that match one or more of the specified VVol container names or
glob-styled patterns.
Summary
Summarize performance across requested objects and time range.
Examples
C:\PS>Get-3parSRStatVLUN
Displays historical performance data reports for VLUNs.
C:\PS>Get-3parSRStatVLUN -option Hourly -btsecs -24h
Displays aggregate hourly performance statistics for all VLUNs beginning 24 hours ago.
C:\PS> Get-3parSRStatVLUN -btsecs -2h -host "set:hostset" -vv "set:vvset*"
Displays VV or host sets can be specified with patterns.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parSRVVSpace
Syntax
Get-3parSRVVSpace [[-attime]] [[-btsecs] ] [[-etsecs] ] [[Hourly]] [[-Daily]] [[-Hires]] [[-groupby] ] [[-usrcpg] ] [[snpcpg] ] [[-provType] ] [[-VVName] ] [[-vmName]
] [[-vmHost] ] [[-vvoLsc] ] [[-vmId] ] [[vvolState] ] [[-SANConnection] ] []
Description
Displays historical performance data reports for VVs.
Parameters
attime
Displays the performance for a particular time interval, specified by the -etsecs option, with one row
per object group described by the -groupby option. Without this option, performance is shown
versus time with a row per time interval.
btsecs
Specifies the begin time in seconds for the report.
etsecs
Specifies the end time in seconds for the report.
Hires
Selects high resolution samples (5 minute intervals) for the report.
Hourly
Selects hourly samples for the report.
Daily
Selects hourly samples for the report.

96

HPE 3PAR PowerShell ToolKit CLI cmdlets

groupby
Following are the allowed options:
DOM_NAME
Displays domain name,
VVID
Displays Vvrtual volume ID.
VV_NAME
Displays Virtual Volume name.
BSID
Displays virtual volume ID of the base virtual volume.
WWN
Displays virtual volume world wide name (WWN).
SNP_CPG_NAME
Displays Snap space Common Provisioning Group name.
USR_CPG_NAME
Display User space Common Provisioning Group name.
PROV_TYPE
Displays the virtual volume provisioning type.
VV_TYPE
Displays the type of the virtual volume.
VVSET_NAME
Displays virtual volume set name.
VM_NAME
Displays virtual Machine name for VVol based VMs.
VM_ID
Displays virtual Machine Identification number for VVol based VMs.
VM_HOST
Displays virtual machine host for VVol based VMs.
VVOLSC
Displays Virtual Volume Storage Container for VVol based VMs.
VVOL_STATE
Displays Virtual Volume state, either bound or unbound.
COMPR
Displays whether Compression is enabled, disabled, or NA.
usrcpg
Specifies that only VVs with user space mapped to a CPG are included. The CPG name matches one
of the specified CPG_name or glob-style patterns.

HPE 3PAR PowerShell ToolKit CLI cmdlets

97

snpcpg
Specifies that only VVs with snp space mapped to a CPG are included. The CPG name matches one
of the specified CPG_name or glob-style patterns.
provType
Specifies that only to include VVs of one or more specified provisioning types.
VVName
Specifies that PDs with IDs that match either the specified PDID or glob-style patterns are included.
vmName
Limit the data to VMs that match one or more of the specified VM names or glob-styled patterns for
VVol based VMs.
vmId
Limit the data to VMs that match one or more of the specified VM IDs or glob-styled patterns for VVol
based VMs.
vmHost
Limit the data to VMs that match one or more of the specified VM host names or glob-styled patterns
for VVol based VMs.
vvolState
Limit the data to VVOLs that have states in either the Bound or Unbound state.
vvoLsc
Limit the data to VVol containers that match one or more of the specified VVol container names or
glob-styled patterns
Examples
C:\PS>Get-3parSRVVSpace
Displays historical space data reports for VVs.
C:\PS> Get-3parSRVVSpace

-Hourly -btsecs -24h -VVName dbvv*

Displays aggregate hourly VV space information for VVs with names matching either dbvv* patterns
beginning 24 hours ago.
C:\PS> Get-3parSRVVSpace -Daily -attime -groupby vv_name -vvName tp*
Displays VV space information for the most recent daily sample aggregated by the VV name for VVs with
names that match the pattern tp*.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatChunklet
Syntax
Get-3parStatChunklet [[-Iteration] ] [[-RW]] [[-IDLEP]] [[-Begin]]
[[-NI]] [[-Delay] ] [[-LDname] ] [[-CHnum] ] [[SANConnection] ] []
Description
Displays chunklet statistics in a timed loop.

98

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
option
RW
Specifies that read and write data are displayed separately. If this option is not used, then the total
of reads plus writes is displayed.
Idlep
Specifies the percent of idle columns in the output.
Begin
Specifies that I/O averages are computed from the system start time. If not specified, the average
is computed since the first iteration of the command.
NI
Specifies that statistics for only non-idle devices are displayed
Delay
Specifies the interval in seconds. Statistics are sampled using an integer from 1 through 2147483.
LDname
Specifies that statistics are restricted to chunklets from a particular logical disk.
CHnum
Specifies that statistics are restricted to a particular chunklet number.
Iteration
Specifies that CMP statistics are displayed specified number of times as indicated by the num
argument using an integer.
Examples
C:\PS>Get-3parStatChunklet -Iterration 1
Displays chunklet statistics in a timed loop.
C:\PS>Get-3parStatChunklet -option RW -Iteration 1
Specifies that reads and writes are displayed separately. The chunklet statistics are displayed in a timed
loop.
C:\PS>Get-3parStatChunklet -LDname demo1 -CHnum 5 -Iterration 1
Specifies particular chunklet number and logical disk.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatCMP
Syntax
Get-3parStatCMP [[-NI]] [[-VVname] ] [[-Domian] ] [[-Delay]
] [[-Iteration] ] [[-SANConnection] ]
[]
Description
Displays CMP (Cache Memory Page) statistics by node or by Virtual Volume.

HPE 3PAR PowerShell ToolKit CLI cmdlets

99

Parameters
VVname
Specifies that statistics are displayed for virtual volumes matching the specified name or pattern.
Domain
Displays VVs that are in domains with names that match one or more of the specified domains or
patterns.
Delay
Specifies the interval, in seconds, that statistics are sampled using an integer from 1 through
2147483.
NI
Specifies that statistics for only non-idle VVs are displayed.
Iteration
Specifies that CMP statistics are displayed a specified number of times as indicated by the num
argument using an integer.
Examples
C:\PS>Get-3parStatCMP -Iteration 1
Displays CMP statistics.
C:\PS>Get-3parStatCMP -VVname Demo1 -Iteration 1
Displays CMP statistics by Virtual Volume -VVname Demo1.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatCPU
Syntax
Get-3parStatCPU [[-delay] ] [[-total]] [[-Iteration] ] [[SANConnection] ] []
Description
Displays CPU statistics for all nodes.
Parameters
Delay
Specifies the interval in seconds that statistics are sampled using an integer from 1 through 2147483.
total
Displays only the totals for all the CPUs on each node.
Iteration
Specifies that CMP statistics are displayed a specified number of times as indicated by the num
argument using an integer.
Examples
C:\PS>Get-3parStatCPU -iteration 1

100

HPE 3PAR PowerShell ToolKit CLI cmdlets

Displays CPU statistics for all nodes.
C:\PS>Get-3parStatCPU -delay 2 -total -iteration 1
Displays only the totals for all the CPUs on each node.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatLD
Syntax
Get-3parStatLD [[-RW]] [[-IDLEP]] [[-Begin]] [[-NI]] [[-VVname] ] [[LDname] ] [[-Domain] ] [[-Delay] ] [[-Iteration]
] [[-SANConnection] ] []
Description
Displays read/write (I/O) statistics for LDs in a timed loop.
Parameters
option
RW
Specifies that read and write data are displayed separately.
Begin
Specifies that I/O averages are computed from the system start time.
IDLEP
Specifies the percent of idle columns in the output.
VVname
Display only LDs that are mapped to VVs with names matching any of the names or patterns
specified.
LDname
Displays only statistics for the specified LD or pattern.
Domain
Displays only LDs that are in domains with names matching any of the names or specified patterns.
Delay
Specifies the interval in seconds. Statistics are sampled using an integer from 1 through 2147483.
Iteration
Specifies that I/O statistics are displayed a specified number of times as indicated by the number
argument using an integer from 1 through 2147483647.
Examples
C:\PS>Get-3parStatLD -Iteration 1
Displays read/write (I/O) statistics for LDs.
C:\PS>Get-3parStatLD

RW -Iteration 1

Displays statistics for LDs with specification read/write
C:\PS>Get-3parStatLD --Begin -Delay 2 -Iteration 1

HPE 3PAR PowerShell ToolKit CLI cmdlets

101

Displays statistics for LDs with specification begin and delay in execution of 2 sec.
C:\PS>Get-3parStatLD -Begin -VVname demo1 -Delay -Iteration 1
Displays statistics for LDs, only LDs that are mapped to VVs.
C:\PS>Get-3parStatLD -Begin -LDname demoLD1 -Delay -Iteration 1
Displays statistics for the specified LDs.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatLink
Syntax
Get-3parStatLink [[-Detail]] [[-Interval] ] [[-Iteration] ]
[[-SANConnection] ] []
Description
Displays statistics for link utilization for all nodes in a timed loop.
Parameters
Detail
Displays detailed information regarding the Queue statistics.
Interval
Specifies the interval, in seconds, that statistics are sampled using an integer from 1 through
2147483.
Iteration
Specifies that I/O statistics are displayed a specified number of times as indicated by the number
argument using an integer from 1 through 2147483647.
Examples
C:\PS>Get-3parStatLink -Iteration 1
Displays statistics for link utilization for all nodes in a timed loop.
C:\PS>Get-3parStatLink -Delay 3 -Iteration 1
Displays statistics for link utilization for all nodes in a timed loop, with a delay of 3 sec.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatPD
Syntax
Get-3parstatPD [[-RW]] [[-IDLEP]] [[-Begin]] [[-NI]] [[-wwn] ] [[nodes] ] [[-slots] ] [[-ports] ] [[-Iteration]
] [[-DevInfo]] [[-SANConnection] ] []
Description
Displays the read/write (I/O) statistics for physical disks in a timed loop.

102

HPE 3PAR PowerShell ToolKit CLI cmdlets

Parameters
option
Devinfo
Indicates the device disk type and speed.
RW
Specifies that reads and writes are displayed separately. If this option is not used, then the total of
reads plus writes is displayed.
Begin
Specifies that I/O averages are computed from the system start time.
IDLEP
Specifies the percent of idle columns in the output.
NI
Specifies that statistics for only non-idle devices are displayed.
wwn
Specifies that statistics for a particular PD identified by WWNs are displayed.
nodes
Specifies that the display is limited to specified nodes and PDs connected to those nodes.
port
Specifies that the display is limited to specified ports and PDs connected to those ports.
Iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
Examples
C:\PS> Get-3parstatPD -RW –Iteration 1
Displays one iteration of I/O statistics for all PDs.
C:\PS> Get-3parstatPD -IDLEP –nodes 2 –Iteration 1
Displays one iteration of I/O statistics for all PDs with the specification idlep preference of node 2.
C:\PS> Get-3parstatPD -NI -wwn 1122112211221122 –nodes 2 –Iteration 1
Specifies that statistics for a particular Physical Disk (PD) identified by World Wide Names (WWNs) and
nodes.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatPort
Syntax
Get-3parStatPort [[-Both]] [[-Ctl]] [[-Data]] [[-Rcfc]] [[-Rcip]] [[-RW]] [[FS]] [[-Host]] [[-Peer]] [[-IDLEP]] [[-Begin]] [[-NI]] [[-Disk]] [[-nodes]
] [[-slots] ] [[-ports] ] [[-Iteration] ] [[SANConnection] ] []

HPE 3PAR PowerShell ToolKit CLI cmdlets

103

Description
Displays read/write (I/O) statistics for ports.
Parameters
Both
Displays both data transfers.
Ctl
Show control transfers only.
Data
Show both data and control transfers only.
Rcfc
Includes only statistics for Remote Copy over Fibre Channel ports related to cached READ requests.
Rcip
Includes only statistics for Ethernet configured Remote Copy ports.
RW
Specifies that the display includes separate read and write data.
Begin
Specifies that I/O averages are computed from the system start time.
Idlep
Specifies the percent of idle columns in the output.
Host
Displays only host ports (target ports).
Disk
Displays only disk ports (initiator ports).
Rcfc
Displays only Fibre Channel remote-copy configured ports.
NI
Specifies that statistics for only non-idle devices are displayed.
FS
Includes only statistics for File Persona ports.
Peer
Specifies to display only host ports (target ports).
nodes
Specifies that the display is limited to specified nodes and PDs connected to those nodes.
port
Specifies that the display is limited to specified ports and PDs connected to those ports.
slots
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI
slots.

104

HPE 3PAR PowerShell ToolKit CLI cmdlets

iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
Examples
C:\PS> Get-3parStatPort -Iteration 1
Displays one iteration of I/O statistics for all ports.
C:\PS> Get-3parStatPort -Both -Iteration 1
Displays one iteration of I/O statistics for all ports, displays data transfers only.
C:\PS> Get-3parStatPort -Host -nodes 2 -Iteration 1
Displays I/O statistics for all ports associated with node 2.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatRCopy
Syntax
Get-3parStatRCopy [[-Interval] ] [[-HeartBeat]] [[-Unit] ]
[[-Iteration] ] [[-SANConnection] ] []
Description
Displays statistics for Remote Copy volume groups.
Parameters
HeartBeat
Specifies that the heartbeat round-trip time of the links should be displayed and the link throughput.
Unit
Displays statistics as k(kilobytes), m (megabytes), or g (gigabytes). If no unit is specified, the default
is kilobytes.
Iteration
Specifies that I/O statistics are displayed a specified number of times as indicated by the num
argument using an integer from 1 through 2147483647.
Interval
Specifies the interval, in seconds, that statistics are sampled using an integer from 1 through
2147483647.
Examples
C:\PS> Get-3parStatRCopy -HeartBeat -Iteration 1
Displays statistics for sending links, specifies the heartbeat round-trip time.
C:\PS> Get-3parStatRCopy -Iteration 1
Displays statistics for sending links, link 0, and link 1.
C:\PS> Get-3parStatRCopy -HeartBeat -Unit k -Iteration 1
Displays statistics for sending links, specifies that the heartbeat round-trip time and displays statistics as
kilobytes.

HPE 3PAR PowerShell ToolKit CLI cmdlets

105

NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatRCVV
Syntax
Get-3parStatRCVV [[-Iteration] ] [[-Interval] ] [[-Target]
] [[-Port] ] [[-Group] ] [[-VVname] ] [[DomainName] ] [[-ASync]] [[-Sync]] [[-Periodic]] [[-Primary]] [[Secondary]] [[-TargetSum]] [[-PortSum]] [[-GroupSum]] [[-VVSum]] [[DomainSum]] [[-NI]] [[-SubSet]] [[-SANConnection] ]
[]
Description
Displays statistics for Remote Copy volumes in a timed loop.
Parameters
Async
Show only volumes which are being copied in asynchronous mode.
sync
Show only volumes that are being copied in synchronous mode.
periodic
Show only volumes that are being copied in asynchronous periodic mode.
primary
Show only volumes that are in the primary role.
secondary
Show only volumes that are in the secondary role.
targetsum
Specifies that the sums for all volumes of a target are displayed.
portsum
Specifies that the sums for all volumes on a port are displayed.
groupsum
Specifies that the sums for all volumes of a group are displayed.
vvsum
Specifies that the sums for all targets and links of a volume are displayed.
domainsum
Specifies that the sums for all volumes of a domain are displayed.
ni
Specifies that statistics for only non-idle devices are displayed.
target
Show only volumes whose group is copied to the specified target name.

106

HPE 3PAR PowerShell ToolKit CLI cmdlets

port
Show only volumes that are copied over the specified port or pattern.
group
Show only volumes whose group matches the specified group name or pattern.
VVname
Displays statistics only for the specified virtual volume or volume name pattern.
Iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
DomainName
Shows only the virtual volumes that are in domains with names that match one or more specified
domain names or patterns.
Interval
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
Subset
Show subset statistics for Asynchronous Remote Copy on a per group basis.
Examples
C:\PS>Get-3parStatRCVV -Iteration 1
Displays statistics for Remote Copy volumes in a timed loop.
C:\PS> Get-3parStatRCVV -Iteration 1 -ASync
C:\PS> Get-3parStatRCVV -Iteration 1 -TargetSum
C:\PS> Get-3parStatRCVV -Iteration 1 -VVSum
C:\PS> Get-3parStatRCVV -Iteration 1 -periodic
Displays statistics for Remote Copy volumes in a timed loop and show only volumes that are being
copied in asynchronous periodic mode.
C:\PS> Get-3parStatRCVV -target demotarget1

-Iteration 1

Displays statistics for Remote Copy volumes in a timed loop and Show only volumes whose group is
copied to the specified target name.
NOTE: For more information, execute Get-Help Command Name with Full Option.

Get-3parStatVlun
Syntax
Get-3parStatVlun [[-RW]] [[-IDLEP]] [[-Begin]] [[-NI]] [[-LW]] [[-DomainSum]] [[-vvSum]] [[-HostSum]] [[domain] ] [[-VVname] ] [[-LUN] ] [[-nodes] ] [[-Iteration] ] [[SANConnection] ] []
Description
Displays statistics for VVs and LUN host attachments.

HPE 3PAR PowerShell ToolKit CLI cmdlets

107

Parameters
LW
Lists the host’s World Wide Name (WWN) or iSCSI names.
Domainsum
Specifies that sums for VLUNs are grouped by domain in the display.
vvSum
Specifies that sums for VLUNs of the same VV are displayed.
Hostsum
Specifies that sums for VLUNs are grouped by host in the display.
RW
Specifies reads and writes to be displayed separately.
Begin
Specifies that I/O averages are computed from the system start time.
IDLEP
Includes a percent idle columns in the output.
NI
Specifies that statistics for only nonidle devices are displayed.
domian
Shows only Virtual Volume Logical Unit Number (VLUNs) whose VVs are in domains with names that
match one or more of the specified domain names or patterns.
VVname
Requests that only Logical Disks (LDs) mapped to VVs that match any of the specified names to be
displayed.
LUN
Specifies that VLUNs with LUNs matching one or more specified LUNs or patterns are displayed.
nodes
Specifies that the display is limited to specified nodes and Physical Disks (PDs) connected to those
nodes.
Iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
Examples
C:\PS> Get-3parStatVlun -Iteration 1
Displays statistics for VVs and LUN host attachments.
C:\PS> Get-3parStatVlun -vvSum -Iteration 1
Displays statistics for VVs and specifies that sums for VLUNs of the same VV are displayed.
C:\PS> Get-3parStatVlun -vvSum -RW -Iteration 1
C:\PS> Get-3parStatVlun -vvSum -RW -VVname xxx -Iteration 1
C:\PS>Get-3parStatVlun -VVname demovv1 -Iteration 1

108

HPE 3PAR PowerShell ToolKit CLI cmdlets

Displays statistics for Virtual Volumes (VVs) and only Logical Disks (LDs) mapped to VVs that match any
of the specified names to be displayed.
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3parStatVV
Syntax
Get-3parStatVV [[-RW]] [[-NI]] [[-Delay] ] [[-domian] ] [[VVname] ] [[-Iteration] ] [[-SANConnection] ]
[]
Description
Displays statistics for VVs.
Parameters
RW
Specifies reads and writes to be displayed separately.
Delay
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
NI
Specifies that statistics for only non-idle devices are displayed.
domian
Shows only Virtual Volume Logical Unit Number (VLUNs) whose VVs are in domains with names that
match one or more of the specified domain names or patterns.
Iteration
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
VVname
Only statistics are displayed for the specified VV.
Examples
C:\PS>Get-3parStatVV -Iteration 1
Displays statistics for VVs in a timed loop.
C:\PS> Get-3parStatVV -RW -Iteration 1
Displays statistics for VVs with specification of read/write option.
C:\PS> Get-3parStatVV -Delay -Seconds 2 -Iteration 1
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483.
C:\PS> Get-3parStatVV -RW -domain ZZZ -VVname demovv1 -Iteration 1
Displays statistics for Virtual Volumes (VVs) with Only statistics are displayed for the specified VVname.
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

HPE 3PAR PowerShell ToolKit CLI cmdlets

109

Get-3parSystem
Syntax
Get-3parSystem [[-Detailed]] [[-SystemParameters]] [[-Fan]] [[SystemCapacity]] [[-vvSpace]] [[-DomainSpace]] [[-Descriptor]] [[-DevType]
] [[-SANConnection] ] []
Description
Displays the HPE 3PAR StoreServ Storage system information.
Parameters
Detailed
Specifies that more detailed information about the system is displayed.
SystemParameters
Specifies that the system parameters are displayed.
Fan
Displays the system fan information.
SystemCapacity
Displays the system capacity information in MiB.
vvSpace
Displays the system capacity information in MiB with an emphasis on VVs.
Domainspace
Displays the system capacity information broken down by domain in MiB.
Descriptor
Displays the system descriptor properties.
DevType
Displays the system capacity information where the disks must have a device type string matching the
specified device type; either Fast Class (FC), Nearline (NL), Solid State Drive (SSD).
Examples
C:\PS>Get-3parSystem
Displays HPE 3PAR Storage system information, such as system name, model, serial number, and
system capacity information.
C:\PS> Get-3parSystem -SystemCapacity
Lists HPE 3PAR StoreServ Storage system space information in MB (1024^2 bytes).
C:\PS> Get-3parSystem -DevType FC
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

110

HPE 3PAR PowerShell ToolKit CLI cmdlets

Get-3parTask
Syntax
Get-3parTask [[-All]] [[-Done]] [[-Failed]] [[-Active]] [[-Hours] ]
[[-Task_type] ] [[-TaskID] ] [[-SANConnection] ]
[]
Description
Displays information about tasks.
Parameters
All
Displays all tasks.
Done
Displays only tasks that are successfully completed.
Failed
Displays only tasks that are unsuccessfully completed.
Active
Displays only tasks that are currently in progress.
Hours
Show only tasks started within the past , where  is an integer from 1 through 99999.
Task_type
Specifies that specified patterns are treated as glob-style patterns and that all tasks whose types
match the specified pattern are displayed. To see the different task types, use the showtask column
help.
TaskID
Shows detailed task status for specified tasks. Tasks must be explicitly specified using their task IDs
. Multiple task IDs can be specified. This option cannot be used in conjunction with other
options.
Examples
C:\PS> Get-3parTask
Display all tasks.
C:\PS>Get-3parTask -All
Display all tasks. Unless the -All option is specified, system tasks are not displayed.
C:\PS> Get-3parTask -Done
Display includes only tasks that are successfully completed
C:\PS> Get-3parTask -Failed
Display includes only tasks that are unsuccessfully completed.
C:\PS> Get-3parTask -Active
Display includes only tasks that are currently in progress.
C:\PS> Get-3parTask -Hours 10
Show only tasks started within the past 
C:\PS> Get-3parTask -Task_type xyz

HPE 3PAR PowerShell ToolKit CLI cmdlets

111

Specifies that specified patterns are treated as glob-style patterns and that all tasks whose types match
the specified pattern are displayed
C:\PS> Get-3parTask -taskID 4
Show detailed task status for specified task 4.
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3parUserConnection
Syntax
Get-3parUserConnection [[-Current]] [[-Detailed]] [[-SANConnection] ]
[]
Description
Displays information about users who are currently connected (logged in) to the storage system.
Parameters
Current
Shows all information about the current connection only.
Examples
C:\PS> Get-3parUserConnection
Shows information about users who are currently connected (logged in) to the storage system.
C:\PS> Get-3parUserConnection

-Current

Shows all information about the current connection only.
C:\PS> Get-3parUserConnection

-Detailed

Specifies the more detailed information about the user connection
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Get-3ParVVolSC
Syntax
Get-3ParVVolSC [[-Detailed]] [[-Listcols]] [[-SC_name] ] [[SANConnection] ] []
Description
Displays VVol storage containers, used to contain VMware Volumes for Virtual Machines (VVols).
Parameters
listcols
Lists the columns available to be shown in the -showcols option described below.
Detailed
Displays more information about the storage containers, including any VVols that have been autodismissed by remote copy DR operations.

112

HPE 3PAR PowerShell ToolKit CLI cmdlets

SC_name
Specifies the name of the storage container.
Examples
C:\PS> Get-3ParVVolSC
C:\PS> Get-3ParVVolSC – option Detailed
NOTE: For more information, execute Get-Help "Command Name" with Full Option.

Invoke cmdlets
Invoke-3parCLICmd
Syntax
Invoke-3parCLICmd [-Connection]  [-Cmds] 
[]
Description
Executes a command on a HPE 3PAR StoreServ Storage using POSH SSH Module or CLI.
Parameters
Connection
Pointer to an object that contains password file and IP address.
Cmds
Command to be executed.
Examples
C:\PS>Invoke-3parCLICmd -Connection $global:SANConnection -Cmds "showsysmgr"
Alternate usage
1. $Cmd = “createvvcopy -s -p set:vvcopyset set:copies”
2. Invoke-3parCLICmd -Connection $SANConnection -cmds $Cmd

Import cmdlets
Import-3parVV
Syntax
Import-3parVV [[-Usrcpg] ] [[-Snapname] ] [[-Snp_cpg]
] [[-NoCons]] [[-Priority] ] [[-Job_ID] ] [[-NoTask]]
[[-Cleanup]] [[-TpVV]] [[-TdVV]] [[-DeDup]] [[-Compr]] [[-MinAlloc] ]
[[-VVName] ] [[-SANConnection] ] []
Description
Starts migrating the data from a remote LUN to the local HPE 3PAR Storage System.

HPE 3PAR PowerShell ToolKit CLI cmdlets

113

Parameters
NoCons
Any VV sets specified will not be imported as consistent groups.
If the VV set contains any VV members that in a previous import attempt were imported consistently,
they will continue to get imported consistently.
Priority
Specifies the priority of migration of a volume or a volume set.
Job_ID
Specifies the Job ID up to 511 characters for the volume.
.
NoTask
Performs import-related preprocessing which results in transitioning the volume to exclusive state and
setting up of the "consistent" flag on the volume if importing consistently.
Cleanup
Performs cleanup on source array after successful migration of the volume.
TpVV
Import the VV into a thinly provisioned space in the CPG specified in the command line.
TdVV
This option is deprecated, see DeDup.
DeDup
Import the VV into a thinly provisioned space in the CPG specified in the command line.
Compr
Import the VV into a compressed virtual volume in the CPG specified in the command line.
MinAlloc
This option specifies the default allocation size (in MB) to be set for TPVVs and TDVVs.
Snapname
Create a snapshot of the volume at the end of the import phase.
Snp_cpg
Specifies the name of the CPG from which the snapshot space will be allocated.
Usrcpg
Specifies the name of the CPG from which the volume user space will be allocated.
Snp_cpg
Specifies the name of the CPG from which the snapshot space will be allocated.
VVName
Specifies the VVs with the specified name.

114

HPE 3PAR PowerShell ToolKit CLI cmdlets

Examples
C:\PS> Import-3parVV -Usrcpg XYZ
C:\PS> Import-3parVV -Usrcpg asCpg -VVName as4
C:\PS> Import-3parVV -Usrcpg asCpg -Snapname asTest -VVName as4
C:\PS> Import-3parVV -Usrcpg asCpg -Snp_cpg asCpg -VVName as4
C:\PS> Import-3parVV -Usrcpg asCpg -Priority high -VVName as4
C:\PS> Import-3parVV -Usrcpg asCpg -NoTask -VVName as4
Returns
String object.
NOTE: For more detail, execute Get-Help "Command Name" with Full Option.

Join cmdlets
Join-3parFed
Syntax
Join-3parFed [[-UUID] ] [[-FedName] ] [[-Comment] ]
[[-Setkv] ] [[-Setkvifnotset] ] [[-SANConnection] ]
[]
Description
Makes the StoreServ system a member of the Federation identified by the specified name and UUID.
Parameters
Comment
Specifies any additional textual information.
Setkv
Sets or resets key/value pairs on the federation.
setkvifnotset
Sets key/value pairs on the federation if not already set.
UUID
Specifies the UUID of the Federation to be joined.
FedName
Specifies the name of the Federation to be joined.
CommentString
Specifies any additional textual information.
Examples
C:\PS> Join-3parFed -FedName TETS -UUID 12345
C:\PS> Join-3parFed -Comment hello -UUID 12345
C:\PS> Join-3parFed -Setkv 12

-UUID 12345 -FedName TEST

NOTE: For More detail execute Get-Help "Command Name" with Full Option.

HPE 3PAR PowerShell ToolKit CLI cmdlets

115

New cmdlets
New-3parCPG
Syntax
New-3parCPG [[-cpgName] ] [[-TemplateName] ] [[-AW] ]
[[-SDGS] ] [[-SDGL] ] [[-SDGW] ] [[-saLD_name]
] [[-sdLD_name] ] [[-Domain] ] [[-RAIDType] ]
[[-SSZ] ] [[-RS] ] [[-SS] ] [[-HA] ] [[-CH]
] [[-SANConnection] ] []
Description
Creates a Common Provisioning Group (CPG).
Parameters
TemplateName
DisplaysTemplate Names.
AW
Specifies the percentage of used snapshot administration or snapshot data space that results in a
warning alert.
SDGS
Specifies the growth increment, the amount of logical disk storage created on each auto-grow
operation.
SDGL
Specifies that the auto-grow operation is limited to the specified storage amount.
SDGW
Specifies that the threshold of used logical disk space, when exceeded, results in a warning alert.
saLD_name
Specifies that existing logical disks are added to the CPG and are used for snapshot admin (SA)
space allocation.
sdLD_name
Specifies that existing logical disks are added to the CPG and are used for snapshot data (SD) space
allocation.
Domain 
Specifies the name of the domain with which the object will reside.
RAID_type
Specifies the RAID type of the logical disk: r0 for RAID-0, r1 for RAID-1, r5 for RAID-5, or r6 for RAID
6. If no RAID type is specified, then the default is r6.
SSZ
Specifies the set size in terms of chunklets. The default depends on the RAID type specified: 2 for
RAID-1, 4 for RAID-5, and 8 for RAID 6.
RS
Specifies the number of sets in a row.

116

HPE 3PAR PowerShell ToolKit CLI cmdlets

SS
Specifies the step size from 32 KB to 512 KB.
HA
Specifies that the layout must support the failure of one port pair, one cage, or one drive magazine
(mag).
CH
Specifies the chunklet location characteristics: either first (attempt to use the lowest numbered
available chunklets) or last(attempt to use the highest numbered available chunklets).
Example
C:\PS> New-3parCPG -cpgName "MyCPG" -Size 32G

-RAIDType r1

Creates a CPG named MyCPG with initial size of 32 GB and RAID configuration is r1 (RAID 1).
C:\PS> New-3parCPG -cpgName asCpg
C:\PS> New-3parCPG -cpgName asCpg1 -AW 1
C:\PS> New-3parCPG -cpgName asCpg1 -SDGS 1
C:\PS> New-3parCPG -cpgName asCpg1 -SDGL 12241
C:\PS> New-3parCPG -cpgName asCpg1 -saLD_name XYZ
C:\PS> New-3parCPG -cpgName asCpg1 -sdLD_name XYZ
C:\PS> New-3parCPG -cpgName asCpg1 -RAIDType r1
Returns
String object.
NOTE: For more information, execute Get-Help with Full Option.

New-3parFed
Syntax
New-3parFed [[-Fedname] ] [[-Comment] ] [[-Setkv] ]
[[-Setkvifnotset] ] [[-SANConnection] ] []
Description
Generates a UUID for the named Federation and makes the StoreServ system a member of that
Federation.
Parameters
comment
Specifies any additional textual information.
Setkv
Sets or resets key/value pairs on the federation.
Setkvifnotset
Sets key/value pairs on the federation if not already set.
Fedname
Specifies the name of the Federation to be created.

HPE 3PAR PowerShell ToolKit CLI cmdlets

117

Examples
C:\PS> New-3parFed -Fedname XYZ
C:\PS> New-3parFed –CommentString XYZ -Fedname XYZ
C:\PS> New-3parFed -Setkv TETS -Fedname XYZ
C:\PS> New-3parFed -Setkvifnotset TETS -Fedname XYZ
Returns
String object.
NOTE: For more information, executeGet-Help  with Full Option.

New-3parVV
Syntax
New-3parVV [[-vvName] ] [[-Size] ] [[-CPGName] ] [[vvSetName] ] [[-Force]] [[-Template] ] [[-Volume_ID]
] [[-Count] ] [[-Wait] ] [[-Comment] ] [[Shared]] [[-tpvv]] [[-Snp_Cpg]] [[-Sectors_per_track] ] [[Heads_per_cylinder] ] [[-minAlloc]] [[-Snp_aw] ] [[Snp_al] ] [[-SANConnection] ] []
Description
Creates a virtual volume.
Parameters
Size
Specifies the memory size to be allocated.
vvName
Assigns a new host name
vvSetName
Allocates the newly created VVol to presentVVol set name.
vvType
Specifies the destination vvcopy type. For example, tpvv or tdvv.
minAlloc
Specifies the default allocation size in MB.
CPGName
Specify the name of CPG.
Template
Use the options defined in template .
Volume_ID
Specifies the ID of the volume. By default, the next available ID is chosen.
Count 
Specifies the number of identical VVs to create.
Shared
Specifies that the system will try to share the logical disks among the VVs.

118

HPE 3PAR PowerShell ToolKit CLI cmdlets

Wait 
If the command would fail due to the lack of clean space, the -wait.
minalloc
This option specifies the default allocation size (in MB) to be set.
Snp_aw 
Enables a snapshot space allocation warning.
Snp_al 
Sets a snapshot space allocation limit.
Comment 
Specifies any additional information up to 511.
Example
C:\PS> New-3parVV
C:\PS> New-3parVV -vvName AVV
C:\PS> New-3parVV -vvName AVV -CPGName ACPG
C:\PS> New-3parVV -vvName VV_Aslam -CPGName CPG_Aslam
C:\PS> New-3parVV -vvName AVV -CPGName CPG_Aslam
C:\PS> New-3parVV -vvName AVV1 -CPGName CPG_Aslam –Force
C:\PS> New-3parVV -vvName AVV -CPGName CPG_Aslam -Force -tpvv
Returns
String object.
NOTE: For more information, execute Get-Help "Command Name" with Full option.

New-3parVVSet
Syntax
New-3parVVSet [[-vvSetName] ] [[-Add]] [[-Count] ] [[Comment] ] [[-Domain] ] [[-vvName] ] [[SANConnection] ] []
Description
Creates a new volume set.
Parameters
vvSetName
Assigns HostSetname.
Domain
Specifies the domain name.
vvName
Specifies the VV to add to the volume set.
comment
Adds comment for Volume set.

HPE 3PAR PowerShell ToolKit CLI cmdlets

119

Count
Add a sequence of  VVs starting with "vvname".
Add
Specifies that the VVs listed should be added to an existing set.
Examples
C:\PS>New-3parVVSet -vvSetName "MyVolumeSet"
Creates a volume set named MyVolumeSet.
C:\PS>New-3parVVSet -vvSetName "MYVolumeSet" -Domain MyDomain
Creates a volume set named MyVolumeSet in the domain MyDomain.
Returns
String object.
NOTE: For more information, execute Get-Help  with Full option.

New-3parHost
Syntax
New-3parHost [[-HostName] ] [[-Iscsi]] [[-Add]] [[-Domain] ]
[[-Forces]] [[-Persona] ] [[-Location] ] [[-IPAddress]
] [[-OS] ] [[-Model] ] [[-Contact] ] [[Comment] ] [[-NSP] ] [[-WWN] ] [[-IscsiName]
] [[-SANConnection] ] []
Description
Creates a host.
Parameters
HostName
Specify new name of the host
Add
Add one or more specified WWNs or iscsi_name(s) to an existing host (at least one WWN or
iscsi_name must be specified).
Domain
Create the host in the specified domain or domain set.
Forces
Forces the tear down of lower priority VLUN exports if necessary.
Persona
Sets the host persona that specifies the personality for all ports which are part of the host set.
Location
Specifies the host location.

120

HPE 3PAR PowerShell ToolKit CLI cmdlets

IPAddress
Specifies the host IP address.
OS
Specifies the operating system running on the host.
Model
Specifies the host model.
Contact
Specifies the host owner and contact information.
Comment
Specifies any additional information for the host.
NSP
Specifies the desired relationship between one or more array ports and host for target-driven zoning.
WWN
Specifies the World Wide Name(WWN) to be assigned or added to an existing host.
IscsiName
Host iSCSI name to be assigned or added to a host. This specifier is optional.
iSCSI
When specified, it means that the address is an iSCSI address.
Example
C:\PS> New-3parHost -HostName HV01A -Persona 2 -WWN 10000000C97B142E
Creates a host entry named HV01A with WWN equal to 10000000C97B142E.
C:\PS> New-3parHost -HostName HV01B -Persona 2 -iSCSI
Creates a host entry named HV01B with iSCSI equal to iqn.1991-06.com.microsoft:dt-391-xp.hq.
3par.com.
C:\PS> New-3parHost -HostName HV01A -Persona 2
C:\PS> New-3parHost -HostName Host3 -iSCSI
C:\PS> New-3parHost -HostName Host4 -iSCSI -Domain ZZZ
Returns
String object.
NOTE: For more information, execute Get-Help  with Full option.

New-3parHostSet
Syntax
New-3parHostSet [[-HostSetName] ] [[-hostName] ] [[-Add]] [[Comment] ] [[-Domain] ] [[-SANConnection] ]
[]

HPE 3PAR PowerShell ToolKit CLI cmdlets

121

Description
Creates a new host set.
Parameters
hostSetName
Specifies the host set name.
hostname
Specify new name of the host
Domain
Create the host set in the specified domain.
Add
Specifies any comment or additional information for the set.
Examples
C:\PS> New-3parHostSet -hostSetName HV01C-HostSet
C:\PS> New-3parHostSet -hostSetName HV01C-HostSet -Domain domain
C:\PS> New-3parHostSet -hostSetName HV01C-HostSet -hostName "MyHost"
Returns
String object.
NOTE: For more information, execute Get-Help with Full Option.

New-3parVLUN
Syntax
New-3parVLUN [[-vvName] ] [[-vvSet] ] [[-LUN] ] [[NSP] ] [[-HostSet] ] [[-HostName] ] [[-Cnt] ]
[[-NoVcn]] [[-Ovrd]] [[-SANConnection] ] []
Description
Creates a vLUN and presents it to a host.
Parameters
vvName
Specifies the virtual volume or virtual volume set name, using up to 31 characters in length. The
volume name is provided in the syntax of basename.int. The VV set name must start with "set:".
vvSet
Specifies the virtual volume or virtual volume set name, using up to 31 characters in length.
LUN
Specifies the LUN as an integer from 0 through 16383.
HostName
Specifies the host where the LUN is exported, using up to 31 characters.

122

HPE 3PAR PowerShell ToolKit CLI cmdlets

HostSet
Specifies the host set where the LUN is exported, using up to 31 characters in length.
NSP
Specifies the system port of the virtual LUN export.
node
Specifies the system node, where the node is a number from 0 through 7.
slot
Specifies the PCI bus slot in the node, where the slot is a number from 0 through 5.
port
Specifies the port number on the FC card, where the port number is 1 through 4.
Cnt
Specifies that a sequence of VLUNs, as specified by the num argument, are exported to the same
system port and host that is created.
NoVcn
Specifies that a VLUN Change Notification (VCN) not be issued after export.
Ovrd
Specifies that existing lower priority VLUNs will be overridden, if necessary.
Examples
C:\PS>New-3parVLUN -vvName PassThru-Disk -PresentTo HV01
Exports a virtual volume named PassThru-Disk and presents it to HV01.
C:\PS>New-3parVLUN -vvName set:Witness_Set -PresentTo set:HV01C-set
Exports a volume set and presents it to a host set.
Returns
String object.
NOTE: For more information, execute Get-Help  with Full Option.

New-3parVVCopy
Syntax
New-3parVVCopy [-parentName]  [-vvCopyName]  [[-online]] [[CPGName] ] [[-snapcpg] ] [[-Tpvv]] [[-Tdvv]] [[-Dedup]] [[Compr]] [[-AddToSet]] [[-R]] [[-Halt]] [[-Saves]] [[-Blocks]] [[-Priority]
] [[-SANConnection] ] []
Description
Creates a full physical copy of a VVol or a read/write virtual copy on another VVol.
Parameters
parentName
Specifies name of the parent Virtual Volume.

HPE 3PAR PowerShell ToolKit CLI cmdlets

123

Online
Creates an online copy of Virtual Volume.
vvCopyName
Specifies the name of the virtual volume copy name.
CPGName
Specifies the name of CPG.
snapcpg
Specifies the name of the CPG from which the snapshot space will be allocated.
Tpvv
Specifies the type of destination vvcopy.
Indicates that the VV the online copy creates should be a thinly provisioned volume. Cannot be used
with the -dedup option.
Tdvv
This option is deprecated, see -dedup.
Dedup
Indicates that the VV the online copy creates should be a thinly deduplicated volume, which is a thinly
provisioned volume with inline data deduplication.
Compr
Indicates that the VV the online copy creates should be a compressed virtual volume.
AddToSet
Adds the VV copies to the specified VV set. The set will be created if it does not exist.
R
Specifies that the destination volume be resynchronized with its parent volume using a saved
snapshot so that only the changes since the last copy or resynchronization needs to be copied.
Halt
Specifies that an ongoing physical copy to be stopped. This will cause the destination volume to be
marked with the 'cpf' status, which will be cleared up when a new copy is started.
Save
Saves the snapshot of the source volume after the copy of the volume is completed.
Blocks
Specifies that this command blocks until the operation is completed.
priority
Specifies the priority of the copy operation when it is started .

124

HPE 3PAR PowerShell ToolKit CLI cmdlets

Examples
C:\PS> New-3parVVCopy -parentName VV1 -vvCopyName VV2
C:\PS> New-3parVVCopy -parentName VV1 -vvCopyName VV2 -online -CPGName ZZZ
C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3 -online -CPGName asCpg -Tpvv

C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3

-Tdvv

C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3

-Dedup

C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3

-Compr

C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3

-AddToSet

C:\PS> New-3parVVCopy -parentName as1 -vvCopyName as3 -Priority med
Returns
String object.
NOTE: For more information, executeGet-Help  with Full Option.

New-3parGroupVVCopy
Syntax
New-3parGroupVVCopy [[-parent_VV] ] [[-destination_VV] ] [[destination_cpg] ] [[-VV_name] ] [[-wwn] ] [[-P]] [[R]] [[-Halt]] [[-S]] [[-B]] [[-Priority] ] [[-Skip_zero]] [[-Online]]
[[-TPVV]] [[-TdVV]] [[-Dedup]] [[-Compressed]] [[-SANConnection] ]
[]
Description
Creates consistent group physical copies of a list of virtual volumes.
Parameters
parent_VV
Indicates the parent virtual volume.
destination_VV
Indicates the destination virtual volume.
destination_cpg
Specifies the destination CPG to use for the destination volume if the -online option is specified.
VV_name
Specifies the virtual volume name to use for the destination volume if the -online option is specified.
wwn
Specifies the WWN to use for the destination volume if the -online option is specified.
P
Starts a copy operation from the specified parent volume to its destination volume.
R
Resynchronizes the set of destination volumes with their respective parents using saved snapshots
so that only the changes made since the last copy or resynchronization is copied.

HPE 3PAR PowerShell ToolKit CLI cmdlets

125

Halt
Halt
S
Saves snapshots of the parent volume for quick resynchronization and to retain the parent-copy
relationships between each parent and destination volume.
B
Use this specifier to block until all the copies are complete.
Priority
Specifies the priority of the copy operation when it is started.
Online
Specifies that the copy is to be performed online.
Skip_zero
When copying from a thin provisioned source, only copy allocated portions of the source VV.
TPVV
Indicates that the VV the online copy creates should be a thinly provisioned volume. Cannot be used
with the -dedup option.
TdVV
This option is deprecated, see -Dedup.
Dedup
Indicates that the VV the online copy creates should be a thinly deduplicated volume, which is a thinly
provisioned volume with inline data deduplication.
Compressed
Indicates that the VV the online copy creates should be a compressed virtual volume.
Examples
C:\PS> New-3parGroupVVCopy -P -parent_VV ZZZ -destination_VV ZZZ
C:\PS> New-3parGroupVVCopy -P -Online -parent_VV ZZZ -destination_cpg ZZZ -VV_name ZZZ -wwn 123456

C:\PS> New-3parGroupVVCopy -R -destination_VV ZZZ
C:\PS> New-3parGroupVVCopy -Halt -destination_VV ZZZ
Returns
String object.
NOTE: For more information, execute Get-Help  with Full Option.

New-3parSnapVolume
Syntax
New-3parSnapVolume [[-svName] ] [[-vvName] ] [[-VV_ID]
] [[-exp] ] [[-retain] ] [[-ro]] [[-Rcopy]] [[vvSetName] ] [[-Comment] ] [[-SANConnection] ]
[]

126

HPE 3PAR PowerShell ToolKit CLI cmdlets

Description
Creates a point in time snapshot copy of a virtual volume.
Parameters
svName
Specifies the snapshotname.
vvName
Specifies the parent volume name or volume set name.
VV_ID
Specifies the ID of the copied VV set.
Comment
Specifies any additional information up to 511 characters for the volume.
exp
Specifies the relative time from the current time, when a volume expires.