Dell Storage API PowerShell SDK Getting
Started Guide
The Dell Storage API PowerShell SDK allows you to manage a Data Collector and Storage Centers to the
same extent as using Storage Manager.
Revision History
Document number: 680-125-001
Revision Date Description
A April 2016 Initial release
Getting Started with the Dell Storage API PowerShell SDK
Prerequisites
• Windows PowerShell 4.0 or higher.
• .NET Framework 4.5 or higher.
• Windows 32–bit or 64–bit operating system.
NOTE: The following cmdlets for Host Setup must be run on a system with a 64-bit operating
system:
– Connect-DellHostSetupIscsiTarget
– Get-DellEmDiscoveredStorageCenter
– Get-DellEmDiscoveredStorageCenterByMacAddress
– Get-DellEmDiscoveredStorageCenterDataCollectorAssociation
– Get-DellEmDiscoveredStorageCenterDisk
– Get-DellEmDiscoveredStorageCenterInitialConfigSteps
– Get-DellHostSetupBestPractices
– Get-DellHostSetupBlackListedDriver
– Get-DellHostSetupHba
– Get-DellHostSetupIscsiPortal
– Set-DellEmDiscoveredStorageCenterIndicatorOff
– Set-DellEmDiscoveredStorageCenterIndicatorOn
– Set-DellHostSetupBestPractices
– Start-DellEmDiscoveredStorageCenterDiscover
– Start-DellEmDiscoveredStorageCenterInitializeConfiguration
– Test-DellEmDiscoveredStorageCenterConfiguration
Document Number: 680-125-001
Rev. A
2016 - 04
• Download and install Visual C++ Redistributable for Visual Studio 2012 from [Link]/en-
us/download/[Link]?id=30679.
• You must be logged in to a user account with permission to execute PowerShell scripts.
• The Storage Manager Data Collector must be installed within the data center. This version of Dell
Storage PowerShell SDK is supported in Storage Manager 2016 R1 and later. For more information,
refer to the Storage Manager Installation Guide.
Download and Install the Dell Storage PowerShell SDK
Before using Dell Storage PowerShell Cmdlets, you must download and install the PowerShell SDK.
1. Download the Dell Storage PowerShell SDK .ZIP file (for example,
DellStoragePowerShellSDK_v3_X_X_XXX.zip) from the Dell Knowledge Center or [Link].
The .ZIP file contains the following items:
• Files required to run Dell Storage PowerShell Cmdlets as well as script examples.
• [Link] – Contains the HTML help files for the Dell Storage PowerShell Cmdlets.
2. Unzip the files from the PowerShell .ZIP file to a local directory.
3. Open Windows PowerShell.
4. Type the following command into PowerShell, using the local directory where the files were saved in
Step 2 in place of “{Install Path}”: Import-Module "{Install Path}
\[Link].psd1"
NOTE: The Import-Module command must be run each time a PowerShell session is initiated.
5. (Optional) To run one of the Host Setup cmdlets listed in the Prerequisites, you must first register the
Host Setup assembly. The assembly needs to be registered only once. To register the assembly, type
the following command into PowerShell on a system with a 64-bit operating system: C:\Windows
\[Link]\Framework64\v4.0.30319\[Link] "{Install Path}
\[Link]" /codebase
NOTE: The RegASM: warning RA0000 may display when you register the Host Setup assembly.
No action is necessary. You may continue to use the Dell Storage PowerShell Cmdlets.
You can now use the Dell Storage PowerShell Cmdlets and use the Get-Help command for more
information on the installed cmdlets.
View Dell Storage PowerShell HTML Documentation
Unzip the file containing the HTML documentation and then use Internet Explorer to view the
documentation.
1. Create a folder to hold the HTML files from [Link].
2. Unzip the contents of [Link] into the new folder.
3. Use Internet Explorer to open the [Link] file in that folder.
2
Run the Dell Storage PowerShell Cmdlets
Use the following cmdlets to open a connection to an Storage Manager Data Collector, view help, view
Storage Centers, and log off the Data Collector.
NOTE: You cannot use the Dell Storage PowerShell Cmdlets by connecting directly to a Storage
Center.
1. Open a connection to an Storage Manager Data Collector:
$conn = Connect-DellApiConnection -HostName
"DataCollectorHostnameOrIpAddress" -User "UserName"
2. View PowerShell help for a Dell Storage cmdlet:
Get-Help Get-DellStorageCenter -Full
3. Retrieve the Storage Centers that can be accessed by your Storage Manager user:
Get-DellStorageCenter -Connection $conn
4. Log off the connection:
Disconnect-DellApiConnection -Connection $conn
Create and Manage a Named Connection
Use the following commands to create, get, and remove a named connection.
• Create a named connection:
Connect-DellApiConnection -HostName "HostnameOrIpAddress" -User "UserName" -
Save "NamedConnection"
• Verify the named connection:
Get-DellSavedApiConnection -Name "NamedConnection"
Port : 3033
Name : NamedConnection
HostName : {Hostname}
User : UserName
DefaultConnection : False
• Use a named connection:
Get-DellStorageCenter -ConnectionName "NamedConnection"
Output...
• Remove a named connection:
Remove-DellSavedApiConnection -Name "NamedConnection"
3
True
Set and Manage a Default Connection
Use the following commands to create, get, and use a default connection.
• Create a named connection to be the default connection:
Connect-DellApiConnection -HostName "HostnameOrIpAddress" -User "UserName" -
Save "DefaultConnection" -Default
• Verify the default connection:
Get-DellSavedApiConnection -Name "DefaultConnection"
Port : 3033
Name : DefaultConnection
HostName : {Hostname}
User : UserName
DefaultConnection : True
• Use the default connection:
Get-DellStorageCenter
Output...
FluidFS Cmdlet Examples
Use the following commands to create and list NAS volumes and SMB shares for a FluidFS cluster.
• Create a new NAS volume for a FluidFS cluster using the default values:
New-DellFluidFsNasVolume "Cluster Name" -Connection $conn -Name
PowerShell_Vol -Size 500gb -InteroperabilityPolicy 0
• List NAS volumes for a FluidFS cluster:
Get-DellFluidFsClusterNasVolumeListAssociation –Connection $conn –Instance
"Cluster Name"
• Create a new SMB share for a NAS volume using the default values:
New-DellFluidFsSmbShare "Cluster Name" -Connection $conn -NasVolumeId 985600
-Path / -ShareName Share1
• List SMB shares for a FluidFS cluster:
Get-DellFluidFsClusterSmbShareListAssociation "Cluster Name" -Connection
$conn
4
Frequently Asked Questions (FAQs) about the Dell Storage API PowerShell
SDK
Find answers to some of the most common questions about the Dell Storage API PowerShell SDK.
Why Does an Error Message Appear When Connecting to an Storage Manager Data Collector Using the
Connect-DellApiConnection Cmdlet?
The following error message appears: Connect-DellApiConnection : HostNotAvailable - Exception
Setting up Connection: Unable to connect to the remote server
To resolve the issue, ensure that the value after the -HostName parameter is to the hostname or IP
address of an available server that has Storage Manager Data Collector installed and running.
Connecting directly to a Storage Center is not supported.
Figure 1. Proper Connection Between the Server and Storage Centers
Why do I get a Confirmation message when running certain cmdlets?
A confirmation message appears that is similar to this example:
Confirm Are you sure you want to perform this action? Performing operation ... [Y] Yes [A] Yes to All [N]
No [L] No to All [S] Suspend [?] Help (default is "Y")
To provide full functionality, some of the Dell Storage cmdlets modify the state of a Storage Center or
Data Collector (this includes restarting or shutting down these devices). In those cases, the cmdlets
require a confirmation that you want to proceed.
If an object, method, or attribute is marked as deprecated, will it be removed from the Dell Storage
API?
Dell follows the standard of supporting deprecated entities in the API through the next major version. For
example, if an object is marked as deprecated in version 3.x, the object will still be present and functional
through all the 3.x and 4.x versions. However, that object may be removed from the API starting with
version 5.x.
5
Dell Storage API PowerShell SDK: Legacy PSCS Mapping
Table 1 shows the mapping between the Legacy Compellent PSCS cmdlets to the current Dell Storage
API PowerShell SDK cmdlets. The mappings do not indicate direct conversions but instead show the new
cmdlets that perform the same basic functionality as the legacy PowerShell cmdlets.
Table 1. Legacy PSCS to Dell Storage API PowerShell SDK Mapping
PSCS 7.x Legacy Dell Storage API 3.x PowerShell SDK
Acknowledge-SCAlert Set-DellScAlertAcknowledged
Add-CMLVolumeAccessPath (None)
Add-SCReplayProfileRule New-DellScReplayProfileRule
Add-SCServerPort Add-DellScPhysicalServerHba
Add-DellScVirtualServerHba
Add-VolumeAccessPath (None)
CancelSwapRole-SCLiveVolume Stop-DellScLiveVolumeSwapRole
ConvertTo-SCAsyncReplication Start-DellScLiveVolumeToReplicationRevert
ConvertTo-SCLiveVolume Convert-DellScReplicationToLiveVolume
Expand-SCVolume Expand-DellScVolume
Get-CMLDiskDevice (None)
Get-CMLNextFreeDriveLetter (None)
Get-CMLVolume (None)
Get-DiskDevice (None)
Get-NextFreeDriveLetter (None)
Get-SCAlert Get-DellScAlert
Get-SCAsyncReplication Get-DellScReplication
Get-SCCmm Get-DellScCopyMirrorMigrate
Get-SCCommandSetVersion Get-DellStorageApiCommandSetVersion
Get-SCConnection Connect-DellApiConnection
Get-SCDisk Get-DellScDisk
6
PSCS 7.x Legacy Dell Storage API 3.x PowerShell SDK
Get-SCDiskFolder Get-DellScDiskFolder
Get-SCLiveVolume Get-DellScLiveVolume
Get-SCOSType Get-DellScServerOperatingSystem
Get-SCPort Get-DellScControllerPort
Get-SCRecycleBinVolume Get-DellScVolume -InRecycleBin $true
Get-SCReplay Get-DellScReplay
Get-SCReplayProfile Get-DellScReplayProfile
Get-SCReplaySchedule Get-DellScReplayProfileRule
Get-SCReplicationQos Get-DellScReplicationQosNode
Get-SCServer Get-DellScServer
Get-SCServerFolder Get-DellScServerFolder
Get-SCStorageCenter Get-DellStorageCenter
Get-SCStorageProfile Get-DellScStorageProfile
Get-SCStorageType Get-DellScStorageType
Get-SCUser Get-DellScUser
Get-SCVolume Get-DellScVolume
Get-SCVolumeFolder Get-DellScVolumeFolder
Get-SCVolumeMap Get-DellScMapping
Get-DellScMappingProfile
Get-Volume (None)
New-CMLVolume (None)
New-SCAsyncReplication New-DellScReplication
New-SCCmmCopy New-DellScCopyMirrorMigrateViaCopy
New-SCCmmMigrate New-DellScCopyMirrorMigrateViaMigrate
New-SCCmmMirror New-DellScCopyMirrorMigrateViaMirror
7
PSCS 7.x Legacy Dell Storage API 3.x PowerShell SDK
New-SCLiveVolume New-DellScLiveVolume
New-SCReplay New-DellScVolumeReplay
New-SCReplayProfile New-DellScReplayProfile
New-SCReplaySchedule New-DellScReplayProfileRule
New-SCReplicationQos New-DellScReplicationQosNode
New-DellScReplicationQosAdvancedSettings
New-SCServer New-DellScServerCluster
New-DellScPhysicalServer
New-DellScVirtualServer
New-SCServerFolder New-DellScServerFolder
New-SCStorageProfile New-DellScStorageProfile
New-SCUser New-DellScUser
New-SCVolume New-DellScVolume
New-SCVolumeFolder New-DellScVolumeFolder
New-SCVolumeMap Add-DellScVolumeToServerMap
New-Volume (None)
Pause-SCAsyncReplication Suspend-DellScReplication
Pause-SCCmm Suspend-DellScCopyMirrorMigrate
Preallocate-SCVolume Start-DellScVolumePreallocateStorage
Remove-CMLVolumeAccessPath (None)
Remove-SCAsyncReplication Remove-DellScReplication
Remove-SCCmm Remove-DellScCopyMirrorMigrate
Remove-SCConnection Remove-DellSavedApiConnection
Remove-SCLiveVolume Remove-DellScLiveVolume
Remove-SCRecycleBinVolume Remove-DellScVolume
Remove-SCReplay Start-DellScReplayExpire
8
PSCS 7.x Legacy Dell Storage API 3.x PowerShell SDK
Remove-SCReplayProfile Remove-DellScReplayProfile
Remove-SCReplaySchedule Remove-DellScReplayProfileRule
Remove-SCReplicationQos Remove-DellScReplicationQosNode
Remove-SCServer Remove-DellScServer
Remove-SCServerFolder Remove-DellScServerFolder
Remove-SCServerPort Remove-DellScVirtualServerHba
Remove-DellScPhysicalServerHba
Remove-SCStorageProfile Remove-DellScStorageProfile
Remove-SCUser Remove-DellScUser
Remove-SCVolume Start-DellScVolumeRecycle
Remove-SCVolume-SkipRecycleBin Remove-DellScVolume
Remove-SCVolumeFolder Remove-DellScVolumeFolder
Remove-SCVolumeMap Remove-DellScMappingProfile
Remove-SCVolumeReplayProfile Set-DellScVolumeConfiguration
Remove-VolumeAccessPath (None)
Rescan-CMLDiskDevice (None)
Rescan-DiskDevice (None)
Restore-SCRecycleBinVolume Restore-DellScVolume
Resume-SCAsyncReplication Resume-DellScReplication
Resume-SCCmm Resume-DellScCopyMirrorMigrate
Set-CMLDiskDevice (None)
Set-CMLVolume (None)
Set-DiskDevice (None)
Set-SCAsyncReplication Set-DellScReplication
Set-SCCmm Set-DellScCopyMirrorMigrate
9
PSCS 7.x Legacy Dell Storage API 3.x PowerShell SDK
Set-SCDisk Set-DellScDiskRevertToManaged
Set-SCLiveVolume Set-DellScLiveVolume
Set-SCReplay Set-DellScReplay
Set-SCReplayProfile Set-DellScReplayProfile
Set-SCReplicationQos Set-DellScReplicationQosNode
Set-SCServer Set-DellScPhysicalServer
Set-DellScVirtualServer
Set-DellScServerCluster
Set-SCServerFolder Set-DellScServerFolder
Set-SCStorageProfile Set-DellScStorageProfile
Set-SCUser Set-DellScUser
Set-SCVolume Set-DellScVolume
Set-DellScVolumeConfiguration
Set-SCVolumeFolder Set-DellScVolumeFolder
Set-SCVolumeReplayProfile Set-DellScVolumeConfiguration
Set-SCVolumeStorageProfile Set-DellScVolumeConfiguration
Set-Volume (None)
SwapRole-SCLiveVolume Start-DellScLiveVolumeSwapRole
Copyright © 2016 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. Dell™ and the Dell logo are trademarks of Dell Inc. in the United States and/or other
jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
10
