HPE 3PAR StoreServ Storage PowerShell Toolkit 2.2 User Guide Store Serv Power Shell
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 368
| Download | |
| Open PDF In Browser | View 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]