en-US/about_PowerStore_Module.help.txt
|
TOPIC
about_PowerStore_Module SHORT DESCRIPTION Explains how to import and use the PowerStore module. LONG DESCRIPTION The PowerShell module for Dell PowerStore provides cmdlets for management of PowerStore clusters. Cmdlets in this module provide tools for provisioning of volumes, volume groups, snapshots, hosts and host groups, managing local and remote replications, and querying hardware and networking resources. HOW TO USE THE MODULE The module must be imported using the Import-Module command. # Simple option to import the module Import-Module Dell.PowerStore # Import the module using a prefix of PowerStore for each command Import-Module -Prefix PowerStore Dell.PowerStore The use of the prefix will allow for all cmdlets to be called via a prefixed form of the cmdlet, e.g. Get-PowerStoreHost can be used instead of Get-Host. This is useful for cases where there is a name conflict between the cmdlets in different modules. An alternative is to prefix the cmdlet with the module name, e.g. Dell.PowerStore\Get-Host. The PowerStore module communicates with one or more PowerStore clusters via HTTPS using the PowerStore REST API. Most cmdlets require that a PowerStore Cluster object be used. Use the Connect-Cluster cmdlet to connect to the target PowerStore cluster and save the output to a variable, e.g. $cluster. $cluster = Connect-Cluster -HostName <host> <credential> Only TLS 1.2 protocol is supported. Certificates need to be imported to the Trusted Root Certification Authorities prior to running the Connect-Cluster command. To disable certificate validation, run "[Net.ServicePointManager]::ServerCertificateValidationCallback = { $true }" prior to executing the Connect-Cluster cmdlet. Please note that this will disable certificate validation for all cmdlets in current PowerShell session including commands from other modules. Supported PowerStore REST API Versions PowerStore REST API versions 1.0 and higher are supported in this release. Cmdlet Input For all cmdlets with Name parameter, the value of the parameter is case sensitive. For PowerStore REST API 1.0, name property is not available for IpPoolAddress and Network, using Name or Identify parameter will cause exception. Get cmdlets for hardware and networking that support Name parameter allow $null or empty string for the Name parameter. If $null is used, only instances without name will be returned. Cmdlet Output For Get cmdlets where only one instance for a given name is expected, ObjectNotFoundException will be thrown if no instance found. Get cmdlets for hardware and networking that support Name parameter could return more than one instances for a given name. If a name is non existing, the cmdlets will return an empty list. PowerStore resource instance returned from a cmdlet may only have resource ID for referenced object, e.g., ApplianceId and NodeId properties of IpPoolAddress (the Appliance and Node properties will not be returned). To get details of the referenced object, use corresponding Get cmdlet for the resource type with the ID, e.g., using Get-Appliance or Get-Node to get details of the appliance or node. Instances in output can be filtered based on their property values by using Where-Object command, for example, Get-Host $cluster -Identify | Where-Object Name -Like *HOST*, will display hosts containing HOST. To learn more about the Where-Object command, please use "help Where-Object". SEE ALSO Connect-Cluster Disconnect-Cluster |