en-US/HPESmartArrayCmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.36--> <!-- Module: HPESmartArrayCmdlets Version: 1.0.0.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Test-HPESAConnection</command:name> <maml:description> <maml:para>The Test-HPESAConnection cmdlet checks if the connection to the target is still valid.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPESAConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPESAConnection cmdlet checks whether the connection to the target is still valid. The result will be stored in the IsConnected output property. For a valid connection, IsConnected will be True; otherwise it will be False.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Test-HPESAConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> Test-HPESAConnection $connection IP : 10.20.30.1 Hostname : abc1.domain.com IsConnected : True Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the output on the server with the Smart Array connection object passed as positional input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP "10.20.30.1,2" -Username admin -Password admin123 PS C:\> Test-HPESAConnection -Connection $connection IP : 10.20.30.1 Hostname : abc1.domain.com IsConnected : True Status : OK IP : 10.20.30.2 Hostname : abc2.domain.com IsConnected : False Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the output on the server with the list of Smart Array connection passed through named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Clear-HPESAPhysicalDrive</command:name> <maml:description> <maml:para>The Clear-HPESAPhysicalDrive erases the data from physical drives.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPESAPhysicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPESAPhysicalDrive erase/sanitize data from physical drives. This cmdlet has the following parameters:</maml:para> <maml:para>. ErasePattern</maml:para> <maml:para>. PhysicalDrive</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPESAPhysicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErasePattern</maml:name> <maml:description> <maml:para>The erase pattern is used to erase the drive. Accepted values are as follows:</maml:para> <maml:para>• SanitizeRestrictedBlockErase: Use the restricted block erase sanitize block erase method to erase a drive. • SanitizeUnrestrictedBlockErase: Use the unrestricted block erase sanitize method to erase a drive. • SanitizeRestrictedOverwrite: Use the restricted overwrite sanitize method to erase a drive. • SanitizeUnrestrictedOverwrite : Use the unrestricted overwrite sanitize method to erase a drive. • SanitizeRestrictedCryptoScramble: Use the unrestricted cryptographic scramble sanitize method to erase a drive. • SanitizeUnrestrictedCryptoScramble: Use the unrestricted cryptographic scramble sanitize method to erase a drive. • OnePass: Use the controller-based one pass erase method that writes zeroes to every sector of the drive. • TwoPass: Use the controller-based two pass erase method that writes random data to every sector of the drive on the first pass, and zeroes on the second pass. • ThreePass: Use the controller-based three pass erase method that writes random data to every sector of the drive on the first two passes, and zeroes on the third pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhysicalDrive</maml:name> <maml:description> <maml:para>A list of the physical drives to be erased.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErasePattern</maml:name> <maml:description> <maml:para>The erase pattern is used to erase the drive. Accepted values are as follows:</maml:para> <maml:para>• SanitizeRestrictedBlockErase: Use the restricted block erase sanitize block erase method to erase a drive. • SanitizeUnrestrictedBlockErase: Use the unrestricted block erase sanitize method to erase a drive. • SanitizeRestrictedOverwrite: Use the restricted overwrite sanitize method to erase a drive. • SanitizeUnrestrictedOverwrite : Use the unrestricted overwrite sanitize method to erase a drive. • SanitizeRestrictedCryptoScramble: Use the unrestricted cryptographic scramble sanitize method to erase a drive. • SanitizeUnrestrictedCryptoScramble: Use the unrestricted cryptographic scramble sanitize method to erase a drive. • OnePass: Use the controller-based one pass erase method that writes zeroes to every sector of the drive. • TwoPass: Use the controller-based two pass erase method that writes random data to every sector of the drive on the first pass, and zeroes on the second pass. • ThreePass: Use the controller-based three pass erase method that writes random data to every sector of the drive on the first two passes, and zeroes on the third pass.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhysicalDrive</maml:name> <maml:description> <maml:para>A list of the physical drives to be erased.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] System.String[][]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> $physicalDriveList = ,@("P1I:1:1","P1I:1:2") PS C:\> $result = Clear-HPESAPhysicalDrive -Connection $connection -ControllerLocation "Slot 0" -ErasePattern OnePass -PhysicalDrive $physicalDriveList PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example clears the physical drive using connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $physicalDriveList1 = @("P1I:1:1","P1I:1:2") PS C:\> $physicalDriveList2 = @("P1I:1:1","P1I:1:2") PS C:\> $result = $connection | Clear-HPESAPhysicalDrive -ControllerLocation @("Slot 0","Slot 1") -ErasePattern OnePass -PhysicalDrive @($physicalDriveList1,$physicalDriveList2) PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. } IP : 10.20.30.50 Hostname : xyz.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. } </dev:code> <dev:remarks> <maml:para>This example clears the physical drive passing a list of connection object as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAUnconfiguredPhysicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAPhysicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Connect-HPESA</command:name> <maml:description> <maml:para>The Connect-HPESA cmdlet creates connections to Smart Array targets.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>HPESA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-HPESA cmdlet creates connections to Smart Array targets represented by an iLO IP. This cmdlet has the following parameters:</maml:para> <maml:para>· IP: Holds the target iLO IP. · Username: Holds the target iLO username. · Password: Holds the target iLO password. · Credential: Holds the target PSCredentials. · Timeout: Holds the HTTPS protocol time out. · DisableCerificateAuthentication: Bypasses the server certificate check.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Connect-HPESA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="iLOIP , Host , Hostname"> <maml:name>IP</maml:name> <maml:description> <maml:para>Specifies iLO/Hostname to create a connection. IP can be either IPv4 or IPv6 address.</maml:para> <maml:para>Aliases: Address, iLOIP, Host, Hostname, IPv6 ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target. Must be entered with the password.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target. Must be entered with the username.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 60.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If this switch parameter is present, the server certificate authentication is disabled while establishing connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="PSCredentialSet"> <!--NAME: PSCredentialSet--> <maml:name>Connect-HPESA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="iLOIP , Host , Hostname"> <maml:name>IP</maml:name> <maml:description> <maml:para>Specifies iLO/Hostname to create a connection. IP can be either IPv4 or IPv6 address.</maml:para> <maml:para>Aliases: Address, iLOIP, Host, Hostname, IPv6 ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential object based on the username and password used to log onto the target.</maml:para> <maml:para>ParameterSetName: PSCredentialSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 60.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If this switch parameter is present, the server certificate authentication is disabled while establishing connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="iLOIP , Host , Hostname"> <maml:name>IP</maml:name> <maml:description> <maml:para>Specifies iLO/Hostname to create a connection. IP can be either IPv4 or IPv6 address.</maml:para> <maml:para>Aliases: Address, iLOIP, Host, Hostname, IPv6 ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target. Must be entered with the password.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target. Must be entered with the username.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 60.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If this switch parameter is present, the server certificate authentication is disabled while establishing connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Credential object based on the username and password used to log onto the target.</maml:para> <maml:para>ParameterSetName: PSCredentialSessionSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] System.Management.Automation.PSCredential[] System.Int32[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection IP : 10.20.30.1 Hostname : abc.domain.com Location : https://abc.domain.com/redfish/v1/SessionService/Sessions/admin000000005a6891f0651eb852/ Uri : https://abc.domain.com/redfish/v1/Sessions/ DisableCertificateAuthentication : False IsConnected : True ConnectionType : Redfish Username : admin ServerName : ProLiant BL460c Gen10 ServerGeneration : GEN10</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPESA cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $connection IP : 10.20.30.2 Hostname : xyz.domain.com Location : https://abc.domain.com/redfish/v1/SessionService/Sessions/admin000000005a6891f0651gs983/ Uri : https://abc.domain.com/redfish/v1/Sessions/ DisableCertificateAuthentication : True IsConnected : True ConnectionType : Redfish Username : admin ServerName : ProLiant DL380 Gen10 ServerGeneration : GEN10</dev:code> <dev:remarks> <maml:para>This example shows the output of Connect-HPESA cmdlet using the DisableCertificateAuthentication switch parameter to bypass server certificate check.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP abc.domain.com -Username admin -Password admin123 PS C:\> $connection IP : 10.20.30.1 Hostname : abc.domain.com Location : https://abc.domain.com/redfish/v1/SessionService/Sessions/admin000000005a68951215c28f5c/ Uri : https://abc.domain.com/redfish/v1/Sessions/ DisableCertificateAuthentication : False IsConnected : True ConnectionType : Redfish Username : admin ServerName : ProLiant BL460c Gen10 ServerGeneration : GEN10</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPESA cmdlet using hostname.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP FE80::E207:1BFF:FEFE:51A6 -Username admin -Password admin123 -DisableCertificateAuthentication WARNING: [fe80::e207:1bff:fefe:51a6] : The host name could not be resolved in DNS. PS C:\> $connection IP : [fe80::e207:1bff:fefe:51a6] Hostname : Location : https://[fe80::e207:1bff:fefe:51a6]/redfish/v1/SessionService/Sessions/admin000000005a6faa0bf7ced81c/ Uri : https://[fe80::e207:1bff:fefe:51a6]/redfish/v1/Sessions/ DisableCertificateAuthentication : True IsConnected : True ConnectionType : Redfish Username : admin ServerName : ProLiant DL360 Gen10 ServerGeneration : GEN10</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPESA cmdlet using IPv6 address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP "10.20.30.10,15,20" -Username admin -Password admin123 PS C:\> $connection.Count 3 PS C:\>$connection[2] IP : 10.20.30.20 Hostname : abc.domain.com Location : https:// abc.domain.com/v1/SessionService/Sessions/admin000000005a6d23e35851eb85/ Uri : https:// abc.domain.com/redfish/v1/Sessions/ DisableCertificateAuthentication : False IsConnected : True ConnectionType : Redfish Username : admin ServerName : ProLiant BL460c Gen10 ServerGeneration : GEN10</dev:code> <dev:remarks> <maml:para>This example shows the multiple connection using the Connect-HPESA cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPESAConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Disconnect-HPESA</command:name> <maml:description> <maml:para>The Disconnect-HPESA cmdlet closes the connection.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>HPESA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disconnect-HPESA cmdlet closes the connection and cleans up the resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disconnect-HPESA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> Disconnect-HPESA $connection</dev:code> <dev:remarks> <maml:para>This example disconnects the connection object passed as positional parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1,10.20.30.2,10,20.30.3 -Username admin -Password admin123 PS C:\> $connection | Disconnect-HPESA</dev:code> <dev:remarks> <maml:para>This example disconnects a list of Smart Array connection objects passed through pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPESAConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAConfigurationStatus</command:name> <maml:description> <maml:para>The Get-HPESAConfigurationStatus gets the status whether configuration(s) are applied or not after reboot of the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAConfigurationStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAConfigurationStatus gets the status whether configuration(s) are applied after reboot of the target server. The current Smart Array Redfish interface does not display an error message immediately after the POST/PATCH and PUT operations. You must restart the server after performing the desired configuration on the Smart Array controller. If the configuration is applied successfully, it returns a success message, otherwise it returns an error message and a list of properties that failed to configure.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAConfigurationStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller location for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller location for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $result = Get-HPESAConfigurationStatus -Connection $connection PS C:\> $result.ConfigurationStatus ControllerLocation : Slot 0 ControllerModel : ETag : F0E1B94B Severity : OK MessageId : Success Message : Request successfully completed Description : Indicates that all conditions of a successful operation have been met. MessageArgs : RelatedProperty : Resolution : None. ControllerLocation : Slot 1 ControllerModel : HPE Smart Array E208e-p SR Gen10 ETag : 1FC5DF2E Severity : Critical MessageId : CanChangeEditableControllerSAMNoLogicalDrives Message : Cannot set controller spare activation mode to %1 because no logical drives are configured Description : Indicates that the controller spare activation mode cannot be set because no logical drives are configured. MessageArgs : Disabled RelatedProperty : #/PredictiveSpareRebuild Resolution : Configure a logical drive. ControllerLocation : Slot 0b ControllerModel : HPE Smart Array S100i SR Gen10 ETag : 876C1B3A Severity : OK MessageId : Success Message : Request successfully completed Description : Indicates that all conditions of a successful operation have been met. MessageArgs : RelatedProperty : Resolution : None.</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAConfigurationStatus where the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40,10.20.30.50 -Username admin -Password admin123 PS C:\> $result = $connection | Get-HPESAConfigurationStatus PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : OK ConfigurationStatus : {@{ControllerLocation=Slot 0; ControllerModel=; ETag=F0E1B94B; Severity=OK; MessageId=Success; Message=Request successfully completed; Description=Indicates that all conditions of a successful operation have been met.; MessageArgs=; RelatedProperty=; Resolution=None.}, @{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array E208e-p SR Gen10; ETag=1FC5DF2E; Severity=Critical; MessageId=CanChangeEditableControllerSAMNoLogicalDrives; Message=Cannot set controller spare activation mode to %1 because no logical drives are configured; Description=Indicates that the controller spare activation mode cannot be set because no logical drives are configured.; MessageArgs=Disabled; RelatedProperty=#/PredictiveSpareRebuild; Resolution=Configure a logical drive.}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; ETag=876C1B3A; Severity=OK; MessageId=Success; Message=Request successfully completed; Description=Indicates that all conditions of a successful operation have been met.; MessageArgs=; RelatedProperty=; Resolution=None.}} IP : 10.20.30.50 Hostname : xyz.domain.com Status : OK ConfigurationStatus : {@{ControllerLocation=Slot 0; ControllerModel=; ETag=F0E1B94B; Severity=OK; MessageId=Success; Message=Request successfully completed; Description=Indicates that all conditions of a successful operation have been met.; MessageArgs=; RelatedProperty=; Resolution=None.}, @{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array E208e-p SR Gen10; ETag=1FC5DF2E; Severity=Critical; MessageId=CanChangeEditableControllerSAMNoLogicalDrives; Message=Cannot set controller spare activation mode to %1 because no logical drives are configured; Description=Indicates that the controller spare activation mode cannot be set because no logical drives are configured.; MessageArgs=Disabled; RelatedProperty=#/PredictiveSpareRebuild; Resolution=Configure a logical drive.}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; ETag=876C1B3A; Severity=OK; MessageId=Success; Message=Request successfully completed; Description=Indicates that all conditions of a successful operation have been met.; MessageArgs=; RelatedProperty=; Resolution=None.}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAConfigurationStatus where a list of connection objects are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAControllerConfiguration</command:name> <maml:description> <maml:para>The Get-HPESAControllerConfiguration cmdlet gets the Smart Array controller configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAControllerConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAControllerConfiguration cmdlet gets the Smart Array controller configuration. The following are the controller properties:</maml:para> <maml:para>• ControllerLocation: Gets the location of the controller. • ControllerModel: Gets the Smart Array controller model. • LocationFormat: Gets the format of the controller location. • DataGuard: Gets the status of the controller whether or not data desctructive actions are allowed. • DegradedPerformanceOptimization: Enables the controller to attempt to improve performance on RAID when one or more physical drives used in the logical drive fail. • DriveWriteCache: Controls the write cache of the physical drives attached to the controller. • ElevatorSort: Enables the controller to sort requests to a physical drive. • EncryptionConfiguration: This indicates the type of encryption configured on the controller. • EncryptionEULA: The value of this field indicates whether the user has accepted the encryption EULA. • ExpandPriority: The level of priority that transformations have over handling current operating system requests. • FlexibleLatencySchedulerSetting: This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting. • InconsistencyRepairPolicy: Enables the controller to update data on RAID 6(ADG) and 60 volumes based on parity information when an inconsistency is discovered during surface scan. • MonitorAndPerformanceAnalysisDelaySeconds: This sets the monitor and performance delay on the controller. Valid values range from 0 to 1440 seconds. Set to 60 seconds for default settings and 0 seconds for video-on-demand optimized setting. • NoBatteryWriteCache: This indicates if the controller will continue to use write cache even if the backup power source is not available • LegacyBootPriority: The boot priority of this logical drive. • PowerModeAfterReboot: The power mode of the controller after a reboot. • PredictiveSpareRebuild: Enables or disables predictive spare rebuild mode. • QueueDepth: This sets the maximum number of requests the controller submits to a drive at any given time. • ReadCachePercent: This indicates the percentage of cache used for read cache on the controller, with the rest of the cache being used for write cache. • RebuildPriority: The level of priority that rebuilds have over handling current operating system requests. • SurfaceScanAnalysisDelaySeconds: Sets the delay of the controller before beginning surface scan analysis. Only valid if SurfaceScanAnalysisPriority is Idle. • SurfaceScanAnalysisPriority: Priority that the controller takes to find and correct disk surface errors. • SurvivalPowerMode: Enables or disables survival mode. • WriteCacheBypassThresholdKiB: This value sets the write cache bypass threshold, ranging from 16 KiB to 1040 KiB in multiples of 16 KiB, where all writes larger than the specified value in KiB units bypass the write cache and are written directly to the disk for non-parity RAID volumes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAControllerConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $controllers = Get-HPESAControllerConfiguration -Connection $connection -ControllerLocation "Slot 0" PS C:\> $controllers IP : 10.20.30.40 Hostname : abc.domain.com Status : OK ControllerConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; LocationFormat=PCISlot; DataGuard=Permissive; DegradedPerformanceOptimization=Disabled; DriveWriteCache=Enabled; ElevatorSort=Enabled; EncryptionConfiguration=None; EncryptionEULA=; ExpandPriority=Medium; FlexibleLatencySchedulerSetting=Default; InconsistencyRepairPolicy=Disabled; MonitorAndPerformanceAnalysisDelaySeconds=60; NoBatteryWriteCache=; LegacyBootPriority=None; PowerModeAfterReboot=Balanced; PredictiveSpareRebuild=Disabled; QueueDepth=Automatic; ReadCachePercent=10; RebuildPriority=RapidLow; SurfaceScanAnalysisDelaySeconds=3; SurfaceScanAnalysisPriority=Idle; SurvivalPowerMode=Enabled; WriteCacheBypassThresholdKiB=1040}} PS C:\> $controllers.ControllerConfiguration ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 LocationFormat : PCISlot DataGuard : Permissive DegradedPerformanceOptimization : Disabled DriveWriteCache : Enabled ElevatorSort : Enabled EncryptionConfiguration : None EncryptionEULA : ExpandPriority : Medium FlexibleLatencySchedulerSetting : Default InconsistencyRepairPolicy : Disabled MonitorAndPerformanceAnalysisDelaySeconds : 60 NoBatteryWriteCache : LegacyBootPriority : None PowerModeAfterReboot : Balanced PredictiveSpareRebuild : Disabled QueueDepth : Automatic ReadCachePercent : 10 RebuildPriority : RapidLow SurfaceScanAnalysisDelaySeconds : 3 SurfaceScanAnalysisPriority : Idle SurvivalPowerMode : Enabled WriteCacheBypassThresholdKiB : 1040</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAControllerConfiguration where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $controllers = $connections | Get-HPESAControllerConfiguration PS C:\> $controllers IP : 10.20.30.40 Hostname : abc1.domain.com Status : OK ControllerConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; LocationFormat=PCISlot; DataGuard=Permissive; DegradedPerformanceOptimization=Disabled; DriveWriteCache=Enabled; ElevatorSort=Enabled; EncryptionConfiguration=None; EncryptionEULA=; ExpandPriority=Medium; FlexibleLatencySchedulerSetting=Default; InconsistencyRepairPolicy=Disabled; MonitorAndPerformanceAnalysisDelaySeconds=60; NoBatteryWriteCache=; LegacyBootPriority=None; PowerModeAfterReboot=Balanced; PredictiveSpareRebuild=Disabled; QueueDepth=Automatic; ReadCachePercent=10; RebuildPriority=RapidLow; SurfaceScanAnalysisDelaySeconds=3; SurfaceScanAnalysisPriority=Idle; SurvivalPowerMode=Enabled; WriteCacheBypassThresholdKiB=1040}} IP : 10.20.30.50 Hostname : abc2.domain.com Status : OK ControllerConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; LocationFormat=PCISlot; DataGuard=Permissive; DegradedPerformanceOptimization=Disabled; DriveWriteCache=Enabled; ElevatorSort=Enabled; EncryptionConfiguration=None; EncryptionEULA=; ExpandPriority=Medium; FlexibleLatencySchedulerSetting=Default; InconsistencyRepairPolicy=Disabled; MonitorAndPerformanceAnalysisDelaySeconds=60; NoBatteryWriteCache=; LegacyBootPriority=None; PowerModeAfterReboot=Balanced; PredictiveSpareRebuild=Disabled; QueueDepth=Automatic; ReadCachePercent=10; RebuildPriority=RapidLow; SurfaceScanAnalysisDelaySeconds=3; SurfaceScanAnalysisPriority=Idle; SurvivalPowerMode=Enabled; WriteCacheBypassThresholdKiB=1040}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAControllerConfiguration where a list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESAControllerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESADataGuard</command:name> <maml:description> <maml:para>The Get-HPESADataGuard cmdlet gets the Smart Array controller data guard configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESADataGuard</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESADataGuard cmdlet gets data guard configuration of the Smart Array controller. Data guard is used to disable any destructive operation on logical drives.</maml:para> <maml:para>The properties of DataGuardConfiguration are as follows: • ControllerLocation: Gets the Smart Array controller location. • ControllerModel: Gets the Smart Array controller model. • DataGuard: Gets the data guard configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESADataGuard</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $dataGuard = Get-HPESADataGuard -Connection $connection -ControllerLocation "Slot 0" PS C:\> $dataGuard IP : 10.20.30.40 Hostname : abc.domain.com Status : OK DataGuardConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; DataGuard=Permissive}} PS C:\> $dataGuard.DataGuardConfiguration ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 DataGuard : Permissive</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESADataGuard where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $dataGuard = $connections | Get-HPESADataGuard PS C:\> $dataGuard IP : 10.20.30.40 Hostname : abc.domain.com Status : OK DataGuardConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; DataGuard=Permissive}} P : 10.20.30.50 Hostname : abc1.domain.com Status : OK DataGuardConfiguration : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array P204i-b SR Gen10; DataGuard=Strict}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESADataGuard where a list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESADataGuard</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESADiscoveryStatus</command:name> <maml:description> <maml:para>The Get-HPESADiscoveryStatus cmdlet gets the Smart Array discovery status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESADiscoveryStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESADiscoveryStatus cmdlet gets the current Smart Array storage device discovery status. The device discovery status are as follows:</maml:para> <maml:para>• Busy: iLO is discovering Smart Array devices. If the server is shut down before discovery is complete, it reflects an incomplete data set. • Complete: iLO has finished discovering the Smart Array storage. • Initial: Default state for Smart Array. • PendingSoftwareRAID: Pending discovery of Dynamic Smart Array. • Cached: Data is cached and the server is offline or the data is not yet available.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESADiscoveryStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.1 admin admin123 -DisableCertificateAuthentication PS C:\> $connection | Get-HPESADiscoveryStatus IP : 10.20.30.1 Hostname : abc.domain.com Status : OK SmartArrayDiscovery : Complete</dev:code> <dev:remarks> <maml:para>This example shows the Smart Array device discovery status with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.1,10.20.30.2 admin admin123 -DisableCertificateAuthentication PS C:\> $connection | Get-HPESADiscoveryStatus IP : 10.20.30.1 Hostname : abc.domain.com Status : OK SmartArrayDiscovery : PendingSoftwareRAID IP : 10.20.30.2 Hostname : abc1.domain.com Status : OK SmartArrayDiscovery : Complete</dev:code> <dev:remarks> <maml:para>This example shows the Get-HPESADiscoveryStatus cmdlet with the list of connection objects.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAEmbeddedSATAConfiguration</command:name> <maml:description> <maml:para>The Get-HPESAEmbeddedSATAConfiguration gets the embedded SATA configuartion of the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAEmbeddedSATAConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAEmbedddedSATAConfiguration gets the emebedded SATA configurtion. This cmdlet gets the details whether SATA configuration is set to Software RAID or AHCI (Advanced Host Controller Interface).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAEmbeddedSATAConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> Get-HPESAEmbeddedSATAConfiguration -Connection $connection IP : 10.20.30.1 Hostname : abc.domain.com Status : OK EmbeddedSATAConfiguration : SoftwareRAID</dev:code> <dev:remarks> <maml:para>This example shows the output of the Get-HPESAEmbeddedSATAConfiguration cmdlet using the connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP "10.20.30.10,15,20" -Username admin -Password admin123 PS C:\> $connection | Get-HPESAEmbeddedSATAConfiguration IP : 10.20.30.10 Hostname : abc.domain.com Status : OK EmbeddedSATAConfiguration : SoftwareRAID IP : 10.20.30.15 Hostname : abc1.domain.com Status : OK EmbeddedSATAConfiguration : AdvancedHostControllerInterface IP : 10.20.30.20 Hostname : abc2.domain.com Status : OK EmbeddedSATAConfiguration : SoftwareRAID</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAEmbeddedSATAConfiguration using a list of connections as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESAEmbeddedSATAConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESALogicalDrive</command:name> <maml:description> <maml:para>The Get-HPESALogicalDrive cmdlet gets the logical drive details.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESALogicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESALogicalDrive cmdlet gets the logical drives details available through the Smart Array controller. This cmdlet gets the following properties of the logical drives:</maml:para> <maml:para>• ControllerLocation: Gets the Smart Array controller location. • ControllerModel: Gets the Smart Array controller model. • VolumeUniqueIdentifier: Gets logical drive volume unique identifier. • LogicalDriveNumber: Gets logical drive number. • LogicalDriveName: Gets logical drive name. • CapacityGiB: Gets Capacity of logical drive in GB. • CapacityBlocks: Gets total usable capacity available on this logical drive in block units. • Accelerator: Gets the acceleration method of the logical drive. • Raid: Gets the current RAID level configured on the logical drive. • ParityGroupCount: Gets the number of parity groups to use in the logical drive; only valid for certain RAID levels. • BlockSizeBytes: Gets the block size of the disk drive in bytes. • StripSizeBytes: Gets the strip size of the logical drive in bytes. • StripeSizeBytes: Gets the stripe size of the logical drive in bytes. • LegacyBootPriority: Gets the boot priority of this logical drive. • DataDrives: Gets the list of physical drives to be used in the logical drive. • DriveLocationFormat: Gets the physical drive location format. • SpareRebuildMode: Gets spare rebuild mode for the spare drives. • SpareDrives: Gets the spare drives to be used in the logical drive.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESALogicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifes the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifes the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $logicalDrive = Get-HPESALogicalDrive -Connection $connection -ControllerLocation "Slot 0" PS C:\> $logicalDrive IP : 10.20.30.40 Hostname : abc.domain.com Status : OK LogicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; VolumeUniqueIdentifier=600508B1001CE925BFF47F448ABF6C2E; LogicalDriveNumber=1; LogicalDriveName=MyLD1; CapacityGiB=931; CapacityBlocks=1953459632; Accelerator=None; Raid=Raid0; ParityGroupCount=0; BlockSizeBytes=512; StripSizeBytes=262144; StripeSizeBytes=262144; LegacyBootPriority=None; DataDrives=P1I:1:1; DriveLocationFormat=ControllerPort:Box:Bay; SpareRebuildMode=}} PS C:\> $logicalDrive.LogicalDrive | fl ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 VolumeUniqueIdentifier : 600508B1001CE925BFF47F448ABF6C2E LogicalDriveNumber : 1 LogicalDriveName : MyLD1 CapacityGiB : 931 CapacityBlocks : 1953459632 Accelerator : None Raid : Raid0 ParityGroupCount : 0 BlockSizeBytes : 512 StripSizeBytes : 262144 StripeSizeBytes : 262144 LegacyBootPriority : None DataDrives : P1I:1:1 DriveLocationFormat : ControllerPort:Box:Bay SpareRebuildMode :</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESALogicalDrive where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $logicalDrives = $connections | Get-HPESALogicalDrive PS C:\> $logicalDrives IP : 10.20.30.40 Hostname : abc.domain.com Status : OK LogicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; VolumeUniqueIdentifier=600508B1001CE925BFF47F448ABF6C2E; LogicalDriveNumber=1; LogicalDriveName=MyLD1; CapacityGiB=931; CapacityBlocks=1953459632; Accelerator=None; Raid=Raid0; ParityGroupCount=0; BlockSizeBytes=512; StripSizeBytes=262144; StripeSizeBytes=262144; LegacyBootPriority=None; DataDrives=P1I:1:1; DriveLocationFormat=ControllerPort:Box:Bay; SpareRebuildMode=}} IP : 10.20.30.50 Hostname : abc.domain.com Status : OK LogicalDrive : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array P204i-b SR Gen10; VolumeUniqueIdentifier=600508B1001CE925BFF47F448ABF6C2E; LogicalDriveNumber=1; LogicalDriveName=MyLD1; CapacityGiB=931; CapacityBlocks=1953459632; Accelerator=None; Raid=Raid0; ParityGroupCount=0; BlockSizeBytes=512; StripSizeBytes=262144; StripeSizeBytes=262144; LegacyBootPriority=None; DataDrives=P1I:1:1; DriveLocationFormat=ControllerPort:Box:Bay; SpareRebuildMode=}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESALogicalDrive where a list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPESALogicalDrive</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAOperatingMode</command:name> <maml:description> <maml:para>The Get-HPESAOperatingMode gets the operating mode of the Smart Array controller.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAOperatingMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAOperatingMode gets the operating mode of the Smart Array controller. This cmdlet has the following properties:</maml:para> <maml:para>. ControllerLocation: Gets the Smart Array controller location. . COntrollerModel: Gets the Smart Array controller model. . PortIndex: Gets the connected port of the Smart Array controller. . OperatingMode: Gets the operating mode of the port.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAOperatingMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $operatingMode = Get-HPESAOperatingMode -Connection $connection -ControllerLocation "Slot 1" PS C:\> $operatingMode.OperatingModeConfiguration ControllerLocation : Slot 1 ControllerModel : HPE Smart Array E208e-p SR Gen10 PortIndex : 0 OperatingMode : Mixed ControllerLocation : Slot 1 ControllerModel : HPE Smart Array E208e-p SR Gen10 PortIndex : 1 OperatingMode : Mixed</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAOperatingMode using the connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP "10.20.30.10,15,20" -Username admin -Password admin123 PS C:\> $operatingMode = $connection | Get-HPESAOperatingMode IP : 10.20.30.10 Hostname : abc.domain.com Status : OK OperatingModeConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=; PortIndex=0; OperatingMode=Mixed}, @{ControllerLocation=Slot 0; ControllerModel=; PortIndex=1; OperatingMode=Mixed}} IP : 10.20.30.15 Hostname :abc1.domain.com Status : OK OperatingModeConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; PortIndex=0; OperatingMode=Mixed}} IP : 10.20.30.20 Hostname : abc5.domain.com Status : OK OperatingModeConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; PortIndex=0; OperatingMode=Mixed}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAOperatingMode using a list of connection objects as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAPowerMode</command:name> <maml:description> <maml:para>The Get-HPESAPowerMode cmdlet gets the Smart Array controller power mode configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAPowerMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAPowerMode cmdlet gets the power mode configuration of the Smart Array controller. The properties of PowerModeConfiguration are as follows:</maml:para> <maml:para>• ControllerLocation: Gets the Smart Array controller location. • ControllerModel: Gets the Smart Array controller model. • PowerMode: Gets the power mode of the controller.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAPowerMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $powerMode = Get-HPESAPowerMode -ControllerLocation $connection -ControllerLocation "Slot 0" PS C:\> $powerMode IP : 10.20.30.40 Hostname : abc.domain.com Status : OK PowerModeConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; PowerMode=Balanced}} PS C:\> $powerMode.PowerModeConfiguration ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 PowerMode : Balanced</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAPowerMode where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $powerMode = $connections | Get-HPESAPowerMode PS C:\> $powerMode IP : 10.20.30.40 Hostname : abc.domain.com Status : OK PowerModeConfiguration : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; PowerMode=Balanced}} IP : 10.20.30.40 Hostname : abc.domain.com Status : OK PowerModeConfiguration : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array P204i-b SR Gen10; PowerMode=MinPower}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAPowerMode where a list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESAPowerMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAStorageEnclosure</command:name> <maml:description> <maml:para>The Get-HPESAStorageEnclosure cmdlet gets the storage enclosure details.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAStorageEnclosure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAStorageEnclosure cmdlet gets the storage enclosure details. The properties of StorageEnclosure are as follows:</maml:para> <maml:para>• ControllerLocation: Gets the Smart Array controller location. • ControllerModel: Gets the Smart Array controller model. • Name: Gets the storage enclosure name. • Model: Gets the storage enclosure model. • DriveBayCount: Gets the number of bay supported. • Location: Gets the location of storage enclosure • LocationFormat: Gets the storage enclosure location format. • SerialNumber: Gets the storage serial number. • FirmwareVersion: Gets the storage enclosure firmware version. • Health: Gets the health status of storage enclosure. • State: Gets the state of storage enclosure.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAStorageEnclosure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $result = Get-HPESAStorageEnclosure -Connection $connection PS C:\> $result.StorageEnclosure ControllerLocation : Slot 1 ControllerModel : HPE Smart Array E208e-p SR Gen10 Name : HpSmartStorageEnclosure Model : D3700 DriveBayCount : 25 Location : 1E:1 LocationFormat : Controller:Box SerialNumber : 4C17385665 FirmwareVersion : 3.64 Health : OK State : Enabled ControllerLocation : Slot 0b ControllerModel : HPE Smart Array S100i SR Gen10 Name : HpSmartStorageEnclosure Model : DriveBayCount : 4 Location : 1I:1 LocationFormat : Controller:Box SerialNumber : FirmwareVersion : Health : OK State : Enabled ControllerLocation : Slot 0b ControllerModel : HPE Smart Array S100i SR Gen10 Name : HpSmartStorageEnclosure Model : DriveBayCount : 4 Location : 2I:1 LocationFormat : Controller:Box SerialNumber : FirmwareVersion : Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAStorageEnclosure where the connection is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $result = $connection | Get-HPESAStorageEnclosure IP : 10.20.30.40 Hostname : abc.domain.com Status : OK StorageEnclosure : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array E208e-p SR Gen10; Name=HpSmartStorageEnclosure; Model=D3700; DriveBayCount=25; Location=1E:1; LocationFormat=Controller:Box; SerialNumber=4C17385665; FirmwareVersion=3.64; Health=OK; State=Enabled}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; Name=HpSmartStorageEnclosure; Model=; DriveBayCount=4; Location=1I:1; LocationFormat=Controller:Box; SerialNumber=; FirmwareVersion=; Health=OK; State=Enabled}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; Name=HpSmartStorageEnclosure; Model=; DriveBayCount=4; Location=2I:1; LocationFormat=Controller:Box; SerialNumber=; FirmwareVersion=; Health=OK; State=Enabled}} IP : 10.20.30.50 Hostname : xyz.domain.com Status : OK StorageEnclosure : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array E208e-p SR Gen10; Name=HpSmartStorageEnclosure; Model=D3700; DriveBayCount=25; Location=1E:1; LocationFormat=Controller:Box; SerialNumber=4C17385665; FirmwareVersion=3.64; Health=OK; State=Enabled}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; Name=HpSmartStorageEnclosure; Model=; DriveBayCount=4; Location=1I:1; LocationFormat=Controller:Box; SerialNumber=; FirmwareVersion=; Health=OK; State=Enabled}, @{ControllerLocation=Slot 0b; ControllerModel=HPE Smart Array S100i SR Gen10 ; Name=HpSmartStorageEnclosure; Model=; DriveBayCount=4; Location=2I:1; LocationFormat=Controller:Box; SerialNumber=; FirmwareVersion=; Health=OK; State=Enabled}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAStorageEnclosure where a list of connections is passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-HPESALogicalDrive</command:name> <maml:description> <maml:para>The New-HPESALogicalDrive cmdlet creates a new logical drive.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>HPESALogicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-HPESALogicalDrive cmdlet creates a new logical drive. This cmdlet has the following parameters:</maml:para> <maml:para>. LogicalDriveName</maml:para> <maml:para>. Raid</maml:para> <maml:para>. CapacityGiB</maml:para> <maml:para>. CapacityBlocks</maml:para> <maml:para>. DataDrive</maml:para> <maml:para>. LegacyBootPriority</maml:para> <maml:para>. SpareRebuildMode</maml:para> <maml:para>. SpareDrive</maml:para> <maml:para>. ParityGroupCount</maml:para> <maml:para>. ParityInitializationType</maml:para> <maml:para>. StripSizeByte</maml:para> <maml:para>. StripeSizeByte</maml:para> <maml:para>. Accelerator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-HPESALogicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogicalDriveName</maml:name> <maml:description> <maml:para>Specifies the logial drive name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Raid</maml:name> <maml:description> <maml:para>Specify the RAID level to create logical drive. Accpeted values are "Raid0", "Raid1", "Raid10","Raid10ADM", "Raid5", "Raid50", "Raid6", and "Raid60".</maml:para> <maml:para>• Raid0: There is no fault tolerance used on this logical drive. • Raid1: Two sets of duplicate data is being stored on a pair of drives. • Raid1ADM: Three sets of duplicate data is being stored on a trio of drives. • Raid10: Data is duplicated and striped across pairs of disk drives. • Raid10ADM: Data is duplicated and striped across trios of disk drives. • Raid5: Fault tolerance is achieved by storing parity data across 3 or more disk drives. • Raid50: Fault tolerance is achieved by storing parity data and striping the data across 6 or more disk drives. • Raid6: Fault tolerance is achieved by storing multiple sets parity data across 4 or more disk drives. • Raid60: Fault tolerance is achieved by storing multiple sets parity data and striping the data across 8 or more disk drives.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CapacityGiB</maml:name> <maml:description> <maml:para>Specify the capacity of logical drive in GB. Set to -1 to use all the remaining space of the physical drive for maximum size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CapacityBlocks</maml:name> <maml:description> <maml:para>Specify the total usable capacity available on this logical drive in block units. Set to -1 to use all remaining space for maximum size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataDrive</maml:name> <maml:description> <maml:para>Specify a list of the physical drives to be used in the logical drive. The physical drive should be in the Controler:Box:Bay format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[][]</command:parameterValue> <dev:type> <maml:name>Object[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specify the boot priority of this logical drive. Accepted values are "Primary", "Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareRebuildMode</maml:name> <maml:description> <maml:para>Specify the type of spare drive used with this logical drive. Accepted values are "Dedicated" and "Roaming".</maml:para> <maml:para>Dedicated : The spare drive temporarily takes over a failed data drive; when the failed data drive is replaced, the spare drive becomes idle again. Roaming : The spare drive replaces the failed data drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareDrive</maml:name> <maml:description> <maml:para>Specify a list of the physical drives to be used as spares for the logical drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[][]</command:parameterValue> <dev:type> <maml:name>Object[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityGroupCount</maml:name> <maml:description> <maml:para>Specify the number of parity groups to use in the logical drive. It is applicable only to certain valid RAID levels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityInitializationType</maml:name> <maml:description> <maml:para>Specify the pairty initialization type when creating a logical drive with a RAID level that requires parity. Accepted values are "Default" and "Rapid".</maml:para> <maml:para>• Default: Parity blocks are initialized in the background and the logical drive is available during this time. • Rapid: Both data and parity blocks are initialized in the foreground and the logical drive will not be available to the operating system until initialization completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripSizeByte</maml:name> <maml:description> <maml:para>Specify the strip size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripeSizeByte</maml:name> <maml:description> <maml:para>Specify the stripe size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>Specify the acceleration method of the logical drive. Accepted value are "None", "ControllerCache", and "IOBypass".</maml:para> <maml:para>• None: Logical drive acceleration is disabled. • ControllerCache: Read and write to the logical drive are cached by the controller. • IOBypass: For logical drives on SSDs, read and write information is obtained directly from the drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogicalDriveName</maml:name> <maml:description> <maml:para>Specifies the logial drive name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Raid</maml:name> <maml:description> <maml:para>Specify the RAID level to create logical drive. Accpeted values are "Raid0", "Raid1", "Raid10","Raid10ADM", "Raid5", "Raid50", "Raid6", and "Raid60".</maml:para> <maml:para>• Raid0: There is no fault tolerance used on this logical drive. • Raid1: Two sets of duplicate data is being stored on a pair of drives. • Raid1ADM: Three sets of duplicate data is being stored on a trio of drives. • Raid10: Data is duplicated and striped across pairs of disk drives. • Raid10ADM: Data is duplicated and striped across trios of disk drives. • Raid5: Fault tolerance is achieved by storing parity data across 3 or more disk drives. • Raid50: Fault tolerance is achieved by storing parity data and striping the data across 6 or more disk drives. • Raid6: Fault tolerance is achieved by storing multiple sets parity data across 4 or more disk drives. • Raid60: Fault tolerance is achieved by storing multiple sets parity data and striping the data across 8 or more disk drives.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CapacityGiB</maml:name> <maml:description> <maml:para>Specify the capacity of logical drive in GB. Set to -1 to use all the remaining space of the physical drive for maximum size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CapacityBlocks</maml:name> <maml:description> <maml:para>Specify the total usable capacity available on this logical drive in block units. Set to -1 to use all remaining space for maximum size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataDrive</maml:name> <maml:description> <maml:para>Specify a list of the physical drives to be used in the logical drive. The physical drive should be in the Controler:Box:Bay format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[][]</command:parameterValue> <dev:type> <maml:name>Object[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specify the boot priority of this logical drive. Accepted values are "Primary", "Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareRebuildMode</maml:name> <maml:description> <maml:para>Specify the type of spare drive used with this logical drive. Accepted values are "Dedicated" and "Roaming".</maml:para> <maml:para>Dedicated : The spare drive temporarily takes over a failed data drive; when the failed data drive is replaced, the spare drive becomes idle again. Roaming : The spare drive replaces the failed data drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareDrive</maml:name> <maml:description> <maml:para>Specify a list of the physical drives to be used as spares for the logical drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[][]</command:parameterValue> <dev:type> <maml:name>Object[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityGroupCount</maml:name> <maml:description> <maml:para>Specify the number of parity groups to use in the logical drive. It is applicable only to certain valid RAID levels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityInitializationType</maml:name> <maml:description> <maml:para>Specify the pairty initialization type when creating a logical drive with a RAID level that requires parity. Accepted values are "Default" and "Rapid".</maml:para> <maml:para>• Default: Parity blocks are initialized in the background and the logical drive is available during this time. • Rapid: Both data and parity blocks are initialized in the foreground and the logical drive will not be available to the operating system until initialization completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripSizeByte</maml:name> <maml:description> <maml:para>Specify the strip size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripeSizeByte</maml:name> <maml:description> <maml:para>Specify the stripe size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>Specify the acceleration method of the logical drive. Accepted value are "None", "ControllerCache", and "IOBypass".</maml:para> <maml:para>• None: Logical drive acceleration is disabled. • ControllerCache: Read and write to the logical drive are cached by the controller. • IOBypass: For logical drives on SSDs, read and write information is obtained directly from the drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] System.Int32[] System.Object[][]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> $result = New-HPESALogicalDrive -Connection $connection -ControllerLocation "Slot 1" -LogicalDriveName LogicalDrive1 -Raid Raid0 -CapacityGiB -1 -DataDrive @(,@("P1I:1:1","P1I:1:2")) PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example creates a new logical drive using the New-HPESALogicalDrive cmdlet, connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40,10.20.30.50 -Username admin -Password admin123 PS C:\> $result = $connection | New-HPESALogicalDrive -ControllerLocation @("Slot 1","Slot 0") -LogicalDriveName LogicalDrive1 -Raid Raid0 -CapacityGiB 500 -DataDrive @(@("1I:1:1","1I:1:2"),@("P1I:1:1","P1I:1:2")) PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. } IP : 10.20.30.50 Hostname : xyz.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example creates a new logical drive using the New-HPESALogicalDrive cmdlet, a list connection objects are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPESALogicalDrive</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-HPESALogicalDrive</command:name> <maml:description> <maml:para>The Remove-HPESALogicalDrive cmdlet deletes the logical drive.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPESALogicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPESALogicalDrive cmdlet deletes the logical drive. This cmdlet deletes the logical drive based on VolumeUniqueIdentifier.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPESALogicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeUniqueIdentifier</maml:name> <maml:description> <maml:para>Specifies the VolumeUniqueIdentifier of the logical drive to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeUniqueIdentifier</maml:name> <maml:description> <maml:para>Specifies the VolumeUniqueIdentifier of the logical drive to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> $result = Remove-HPESALogicalDrive -Connection $connection -ControllerLcation "Slot 1" -VolumeUniqueIdentifier 600508B1001C04EE029C39D352872DC6 PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example shows the ouput of Remove-HPESALogicalDrive using the connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP "10.20.30.40,50" -Username admin -Password admin123 PS C:\> $result = $connection | Remove-HPESALogicalDrive -ControllerLcation "Slot 1" -VolumeUniqueIdentifier @("600508B1001C4856926C526D4E303EAA","600508B1001C3ED6F076E5691890B366") PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. } IP : 10.20.30.50 Hostname : xyz.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example shows the ouput of Remove-HPESALogicalDrive using a list of connections as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESALogicalDrive</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPESALogicalDrive</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Reset-HPESAController</command:name> <maml:description> <maml:para>The Reset-HPESAController cmdlet resets the controller configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPESAController</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPESAController cmdlet resets the controller configuration. The reset of the controller can be done with the following parameters:</maml:para> <maml:para>• ClearConfigurationMetadata: Clear the configuration metadata from the physical drives that are masked from the OS. • FactoryReset: Reset the controller to factory settings by performing the following steps: - Delete all logical drives. - Remove all license keys. - Clear the encryption configuration. - Clear the controller NVRAM. - Clear the configuration metadata from all the physical drives that are masked from the OS.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ClearConfiguerationSet" default="true"> <!--NAME: ClearConfiguerationSet--> <!--TAG: DEFAULT--> <maml:name>Reset-HPESAController</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ClearConfigurationMetadata</maml:name> <maml:description> <maml:para>Specify this switch parameter to clear the configuration metadata from the physical drives that are masked from the OS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="FactoryResetSet"> <!--NAME: FactoryResetSet--> <maml:name>Reset-HPESAController</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FactoryReset</maml:name> <maml:description> <maml:para>Specify this switch parameter to reset the controller to factory settings. This will delete all logical drives, remove all license keys, clear the encryption configuration, clear the controller NVRAM, and clear configuration metadata from all physical drives that are masked from the OS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ClearConfigurationMetadata</maml:name> <maml:description> <maml:para>Specify this switch parameter to clear the configuration metadata from the physical drives that are masked from the OS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FactoryReset</maml:name> <maml:description> <maml:para>Specify this switch parameter to reset the controller to factory settings. This will delete all logical drives, remove all license keys, clear the encryption configuration, clear the controller NVRAM, and clear configuration metadata from all physical drives that are masked from the OS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] System.Management.Automation.SwitchParameter</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> $result = Reset-HPESAController -Connection $connection -FactoryReset PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example resets the Smart Array controller using the connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.45 -Username admin -Password admin123 PS C:\> $result = Reset-HPESAController -Connection $connection -ClearConfigurationMetadata PS C:\> $result IP : 10.20.30.45 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example clears the configuration metada of the Smart Array controller using the connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40,10.20..30.50 -Username admin -Password admin123 PS C:\>$result = $connection | Reset-HPESAController -FactoryReset PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. } IP : 10.20.30.50 Hostname : xyz.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example resets the Smart Array controller on the targets servers using a list of connections are passed as pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPESAControllerConfiguration</command:name> <maml:description> <maml:para>The Set-HPESAControllerConfiguration cmdlets sets the Smart Array controller settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESAControllerConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESAControllerConfiguration cmdlets sets the Smart Array controller settings. This cmdlet has the following parameters.</maml:para> <maml:para>. DataGuard . DegradedPerformanceOptimization . DriveWriteCache . ElevatorSort . EncryptionConfiguration . EncryptionEULA . ExpandPriority . FlexibleLatencySchedulerSetting . InconsistencyRepairPolicy . MonitorAndPerformanceAnalysisDelaySeconds . NoBatteryWriteCache . LegacyBootPriority . PowerModeAfterReboot . PredictiveSpareRebuild . QueueDepth . ReadCachePercent . RebuildPriority . SurfaceScanAnalysisDelaySeconds . SurfaceScanAnalysisPriority . SurvivalPowerMode . WriteCacheBypassThresholdKiB</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESAControllerConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataGuard</maml:name> <maml:description> <maml:para>Specify the data guard value for the Smart Array controller. This parameter sepcifies whether data destructive actions are allowed on the Smart Array controller. Accepted values are "Strict", "Permissive", and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DegradedPerformanceOptimization</maml:name> <maml:description> <maml:para>Enables the controller to attempt to improve performance on RAID5 RAID50 RAID6(ADG) RAID60 logical drives when one or more physical drives in the logical drive are failed. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DriveWriteCache</maml:name> <maml:description> <maml:para>Enables or disables the write cache of the physical drives attached to the controller. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ElevatorSort</maml:name> <maml:description> <maml:para>Enables the controller to sort requests to a physical drive. Accpeted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EncryptionConfiguration</maml:name> <maml:description> <maml:para>Specifies the type of encryption configured on the controller. Accepted values are "ExpressLocal" and "None".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EncryptionEULA</maml:name> <maml:description> <maml:para>Specifies whether or not the user has accepted the encryption EULA. Accepted values are "Accept" and "Decline".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExpandPriority</maml:name> <maml:description> <maml:para>The level of priority that transformations have over handling current operating system requests. Accepted values are "High", "Medium", and "Low".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FlexibleLatencySchedulerSetting</maml:name> <maml:description> <maml:para>This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting. Accepted values are "Default", "Low250", "Middle100", "Middle50", "Aggressive30", and "Aggressive10".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specifies the boot priority of this logical drive. Accepted values are "Primary","Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InconsistencyRepairPolicy</maml:name> <maml:description> <maml:para>Enables the controller to update data on RAID 6(ADG) and 60 volumes based on parity information when an inconsistency is discovered during surface scan. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MonitorAndPerformanceAnalysisDelaySeconds</maml:name> <maml:description> <maml:para>This sets the monitor and performance delay on the controller. Valid values range from 0 to 1440 seconds. Set to 60 seconds for default settings and 0 seconds for video-on-demand optimized setting. Accepted minimum value is 0 and maximum value is 1440.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoBatteryWriteCache</maml:name> <maml:description> <maml:para>This indicates if the controller will continue to use write cache even if the backup power source is not available. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerModeAfterReboot</maml:name> <maml:description> <maml:para>This parameter specifies the power mode of the Smart Array controller after reboot of the target server. Accepted values are "Invalid", "MinPower", "Balanced", and "MaxPerformance".</maml:para> <maml:para>• Invalid: The controller will be operating in an unknown power mode after a reboot. • MinPower: The controller will be operating in minimum power mode after a reboot. • Balanced: The controller will be operating in a balanced mode after a reboot. • MaxPerformance: The controller will be operating in maximum performance power mode after a reboot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PredictiveSpareRebuild</maml:name> <maml:description> <maml:para>Enables or disables predictive spare rebuild mode. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>QueueDepth</maml:name> <maml:description> <maml:para>This sets the maximum number of requests the controller submits to a drive at any given time. Accepted values are "Queue2", "Queue4", "Queue8", "Queue16", "Queue32", "Automatic".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCachePercent</maml:name> <maml:description> <maml:para>This indicates the percentage of cache used for read cache on the controller, with the rest of the cache being used for write cache. Minimum range 0 to maximum 100.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RebuildPriority</maml:name> <maml:description> <maml:para>The level of priority that rebuilds have over handling current operating system requests. Accepted values are "High", "Medium", "Low", "RapidHigh", "RapidMediumHigh", "RapidMedium" and "RapidLow".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurfaceScanAnalysisDelaySeconds</maml:name> <maml:description> <maml:para>Sets the delay of the controller before beginning surface scan analysis. Only valid if SurfaceScanAnalysisPriority is Idle. Accepted range is 1 to 16.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurfaceScanAnalysisPriority</maml:name> <maml:description> <maml:para>Priority that the controller takes to find and correct disk surface errors. Accepted value are "Disabled", "High", "Medium", "Low" and "Idle".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurvivalPowerMode</maml:name> <maml:description> <maml:para>Enables or disables survival mode. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WriteCacheBypassThresholdKiB</maml:name> <maml:description> <maml:para>This value sets the write cache bypass threshold, ranging from 16 KiB to 1040 KiB in multiples of 16 KiB, where all writes larger than the specified value in KiB units bypass the write cache and are written directly to the disk for non-parity RAID volumes. The accepted minimum range is 16 and the maximum is 1040. Accepted values should be a multiple of 16.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get the ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataGuard</maml:name> <maml:description> <maml:para>Specify the data guard value for the Smart Array controller. This parameter sepcifies whether data destructive actions are allowed on the Smart Array controller. Accepted values are "Strict", "Permissive", and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DegradedPerformanceOptimization</maml:name> <maml:description> <maml:para>Enables the controller to attempt to improve performance on RAID5 RAID50 RAID6(ADG) RAID60 logical drives when one or more physical drives in the logical drive are failed. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DriveWriteCache</maml:name> <maml:description> <maml:para>Enables or disables the write cache of the physical drives attached to the controller. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ElevatorSort</maml:name> <maml:description> <maml:para>Enables the controller to sort requests to a physical drive. Accpeted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EncryptionConfiguration</maml:name> <maml:description> <maml:para>Specifies the type of encryption configured on the controller. Accepted values are "ExpressLocal" and "None".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EncryptionEULA</maml:name> <maml:description> <maml:para>Specifies whether or not the user has accepted the encryption EULA. Accepted values are "Accept" and "Decline".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExpandPriority</maml:name> <maml:description> <maml:para>The level of priority that transformations have over handling current operating system requests. Accepted values are "High", "Medium", and "Low".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FlexibleLatencySchedulerSetting</maml:name> <maml:description> <maml:para>This allows the controller to process certain high-latency requests after a delay that may time out when elevator sorting. Accepted values are "Default", "Low250", "Middle100", "Middle50", "Aggressive30", and "Aggressive10".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specifies the boot priority of this logical drive. Accepted values are "Primary","Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InconsistencyRepairPolicy</maml:name> <maml:description> <maml:para>Enables the controller to update data on RAID 6(ADG) and 60 volumes based on parity information when an inconsistency is discovered during surface scan. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MonitorAndPerformanceAnalysisDelaySeconds</maml:name> <maml:description> <maml:para>This sets the monitor and performance delay on the controller. Valid values range from 0 to 1440 seconds. Set to 60 seconds for default settings and 0 seconds for video-on-demand optimized setting. Accepted minimum value is 0 and maximum value is 1440.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoBatteryWriteCache</maml:name> <maml:description> <maml:para>This indicates if the controller will continue to use write cache even if the backup power source is not available. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerModeAfterReboot</maml:name> <maml:description> <maml:para>This parameter specifies the power mode of the Smart Array controller after reboot of the target server. Accepted values are "Invalid", "MinPower", "Balanced", and "MaxPerformance".</maml:para> <maml:para>• Invalid: The controller will be operating in an unknown power mode after a reboot. • MinPower: The controller will be operating in minimum power mode after a reboot. • Balanced: The controller will be operating in a balanced mode after a reboot. • MaxPerformance: The controller will be operating in maximum performance power mode after a reboot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PredictiveSpareRebuild</maml:name> <maml:description> <maml:para>Enables or disables predictive spare rebuild mode. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>QueueDepth</maml:name> <maml:description> <maml:para>This sets the maximum number of requests the controller submits to a drive at any given time. Accepted values are "Queue2", "Queue4", "Queue8", "Queue16", "Queue32", "Automatic".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCachePercent</maml:name> <maml:description> <maml:para>This indicates the percentage of cache used for read cache on the controller, with the rest of the cache being used for write cache. Minimum range 0 to maximum 100.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RebuildPriority</maml:name> <maml:description> <maml:para>The level of priority that rebuilds have over handling current operating system requests. Accepted values are "High", "Medium", "Low", "RapidHigh", "RapidMediumHigh", "RapidMedium" and "RapidLow".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurfaceScanAnalysisDelaySeconds</maml:name> <maml:description> <maml:para>Sets the delay of the controller before beginning surface scan analysis. Only valid if SurfaceScanAnalysisPriority is Idle. Accepted range is 1 to 16.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurfaceScanAnalysisPriority</maml:name> <maml:description> <maml:para>Priority that the controller takes to find and correct disk surface errors. Accepted value are "Disabled", "High", "Medium", "Low" and "Idle".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SurvivalPowerMode</maml:name> <maml:description> <maml:para>Enables or disables survival mode. Accepted values are "Enabled" and "Disabled".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WriteCacheBypassThresholdKiB</maml:name> <maml:description> <maml:para>This value sets the write cache bypass threshold, ranging from 16 KiB to 1040 KiB in multiples of 16 KiB, where all writes larger than the specified value in KiB units bypass the write cache and are written directly to the disk for non-parity RAID volumes. The accepted minimum range is 16 and the maximum is 1040. Accepted values should be a multiple of 16.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] System.Int32[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPESAControllerConfiguration -Connection $connection -ControllerLocation "Slot 0" -DriveWriteCache "Enabled" -InconsistencyRepairPolicy "Enabled"</dev:code> <dev:remarks> <maml:para>This example sets DriveWriteCache and InconsistencyRepairPolicy to the specified value using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $connection | Set-HPESAControllerConfiguration -ControllerLocation "Slot 0","Slot 1" -DriveWriteCache "Enabled", "Disabled" -InconsistencyRepairPolicy "Enabled","Disabled"</dev:code> <dev:remarks> <maml:para>This example sets DriveWriteCache and InconsistencyRepairPolicy to the specified values passing a list of connection objects as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAControllerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPESADataGuard</command:name> <maml:description> <maml:para>The Set-HPESADataGuard cmdlet sets the data guard configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESADataGuard</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESADataGuard cmdlet sets the data guard configuration of the Smart Array controller. This cmdlet has the following parameter:</maml:para> <maml:para>. DataGuard</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESADataGuard</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataGuard</maml:name> <maml:description> <maml:para>Specifies the data guard value for the Smart Array controller. This parameter sepcifies whether data destructive actions are allowed on the Smart Array controller. Accepted values are "Strict", "Permissive", and "Disabled".</maml:para> <maml:para>• Strict: Data destructive actions are not allowed. • Permissive: Logical drive delete actions will be ignored. • Disabled: Data destructive actions are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DataGuard</maml:name> <maml:description> <maml:para>Specifies the data guard value for the Smart Array controller. This parameter sepcifies whether data destructive actions are allowed on the Smart Array controller. Accepted values are "Strict", "Permissive", and "Disabled".</maml:para> <maml:para>• Strict: Data destructive actions are not allowed. • Permissive: Logical drive delete actions will be ignored. • Disabled: Data destructive actions are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPESADataGuard -Connection $connection -ControllerLocation "Slot 0" -DataGuard "Permissive"</dev:code> <dev:remarks> <maml:para>This example sets the DataGuard value using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $connection | Set-HPESADataGuard -ControllerLocation "Slot 0","Slot 1" -DataGuard "Permissive","Strict"</dev:code> <dev:remarks> <maml:para>This example sets the DataGuard value passing the list of connection objects as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESADataGuard</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPESAEmbeddedSATAConfiguration</command:name> <maml:description> <maml:para>The Set-HPESAEmbeddedSATAConfiguration cmdlet sets the embedded SATA configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESAEmbeddedSATAConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESAEmbeddedSATAConfiguration cmdlet sets the embedded SATA configuration. This cmdlet has the following parameter:</maml:para> <maml:para>. EmbeddedSATAConfiguration</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESAEmbeddedSATAConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedSATAConfiguration</maml:name> <maml:description> <maml:para>Specifies the embedded SATA configuration. Use this parameter to set Software RAID or AHCI (Advanced Host Controller Interface). Accepted values are "AdvancedHostControllerInterface" and "SoftwareRAID".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>oe</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedSATAConfiguration</maml:name> <maml:description> <maml:para>Specifies the embedded SATA configuration. Use this parameter to set Software RAID or AHCI (Advanced Host Controller Interface). Accepted values are "AdvancedHostControllerInterface" and "SoftwareRAID".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>oe</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> Set-HPESAEmbeddedSATAConfiguration -Connection $connection -EmbeddedSATAConfiguration SoftwareRAID</dev:code> <dev:remarks> <maml:para>This example sets SoftwareRAID as embedded SATA cofiguration using connection as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40,10..20.30.50 -Username admin -Password admin123 PS C:\> $connection | Set-HPESAEmbeddedSATAConfiguration -EmbeddedSATAConfiguration AdvancedHostControllerInterface</dev:code> <dev:remarks> <maml:para>This example sets AdvancedHostControllerInterface as embedded SATA cofiguration using a list connection as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAEmbeddedSATAConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPESALogicalDrive</command:name> <maml:description> <maml:para>The Set-HPESALogicalDrive cmdlet sets the logical drive configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESALogicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESALogicalDrive cmdlet sets the logical drive configuration. This cmdlet has the following parameters:</maml:para> <maml:para>. VolumeUniqueIdentifier</maml:para> <maml:para>. LogicalDriveName</maml:para> <maml:para>. LegacyBootPriority</maml:para> <maml:para>. SpareRebuildMode</maml:para> <maml:para>. ParityGroupCount</maml:para> <maml:para>. ParityInitializationType</maml:para> <maml:para>. StripSizeByte</maml:para> <maml:para>. StripeSizeByte</maml:para> <maml:para>. Accelerator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESALogicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeUniqueIdentifier</maml:name> <maml:description> <maml:para>Specifies the VolumeUniqueIdentifier of the logical drive that has to be configured.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogicalDriveName</maml:name> <maml:description> <maml:para>Specifies the logical drive name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specifies the boot priority of this logical drive. Accepted values are "Primary","Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareRebuildMode</maml:name> <maml:description> <maml:para>Specifies the type of the spare drive used with this logical drive. Accepted values are "Dedicated" and "Roaming".</maml:para> <maml:para>• Dedicated: The spare drive temporarily takes over a failed data drive; when the failed data drive is replaced, the spare drive becomes idle again. • Roaming: The spare drive replaces the failed data drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityGroupCount</maml:name> <maml:description> <maml:para>Specify the number of parity groups to use in the logical drive. It is applicable only to certain valid RAID levels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityInitializationType</maml:name> <maml:description> <maml:para>Specifies the parity initialization type when creating a logical drive with a RAID level that requires parity. Accepted values are "Default" and "Rapid".</maml:para> <maml:para>• Default: Parity blocks are initialized in the background and the logical drive is available during this time. • Rapid: Both data and parity blocks are initialized in the foreground and the logical drive will not be available to the operating system until initialization completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripSizeByte</maml:name> <maml:description> <maml:para>Specifies the strip size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripeSizeByte</maml:name> <maml:description> <maml:para>Specify the stripe size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>Specifies the acceleration method of the logical drive. Accepted value are "None" , "ControllerCache", and "IOBypass".</maml:para> <maml:para>• None: Logical drive acceleration is disabled. • ControllerCache: Read and writes to the logical drive are cached by the controller. • IOBypass: For logical drives on SSDs, read and write information is obtained directly from the drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeUniqueIdentifier</maml:name> <maml:description> <maml:para>Specifies the VolumeUniqueIdentifier of the logical drive that has to be configured.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogicalDriveName</maml:name> <maml:description> <maml:para>Specifies the logical drive name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LegacyBootPriority</maml:name> <maml:description> <maml:para>Specifies the boot priority of this logical drive. Accepted values are "Primary","Secondary", "All", and "None".</maml:para> <maml:para>• Primary: This logical drive is the primary boot volume. • Secondary: This logical drive is the secondary boot volume. • All: This logical drive is both the primary and secondary boot volume. • None: This logical drive has no legacy boot priority.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SpareRebuildMode</maml:name> <maml:description> <maml:para>Specifies the type of the spare drive used with this logical drive. Accepted values are "Dedicated" and "Roaming".</maml:para> <maml:para>• Dedicated: The spare drive temporarily takes over a failed data drive; when the failed data drive is replaced, the spare drive becomes idle again. • Roaming: The spare drive replaces the failed data drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityGroupCount</maml:name> <maml:description> <maml:para>Specify the number of parity groups to use in the logical drive. It is applicable only to certain valid RAID levels.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ParityInitializationType</maml:name> <maml:description> <maml:para>Specifies the parity initialization type when creating a logical drive with a RAID level that requires parity. Accepted values are "Default" and "Rapid".</maml:para> <maml:para>• Default: Parity blocks are initialized in the background and the logical drive is available during this time. • Rapid: Both data and parity blocks are initialized in the foreground and the logical drive will not be available to the operating system until initialization completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripSizeByte</maml:name> <maml:description> <maml:para>Specifies the strip size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StripeSizeByte</maml:name> <maml:description> <maml:para>Specify the stripe size of the logical drive in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>Specifies the acceleration method of the logical drive. Accepted value are "None" , "ControllerCache", and "IOBypass".</maml:para> <maml:para>• None: Logical drive acceleration is disabled. • ControllerCache: Read and writes to the logical drive are cached by the controller. • IOBypass: For logical drives on SSDs, read and write information is obtained directly from the drive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[] System.Int32[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> Set-HPESALogicalDrive -Connection $connectoin -ControllerLocation "Slot 0" -VolumeUniqueIdentifier 600508B1001C04EE029C39D352872DC6 -LogicalDriveName MyDrive1 -SpareRebuildMode Roaming</dev:code> <dev:remarks> <maml:para>This example sets the LogicalDriveName and SpareRebuildMode for the logical drive whose VolumeUniqueIdentifier is 600508B1001C04EE029C39D352872DC6 using the connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40,10..20.30.50 -Username admin -Password admin123 PS C:\> $connectoin | Set-HPESALogicalDrive -ControllerLocation @("Slot 0","Slot 1") -VolumeUniqueIdentifier @("600508B1001C04EE029C39D352872DC6","600508B1001C4856926C526D4E303EAA") -Accelerator @("IOBypass","ControllerCache") -SpareRebuildMode @("Dedicated","Roaming")</dev:code> <dev:remarks> <maml:para>This example sets the Accelerator and SpareRebuildMode for the logical drive whose VolumeUniqueIdentifiers are specified using a list connection object as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESALogicalDrive</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPESALogicalDrive</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPESALogicalDrive</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAUnconfiguredPhysicalDrive</command:name> <maml:description> <maml:para>The Get-HPESAUnconfiguredPhysicalDrive cmdlet gets the unconfigured physical drive infromation.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAUnconfiguredPhysicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAUnconfiguredPhysicalDrive cmdlet gets information about the unconfigured physical drives, which are attached with the Smart Array controller. The cmdlet gets the following properties:</maml:para> <maml:para>• ControllerLocation • ControllerModel • BlockSizeBytes • CapacityGB • CapacityLogicalBlocks • CapacityMiB • CarrierApplicationVersion • CarrierAuthenticationStatus • CurrentTemperatureCelsius • Description • DiskDriveStatusReasons • DiskDriveUse • EncryptedDrive • FirmwareVersion • InterfaceSpeedMbps • InterfaceType • LegacyBootPriority • Location • LocationFormat • MaximumTemperatureCelsius • MediaType • Model • Name • PowerOnHours • RotationalSpeedRpm • SSDEnduranceUtilizationPercentage • SerialNumber • Health • State</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAUnconfiguredPhysicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $unconfiguredphysicalDrive = Get-HPESAUnconfiguredPhysicalDrive -Connection $connection -ControllerLocation "Slot 0" PS C:\> $unconfiguredphysicalDrive IP : 10.20.30.40 Hostname : abc.domain.com Status : OK UnconfiguredPhysicalDrive: {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Data; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}} PS C:\> $unconfiguredphysicalDrive.UnconfiguredPhysicalDrive ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 BlockSizeBytes : 512 CapacityGB : 1000 CapacityLogicalBlocks : 1953525168 CapacityMiB : 953869 CarrierApplicationVersion : 11 CarrierAuthenticationStatus : OK CurrentTemperatureCelsius : 24 Description : HPE Smart Storage Disk Drive View DiskDriveStatusReasons : None DiskDriveUse : Raw EncryptedDrive : false FirmwareVersion : HPD2 InterfaceSpeedMbps : 6000 InterfaceType : SAS LegacyBootPriority : Primary Location : 1I:1:1 LocationFormat : ControllerPort:Box:Bay MaximumTemperatureCelsius : 42 MediaType : HDD Model : MM1000FECVH Name : HpeSmartStorageDiskDrive PowerOnHours : RotationalSpeedRpm : 7200 SSDEnduranceUtilizationPercentage : SerialNumber : L0JWZN0K Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAUnconfiguredPhysicalDrive where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $unconfiguredphysicalDrive = $connections | Get-HPESAUnconfiguredPhysicalDrive PS C:\> $physicalDrive IP : 10.20.30.40 Hostname : abc.domain.com Status : OK UnconfiguredPhysicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Raw; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}} IP : 10.20.30.50 Hostname : abc1.domain.com Status : OK UnconfiguredPhysicalDrive : {@{ControllerLocation=Slot 1; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Raw; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}}</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPESAUnconfiguredPhysicalDrive where the list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAPhysicalDrive</command:name> <maml:description> <maml:para>The Get-HPESAPhysicalDrive cmdlet gets the physical drive information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAPhysicalDrive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAPhysicalDrive cmdlet gets information about the physical drives, which are attached with the Smart Array controller. This cmdlet gets the following properties:</maml:para> <maml:para>• ControllerLocation • ControllerModel • BlockSizeBytes • CapacityGB • CapacityLogicalBlocks • CapacityMiB • CarrierApplicationVersion • CarrierAuthenticationStatus • CurrentTemperatureCelsius • Description • DiskDriveStatusReasons • DiskDriveUse • EncryptedDrive • FirmwareVersion • InterfaceSpeedMbps • InterfaceType • LegacyBootPriority • Location • LocationFormat • MaximumTemperatureCelsius • MediaType • Model • Name • PowerOnHours • RotationalSpeedRpm • SSDEnduranceUtilizationPercentage • SerialNumber • Health • State</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAPhysicalDrive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation. If the controller location is not specified, then it fetches the information from all the available Smart Array controllers in the target server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $physicalDrive = Get-HPESAPhysicalDrive -Connection $connection -ControllerLocation "Slot 0" PS C:\> $physicalDrive IP : 10.20.30.40 Hostname : abc.domain.com Status : OK PhysicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Data; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}} PS C:\> $physicalDrive.PhysicalDrive ControllerLocation : Slot 0 ControllerModel : HPE Smart Array P204i-b SR Gen10 BlockSizeBytes : 512 CapacityGB : 1000 CapacityLogicalBlocks : 1953525168 CapacityMiB : 953869 CarrierApplicationVersion : 11 CarrierAuthenticationStatus : OK CurrentTemperatureCelsius : 24 Description : HPE Smart Storage Disk Drive View DiskDriveStatusReasons : None DiskDriveUse : Data EncryptedDrive : false FirmwareVersion : HPD2 InterfaceSpeedMbps : 6000 InterfaceType : SAS LegacyBootPriority : Primary Location : 1I:1:1 LocationFormat : ControllerPort:Box:Bay MaximumTemperatureCelsius : 42 MediaType : HDD Model : MM1000FECVH Name : HpeSmartStorageDiskDrive PowerOnHours : RotationalSpeedRpm : 7200 SSDEnduranceUtilizationPercentage : SerialNumber : L0JWZN0K Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output of the Get-HPESAPhysicalDrive where the connection is passed as named parameter and ControllerLocation is specified as "Slot 0".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $physicalDrive = $connections | Get-HPESAPhysicalDrive PS C:\> $physicalDrive IP : 10.20.30.40 Hostname : abc.domain.com Status : OK PhysicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Data; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}} IP : 10.20.30.50 Hostname : abc1.domain.com Status : OK PhysicalDrive : {@{ControllerLocation=Slot 0; ControllerModel=HPE Smart Array P204i-b SR Gen10; BlockSizeBytes=512; CapacityGB=1000; CapacityLogicalBlocks=1953525168; CapacityMiB=953869; CarrierApplicationVersion=11; CarrierAuthenticationStatus=OK; CurrentTemperatureCelsius=24; Description=HPE Smart Storage Disk Drive View; DiskDriveStatusReasons=None; DiskDriveUse=Data; EncryptedDrive=false; FirmwareVersion=HPD2; InterfaceSpeedMbps=6000; InterfaceType=SAS; LegacyBootPriority=Primary; Location=1I:1:1; LocationFormat=ControllerPort:Box:Bay; MaximumTemperatureCelsius=42; MediaType=HDD; Model=MM1000FECVH; Name=HpeSmartStorageDiskDrive; PowerOnHours=; RotationalSpeedRpm=7200; SSDEnduranceUtilizationPercentage=; SerialNumber=L0JWZN0K; Health=OK; State=Enabled}}</dev:code> <dev:remarks> <maml:para>This example shows output of the Get-HPESAPhysicalDrive where the list of connections are passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Find-HPESA</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Find-HPESA</command:name> <maml:description> <maml:para>The Find-HPESA cmdlet finds the Smart Array controller available on the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Find</command:verb> <command:noun>HPESA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-HPESA cmdlet finds the Smart Array controller available on the target servers. This cmdlets gets the following controller properties:</maml:para> <maml:para>• ControllerModel: Gets the Smart Array controller model. • ControllerLocation: Gets the PCI slot location where the Smart Array controller is installed. • Health: Gets the health status of the Smart Array controller. • State: Gets the state of the Smart Array controller.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Find-HPESA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.1 admin admin123 -DisableCertificateAuthentication PS C:\> $findSmartArray = $connection | Find-HPESA PS C:\> $findSmartArray IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK SmartArrayController : {@{ControllerModel=HPE Smart Array P204i-b SR Gen10; ControllerLocation=Slot 0; Health=OK; State=Enabled}} PS C:\> $findSmartArray.SmartArrayController ControllerModel : HPE Smart Array P204i-b SR Gen10 ControllerLocation : Slot 0 Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output of Find-HPESA with the connection object passed through pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.1,10.20.30.2 admin admin -DisableCertificateAuthentication PS C:\> $smartArrayList = Find-HPESA -Connection $connections PS C:\> $smartArrayList IP : 10.20.30.1 Hostname : abc.domain.com Status : OK SmartArrayController : {@{ControllerModel=HPE Smart Array P204i-b SR Gen10; ControllerLocation=Slot 0; Health=OK; State=Enabled}} IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SmartArrayController : {@{ControllerModel=HPE Smart Array P204i-b SR Gen10; ControllerLocation=Slot 0; Health=OK; State=Enabled}, @{Model=HPE Smart Array S100i SR Gen10 ; Location=Slot 0b; Health=OK; State=Enabled}} PS C:\> $smartArrayList[1].SmartArrayController ControllerModel : HPE Smart Array P204i-b SR Gen10 ControllerLocation : Slot 0 Health : OK State : Enabled ControllerModel : HPE Smart Array S100i SR Gen10 ControllerLocation : Slot 0b Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output of Find-HPESA with a list of connection objects provided through named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESADiscoveryStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-HPESAPowerMode</command:name> <maml:description> <maml:para>The Set-HPESAPowerMode cmdlet sets the Smart Array controller power mode.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESAPowerMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESAPowerMode cmdlet sets the Smart Array controller power mode. This cmdlets has the following parameter:</maml:para> <maml:para>• PowerMode</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESAPowerMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerMode</maml:name> <maml:description> <maml:para>This parameter specifies the power mode of the Smart Array controller after the reboot of the target server. Accepted values are Invalid, MinPower, Balanced, and MaxPerformance.</maml:para> <maml:para>• Invalid: The controller operates in an unknown power mode after a reboot. • MinPower: The controller operates in minimum power mode after a reboot. • Balanced: The controller operates in a balanced mode after a reboot. • MaxPerformance: The controller operates in maximum performance power mode after a reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerMode</maml:name> <maml:description> <maml:para>This parameter specifies the power mode of the Smart Array controller after the reboot of the target server. Accepted values are Invalid, MinPower, Balanced, and MaxPerformance.</maml:para> <maml:para>• Invalid: The controller operates in an unknown power mode after a reboot. • MinPower: The controller operates in minimum power mode after a reboot. • Balanced: The controller operates in a balanced mode after a reboot. • MaxPerformance: The controller operates in maximum performance power mode after a reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot 1" and "slot 1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPESAPowerMode -Connection $connection -ControllerLocation "Slot 0" -PowerMode "Balanced"</dev:code> <dev:remarks> <maml:para>This example sets the PowerMode value using a connection object as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connections = Connect-HPESA 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\> $connections | Set-HPESAPowerMode -ControllerLocation "Slot 0","Slot 1" -PowerMode "MinPower","MaxPerformance"</dev:code> <dev:remarks> <maml:para>This example sets the PowerMode value passing a list of connection objects as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAPowerMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Update-HPESAModuleVersion</command:name> <maml:description> <maml:para>The Update-HPESAModuleVersion cmdlet checks if an updated version of the HPESmartArrayCmdlets is available on the Hewlett Packard Enterprise website and returns the link to download the new version.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPESAModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPESAModuleVersion cmdlet checks whether an updated version of the Smart Array cmdlets is available on the Hewlett Packard Enterprise website and returns the link to download the new version. All users are allowed access to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Update-HPESAModuleVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Update-HPESAModuleVersion The currently installed version 1.0.0.0 is the most current.</dev:code> <dev:remarks> <maml:para>This example shows that the currently installed version is the most current.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Update-HPESAModuleVersion There is a newer version of HPEBIOSCmdlets available at http://www.hpe.com/servers/powershell. Do you want to go there to download the new version?(Y/N): Y</dev:code> <dev:remarks> <maml:para>This example shows that a newer version of cmdlets is available on the Hewlett Packard Enterprise website for download. Input Y to open the website with default browser.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAModuleVersion</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPESAModuleVersion</command:name> <maml:description> <maml:para>The Get-HPESAModuleVersion cmdlet gets the module details of the installed HPESmartArrayCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAModuleVersion cmdlet gets the module details of the installed HPESmartArrayCmdlets module. The details include name of file, path, description, GUID, version, and supported UI cultures with the respective versions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAModuleVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPESAModuleVersion Name : HPESmartArrayCmdlets Path : C:\Program Files (x86)\Hewlett Packard Enterprise\PowerShell\Modules\HPESmartArrayCmdlets\HPESmartArrayCmdlets.dll Description : PowerShell Cmdlet to manage HPE SmartArray controller. GUID : f2dffb11-25be-4e15-96c5-2358f8d89419 CurrentUICultureName : en-US CurrentUICultureVersion : Version : 1.0 DotNetVersion : 4.6.1 PSVersion : @{PSVersion=5.1.14409.1005; PSEdition=Desktop; PSCompatibleVersions=System.Version[]; BuildVersion=10.0.14409.1005; CLRVersion=4.0.30319.42000; WSManStackVersion=3.0; PSRemotingProtocolVersion=2.3; SerializationVersion=1.1.0.1} OSVersion : @{Caption=Microsoft Windows 8.1 Enterprise; CSDVersion=; Version=6.3.9600; BuildNumber=9600} CCGVersion : 1.3.0.0 AvailableUICulture : {}</dev:code> <dev:remarks> <maml:para>This example shows the output of the Get-HPESAModuleVersion cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Clear-HPESALog</command:name> <maml:description> <maml:para>The Clear-HPESALog cmdlet clears any logs created by the HPESACmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPESALog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPESALog cmdlet clears any logs created by the HPESACmdlets module. You are prompted for confirmation unless you specify the Force parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPESALog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the integer as a value and if X value is specified, then X number of logs in the descending order of their age will be cleared (oldest logs will be cleared first). If no parameter is used, all existing logs, including the current log, will be cleared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Clears all existing logs without prompting for confirmation. By default, Clear-HPESALog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the integer as a value and if X value is specified, then X number of logs in the descending order of their age will be cleared (oldest logs will be cleared first). If no parameter is used, all existing logs, including the current log, will be cleared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Clears all existing logs without prompting for confirmation. By default, Clear-HPESALog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Clear-HPESALog</dev:code> <dev:remarks> <maml:para>This example clears the logs.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/poweshell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Disable-HPESALog</command:name> <maml:description> <maml:para>The Disable-HPESALog cmdlet disables the HPESACmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPESALog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPESALog cmdlet disables the HPESACmdlets logging for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPESALog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Disable-HPESALog Logging disabled for the current session!</dev:code> <dev:remarks> <maml:para>This example disables the HPESACmdlets logging for the current PowerShell session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe/com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Enable-HPESALog</command:name> <maml:description> <maml:para>The Enable-HPESALog cmdlet enables the HPESACmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPESALog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPESALog cmdlet enables the HPESACmdlets logging for the current PowerShell session. By default, logging is disabled and must be enabled explicitly.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPESALog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Enable-HPESALog LogFilePath ----------- C:\Program Files\Hewlett Packard Enterprise\PowerShell\Modules\HPESmartArrayCmdlets\Logs\HPESmartArrayCmdlets_11222017_15432514.log</dev:code> <dev:remarks> <maml:para>This example enables HPESACmdlets logging for the current PowerShell session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPESALog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.36--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-HPESAVolume</command:name> <maml:description> <maml:para>The Get-HPESAVolume gets the storage volume details of the server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESAVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESAVolume cmdlet gets the volume details available the Storage. Some of the details provided are,</maml:para> <maml:para>Id Name Encrypted CapacityBytes BlockSizeBytes StripSizeBytes DisplayName VolumeUsage LogicalUnitNumber WriteCachePolicy</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESAVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 1</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $volume = Get-HPESAVolume -Connection $connection PS C:\> $volume Id : 1 Name : SR Volume 1 Encrypted : false CapacityBytes : 480070426624 BlockSizeBytes : 512 StripSizeBytes : 262144 DisplayName : Logical Drive 1 VolumeUsage : Data LogicalUnitNumber : 1 WriteCachePolicy : Off Id : 2 Name : SR Volume 2 Encrypted : false CapacityBytes : 960163569664 BlockSizeBytes : 512 StripSizeBytes : 262144 DisplayName : Logical Drive 2 VolumeUsage : Data LogicalUnitNumber : 2 WriteCachePolicy : Off Id : 3 Name : SR Volume 3 Encrypted : false CapacityBytes : 960163569664 BlockSizeBytes : 512 StripSizeBytes : 262144 DisplayName : Logical Drive 3 VolumeUsage : Data LogicalUnitNumber : 3 WriteCachePolicy : Off</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of Get-HPESAVolume where the connection is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>Set-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>New-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Set-HPESAVolume</command:name> <maml:description> <maml:para>The Set-HPESAVolume sets the storage volume details of the server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESAVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPESAVolume cmdlet sets the volume details available the Storage. Some of the values that can be set are,</maml:para> <maml:para>CapacityBytes StripSizeBytes DisplayName IOPrefModeEnabled WriteCachePolicy ReadCachePolicy WriteHoleCachePolicy</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESAVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">CapacityBytes</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The CapacityBytes value has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The slot details of the controllers needs to be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">VolumeName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The volume name has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">DisplayName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The Display name has to be provided where the set operation will be performed. This changes the Display Name of the Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">StripSizeBytes </maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The StripSizeBytes value has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">IOPrefModeEnabled</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The IOPrefModeEnabled is used to modify the IO performance mode (also known as Smart Path or FastPath) of an existing volume. Set the value to true or false. Enabling IO performance mode requires an SSD volume and both the write cache policy and read cache policy set to Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ReadCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The IOPrefModeEnabled is used to modify the ReadCachePolicy of an existing volume. Allowable values may include Off or ReadAhead. Enabling ReadAhead requires that IOPerfModeEnabled set to false</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteCachePolicy is used to modify the WriteCachePolicy (also known as flash backed write cache) of an existing volume. Allowable values may include Off, WriteThrough, ProtectedWriteBack, or UnprotectedWriteBack. Enabling ProtectedWriteBack or UnprotectedWriteBack using a supported controller model requires IOPerfModeEnabled set to false. ProtectedWriteBack also requires a properly installed HPE Smart Storage Battery and controller backup power cable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteHoleProtectionPolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteHoleProtectionPolicy is used to assign a drive to be used as JournalingMedia to enable write hole protection. Write hole protection is a specific partial data loss scenario involving a double fault condition of a degraded parity volume and ungracefull shutdown while a host write operation is in progress. Some controllers support write hole protection without needing a journaling media drive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>DedicatedSpareDrives</maml:name> <maml:description> <maml:para>Used to modify the spare drives assigned to an existing volume. Spare drives need to be the same media type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DedicatedSpareDrives[]</command:parameterValue> <dev:type> <maml:name>DedicatedSpareDrives[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The slot details of the controllers needs to be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">VolumeName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The volume name has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">CapacityBytes</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The CapacityBytes value has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">DisplayName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The Display name has to be provided where the set operation will be performed. This changes the Display Name of the Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">StripSizeBytes </maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The StripSizeBytes value has to be provided where the set operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">IOPrefModeEnabled</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The IOPrefModeEnabled is used to modify the IO performance mode (also known as Smart Path or FastPath) of an existing volume. Set the value to true or false. Enabling IO performance mode requires an SSD volume and both the write cache policy and read cache policy set to Off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteCachePolicy is used to modify the WriteCachePolicy (also known as flash backed write cache) of an existing volume. Allowable values may include Off, WriteThrough, ProtectedWriteBack, or UnprotectedWriteBack. Enabling ProtectedWriteBack or UnprotectedWriteBack using a supported controller model requires IOPerfModeEnabled set to false. ProtectedWriteBack also requires a properly installed HPE Smart Storage Battery and controller backup power cable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ReadCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The IOPrefModeEnabled is used to modify the ReadCachePolicy of an existing volume. Allowable values may include Off or ReadAhead. Enabling ReadAhead requires that IOPerfModeEnabled set to false</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteHoleProtectionPolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteHoleProtectionPolicy is used to assign a drive to be used as JournalingMedia to enable write hole protection. Write hole protection is a specific partial data loss scenario involving a double fault condition of a degraded parity volume and ungracefull shutdown while a host write operation is in progress. Some controllers support write hole protection without needing a journaling media drive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>DedicatedSpareDrives</maml:name> <maml:description> <maml:para>Used to modify the spare drives assigned to an existing volume. Spare drives need to be the same media type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DedicatedSpareDrives[]</command:parameterValue> <dev:type> <maml:name>DedicatedSpareDrives[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:description> </command:inputType> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">VolumeName[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 1</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPESAVolume -Connection $connection -ControllerLocation "Slot=12" -VolumeName "P Volume" -DisplayName "SR Volume 1" PS C:\> </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of Set-HPESAVolume where the connection, controller location, volume and the parameter to perform set operation is passed.</maml:para> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 2</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPESAVolume -Connection $connection -ControllerLocation "Slot=12" -VolumeName "P Volume" -WriteCachePolicy Off PS C:\> </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of Set-HPESAVolume where the connection, controller location, volume and the parameter to perform set operation is passed.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://www.sapien.com</maml:uri> </maml:navigationLink> <!--Links--> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>Get-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>New-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-HPESAVolume</command:name> <maml:description> <maml:para>The New-HPESAVolume creates new volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>HPESAVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-HPESAVolume cmdlet creates new volume, Below are values that can be added when creating volume,</maml:para> <maml:para>CapacityBytes StripSizeBytes DisplayName IOPrefModeEnabled WriteCachePolicy ReadCachePolicy WriteHoleCachePolicy DedicatedSpareDrives Drives RAIDType InitializeMethod WriteHoleProtectionPolicy</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-HPESAVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">CapacityBytes</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The CapacityBytes value has to be provided for creating the new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The slot details of the controllers needs to be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">DisplayName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The Display name of the Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">StripSizeBytes </maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The StripSizeBytes value for creating the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">IOPrefModeEnabled</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Enabling IO performance mode requires an SSD volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ReadCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The ReadCachePolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteCachePolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteHoleProtectionPolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteHoleProtectionPolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>DedicatedSpareDrives</maml:name> <maml:description> <maml:para>The spare drives assigned to an existing volume. Spare drives need to be the same media type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DedicatedSpareDrives[]</command:parameterValue> <dev:type> <maml:name>DedicatedSpareDrives[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The slot details of the controllers needs to be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">CapacityBytes</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The CapacityBytes value has to be provided for creating the new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">DisplayName</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The Display name of the Volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">StripSizeBytes </maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The StripSizeBytes value for creating the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Int[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">IOPrefModeEnabled</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Enabling IO performance mode requires an SSD volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteCachePolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ReadCachePolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The ReadCachePolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">WriteHoleProtectionPolicy</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The WriteHoleProtectionPolicy for creating new volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>DedicatedSpareDrives</maml:name> <maml:description> <maml:para>The spare drives assigned to an existing volume. Spare drives need to be the same media type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DedicatedSpareDrives[]</command:parameterValue> <dev:type> <maml:name>DedicatedSpareDrives[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Drives</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The drive location where the volume is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Drives[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Drives[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RAIDType</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The Raid type for creating the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">InitializeMethod</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>The InitializeMethod for creating the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">ControllerLocation[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:description> </command:inputType> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RAIDType[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:description> </command:inputType> <command:inputType xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Drives[] System.String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">System.Management.Automation.PSObject[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10"></maml:uri> </dev:type> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 1</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> New-HPESAVolume $connection -ControllerLocation "Slot=14" -RAIDType RAID0 -Drives "/redfish/v1/Systems/1/Storage/DE009000/Drives/1" PS C:\> </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of New-HPESAVolume where the connection, controller location, RAIDType and Drive location are specified for SR Controllers.</maml:para> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 2</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> New-HPESAVolume $connection -ControllerLocation "Slot=14" -RAIDType RAID0 -Drives "/redfish/v1/Systems/1/Storage/DE009000/Drives/1" -CapacityBytes 1920349855744 PS C:\> </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of New-HPESAVolume where the connection, controller location, RAIDType, CapacityBytes and Drive location are specified for SR Controllers.</maml:para> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 3</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\> $connection = Connect-HPESA 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> New-HPESAVolume $connection -ControllerLocation "Slot=14" -RAIDType RAID0 -Drives "/redfish/v1/Chassis/DE009000/Drives/1" PS C:\> </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para>This example shows the output of New-HPESAVolume where the connection, controller location, RAIDType and Drive location are specified for MR Controllers.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://www.sapien.com</maml:uri> </maml:navigationLink> <!--Links--> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>Get-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:linkText>Set-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-HPESAVolume</command:name> <maml:description> <maml:para>The Remove-HPESAVolume cmdlet deletes the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPESAVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPESAVolume cmdlet deletes the specified volume. This cmdlet deletes the volume based on VolumeName.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPESAVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the VolumeName of the volume to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPESA command using the IP/Hostname and accompanying Username and Password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Connection[]</command:parameterValue> <dev:type> <maml:name>Connection[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ControllerLocation</maml:name> <maml:description> <maml:para>Specifies the installed slot location of the Smart Array controller in the target server. This parameter does not accept multiple controller locations for one target server. The value of this parameter is case sensitive. Use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specifies the VolumeName of the volume to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.SA.CommunicationLayer.Connection[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The parameter ControllerLocation is case sensitive. Therefore, the values "Slot=1" and "slot=1" are treated as two different values. A better approach to avoid wrong ControllerLocation is to use the Find-HPESA cmdlet to get ControllerLocation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPESA -IP 10.20.30.40 -Username admin -Password admin123 PS C:\> $result = Remove-HPESAVolume -Connection $connection -ControllerLcation "Slot=1" -VolumeName "Volume 1" PS C:\> $result IP : 10.20.30.40 Hostname : abc.domain.com Status : Information StatusInfo : @{Category=Usability; Message=Reboot of the target server is required. }</dev:code> <dev:remarks> <maml:para>This example shows the ouput of Remove-HPESAVolume using the connection as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPESAVolume</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPESAVolume</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPESAVolume</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> </helpItems> |