en-US/HPOneView.500.psm1-help.xml
|
<?xml version='1.0'?>
<helpItems xmlns="http://msh" schema="maml"> <!--ADD-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <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"> <!--ADD-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <command:details> <command:name>Add-HPOVApplianceTrustedCertificate</command:name> <maml:description> <maml:para>Add X.509 SSL certificates to appliance trusted store.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVApplianceTrustedCertificate</command:noun> </command:details> <maml:description> <maml:para>HPE OneView performs certificate validation for all Transport Layer Security (TLS) communications between the appliance and external servers or devices. These checks guarantee confidentiality, integrity, and authentication with the remote end-point. In production environments, Hewlett Packard Enterprise strongly recommends that certificate validation be enabled. In environments where security is not a concern, such as a testing environment, certificate validation can optionally be disabled. This Cmdlet will allow an administrator to add X.509 compliant SSL certificates to the appliance trusted store. Minimum required privileges: * Infrastructure Administrator to add certificate authority certificates and server certificates. * Network administrator, Server administrator, Software administrator, or Storage administrator to add server certificates.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVApplianceTrustedCertificate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Path</maml:name> <maml:description> <maml:para>The filesystem object of the X.509 public SSL certificate to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>CertObject</maml:name> <maml:description> <maml:para>Specify the public Base64 X.509 certificate of the remote endpoint to add to the appliances internal trust store.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The remote endpoint Computer Name or IP Address. This should match either the X.509 Subject or Subject Alternative Name fields with in the cert object. If omitting the -CertObject parameter, the Cmdlet will initiate a TCP connection in order to retrieve the certificate. Use the -Port parameter to specify the correct TCP port the SSL/TLS service is listening on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specify the TCP port where the TLS/SSL service is bound and listening on. Use with the -ComputerName parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>Specify an alias name of the certificate stored on the appliance. By default, the Subject name will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force add an untrusted (self signed or a certificate authority certificate has not been added to the appliance) certificate into the appliances trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AliasName</maml:name> <maml:description> <maml:para>Specify an alias name of the certificate stored on the appliance. By default, the Subject name will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>CertObject</maml:name> <maml:description> <maml:para>Specify the public Base64 X.509 certificate of the remote endpoint to add to the appliances internal trust store.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The remote endpoint Computer Name or IP Address. This should match either the X.509 Subject or Subject Alternative Name fields with in the cert object. If omitting the -CertObject parameter, the Cmdlet will initiate a TCP connection in order to retrieve the certificate. Use the -Port parameter to specify the correct TCP port the SSL/TLS service is listening on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force add an untrusted (self signed or a certificate authority certificate has not been added to the appliance) certificate into the appliances trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Path</maml:name> <maml:description> <maml:para>The filesystem object of the X.509 public SSL certificate to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specify the TCP port where the TLS/SSL service is bound and listening on. Use with the -ComputerName parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>The filesystem object of the X.509 public SSL certificate to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-ChildItem C:\Path\srv1-pub.cer | Add-HPOVApplianceTrustedCertificate</dev:code> <dev:remarks> <dev:para>Add the provided offline certificate to the appliance trust store.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVApplianceTrustedCertificate -ComputerName $RemoteBackupHostname -Port 443 -AliasName backupserver -Async -Outvariable Task</dev:code> <dev:remarks> <dev:para>Use the Cmdlet to add the remote certificate to the appliance trust store without waiting for the task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVApplianceTrustedCertificate -ComputerName server1-ilo.domain.com -AliasName server1iLo -force</dev:code> <dev:remarks> <dev:para>Use the Cmdlet to add the self signed iLO certificate to the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVBASELINE--> <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"> <!--ADD-HPOVBASELINE--> <command:details> <command:name>Add-HPOVBaseline</command:name> <maml:description> <maml:para>Upload new SPP Baseline or hotfix to appliance firmware repository.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVBaseline</command:noun> </command:details> <maml:description> <maml:para>The appliance provides reliable and simplified firmware management across the data center. Using the firmware management features built in to the appliance, you can define firmware baselines and perform firmware updates across many resources. When you add a resource to the appliance, the appliance automatically updates the resource firmware to the minimum version required to be managed by the appliance or version defined to be a baseline. A firmware bundle, also known as an HPE Service Pack for ProLiant (SPP), is a comprehensive collection of firmware and system software components, all tested together as a single solution stack that includes drivers, agents, utilities, and firmware packages. Firmware bundles enable you to update firmware on HPE ProLiant servers, controllers, storage, servers, interconnects, and enclosures. NOTE: If you attempt to add a firmware bundle that does not contain the required firmware version and components, the firmware bundle is uploaded with a warning message in the appliance firmware repository. The warning message displays the missing components in the firmware bundle. All the components below the minimum required versions are considered as missing. Retrieve the list of SPPs or hotfixes which have been uploaded to the appliance, and their detail. You can examine the included components and their versions reported by the baseline. Please note that any file name that contains the . (period, CHAR46) character will be replaced with _ (underscore, CHAR95). Example: My.Spp.To.Upload.201605.iso will become My_Spp_To_Upload_201605.iso. Minimum required privileges: Infrastructure administrator, Network administrator, or Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVBaseline</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>File</maml:name> <maml:description> <maml:para>The full path and file name of the SPP file. The function returns an error if the file path cannot be validated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>CompSigFile</maml:name> <maml:description> <maml:para>When adding a Gen10 hotfix component, the associated compsig file is required to validate the digital signature of the hotfix. Use this parameter to accompany the hotfix file upload to the repository.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>CompSigFile</maml:name> <maml:description> <maml:para>When adding a Gen10 hotfix component, the associated compsig file is required to validate the digital signature of the hotfix. Use this parameter to accompany the hotfix file upload to the repository.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="sppFile"> <maml:name>File</maml:name> <maml:description> <maml:para>The full path and file name of the SPP file. The function returns an error if the file path cannot be validated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.IO.FileSystemInfo</maml:name> </dev:type> <maml:description> <maml:para>File System bject from Get-ChildItem</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The progress of uploading the file to the appliance, and in-progress or completion result.</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>Add-HPOVBaseline -File "C:\Users\me\Documents\SPP2012060B.2012.0525.1.iso"</dev:code> <dev:remarks> <dev:para>Upload SPP ISO to all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVBaseline -File (Get-ChildItem .\CP672214.exe)</dev:code> <dev:remarks> <dev:para>Upload the specified hotfix to all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$HotFixFile = dir .\CP672214.exe $CompSigFile = dir .\CP672214.compsig Add-HPOVBaseline -File $HotFixFile -CompSigFile $CompSigFile</dev:code> <dev:remarks> <dev:para>Upload the specified Gen10 hotfix and its associated compsig file to all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVBaselineRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVBaselineRepositorySize</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVCLUSTERMANAGER--> <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"> <!--ADD-HPOVCLUSTERMANAGER--> <command:details> <command:name>Add-HPOVClusterManager</command:name> <maml:description> <maml:para>Add new hypervisor manager.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVClusterManager</command:noun> </command:details> <maml:description> <maml:para>Hypervisor Manager is software for managing virtualized environments. Through the HPE OneView Hypervisor Manager resource, you can create, import, configure, and manage hypervisors and hypervisor clusters. A hypervisor manager provides the hostname and credentials to register with HPE OneView. HPE OneView uses these details to communicate with a hypervisor manager to perform tasks such as add, edit, and remove hypervisors or hypervisor clusters. You can register a new hypervisor cluster manager with HPE OneView by providing the hostname and credentials. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences using the edit operation. You can override these values in a hypervisor cluster profile. A valid hypervisor manager certificate must be added to HPE OneView trust store to be able to successfully communicate with a hypervisor manager. The user must have an infrastructure administrator privilege to register or update the hypervisor manager resource in HPE OneView. You can assign scopes to the hypervisor manager resource in HPE OneView. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVClusterManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP or FQDN address of the hypervisor manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide the cluster manager credentials.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Override display name of the hypervisor manager. By default Hostname will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>HTTPS port of the target hypervisor manager. Default is 443.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an [HPOneView.Appliance.ScopeCollection] resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide the cluster manager credentials.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Override display name of the hypervisor manager. By default Hostname will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Name, ComputerName"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP or FQDN address of the hypervisor manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>HTTPS port of the target hypervisor manager. Default is 443.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an [HPOneView.Appliance.ScopeCollection] resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress.</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>Add-HPOVClusterManager -Hostname vcenter.domain.local -Credential (Get-Credential -Username administrator@vsphere.local -Message Password)</dev:code> <dev:remarks> <dev:para>Add hypervisor manager by providing prompted PSCredential.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVCLUSTERNODE--> <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"> <!--ADD-HPOVCLUSTERNODE--> <command:details> <command:name>Add-HPOVClusterNode</command:name> <maml:description> <maml:para>Add a new cluster member to an existing cluster.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVClusterNode</command:noun> </command:details> <maml:description> <maml:para>A hypervisor is software deployed on a server node that creates and runs virtual machines. Hypervisors are clustered to ensure high availability, to optimize resource utilization, and to be fault tolerant. A hypervisor cluster profile enables you to deploy and manage a cluster of hypervisors running on servers managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A hypervisor cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to hypervisors in the cluster. The server profiles define physical server configurations for server nodes in the cluster, which are derived from hypervisor cluster profile and the associated server profile template. The hypervisor profiles define network and storage configurations for hypervisors in the cluster, which are derived from hypervisor cluster profile. Hypervisor network and storage configurations in the hypervisor cluster profile are defined based on physical server configuration to ensure consistent configuration from server node to hypervisor. You can import additional hypervisors into the hypervisor cluster profile by adding existing hypervisors. Use this option if you are deploying the hypervisor OS on the server nodes outside of HPE OneView. This option helps you to deploy and manage hypervisor clusters using the hypervisor OS deployment tool of your choice. To add a node to an existing cluster, a server profile must be assigned to a server resource, created from the same server profile template the cluster was created from. The hypervisor OS must be installed and host added to the hypervisor manager using its management interface. Minimum required privilegesMinimum required privileges: Infrastructure administrator, Server administrator, Server profile architect, or Server profile administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVClusterNode</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name of the hypervisor host to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide the hypervisor manager credentials.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Name"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name of the hypervisor host to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide the hypervisor manager credentials.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.ServerHardware</maml:name> </dev:type> <maml:description> <maml:para>The server hardware resource to add to the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource to monitor.</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>Add-HPOVClusterNode</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enter-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exit-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVENCLOSURE--> <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"> <!--ADD-HPOVENCLOSURE--> <command:details> <command:name>Add-HPOVEnclosure</command:name> <maml:description> <maml:para>Import a support HPE BladeSystem c-Class enclosure.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVEnclosure</command:noun> </command:details> <maml:description> <maml:para>An enclosure (HPE c-Class BladeSystem enclosure or Synergy frame) is a physical structure with device bays supporting compute, networking, and storage building blocks. These building blocks share the enclosure's common power, cooling, and management infrastructure. This Cmdlet will import an HPE BladeSystem c7000 enclosure for HPE OneView management. The Onboard Administrator needs to have at least an IP Address for each OA module, and a valid Administrator account. An Enclosure Group must also be created. NOTE: HPE Synergy enclosures are automatically discovered when their frame link manager is connected to the Synergy management ring. This Cmdlet will attempt a connection to the XML Reply interface to examine if an existing VC Domain is present. If so, you are prompted if you wish to continue and force import the enclosure. CRITICAL: FORCE IMPORT OF AN ENCLOSURE WILL DELETE ANY EXISTING VC DOMAIN CONFIGURATION, AND NOT PERFORM ANY VC DOMAIN CONFIGURATION MIGRATION. PLEASE BACKUP YOUR VC DOMAIN IF YOU WISH TO RESTORE TO ITS ORIGINAL CONFIGURATION. If you wish to migrate the enclosure from a Virtual Connect Manager or Virtual Connect Enterprise Manager configuration, please use the Invoke-HPOVVcmMigration Cmdlet. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Enclosure Group Name to associate with the enclosure to import.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Username</maml:name> <maml:description> <maml:para>Administrator account of the target OA. Can be either an OA Local Administrator or Active Directory (AD) account if the OA is configured for AD authentication.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Password</maml:name> <maml:description> <maml:para>Administrator Account password of the OA specified. Value can be [System.String] or [System.Security.SecureString].</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Baseline File Name, Name, URI or Object. Examples: $FileName = "bp-hp-service-pack-for-proliant-oneview-2014-11-30-05.iso" $Name = "HP Service Pack For ProLiant OneView 2014 11 13"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para> Force the installation of the provided Firmware Baseline.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Enclosure Group Name to associate with the enclosure to import.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Baseline File Name, Name, URI or Object. Examples: $FileName = "bp-hp-service-pack-for-proliant-oneview-2014-11-30-05.iso" $Name = "HP Service Pack For ProLiant OneView 2014 11 13"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para> Force the installation of the provided Firmware Baseline.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredCredential, Monitored"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Add the specified enclosure for monitor only management. You can view hardware for inventory and status information only. Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and alert users to specific conditions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Username</maml:name> <maml:description> <maml:para>Administrator account of the target OA. Can be either an OA Local Administrator or Active Directory (AD) account if the OA is configured for AD authentication.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Password</maml:name> <maml:description> <maml:para>Administrator Account password of the OA specified. Value can be [System.String] or [System.Security.SecureString].</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredCredential, Monitored"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Add the specified enclosure for monitor only management. You can view hardware for inventory and status information only. Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and alert users to specific conditions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed" aliases="fwIso, fwBaselineIsoFilename"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Baseline File Name, Name, URI or Object. Examples: $FileName = "bp-hp-service-pack-for-proliant-oneview-2014-11-30-05.iso" $Name = "HP Service Pack For ProLiant OneView 2014 11 13"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagedCredential, Managed" aliases="eg, EnclGroupName"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Enclosure Group Name to associate with the enclosure to import.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed" aliases="forceFw, forceInstall"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para> Force the installation of the provided Firmware Baseline.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored" aliases="oa"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address, Hostname or FQDN of the Primary C7000 Onboard Administrator (OA).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, Managed" aliases="license, l"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>OneView</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredCredential, Monitored" aliases="None"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Add the specified enclosure for monitor only management. You can view hardware for inventory and status information only. Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and alert users to specific conditions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="p, pw"> <maml:name>Password</maml:name> <maml:description> <maml:para>Administrator Account password of the OA specified. Value can be [System.String] or [System.Security.SecureString].</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedCredential, MonitoredCredential, Managed, Monitored" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="u, user"> <maml:name>Username</maml:name> <maml:description> <maml:para>Administrator account of the target OA. Can be either an OA Local Administrator or Active Directory (AD) account if the OA is configured for AD authentication.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Enclosure Group Resource that will be used to set the Enlosure policy.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process.</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>Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView</dev:code> <dev:remarks> <dev:para>Add a new enclosure to the appliance, using the EG1 Enclosure Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVEnclosure -oa "192.168.1.1" -enclGroupName EG1 -user admin -pass hpinvent -license OneView -confirm:$false</dev:code> <dev:remarks> <dev:para>Add a new enclosure to the appliance, using the EG1 Enclosure Group, and force add the target enclosure. THIS IS A DESTRUCTIVE PROCESS IF AN EXISTING VC DOMAIN EXISTS.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVEnclosure -oa "192.168.1.1" -user admin -pass hpinvent -monitored</dev:code> <dev:remarks> <dev:para>Add a new enclosure to the appliance for monitoring only.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPOVVcmMigration</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureActiveFLM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVFABRICMANAGER--> <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"> <!--ADD-HPOVFABRICMANAGER--> <command:details> <command:name>Add-HPOVFabricManager</command:name> <maml:description> <maml:para>Add an external fabric manager.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVFabricManager</command:noun> </command:details> <maml:description> <maml:para>Fabric Managers is a resource manager in HPE OneView that enables integration of a Cisco ACI fabric (an external entity) with HPE Synergy. A fabric manager aligns HPE OneView resources as defined by Cisco Application Policy Infrastructure Controller (APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric. You can operate a fabric manager after adding it in HPE OneView and configure a list of tenants to cover policies necessary for HPE Synergy and Cisco APIC integration. Remediation of networks, network sets, and logical interconnects Remediation is a process to convert a noncompliant health state of an HPE OneView resource to a compliant health state with respect to APIC policy definitions. The following conditions cause the fabric manager to be unable to synchronize with network policies: * One or more networks connected across uplink sets in a logical interconnect within HPE Synergy have the same VLAN tag * The two networks are shared across tenants When a fabric manager is non compliant with APIC network policies, a software remediation enables a fabric manager to synchronize with network policies. A compliance report is generated immediately after adding a fabric manager and is updated again after remediation. The compliance report details actions that you can perform to remediate inconsistencies. There are indicators for compliant, noncompliant, and compliance-check progress for each resource. Every tenant has a list of consistent and inconsistent reports based on the compliance records generated for a tenant. An inconsistency appears in the form of an alert, which contains an action choice: auto-remediate or manual. If you choose to auto-remediate, an automatic update of the selected HPE OneView resource will initiate. Minimum required privileges: Infrastructure administrator or Network administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVFabricManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers primary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fabric managers resource name to use.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecondaryManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers secondary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TertiearyManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers tertieary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers primary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fabric managers resource name to use.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecondaryManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers secondary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TertiearyManagementAddress</maml:name> <maml:description> <maml:para>The fabric managers tertieary IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the resource SSL certificate is not trusted, use this parameter to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress.</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>Add-HPOVFabricManager -Name ProdFabricManager -ManagementAddress fabricmgr1-vip.domain.local -SecondaryManagementAddress fabricmgr1-vip2.domain.local</dev:code> <dev:remarks> <dev:para>Add the specified farbic manager with a redundant address.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVLDAPSERVER--> <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"> <!--ADD-HPOVLDAPSERVER--> <command:details> <command:name>Add-HPOVLdapServer</command:name> <maml:description> <maml:para>Add a new LDAP Directory Server.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVLdapServer</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. This Cmdlet will add a new LDAP Directory Server to an existing authentication directory. When a directory is configured on the appliance, you can specify one or more directory servers that can be accessed for the directory service. If more than one directory server is added for a directory, they are assumed to be replicated servers for high availability or disaster tolerance. If one directory server is not reachable, the other configured servers are accessed for authenticating the user. NOTE: * If you use a cluster for your directory server configuration, the cluster hostname can be specified as the directory server. Hewlett Packard Enterprise recommends using a cluster for your directory server configuration instead of configuring replicated directory servers in the appliance. * Directory search operations can be time consuming depending on your directory configuration and network latency affecting login time. When using Active Directory with many domains, for optimal login performance, configure a global catalog for your directory server. User login formats used for authentication To support user login with only the user name specified, the following formats are tried to authenticate with the directory service: If the user name is not an email address (denoted by the presence of an @ character) or a \ character (to denote the domain\user name format), logins are attempted in the following order: * The user name is treated as the logon name, and directory-name gets prepended as directory-name\user-name, for example: example\jane. * The user name is treated as a UID. * The user name is treated as Common Name (CN). NOTE: If the Active Directory Server Service configured in HPE OneView has a user lock-out policy (defined, for example, on n number of successive failed login attempts), Hewlett Packard Enterprise recommends that you use the email or the domain\user name format to log into HPE OneView. If email or domain\user name format is not used (instead, just the user name is used), HPE OneView internally tries different login formats as described previously. This may result in locking out the user from the GUI on a single failed login attempt (wrong password). To minimize login attempts, configure the directory display name to be the same as the first component of the directories fully qualified domain name. For example, assign the HPE OneView name example for the directory example.com. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVLdapServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Directory server name or IP Address to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with in order to validate LDAP configuration.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>SSLPort</maml:name> <maml:description> <maml:para>Directory Servers LDAP SSL Port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the Cmdlet will attempt to retrieve the Directory Servers Secure LDAP Certiciate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password in order to validate LDAP configuration. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or, use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority"s certificate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVLdapServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Directory server name or IP Address to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>SSLPort</maml:name> <maml:description> <maml:para>Directory Servers LDAP SSL Port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the Cmdlet will attempt to retrieve the Directory Servers Secure LDAP Certiciate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or, use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority"s certificate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default" aliases="cert"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the Cmdlet will attempt to retrieve the Directory Servers Secure LDAP Certiciate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default" aliases="Name"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Directory server name or IP Address to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="p, pass"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password in order to validate LDAP configuration. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default" aliases="port"> <maml:name>SSLPort</maml:name> <maml:description> <maml:para>Directory Servers LDAP SSL Port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>636</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, default" aliases="None"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or, use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority"s certificate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="u, user"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with in order to validate LDAP configuration.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Authentication Directory object that will have the LDAP Server added to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated Authentication Directory.</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>Get-HPOVLdapDirectory -Name MyDirectory | Add-HPOVLdapServer -Name servera.domain.com -Username MyAdminName -Password (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)</dev:code> <dev:remarks> <dev:para>Add a new LDAP Directory server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVPOWERDEVICE--> <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"> <!--ADD-HPOVPOWERDEVICE--> <command:details> <command:name>Add-HPOVPowerDevice</command:name> <maml:description> <maml:para>Import a power device.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVPowerDevice</command:noun> </command:details> <maml:description> <maml:para>Power delivery devices provide power to IT hardware. A typical power topology in a data center includes power delivery devices such as power feeds, breaker panels, branch circuits, and power distribution units (PDUs), as well as the load segments, outlet bars, and outlet components of these devices. Adding your power delivery devices to the appliance enables power management using thermal limits, rated capacity, and derated capacity. Power Delivery Devices describes the following classes of devices: * Intelligent Power Distribution Units (iPDUs), which the appliance can automatically discover and control. * Other power delivery devices that the appliance cannot discover. By manually adding these devices to the appliance, they become available for tracking, inventory, and power management purposes. Regardless of how power delivery devices are added to the appliance, the appliance automatically generates the same types of analysis (capacity, redundancy, and configuration). For iPDUs, the appliance gathers statistical data and reports errors. Connectivity and synchronization with the appliance The appliance monitors the connectivity status of iPDUs. If the appliance loses connectivity with an iPDU, an alert displays until connectivity is restored. The appliance will try to resolve connectivity issues and clear the alert automatically, but if it cannot, you must resolve the issue and manually refresh the iPDU to bring it in synchronization with the appliance. The appliance also monitors iPDU to remain synchronized with changes to hardware and power connections. However, some changes to devices made outside of the control of the appliance (from iLO or the OA, for example) may cause them to become out of synchronization with the appliance. You may have to manually refresh devices that lose synchronization with the appliance. Minimum required privilegesMinimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVPowerDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Hostname of the iPDU, either IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Username</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please transition to the -Credential parameter. Administrator account of the target iPDU.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please transition to the -Credential parameter. Account password of the iPDU specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the iPDU SSL certificate is not trusted, use this Cmdlet to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the import of the iPDU when currently managed by another HPE OneView appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the import of the iPDU when currently managed by another HPE OneView appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Hostname of the iPDU, either IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please transition to the -Credential parameter. Account password of the iPDU specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>If the iPDU SSL certificate is not trusted, use this Cmdlet to add the certificate to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please transition to the -Credential parameter. Administrator account of the target iPDU.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress.</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>Add-HPOVPowerDevice -Hostname ipdu24.example.com -Credential (Get-Credential)</dev:code> <dev:remarks> <dev:para>Add the iPDU to the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVRACKMANAGER--> <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"> <!--ADD-HPOVRACKMANAGER--> <command:details> <command:name>Add-HPOVRackManager</command:name> <maml:description> <maml:para>Add supported Rack Manager (HPE Superdome Flex) resource.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVRackManager</command:noun> </command:details> <maml:description> <maml:para>A rack manager platform is a multi-node system. The nodes are housed within a rack or across racks, and are centrally managed by a management controller. The Rack Managers screen enables you to manage and visualize the physical location of rack manager platforms within a rack. A rack manager platform consists of the following: * One or more chassis - The chassis are individual nodes that are used to build logical components such as systems or partitions. Each chassis is a physical container for system components like the compute, storage, or network nodes. In an HPE Superdome Flex Server, the chassis are 5U nodes that represent the compute nodes with CPU, memory, I/O, power supplies, and fans. * One or more systems or partitions - The system is a logical entity that functions as a server, and runs a single instance of an operating system to host services. In HPE OneView, the partition is modeled as a server hardware resource. In an HPE Superdome Flex Server, the systems are also called partitions. A partition consists of one or more compute chassis that are interconnected through an ultra-fast fabric. Each partition starts with a base chassis and can be extended using expansion chassis to form a large system. * One or more managers - The manager component manages the rack manager platform, and hosts the management controller function. HPE OneView communicates with the rack manager through this management controller enabling system administration, control, and platform management of the rack manager platform. Some platforms have multiple manager components to support redundancy. In an HPE Superdome Flex Server, the manager component is called the Rack Management Controller (RMC). The RMC hosts the DMTF Redfish APIs. * One or more racks - The racks physically contain all the rack manager platform components. When you add a rack manager, HPE OneView automatically applies the HPE OneView Standard license to the rack manager. HPE OneView discovers and monitors the hardware subcomponents of the rack manager. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVRackManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The IP/Address of the supported rack manager</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force add the resource. Use if you need to override the claim of a resource, and force the connected appliance to add. Do know if the resource was claimed or added to a different appliance, it will no longer be able to monitor and/or manage the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Name"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The IP/Address of the supported rack manager</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force add the resource. Use if you need to override the claim of a resource, and force the connected appliance to add. Do know if the resource was claimed or added to a different appliance, it will no longer be able to monitor and/or manage the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>$Credential = Get-Credential -Username Administrator -Message "RackManager Password" Add-HPOVRackManager -ComputerName rackmanger1.domain.com -Credential $Credential</dev:code> <dev:remarks> <dev:para>Add the specified rack manager.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVRACKTODATACENTER--> <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"> <!--ADD-HPOVRACKTODATACENTER--> <command:details> <command:name>Add-HPOVRackToDataCenter</command:name> <maml:description> <maml:para>Add rack resource to DataCenter.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVRackToDataCenter</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, rack managers, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. NOTE: When the appliance discovers Intelligent Series Racks, it sets the rack height automatically using the Intelligent Rack Location Discovery Services for c7000 enclosures. For non-intelligent racks or for empty racks, the default rack height is 42U. After adding a rack to the appliance for management, you can add the rack to a data center to visualize the data center layout and to monitor device power and cooling data. After the rack is under management, you can configure the power delivery topology with redundant and uninterruptible power supplies to the devices in the rack. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVRackToDataCenter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Rack object from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DataCenter</maml:name> <maml:description> <maml:para>The DataCenter object from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>X</maml:name> <maml:description> <maml:para>The X coordinate in the DC. Value can be in US Feet or Millimeters. If specifying Millimeters, you need to include the -Millimeters switch parameter. Feet will be converted to Millimeters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Y</maml:name> <maml:description> <maml:para>The Y coordinate in the DC. Value can be in US Feet or Millimeters. If specifying Millimeters, you need to include the -Millimeters switch parameter. Feet will be converted to Millimeters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If X and/or Y are in Millimeters, you must include this parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Rotate</maml:name> <maml:description> <maml:para>Specify the degree rotation of the rack. Allowed range 0 to 360</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DataCenter</maml:name> <maml:description> <maml:para>The DataCenter object from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Rack object from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If X and/or Y are in Millimeters, you must include this parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Rotate</maml:name> <maml:description> <maml:para>Specify the degree rotation of the rack. Allowed range 0 to 360</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>X</maml:name> <maml:description> <maml:para>The X coordinate in the DC. Value can be in US Feet or Millimeters. If specifying Millimeters, you need to include the -Millimeters switch parameter. Feet will be converted to Millimeters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Y</maml:name> <maml:description> <maml:para>The Y coordinate in the DC. Value can be in US Feet or Millimeters. If specifying Millimeters, you need to include the -Millimeters switch parameter. Feet will be converted to Millimeters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.Rack [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Rack resource object from Get-HPOVRack.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.DataCenter [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated DataCenter object with the newly added Rack resource in the contents property.</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>$DC = Get-HPOVDataCenter -Name Houston_DC1 -ErrorAction Stop $X = 10 $Y = 12 Get-HPOVRack -Name MyRack -ErrorAction Stop | Add-HPOVRackToDataCenter -DataCenter $DC -X $X -Y $Y</dev:code> <dev:remarks> <dev:para>Add "MyRack" to "Houston_DC1" datacenter object, located at 10",12".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVREMOTEFRAME--> <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"> <!--ADD-HPOVREMOTEFRAME--> <command:details> <command:name>Add-HPOVRemoteFrame</command:name> <maml:description> <maml:para>Add remote HPE Synergy Frame to Composer.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVRemoteFrame</command:noun> </command:details> <maml:description> <maml:para>A Synergy frame is automatically added during hardware setup. If the Synergy frame is connected to a group of linked Synergy frames, each Synergy frame in the group is discovered as part of hardware setup. Additional Synergy frames added after initial hardware setup are discovered automatically when a cable is connected from the LINK port on the frame link module of an already discovered frame to the LINK port on the frame link module of another frame with factory settings. Remote frame link topologies, which include remote HPE Synergy Frames, do not include Synergy Composers. Management LAN connectivity enables remote frame link topologies to be managed by the Synergy Composers in the primary frame link topology. You can use the Add remote enclosures option to bring remote frame link topologies under management. The remote frame link topology must be in the same VLAN as the primary frame link topology, due to IPv6 Link Local restrictions. You can use this Cmdlet to add remote enclosures to manage enclosures for which LINK cabling is not directly connected to the primary frame link topology. This allows HPE OneView to manage enclosures that are spread across racks and rows in the datacenter. Minimum required privileges: Infrastructure administrator or Hardware setup.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVRemoteFrame</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The IPv6 Link Local address of the remote frame. This can be viewed from the Frame Link Module (FLM) console using a crash cart.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The IPv6 Link Local address of the remote frame. This can be viewed from the Frame Link Module (FLM) console using a crash cart.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring.</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>Add-HPOVRemoteFrame -Hostname fe80::c8f:fbcb:aa8a:97c8</dev:code> <dev:remarks> <dev:para>Add the specified remote HPE Synergy Frame.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVRESOURCETOLABEL--> <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"> <!--ADD-HPOVRESOURCETOLABEL--> <command:details> <command:name>Add-HPOVResourceToLabel</command:name> <maml:description> <maml:para>Associate resource with new or existing Label.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVResourceToLabel</command:noun> </command:details> <maml:description> <maml:para>Labels identify resources so that you can organize them into groups. After labeling your resources, you can quickly view them by searching on the labels. For example, you might want to identify the servers that are used primarily by the Finance team, or identify the storage systems assigned to the Asia/Pacific division. Resources supporting labels also have filters to allow you to filter by the labels that have been placed on the resource. The global search can be used to search for resources by label. Using this Cmdlet will add supported resources to a new or existing Label. If the Label does not exist, it will be created. Minimum required privileges: Edit privileges for the resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVResourceToLabel</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label to associate resources to. If Label does not exist, a new one will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The collection of resources to associate the label with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="1" parameterSetName="(All)" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The collection of resources to associate the label with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label to associate resources to. If Label does not exist, a new one will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Array</maml:name> </dev:type> <maml:description> <maml:para>Collection of resources to associate with the label.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The created or modified Label resource.</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>$Resources = Get-HPOVNetwork -Name Finance* -ErrorAction Stop $Resources += Get-HPOVServerHardware -Name Finance* Add-HPOVResourceToLabel -Name Finance -InputObject $Resources</dev:code> <dev:remarks> <dev:para>Collect various resources for Finance, creating a new label called "Finance".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVRESOURCETORACK--> <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"> <!--ADD-HPOVRESOURCETORACK--> <command:details> <command:name>Add-HPOVResourceToRack</command:name> <maml:description> <maml:para>Add supported resource to rack.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVResourceToRack</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, rack managers, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. NOTE: When the appliance discovers Intelligent Series Racks, it sets the rack height automatically using the Intelligent Rack Location Discovery Services for c7000 enclosures. For non-intelligent racks or for empty racks, the default rack height is 42U. After adding a rack to the appliance for management, you can add the rack to a data center to visualize the data center layout and to monitor device power and cooling data. After the rack is under management, you can configure the power delivery topology with redundant and uninterruptible power supplies to the devices in the rack. Minimum required privileges: Edit privileges for the resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVResourceToRack</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The supported resource object to add. Supported resource objects are: * Enclosures * Servers * Rack manager * Power device * Unmanaged device</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Rack</maml:name> <maml:description> <maml:para>The Rack object from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ULocation</maml:name> <maml:description> <maml:para>The rack unit location where the resource is located.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The supported resource object to add. Supported resource objects are: * Enclosures * Servers * Rack manager * Power device * Unmanaged device</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Rack</maml:name> <maml:description> <maml:para>The Rack object from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ULocation</maml:name> <maml:description> <maml:para>The rack unit location where the resource is located.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.Rack [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Rack resource object from Get-HPOVRack.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.Rack [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated rack object with the newly added resources in the contents property.</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>$Rack = Get-HPOVRack -Name MyRack221 -ErrorAction Stop $Servers = Get-HPOVServers -Name Prod221* -ErrorAction Stop $_U = 1 ForEach ($Server in $Servers) { Add-HPOVResourceToRack -InputObject $Server -Rack $Rack -ULocation $_U $_U += $Server.formFactor.Replace("U",$null) }</dev:code> <dev:remarks> <dev:para>Add "Prod221" (DL) servers to "MyRack221" rack object, starting at Rack U 1, and increasing the location based on the form factor of the DL servers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Rack = Get-HPOVRack -Name MyRack222 -ErrorAction Stop $Enclosures = Get-HPOVEnclosures -Name Encl-Prod* -ErrorAction Stop | ? rackName -eq $Rack.name $_U = 1 ForEach ($Enclosure in $Enclosures) { Add-HPOVResourceToRack -InputObject $Enclosure -Rack $Rack -ULocation $_U $_U += 10 }</dev:code> <dev:remarks> <dev:para>Add Enclosures which the Onboard Administrators report are in "MyRack222", and add them to "MyRack222" rack object, starting at Rack U 1, and increasing the location by 10U.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVRackToDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVRESOURCETOSCOPE--> <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"> <!--ADD-HPOVRESOURCETOSCOPE--> <command:details> <command:name>Add-HPOVResourceToScope</command:name> <maml:description> <maml:para>Add supported resource(s) to a Scope.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVResourceToScope</command:noun> </command:details> <maml:description> <maml:para>A scope is a grouping of resources that can be used to restrict the range of an operation or action. For example, you can create scopes based on: * Organization or department (Marketing, Research and Development, Finance) * Usage (Production, Development, Testing) * Skills (Linux, Windows) For example, a data center could be organized so that all servers running Linux are monitored using one scope and all servers running MS Windows are monitored using another scope. Email notifications can be configured such that Windows technicians are notified for issues on the servers running Windows and Linux technicians are notified for issues on the servers running Linux. When scopes are defined and resources assigned to them, you can: * Restrict the resources displayed in the user interface (UI) to those assigned to the scope. * Restrict user permissions to grant access only to the resources in a scope. * Configure filtered email notifications for alerts based on previously-defined scopes. This Cmdlet will add supported resources to a specified Scope. All the resources in these categories can be added to or removed from a scope: * Enclosure Groups * Enclosures * Logical Enclosures * Server Hardware * Rack Managers * Server Profiles * Server Profile Templates * OS Deployment Plans * Networks (Ethernet, FC, and FCoE) * Network Sets * Hypervisor Cluster Profiles, Hypervisor Profiles, Hypervisor Managers * Interconnects, excluding SAS resources * Logical Interconnects, excluding SAS resources * Logical Interconnect Groups, excluding SAS resources * Switches * Logical Switches * Logical Switch Groups * Storage Pools * Volume Sets * Volume Templates * Volumes NOTE: Resources in other categories are considered to be included in all scopes, and they cannot be removed. Minimum required privileges: Infrastructure administrator, scope administrator, scope operator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVResourceToScope</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The supported resource object to add to the intended scope provided in the -Scope parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The supported resource object to add to the intended scope provided in the -Scope parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> </dev:type> <maml:description> <maml:para>Scope resource object from Get-HPOVScope.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource that updates the Scope and associated resources.</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>$Resources += Get-HPOVNetwork -Name ProdVLan* $Resources += Get-HPOVServer -Name Encl1* Get-HPOVScope -Name MyScope | Add-HPOVResourceToScope -InputObject $Resources</dev:code> <dev:remarks> <dev:para>Add the resources collected to the MyScope scope.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSANMANAGER--> <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"> <!--ADD-HPOVSANMANAGER--> <command:details> <command:name>Add-HPOVSanManager</command:name> <maml:description> <maml:para>Add a supported SAN Manager</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVSanManager</command:noun> </command:details> <maml:description> <maml:para>SAN managers are a resource in HPE OneView that represent a connection to an external entity through which SANs are discovered and managed. The external entity can be vendor-specific management software or a physical switch. SANs are created outside of HPE OneView in the SAN manager vendor?s management interface. Once created, SANs can be discovered and managed in HPE OneView using the SAN Manager resource. When managing SAN managers, HPE OneView does not permit a SAN to be managed through more than one SAN manager. When associating an HPE OneView network to the SAN, the choice of which SAN to associate determines which SAN manager will be used to manage the SAN. Any subsequent change to a new SAN manager application requires to go through a phased migration process. HPE OneView supports SAN managers from different vendors. Supported SAN Managers are: * Brocade SAN Network Advisor * Brocade FOS capable switches. Not all Brocade FC switches support FOS REST API. Please refer to Brocade/Brocade FC switch documentation for more information. * HPE Networking 5900CP (FC or FCoE) * HPE Networking 5900AF (FC-only) * Cisco Nexus (FC or FCoE) * Cisco MDS (FC-only) Minimum required privileges: Infrastructure administrator or Storage administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Type</maml:name> <maml:description> <maml:para>SAN Manager type to add. Accepted values are: * Brocade * BNA * Brocade Network Advisor * BrocadeFOS * FOS * HP * HPE * Cisco</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>FQDN or IP Address of the SAN Manager</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Port</maml:name> <maml:description> <maml:para>TCP Port of the SAN Manager. The default port for Brocade Network Advisor is "5989". The default port for HPN 5900CP is "161".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager. Can be either String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade"> <maml:name>UseSsl</maml:name> <maml:description> <maml:para>Use to enable SSL communication with the SAN Manager (specifically for the Brocade Network Advisor or BrocadeFOS SAN Manager type</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Type</maml:name> <maml:description> <maml:para>SAN Manager type to add. Accepted values are: * Brocade * BNA * Brocade Network Advisor * BrocadeFOS * FOS * HP * HPE * Cisco</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>FQDN or IP Address of the SAN Manager</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>The SNMPv3 Community User Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Port</maml:name> <maml:description> <maml:para>TCP Port of the SAN Manager. The default port for Brocade Network Advisor is "5989". The default port for HPN 5900CP is "161".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>The SNMPv3 Authentication Level. Allowed values are: * None - No Security is required, only the SNMPv3 UserName is provided. * AuthOnly - SNMPv3 Authentication Encryption Security Level only. Must also provide -SnmpAuthProtocol and -SnmpAuthPassword parameters. * AuthAndPriv - SNMPv3 Authentication Encryption Security and Privacy Levels. Must also provide -SnmpAuthProtocol, -SnmpAuthPassword, -SnmpPrivProtocol and -SnmpPrivPassword parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Password Encryption Protocol. Allowed values are: * SHA * MD5</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 UserName Password. Can be either System.String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Protocol. Allowed values are: * AES * DES</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Encryption Password. Can be either String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>FQDN or IP Address of the SAN Manager</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager. Can be either String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>TCP Port of the SAN Manager. The default port for Brocade Network Advisor is "5989". The default port for HPN 5900CP is "161".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>The SNMPv3 Authentication Level. Allowed values are: * None - No Security is required, only the SNMPv3 UserName is provided. * AuthOnly - SNMPv3 Authentication Encryption Security Level only. Must also provide -SnmpAuthProtocol and -SnmpAuthPassword parameters. * AuthAndPriv - SNMPv3 Authentication Encryption Security and Privacy Levels. Must also provide -SnmpAuthProtocol, -SnmpAuthPassword, -SnmpPrivProtocol and -SnmpPrivPassword parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 UserName Password. Can be either System.String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Password Encryption Protocol. Allowed values are: * SHA * MD5</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Encryption Password. Can be either String or System.Security.SecureString type.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Protocol. Allowed values are: * AES * DES</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>The SNMPv3 Community User Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade, HPCisco" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>SAN Manager type to add. Accepted values are: * Brocade * BNA * Brocade Network Advisor * BrocadeFOS * FOS * HP * HPE * Cisco</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade" aliases="None"> <maml:name>UseSsl</maml:name> <maml:description> <maml:para>Use to enable SSL communication with the SAN Manager (specifically for the Brocade Network Advisor or BrocadeFOS SAN Manager type</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Brocade" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username used to authenticate and manage the SAN Manager. This is only applicable for BNA SAN Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>$task = Add-HPOVSanManager -type BNA -hostname BNA.contoso.com -Credential (Get-Credential) -usessl Wait-HPOVTaskComplete -InputObject $task</dev:code> <dev:remarks> <dev:para>Add a new Brocade Network Advisor SAN Manager.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Define the SNMPv3 auth protocol and levels $CiscoSanManagerSnmpUserName = "ssh-user-SHA-AES128" $CiscoSanManagerSnmpAuthLevel = "AuthAndPriv" $CiscoSanManagerSnmpAuthProtocol = "SHA" $CiscoSanManagerSnmpPrivProtocol = "aes-128" $CiscoSanManagerSnmpAuthPassword = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force $CiscoSanManagerSnmpPrivPassword = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force # Define the parameters for the two SAN fabric switches to add $Params = @(@{ Hostname = "172.18.20.1"; Type = "Cisco"; SnmpUsername = $CiscoSanManagerSnmpUserName; SnmpAuthLevel = $CiscoSanManagerSnmpAuthLevel; SnmpAuthProtocol = $CiscoSanManagerSnmpAuthProtocol; SnmpAuthPassword = $CiscoSanManagerSnmpAuthPassword; SnmpPrivProtocol = $CiscoSanManagerSnmpPrivProtocol; SnmpPrivPassword = $CiscoSanManagerSnmpPrivPassword }, @{ Hostname = "172.18.20.2"; Type = "Cisco"; SnmpUsername = $CiscoSanManagerSnmpUserName; SnmpAuthLevel = $CiscoSanManagerSnmpAuthLevel; SnmpAuthProtocol = $CiscoSanManagerSnmpAuthProtocol; SnmpAuthPassword = $CiscoSanManagerSnmpAuthPassword; SnmpPrivProtocol = $CiscoSanManagerSnmpPrivProtocol; SnmpPrivPassword = $CiscoSanManagerSnmpPrivPassword }) # Add the SAN fabric switches as SAN managers $Params | % { Add-HPOVSanManager @_ | Wait-HPOVTaskComplete }</dev:code> <dev:remarks> <dev:para>Add two Cisco FC SAN switches as SAN Managers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSERVER--> <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"> <!--ADD-HPOVSERVER--> <command:details> <command:name>Add-HPOVServer</command:name> <maml:description> <maml:para>Import a physical server.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>A server hardware resource represents an instance of a server being managed or monitored by HPE OneView. For a managed server hardware resource, the configuration can be applied by assigning a server profile to it. Servers are associated with a server hardware type. A server hardware type captures the details of the relevant physical configuration for server hardware and defines which settings are available to server profiles that are to be assigned to that type of server hardware. Servers can be added into HPE OneView as either Managed or Monitored. Managed HPE OneView manages the server enabling you to apply configurations, assign server profiles, monitor operation status, collect statistics, and alert users to specific conditions. Server blades that are in a managed enclosure will automatically be added as managed. Managed servers require an HPE OneView Advanced or an HPE OneView Advanced w/o iLO license. For HPE Superdome Flex Server, server chassis that are in a rack manager will automatically be added as managed if the firmware installed on the rack manager supports managed mode features. Monitored HPE OneView monitors the hardware for inventory and hardware status only. The server is managed outside of HPE OneView. Server blades that are in a monitored enclosure are added as monitored. Monitored servers use a free license called HPE OneView Standard. For HPE Superdome Flex Server, server chassis that are in a rack manager are added as monitored if the firmware installed on the rack manager does not support managed mode features. You cannot remove a server that is part of an enclosure or rack manager from the appliance using either Remove-HPOVServer. You must remove the rack manager instead using Remove-HPOVRackManager. Removing a rack manager from management removes its partitions and associations. To remove a HPE BladeSystem or HPE Synergy server, it must be physically removed from the enclosure it is hosted within. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Hostname of the server's iLO, either IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Username</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Administrator account of the target iLO.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Password</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Account password of the iLO specified. Can be String or SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the server being imported. This is only required when the -Managed parameter switch is provided. If you include the -Monitored switch, LicenseIntent should not be provided. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Managed, Monitored"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Hostname of the server's iLO, either IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Add the specified server for monitor only management. You can view hardware for inventory and status information only. Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and alert users to specific conditions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Username</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Administrator account of the target iLO.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Password</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Account password of the iLO specified. Can be String or SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Hostname of the server's iLO, either IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed" aliases="None"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the server being imported. This is only required when the -Managed parameter switch is provided. If you include the -Monitored switch, LicenseIntent should not be provided. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>OneView</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored" aliases="None"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Add the specified server for monitor only management. You can view hardware for inventory and status information only. Omitting this parameter, you can apply configurations, deploy server profiles, monitor operation status, collect statistics, and alert users to specific conditions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Account password of the iLO specified. Can be String or SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an array of <HPOneView.Appliance.ScopeResource> Scope resource(s) to initially add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Managed, Monitored" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>This parameter is now deprecated. Please transition to using the -Credential parameter. Administrator account of the target iLO.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The Hostname, FQDN or IPAddress of a server's management process (i.e. iLO) to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns an async task resource to monitor.</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>Add-HPOVServer -Hostname serverilo.contoso.com -Credential (Get-Credential) -LicenseIntent OneView</dev:code> <dev:remarks> <dev:para>Add serverilo.contoso.com to the appliance, with the OneView license.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVServer -Hostname serverilo2.contoso.com -Credential (Get-Credential) -Monitored</dev:code> <dev:remarks> <dev:para>Add serverilo2.contoso.com to the appliance as a monitored only device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSMTPALERTEMAILFILTER--> <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"> <!--ADD-HPOVSMTPALERTEMAILFILTER--> <command:details> <command:name>Add-HPOVSmtpAlertEmailFilter</command:name> <maml:description> <maml:para>Add SMTP email alert filter</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVSmtpAlertEmailFilter</command:noun> </command:details> <maml:description> <maml:para>Email alerting feature notifies specified recipients when a certain alert occurs. When this feature is configured and enabled, the appliance performs these steps in addition to posting the alert: * The appliance compares the alert to configured search criteria. * If the alert matches, it creates an email message containing the text of the alert. * The appliance sends the email message to designated recipients in both plain text and HTML MIME types. Sending in both types allows the recipient?s mail application to determine the display. You can enable or disable this email notification feature, or you can enable or disable individual filter notifications, as required. The appliance provides for as many as 100 recipient and filter combinations, and allows as many as 50 recipients in a single email message. This flexibility lets you fine-tune which alert messages are sent and to whom. For example, you can configure the appliance to send Warning alerts to one recipient and Critical alerts to another. This Cmdlet will help create an advanced alert to the specified recipient(s). You can also use the Cmdlet to add default OneView Remote Support alerting to specified recipient(s) using the -RemoteSupportFilter parameter. Appliance Email notification must be configured. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVSmtpAlertEmailFilter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Filter you are creating.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Destination EMail address(es).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Net.Mail.MailAddress[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Filter</maml:name> <maml:description> <maml:para>REST API filter specifying the resource category, URI, name, and severity. Example: CPU status:"warning" or status:"critical"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope(s) the Filter should apply to. Omitting parameter will apply filter to all resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ScopeMatchPreference</maml:name> <maml:description> <maml:para>If providing multiple Scope resources, specify AND or OR to indicate match preference.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVSmtpAlertEmailFilter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter"> <maml:name>RemoteSupportFilter</maml:name> <maml:description> <maml:para>Use to create the HPE OneView Remote Support email filter for service events.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="recipients"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Destination EMail address(es).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Net.Mail.MailAddress[]</command:parameterValue> <dev:type> <maml:name>Net.Mail.MailAddress[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="query"> <maml:name>Filter</maml:name> <maml:description> <maml:para>REST API filter specifying the resource category, URI, name, and severity. Example: CPU status:"warning" or status:"critical"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Filter you are creating.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupportFilter" aliases="None"> <maml:name>RemoteSupportFilter</maml:name> <maml:description> <maml:para>Use to create the HPE OneView Remote Support email filter for service events.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Scope(s) the Filter should apply to. Omitting parameter will apply filter to all resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ScopeMatchPreference</maml:name> <maml:description> <maml:para>If providing multiple Scope resources, specify AND or OR to indicate match preference.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>OR</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>Net.Mail.MailAddress[]</maml:name> </dev:type> <maml:description> <maml:para>Array of email address recipient(s).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource {System.Management.Automation.PSCustomObject}</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns an async task resource to monitor.</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>Add-HPOVSmtpAlertEmailFilter -Name "Monitor CPU Error and Warning conditions" -query "CPU status:warning or status:critical" -emails admin1@domain.com,admin2@domain.com</dev:code> <dev:remarks> <dev:para>Set SMTP Alert to notify when system CPU status is either "warning" or "critical", and email 2 addresses.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVSmtpAlertEmailFilter -Name "My Test Filter 3" -Filter "status:critical" -Emails "user1@domain.com","user2@domain.com" -Scope "My new Scope","My new Scope2" -Async</dev:code> <dev:remarks> <dev:para>Create a new email critical alert for the two scope names, and return the Async Task object without waiting.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Add-HPOVSmtpAlertEmailFilter -RemoteSupportFilter</dev:code> <dev:remarks> <dev:para>Create OneView Remote Support filter on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSMTPConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVSMTPConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPOVEmailAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSTORAGEPOOL--> <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"> <!--ADD-HPOVSTORAGEPOOL--> <command:details> <command:name>Add-HPOVStoragePool</command:name> <maml:description> <maml:para>Add managed Storage Pools.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVStoragePool</command:noun> </command:details> <maml:description> <maml:para>NOTE: This Cmdlet has been replaced by Set-HPOVStoragePool. This Cmdlet only exists for backwards compatibility. A storage pool is an aggregation of physical storage resources (disks) in a storage system. Storage systems contain information about the storage ports through which they can be accessed. You can provision logical storage spaces, known as volumes, from storage pools. You can select one or more storage pools for management when adding a storage system to the appliance. Storage pools are created on a storage system using the management software for that system. NOTE: For HPE Nimble storage, you can define folders within pools in the Nimble administrative user interface. You cannot create or delete storage pools from the appliance. Storage pools are automatically discovered during the storage system add or refresh. After you elect to manage storage pools, you can provision volumes on them. All storage pools that are usable in HPE OneView are visible on the Storage Pools screen. Pools refreshed into HPE OneView are initially designated as discovered, and must be explicitly set to managed by editing the pool in HPE OneView using the Edit action on the storage pool screen. A storage system must first be added to the appliance before a storage pool can be managed. Storage pools are scoped resources. You can associate a scope to a pool to restrict who can use the pool. Minimum required privileges: Infrastructure administrator or Storage administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVStoragePool</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The Storage System object from Get-HPOVStorageSystem</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Pool</maml:name> <maml:description> <maml:para>One or more storage pool name resource(s) to be added during storage system import. Example: $pools = "cpg1","cpg2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="PoolName, spName, cpg"> <maml:name>Pool</maml:name> <maml:description> <maml:para>One or more storage pool name resource(s) to be added during storage system import. Example: $pools = "cpg1","cpg2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Hostname, name"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The Storage System object from Get-HPOVStorageSystem</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage System resource object from Get-HPOVStorageSystem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource.</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>Add-HPOVStoragePool -StorageSystem HP3PAR_1 -Pool HP_CPG1</dev:code> <dev:remarks> <dev:para>Add the "HP_CPG1" Storage Pool that is managed in the HP3PAR_1 Storage System. PoolName parameter data type will be converted from System.String to System.Collections.ArrayList .</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myPools = "cpg1","cpg2" Add-HPOVStoragePool -StorageSystem (Get-HPOVStorageSystem -Name HP3PAR_1) -Pool $myPools</dev:code> <dev:remarks> <dev:para>Add the "HP_CPG1" Storage Pool that is managed in the HP3PAR_1 Storage System.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSTORAGESYSTEM--> <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"> <!--ADD-HPOVSTORAGESYSTEM--> <command:details> <command:name>Add-HPOVStorageSystem</command:name> <maml:description> <maml:para>Import a supported Storage System</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVStorageSystem</command:noun> </command:details> <maml:description> <maml:para>A storage system is a storage device from which logical disks (volumes) can be provisioned and presented to servers through Fibre Channel ports or iSCSI IP addresses. Bringing SAN storage systems under management of the appliance enables you to add and create volumes. You can then attach volumes to server profiles through volume attachments. This enables the server hardware assigned to the server profiles to access the SAN storage system. StorveServe, StoreVirtual, and Nimble are the supported storage system types. This Cmdlet will assist with importing a supported Storage System. In order for the Storage Ports to be mapped to Expected Networks, either a Supported SAN Manager will need to be configured, or Fibre Channel Direct Attach networks will have to exist. When adding supported HP 3PAR storage systems, please make sure "startwsapi" has been executed from the HP 3PAR CLI, which enables the HP 3PAR REST API that is required by HPE OneView. Minimum required privileges: Infrastructure administrator or Storage administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVStorageSystem</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address or FQDN of the storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide the credentials to authenticate to the storage system.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Username</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Administrator account of the target storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Password</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Password of administrator account password. Can either be String or System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specify the HPE 3PAR Virtual Domain name. Default is "NO DOMAIN". The value provided is CAsesEnSItive.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe"> <maml:name>Ports</maml:name> <maml:description> <maml:para>Specify the Host Ports and Expected Network in an Array of PSCustomObject entries. Example: @{"1:1:1"="Fabric A";"2:2:2"="Fabric B"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe"> <maml:name>PortGroups</maml:name> <maml:description> <maml:para>Specify the Host Ports to group together. Example: @{"1:1:1" = "PG1"; "2:2:2" = "PG2"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>ShowSystemDetails</maml:name> <maml:description> <maml:para>By default, the Cmdlet will no longer display the details about the Storage System. Use this parameter to display information about the storage system when adding to the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-HPOVStorageSystem</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address or FQDN of the storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble"> <maml:name>VIPS</maml:name> <maml:description> <maml:para>Specify the StoreVirtual or Nimble VIP(s) and associated Ethernet Network. Example: @{"10.158.11.42" = $EthernetNetwork} or @{"10.158.11.42" = $EthernetNetwork1; "10.158.12.42" = $EthernetNetwork2;}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide the credentials to authenticate to the storage system.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Username</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Administrator account of the target storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Password</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Password of administrator account password. Can either be String or System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>ShowSystemDetails</maml:name> <maml:description> <maml:para>By default, the Cmdlet will no longer display the details about the Storage System. Use this parameter to display information about the storage system when adding to the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide the credentials to authenticate to the storage system.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe" aliases="None"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specify the HPE 3PAR Virtual Domain name. Default is "NO DOMAIN". The value provided is CAsesEnSItive.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>NO DOMAIN</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>StoreServ</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>IP Address or FQDN of the storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Password of administrator account password. Can either be String or System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe" aliases="None"> <maml:name>PortGroups</maml:name> <maml:description> <maml:para>Specify the Host Ports to group together. Example: @{"1:1:1" = "PG1"; "2:2:2" = "PG2"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreServe" aliases="None"> <maml:name>Ports</maml:name> <maml:description> <maml:para>Specify the Host Ports and Expected Network in an Array of PSCustomObject entries. Example: @{"1:1:1"="Fabric A";"2:2:2"="Fabric B"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>ShowSystemDetails</maml:name> <maml:description> <maml:para>By default, the Cmdlet will no longer display the details about the Storage System. Use this parameter to display information about the storage system when adding to the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble, StoreServe" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>NOTE: This parameter is now deprecated. Please update to the -Credential parameter. Administrator account of the target storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtualOrNimble" aliases="None"> <maml:name>VIPS</maml:name> <maml:description> <maml:para>Specify the StoreVirtual or Nimble VIP(s) and associated Ethernet Network. Example: @{"10.158.11.42" = $EthernetNetwork} or @{"10.158.11.42" = $EthernetNetwork1; "10.158.12.42" = $EthernetNetwork2;}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Add Storage System Async Task.</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>$task = Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -Credential (Get-Credential) -Async Wait-HPOVTaskComplete -InputObject $task</dev:code> <dev:remarks> <dev:para>Add the Storage System using default settings, and let the appliance detect the connected Storage System Ports. (A supported SAN Manager must first be added, and Managed SANs mapped to the specific FC Network resources.)</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$StorageSystemPorts = @{"1:1:1" = "Fabric A"; "2:1:1" = "Fabric A"; "1:1:2" = "Fabric B"; "2:1:2" = "Fabric B"} $StoragePortGroups = @{"1:1:1"= "PG1"; "2:1:1" = "PG1"; "1:1:2" = "PG2"; "2:1:2" = "PG2"} Add-HPOVStorageSystem -hostname "3par-array.consoto.com" -username 3paradm -password 3pardata -Domain VirtaulDomain1 -Ports $StorageSystemPorts -PortGroups $StoragePortGroups | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Add the Storage System using default settings, and specify the Storage System Ports that will be assigned to the Expected Networks.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$IscsiNetwork = Get-HPOVNetwork -Name "IscsiNetwork" -ErrorAction Stop $NimbleAddress = "nimble.domain.com" $StorageSystemPSCredential = Get-Credential -Username administrator Add-HPOVStorageSystem -Family Nimble -Hostname $NimbleAddress -Credential $StorageSystemPSCredential -VIPS @{ "192.168.191.22" = $IscsiNetwork }</dev:code> <dev:remarks> <dev:para>Add a Nimble iSCSI storage system with PSCredential object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVStorageSystemPerformancePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ADD-HPOVSTORAGEVOLUME--> <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"> <!--ADD-HPOVSTORAGEVOLUME--> <command:details> <command:name>Add-HPOVStorageVolume</command:name> <maml:description> <maml:para>Import an existing Storage Volume resource.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>A volume represents a logical disk provisioned from a storage pool on a storage system. A volume can be used by a single server (private) or can be used by multiple servers (shared). You can attach volumes to one or more servers by configuring a volume attachment in the server profile. The volume attachment manages volume presentation on the storage system (StoreServ port selection, host and vLUN creation) as well as SAN zoning on SANs (with automatic zoning enabled) that connect the server and storage system. Using volume templates, you can create multiple volumes with the same configuration. You can increase (grow) the capacity of a volume by editing it. You cannot decrease the capacity of a volume. This Cmdlet will help add an existing storage volume that was provisioned on the Storage System. In order to import an existing storage volume, the following prerequisites must be met: * The storage system that contains the volume you want to add is being managed by the appliance, and the volume must be within the same 3Par virtual domain as the managed storage system. * The storage pool that contains the volume you want to add is being managed by the appliance. * The snapshot storage pool defined for the volume you want to add is being managed by the appliance. The Storage Volume's WWN or device name will be needed, which can be retrieved from the storage system management console. Minimum required privileges: Infrastructure administrator or Storage administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Add-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The Storage System where the volume will be imported from. Volume to be imported must be provisioned to the same Managed Domain as the Storage System.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>StorageDeviceName</maml:name> <maml:description> <maml:para>The Storage Systems Device Name of the volume. This can be found in either the 3PAR IMC, CLI or HPE SSMC by looking at the provisioned volume and copying the "Name" property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specify the Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please use the -StorageDeviceName parameter. The 128bit WWN FC address of the volume to be imported. Address must be in the following format: AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>StorageDeviceName</maml:name> <maml:description> <maml:para>The Storage Systems Device Name of the volume. This can be found in either the 3PAR IMC, CLI or HPE SSMC by looking at the provisioned volume and copying the "Name" property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The Storage System where the volume will be imported from. Volume to be imported must be provisioned to the same Managed Domain as the Storage System.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="volid, id, wwn"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Warning: This parameter is deprecated. Please use the -StorageDeviceName parameter. The 128bit WWN FC address of the volume to be imported. Address must be in the following format: AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA:BB:CC:DD:EE:AA</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Name"> <maml:name>VolumeName</maml:name> <maml:description> <maml:para>Specify the Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Pool resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async create task</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>Add-HPOVStorageVolume -StorageSystem (Get-HPOVStorageSystem -Name 3ParSys1) -StorageDeviceName MyStorageVol1 -VolumeName MyStorageVol1</dev:code> <dev:remarks> <dev:para>Import the volume "MyStorageVol1" from the "3ParSys1" Storage System.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageSystem -Name 3ParSys1 | Add-HPOVStorageVolume -StorageDeviceName MyStorageVol1 -VolumeName MyStorageVol1</dev:code> <dev:remarks> <dev:para>Import the volume "MyStorageVol1" from the "3ParSys1" Storage System using the pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageSystem -Name 3ParSys1 | Add-HPOVStorageVolume -StorageDeviceName ClusterSharedVol1 -VolumeName ClusterSharedVol1 -Shared</dev:code> <dev:remarks> <dev:para>Import a volume using the storage device name "ClusterSharedVol1" on the "3ParSys1" Storage System.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CLEAR-HPOVALERT--> <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"> <!--CLEAR-HPOVALERT--> <command:details> <command:name>Clear-HPOVAlert</command:name> <maml:description> <maml:para>[DEPRECATED] Clear an Alert status.</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>HPOVAlert</command:noun> </command:details> <maml:description> <maml:para>DEPRECATED as of 2.0. Please use Set-HPOVAlert</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Clear-HPOVAlert</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> </command:returnValues> <command:examples> <!--Examples--> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONNECT-HPOVMGMT--> <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"> <!--CONNECT-HPOVMGMT--> <command:details> <command:name>Connect-HPOVMgmt</command:name> <maml:description> <maml:para>Initiate a connection to an HPE OneView appliance.</maml:para> </maml:description> <command:verb>Connect</command:verb> <command:noun>HPOVMgmt</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet establishes a connection to the specified HPE OneView or HPE Synergy Composer appliance. When the connection is successful, the user establishes a session for use with subsequent Cmdlet requests. The effective user permissions are established on the first connection. Please refer to about_appliance_connection_permissions and about_appliance_connections for more information about initiating multiple appliance connections. Appliance hostname or IP can include an alternate TCP port number. While the appliance does not allow the default TCP port 443 to be changed, the appliance could reside behind a firewall, which is redirecting an alternate TCP port number. If the appliance is configured to Common Access Card (CAC) authentication, the -Certificate parameter is required. If the CAC requires a PIN to unlock, the user will be prompted by the credential service to provide that value. The Cmdlet does not offer the ability to retrieve or store the CAC PIN. Minimum required privileges: Read-only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Connect-HPOVMgmt</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The hostname or IP address of the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UsernamePassword"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. User name to authenticate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, UsernamePassword"> <maml:name>AuthLoginDomain</maml:name> <maml:description> <maml:para>The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts. Default is determined by connecting to the requested appliance and retrieving the default login directory. If not LOCAL, and you attempt to use an embedded user account, you must use -AuthLoginDomain parameter with the Local value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UsernamePassword"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Password to log into the appliance. Can be either System.String or SecureString value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>LoginAcknowledge</maml:name> <maml:description> <maml:para>When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt does not support the -Confirm parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-HPOVMgmt</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The hostname or IP address of the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Provide the X.509 certificate/SmartCard digital badge in order to authenticate to a supported appliance. Two-factor authentication must be configured on the appliance in order to provide a X.509 certificate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>LoginAcknowledge</maml:name> <maml:description> <maml:para>When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt does not support the -Confirm parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-HPOVMgmt</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The hostname or IP address of the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide a secure crednetial object. The Username format can support either just a string username value (i.e. JSmith), or include either NTDomainName (i.e. MyDomain\JSmith) or Universal Principle Name (i.e. jsmith@domain.com). If providing either NYDomainname or Universal Principal Name, ensure the Authentication Directory name is spelled exactly the same, and the -AuthLoginDomain is not required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, UsernamePassword"> <maml:name>AuthLoginDomain</maml:name> <maml:description> <maml:para>The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts. Default is determined by connecting to the requested appliance and retrieving the default login directory. If not LOCAL, and you attempt to use an embedded user account, you must use -AuthLoginDomain parameter with the Local value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword"> <maml:name>LoginAcknowledge</maml:name> <maml:description> <maml:para>When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt does not support the -Confirm parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, UsernamePassword" aliases="authProvider"> <maml:name>AuthLoginDomain</maml:name> <maml:description> <maml:para>The Directory Name for LDAP/Active Directory authentication, or LOCAL for appliance internal user accounts. Default is determined by connecting to the requested appliance and retrieving the default login directory. If not LOCAL, and you attempt to use an embedded user account, you must use -AuthLoginDomain parameter with the Local value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>LOCAL</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate" aliases="None"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Provide the X.509 certificate/SmartCard digital badge in order to authenticate to a supported appliance. Two-factor authentication must be configured on the appliance in order to provide a X.509 certificate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential" aliases="PSCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter to provide a secure crednetial object. The Username format can support either just a string username value (i.e. JSmith), or include either NTDomainName (i.e. MyDomain\JSmith) or Universal Principle Name (i.e. jsmith@domain.com). If providing either NYDomainname or Universal Principal Name, ensure the Authentication Directory name is spelled exactly the same, and the -AuthLoginDomain is not required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword" aliases="Appliance, Computername"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The hostname or IP address of the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Certificate, PSCredential, UsernamePassword" aliases="None"> <maml:name>LoginAcknowledge</maml:name> <maml:description> <maml:para>When a Login Message has been configured and acknowledgement is Required, use this parameter to acknowledge it during the initial call. Otherwise, if omitted, and a Login Banner acknowledgement is required, the caller will be prompted. This prompt does not support the -Confirm parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UsernamePassword" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Password to log into the appliance. Can be either System.String or SecureString value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UsernamePassword" aliases="u, user"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. User name to authenticate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When a valid connection is established with an appliance, this object is then added to ${Global:ConnectedSessions} connection tracker variable. The object returned will contain the following public properties: ============================================================================== | Name | Type | Value | |----------------------------------------------------------------------------- | AuthLoginDomain | String | Local | ------------------------------------------------------------------------------ | ConnectionId | Int | 1 | ------------------------------------------------------------------------------ | Name | String | Hostname value | ---------------------- ------------------------------------------------------- | SessionID | String | AUTH string returned from API | ------------------------------------------------------------------------------ | ApplianceType | String | Indicate connected appliance type. | -------------------- --------------------------------------------------------- | UserName | String | Username value | ------------------------------------------------------------------------------ | AuthType | String | Credential or Certificate/2FA | ------------------------------------------------------------------------------ | ActivePermissions | IList | Collection of Scopes and permissions | ------------------------------------------------------------------------------ | ApplianceSecurityRoles | IList | Collection of roles | ------------------------------------------------------------------------------ | Default | Boolean | Is connection default for library | ------------------------------------------------------------------------------</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.ErrorRecord</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>On error, appliance response is returned as a terminating error.</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>Connect-HPOVMgmt -appliance myappliance.domain.com ConnectionID Name UserName AuthLoginDomain ------------ ---- -------- --------------- 1 myappliance.domain.com Administrator LOCAL</dev:code> <dev:remarks> <dev:para>Connect to a specific appliance FQDN. The user will be prompted for authentication provider, user name and password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Connect-HPOVMgmt -appliance myappliance.domain.com:11223</dev:code> <dev:remarks> <dev:para>Connect to a specific appliance, where the target TCP port isn't the default. The user will be prompted for authentication provider, user name and password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MySmartCard = gci Cert:\CurrentUser\my | ? { $_.EnhancedKeyUsageList.FriendlyName -match "Smart Card Logon" } Connect-HPOVMgmt -appliance myappliance.domain.com -Certificate $MySmartCard</dev:code> <dev:remarks> <dev:para>Connect to a specific appliance using a digital badge.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disconnect-HPOVMgmt</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_Appliance_Connection_Permissions</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[${Global:ConnectedSessions}]</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERT-HPOVSERVERPROFILE--> <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"> <!--CONVERT-HPOVSERVERPROFILE--> <command:details> <command:name>Convert-HPOVServerProfile</command:name> <maml:description> <maml:para>Migrate Server Profile.</maml:para> </maml:description> <command:verb>Convert</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile. Changing to a different server hardware type may change the capabilities available to the server profile. Changing the enclosure group may change the connections which are available for the profile. * The server hardware field will be set to "unassigned", requiring re-seletion of server hardware. * It may also cause incompatibilities with the current configuration. * All deployed connections will have their port assignment set to "Auto". * Any incompatibilities will be flagged when the server profile is committed. * If the new server hardware type does not support the local storage configuration, some storage may be lost. * If the enclosure group is changed, mezzanine storage is lost and the disk drives are released. * To prevent data loss, cancel this operation and backup data before applying the profile. * Any change in the server hardware type will lead to the associated volume loss. * If the server profile is associated with a server profile template, the server profile will become inconsistent with the template. The server profile should be unassociated with the template before or after the migration. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Convert-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ServerProfile object from Get-HPOVServerProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Specify the HPOneView.ServerHardwareType object to transform to. BIOS Settings will be reset to defaults, and Connection FlexNIC assignment will be reset back to Auto.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Specify the target HPOneView.EnclosureGroup resource object. By changing the Enclosure Group, assigned Networks with Connections that do not exist on in the associated Logical Interconnect Group(s), the Connection may not be assigned to an available FlexNIC.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Specify the target HPOneView.EnclosureGroup resource object. By changing the Enclosure Group, assigned Networks with Connections that do not exist on in the associated Logical Interconnect Group(s), the Connection may not be assigned to an available FlexNIC.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="ServerProfile, Profile"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ServerProfile object from Get-HPOVServerProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Specify the HPOneView.ServerHardwareType object to transform to. BIOS Settings will be reset to defaults, and Connection FlexNIC assignment will be reset back to Auto.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile</maml:name> </dev:type> <maml:description> <maml:para>The Server Profile resource object to transform.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress of the Server Profile transformation.</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>$ServerProfile = Get-HPOVServerProfile -Name "Prod Server 1" -ErrorAction Stop $NewServerHardwareType = Get-HPOVServerHardwareType -Name "BL460 Gen9 3" -ErrorAction Stop Convert-HPOVServerProfile -InputObject $ServerProfile -ServerHardwareType $NewServerHardwareType</dev:code> <dev:remarks> <dev:para>Transform the specified server profile object to a different server hardware type resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerProfile = Get-HPOVServerProfile -Name "Prod Server 1" -ErrorAction Stop $NewEnclosureGroup = Get-HPOVEnclosureGroup -Name "Dev EG 1" -ErrorAction Stop Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup</dev:code> <dev:remarks> <dev:para>Transform the specified server profile object to a different enclosure group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerProfile = Get-HPOVServerProfile -Name "Prod Server 1" -ErrorAction Stop $NewEnclosureGroup = Get-HPOVEnclosureGroup -Name "Dev EG 1" -ErrorAction Stop $NewServerHardwareType = Get-HPOVServerHardwareType -Name "BL460 Gen9 3" -ErrorAction Stop Convert-HPOVServerProfile -InputObject $ServerProfile -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $NewServerHardwareType</dev:code> <dev:remarks> <dev:para>Transform the specified server profile object to a different enclosure group and server hardware type resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERT-HPOVSERVERPROFILETEMPLATE--> <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"> <!--CONVERT-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>Convert-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Migrate Server Profile Template.</maml:para> </maml:description> <command:verb>Convert</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to change the Server Hardware Type and/or Enclosure Group set within the Server Profile Template. Changing to a different server hardware type may change the capabilities available to the server profile. Changing the enclosure group may change the connections which are available for the profile template. * It may also cause incompatibilities with the current configuration. * All defined connections will have their port assignment set to "Auto". * Any incompatibilities will be flagged when the server profile template is committed. * If the new server hardware type does not support the local storage configuration, some storage may not be configurable. * If the enclosure group is changed, mezzanine storage for HPE Synergy is lost and the disk drives are released. * Any change in the server hardware type will lead to the associated volume loss. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Convert-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ServerProfileTemplate object from Get-HPOVServerProfileTemplate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Specify the HPOneView.ServerHardwareType object to transform to. BIOS Settings will be reset to defaults, and Connection FlexNIC assignment will be reset back to Auto.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Specify the target HPOneView.EnclosureGroup resource object. By changing the Enclosure Group, assigned Networks with Connections that do not exist on in the associated Logical Interconnect Group(s), the Connection may not be assigned to an available FlexNIC.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Specify the target HPOneView.EnclosureGroup resource object. By changing the Enclosure Group, assigned Networks with Connections that do not exist on in the associated Logical Interconnect Group(s), the Connection may not be assigned to an available FlexNIC.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="ServerProfileTemplate, SPT"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ServerProfileTemplate object from Get-HPOVServerProfileTemplate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Specify the HPOneView.ServerHardwareType object to transform to. BIOS Settings will be reset to defaults, and Connection FlexNIC assignment will be reset back to Auto.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfileTemplate</maml:name> </dev:type> <maml:description> <maml:para>The Server Profile Template resource object to transform.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress of the Server Profile transformation.</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>$SPT = Get-HPOVServerProfileTemplate -Name "My Template Name" -ErrorAction Stop $NewServerHardwareType = Get-HPOVServerHardwareType -Name "SY480 Gen10 2" -ErrorAction Stop Convert-HPOVServerProfileTemplate -InputObject $SPT -ServerHardwareType $NewServerHardwareType</dev:code> <dev:remarks> <dev:para>Transform the specified server profile template object to a different server hardware type resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SPT = Get-HPOVServerProfileTemplate -Name "My Template Name" -ErrorAction Stop $NewEnclosureGroup = Get-HPOVEnclosureGroup -Name "Dev EG 1" -ErrorAction Stop Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup</dev:code> <dev:remarks> <dev:para>Transform the specified server profile template object to a different enclosure group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SPT = Get-HPOVServerProfileTemplate -Name "My Template Name" -ErrorAction Stop $NewEnclosureGroup = Get-HPOVEnclosureGroup -Name "Dev EG 1" -ErrorAction Stop $NewServerHardwareType = Get-HPOVServerHardwareType -Name "BL460 Gen9 3" -ErrorAction Stop Convert-HPOVServerProfileTemplate -InputObject $SPT -EnclosureGroup $NewEnclosureGroup -ServerHardwareType $NewServerHardwareType</dev:code> <dev:remarks> <dev:para>Transform the specified server profile template object to a different enclosure group and server hardware type resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERTTO-HPOVIMAGESTREAMERCONFIGURATION--> <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"> <!--CONVERTTO-HPOVIMAGESTREAMERCONFIGURATION--> <command:details> <command:name>ConvertTo-HPOVImageStreamerConfiguration</command:name> <maml:description> <maml:para>Convert Logical Enclosure to support HPE Image Streamer.</maml:para> </maml:description> <command:verb>ConvertTo</command:verb> <command:noun>HPOVImageStreamerConfiguration</command:noun> </command:details> <maml:description> <maml:para>Convert Logical Enclosure and associated Enclosure Group and Logical Interconnect Group to support Internal Image Streamer configuration. HPE Synergy Virtual Connect Logical Interconnect Group must reside in Bays 3 and 6 in order to be reconfigured. When using this Cmdlet, a service outage will occur, as the Logical Enclosure will need to be recreated. This means Server Profiles will be unassigned, Logical Enclosure removed then recreated, and then Server Profiles reassigned to their original location. If the Logical Enclosure contains HPE Synergy SAS Logical Interconnects, data loss may occur, as the Server Profiles may not be assigned in the right order, which would cause disk selection to assign different physical disks. Please make sure all data is backed up prior to migration. By Default, the Cmdlet will not migrate a Logical Enclosure if SAS Logical Interconnects are found. To override, use the -IgnoreSasLogicalInterconnects switch, which again may cause loss of data. Any associated Enclosure Groups with the Virtual Connect Ethernet Logical Interconnect Group will also be modified. If this is not intended, you should first remove the Logical Interconnect Group from the Enclosure Group before executing this Cmdlet. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>ConvertTo-HPOVImageStreamerConfiguration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure resource object or name that will be recreated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>UplinkSetName</maml:name> <maml:description> <maml:para>The Uplink Set Name to be added.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Name</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>DeploymentNetwork</maml:name> <maml:description> <maml:para>Provide the Deployment Network object. Must be associated with a valid IPv4 Subnet that is within the same subnet as the Composer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Specify 4 redundant Uplink Ports.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>DeploymentNetwork</maml:name> <maml:description> <maml:para>Provide the Deployment Network object. Must be associated with a valid IPv4 Subnet that is within the same subnet as the Composer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="EnclosureGroup, EG"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure resource object or name that will be recreated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Specify 4 redundant Uplink Ports.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@("Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.1","Enclosure2:Bay6:Q2.1")</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>UplinkSetName</maml:name> <maml:description> <maml:para>The Uplink Set Name to be added.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Name</command:parameterValue> <dev:type> <maml:name>Name</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.LogicalEnclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>HPE Synergy Logical Enclosure to convert.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If the Logical Enclosure cannot be removed or re-created, as PSCustomObject with original Server Profile location is provided. Object properties are Name, ProfileUri, ServerSerialNumber.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task for each Server Profile that will be re-assigned for the caller to monitor.</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>$LE = Get-HPOVLogicalEnclosure -Name MyLE1 -ErrorAction Stop $UplinkPorts = @("Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1") $UplinkSetName = "ImageStreamer UplinkSet" $DeploymentNetwork = Get-HPOVNetwork -Name "ImageStreamer Deployment" -ErrorAction Stop ConvertTo-HPOVImageStreamerConfiguration -InputObject $le -UplinkSetName $UplinkSetName -UplinkPorts $UplinkPorts -DeploymentNetwork $DeploymentNetwork -IgnoreSasLogicalInterconnects</dev:code> <dev:remarks> <dev:para>Convert the MyLE1 Logical Enclosure to support Image Streamer, specifying uplink ports, OS Deployment Network and to ignore found SAS Logical Interconnects if found.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERTTO-HPOVPOWERSHELLSCRIPT--> <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"> <!--CONVERTTO-HPOVPOWERSHELLSCRIPT--> <command:details> <command:name>ConvertTo-HPOVPowerShellScript</command:name> <maml:description> <maml:para>Create PowerShell script from resource.</maml:para> </maml:description> <command:verb>ConvertTo</command:verb> <command:noun>HPOVPowerShellScript</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist administrators or scripters to help generate script code from specific resources. The code generated is a starting point to be used for repeating similar tasks performed by the UI, or to incorporate into scripts or workflows. The following resources are supported by this Cmdlet: * Baselines (Get-HPOVBaseline) * Appliance address pool ranges (Get-HPOVAddressPoolRange) * Appliance address pool Subnets (Get-HPOVAddressPoolSubnet) * Appliance Date Time and Locale (Get-HPOVApplianceDateTime) * Appliance LDAP Directory (Get-HPOVLdapDirectory) * Appliance LDAP Directory Group (Get-HPOVLdapGroup) * Appliance SNMP configuration (Get-HPOVSnmpReadCommunity) * Appliance SNMPv3 Users (Get-HPOVSnmpV3User) * Appliance Email Notifications (Get-HPOVApplianceProxy) * Appliance Proxy (Get-HPOVApplianceProxy) * Appliance User (Get-HPOVUser) * Scopes (Get-HPOVScope) * Network (Get-HPOVNetwork) * Network Set (Get-HPOVNetworkSet) * SAN Manager (Get-HPOVSanNanager) * Storage System (Get-HPOVStorageSystem) * Storage Pool (Get-HPOVStoragePool) * Storage Volume Template (Get-HPOVStorageVolumeTemplate) * Storage Volume (Get-HPOVStorageVolume) * Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) * Logical Enclosure Group (Get-HPOVLogicalEnclosureGroup) * Logical Enclosure (Get-HPOVLogicalEnclosure) * Server Profile Template (Get-HPOVServerProfileTemplate) * Server Profile (Get-HPOVServerProfile)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>ConvertTo-HPOVPowerShellScript</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object from supported Cmdlets.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Export</maml:name> <maml:description> <maml:para>Location where to write UTF-8 file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Append</maml:name> <maml:description> <maml:para>Indicte if the export file should be appended. By default, a new file will be created with new content.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="NoClobber"> <maml:name>Append</maml:name> <maml:description> <maml:para>Indicte if the export file should be appended. By default, a new file will be created with new content.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Export</maml:name> <maml:description> <maml:para>Location where to write UTF-8 file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object from supported Cmdlets.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para>Various objects are supported.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>String output of generated code.</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>Get-HPOVServerProfile | ConvertTo-HPOVPowerShellScript</dev:code> <dev:remarks> <dev:para>Generate PowerShell script code for the returned server profile objects.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERTTO-HPOVSERVERPROFILETEMPLATE--> <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"> <!--CONVERTTO-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>ConvertTo-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Create a Server Profile Template from Server Profile.</maml:para> </maml:description> <command:verb>ConvertTo</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will allow the user to "clone" or create a Server Profile Template from an existing Server Profile object. Not all Server Profile features will be converted to a Server Profile Template. For instance, the following features are not supported with a Server Profile Template: * Import existing local Smart Array Logical Disk configuration * Attach SAN Storage Volumes must be assigned a unique LUN ID If the source Server Profile has the "Import existing logical drives" enabled, this setting will be disabled, and the Local Disk Configuration policy will be set to "disabled". If any SAN Storage Volume attachments contain an "Auto" LUN value, it will be set to "Manual", with the LUN ID set to a unique value based on the Array Index value. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>ConvertTo-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A source Server Profile Object or Resource Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Server Profile Template Name to assign. If omitted, then a new name of "Copy of - {Original_Name}" will be defined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Server Profile description.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Server Profile description.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="source, ServerProfile"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A source Server Profile Object or Resource Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Server Profile Template Name to assign. If omitted, then a new name of "Copy of - {Original_Name}" will be defined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Server Profile resource object from Get-HPOVServerProfile.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Multiple HPOneView.ServerProfile [System.Management.Automation.PSCustomObject] objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] objects.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task of the Server Profile Template creation request.</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>Get-HPOVServerProfile -Name MyProfile | ConvertTo-HPOVServerProfileTemplate -Name "Hypervisor Gold Template 1"</dev:code> <dev:remarks> <dev:para>Use Get-HPOVServerProfile to retrieve the "MyProfile" object, creating a new Server Profile Template "Hyervisor Gold Template 1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--CONVERTTO-HPOVSTORAGEVOLUME--> <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"> <!--CONVERTTO-HPOVSTORAGEVOLUME--> <command:details> <command:name>ConvertTo-HPOVStorageVolume</command:name> <maml:description> <maml:para>Convert an existing Storage Volume Snapshot to a Storage Volume.</maml:para> </maml:description> <command:verb>ConvertTo</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>A snapshot is a virtual copy of an existing volume at a point in time. You can use a snapshot as a backup of a volume, and then use the snapshot to revert a volume to the backup, or to create new volumes from the snapshot. A snapshot is a static copy of a volume at the point the snapshot is created. Snapshots are not updated to reflect changes in the volume since the snapshot was taken. A new volume created from a snapshot will be the same size as the snapshot and will contain all of the data in the snapshot. The two volumes are logically unrelated, but physically, unchanged data is only stored once between the two volumes. Reverting a volume to a snapshot will revert to the data the volume contained when the snapshot was taken. The size of the volume will remain the same as when it was reverted. For example, if you take a snapshot of a 50 GiB volume, grow the volume to 100 GiB, and then revert to the snapshot, the volume will be 100 GiB with the data from the 50 GiB snapshot. Reverting to a snapshot of a volume will cause all data created or changed since the snapshot was taken to be lost. Backup your data to prevent data loss. NOTE: You cannot create a volume from an HPE Nimble storage system snapshot from HPE OneView. Minimum required privileges: Infrastructure administrator, Server administrator, or Storage administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>ConvertTo-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the snapshot resource object to convert managed by the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the storage volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>SharingMode</maml:name> <maml:description> <maml:para>Specify if the new storage volume should be Private or Shared.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="4" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the storage volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Snapshot"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the snapshot resource object to convert managed by the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>SharingMode</maml:name> <maml:description> <maml:para>Specify if the new storage volume should be Private or Shared.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.VolumeSnapshot [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume Snapshot resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple resources</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Create Storage Volume async task.</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>$Volume = Get-HPOVStorageVolume -Name PrivVolume1 | Get-HPOVStorageVolumeSnapshot | Select-Object -Last 1 ConvertTo-HPOVStorageVolume -Name "Copy of PrivVolume1"</dev:code> <dev:remarks> <dev:para>Get the most recent snapshot of PrivVolume1 and convert it to a volume.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Snapshots = Get-HPOVStorageVolume "Volume 1" | Get-HPOVStorageVolumeSnapshot $Snapshots | ? { ((Get-Date $_.created -Format d) -eq (Get-Date 02/23/2016 -format d)} | ConvertTo-HPOVStorageVolume -Name "Copy of Volume 1" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Get all of the available storage volume snapshots for "Volume 1", then convert the snapshot created on the specified date to a storage volume resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--COPY-HPOVSERVERPROFILE--> <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"> <!--COPY-HPOVSERVERPROFILE--> <command:details> <command:name>Copy-HPOVServerProfile</command:name> <maml:description> <maml:para>Copy or clone a server profile.</maml:para> </maml:description> <command:verb>Copy</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>You can copy a server profile to server hardware of the same server hardware type and in the same enclosure group (for servers). If you are deploying multiple servers of the same type into the same enclosure, you can create a server profile template to streamline server provisioning. This Cmdlet will copy a source Server Profile to a new instance You can assign the copy to an existing Server Device, or specify "unassigned". Minimum required privileges: Infrastructure administrator or Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Copy-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The object of the source server profile to be copied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>DestinationName</maml:name> <maml:description> <maml:para>The name of the destination server profile that will be created. If omitted, the new name will have "Copy of " prefixed to the source name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Assign</maml:name> <maml:description> <maml:para>The object of the target server to assign the new profile to. If omitted, profile will be "unassigned"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Assign</maml:name> <maml:description> <maml:para>The object of the target server to assign the new profile to. If omitted, profile will be "unassigned"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>unassigned</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="dname, dst"> <maml:name>DestinationName</maml:name> <maml:description> <maml:para>The name of the destination server profile that will be created. If omitted, the new name will have "Copy of " prefixed to the source name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="sname, src, SourceName"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The object of the source server profile to be copied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Profile Create async task</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>Get-HPOVServerProfile -Name "Profile 1" | Copy-HPOVServerProfile</dev:code> <dev:remarks> <dev:para>Copy "Profile 1" to a new Server Profile that is unassigned and named "Copy of Profile 1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Copy-HPOVServerProfile -InputObject (Get-HPOVServerProfile -Name "Profile 1") -DestinationName "Profile 2"</dev:code> <dev:remarks> <dev:para>Copy "Profile 1" to a new Server Profile that is unassigned and named "Profile 2".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerProfile = Get-HPOVServerProfile -Name "Profile 1" $Server = Get-HPOVServer -Name "Encl1, Bay 9" Copy-HPOVServerProfile -InputObject $ServerProfile -DestinationName "Profile 2" -assign $Server</dev:code> <dev:remarks> <dev:para>Copy "Profile 1" to a new Server Profile that is assigned to "Encl1, Bay 9" named "Profile 2".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerProfile = Get-HPOVServerProfile -Name "Profile Template" 11.16 | % { Copy-HPOVServerProfile -InputObject $ServerProfile -DestinationName "Profile $_" -Assign "Encl1, bay $_" }</dev:code> <dev:remarks> <dev:para>Copy 5 Server Profiles from "Profile Template" that will be assigned to bays 11 - 16 of Encl1.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVAPPLIANCECOMPLEXPASSWORDS--> <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"> <!--DISABLE-HPOVAPPLIANCECOMPLEXPASSWORDS--> <command:details> <command:name>Disable-HPOVApplianceComplexPasswords</command:name> <maml:description> <maml:para>Disable appliance complex password policy.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVApplianceComplexPasswords</command:noun> </command:details> <maml:description> <maml:para>Disables whether users are required to have complex passwords. This option does not force existing users to change their passwords, nor has any impact on directory accounts. By default, the appliance does not enforce complex passwords during creating or modifying internal user account passwords. Use this Cmdlet to disable the policy. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVApplianceComplexPasswords</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Disable-HPOVApplianceComplexPasswords</dev:code> <dev:remarks> <dev:para>Disable complex password policy on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <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"> <!--DISABLE-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <command:details> <command:name>Disable-HPOVApplianceDataAtRestEncryption</command:name> <maml:description> <maml:para>Turn off HPE Synergy Composer data at rest encryption.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVApplianceDataAtRestEncryption</command:noun> </command:details> <maml:description> <maml:para>HPE OneView encrypts sensitive data, such as managed device credentials, when it is stored on-disk in the appliance. The HPE OneView appliance encryption key (AEK) is used internally to encrypt the credentials for managed devices (such as, iLO, onboard administrator, frame link module). By default, the AEK is stored on the HPE Synergy Composer disk and also included in the appliance backup. This could pose a security risk in case the disk is stolen. The secure data-at-rest option, when enabled, stores the AEK off-disk in Composer NVRAM, and does not include the key in the appliance backup. Enabling this option requires the administrator to save a copy of the AEK (recovery AEK) for use in the following circumstances: * When restoring a backup taken when a different AEK was in effect. * To successfully boot the system in the unlikely event that the system copy of the key is corrupted. * A backup is being restored to a different new Composer or to the same Composer that has been factory reset. The administrator must store the recovery AEK in a secure location, where it can be only accessed by authorized personnel. In the rare circumstance where the key cannot be read from the Composer NVRAM or the key gets corrupted, the administrator must use the appliance maintenance console to upload the AEK recovery copy, based on the error resolution message displayed. In the rare circumstance where the Composer NVRAM itself becomes inaccessible, users can choose to disable secure-data-at-rest option until the hardware issue itself is resolved. If the downloaded recovery key and the AEK stored in the Composer NVRAM are both lost, the appliance data cannot be recovered. Using this Cmdlet will disable data at rest encryption on configured and support HPE Synergy Composer appliances. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVApplianceDataAtRestEncryption</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Disable-HPOVApplianceDataAtRestEncryption</dev:code> <dev:remarks> <dev:para>Disable appliance data at rest encryption.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVAPPLIANCESERVICECONSOLEACCESS--> <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"> <!--DISABLE-HPOVAPPLIANCESERVICECONSOLEACCESS--> <command:details> <command:name>Disable-HPOVApplianceServiceConsoleAccess</command:name> <maml:description> <maml:para>Disable appliance service console access.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVApplianceServiceConsoleAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView contains a technical feature that will allow an on-site Authorized technical support to access your system, through the system console, to assess problems that you have reported. This access will be controlled by a password generated by HPE that will only be provided to the Authorized technical support. You can enable or disable access at any time while the system is running. Hewlett Packard Enterprise recommends that you enable service console access so that an Authorized technical support can diagnose your system in the event of a a system failure. Use this Cmdlet to disable service console access. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVApplianceServiceConsoleAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Disable-HPOVApplianceServiceConsoleAccess</dev:code> <dev:remarks> <dev:para>Disable service console access on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVAPPLIANCESSHACCESS--> <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"> <!--DISABLE-HPOVAPPLIANCESSHACCESS--> <command:details> <command:name>Disable-HPOVApplianceSshAccess</command:name> <maml:description> <maml:para>Disable appliance SSH access.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVApplianceSshAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView supports Secure Shell (SSH) to remotely access the appliance to perform maintenance and recovery operations. Without SSH access, you must access the virtual machine system console. To avoid requiring a console access, SSH access is enabled by default. However, remote access to maintenance and recovery operations is considered a security risk by some users. Therefore, HPE OneView provides the option to disable remote access to the appliance via SSH. Use this Cmdlet to disable appliance SSH access. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVApplianceSshAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Disable-HPOVApplianceSshAccess</dev:code> <dev:remarks> <dev:para>Disable appliance SSH access.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <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"> <!--DISABLE-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <command:details> <command:name>Disable-HPOVApplianceTwoFactorAuthentication</command:name> <maml:description> <maml:para>Disable appliance two-factor authentication settings.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVApplianceTwoFactorAuthentication</command:noun> </command:details> <maml:description> <maml:para>Enabling two-factor authentication allows you to use smart cards (for example, Common Access Cards (CAC), or Personal Identity Verification (PIV) cards) to authenticate within HPE OneView. The client certificate embedded in the smart card is presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority (CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in HPE OneView. When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned by the user to access an Active Directory entry for the user, rather than using an account associated with the user name received during first time login. Use this Cmdlet to configure two factor authentication state of the connected appliance. An Active Directory authentication directory must be configured, with a Service Account, and the root or issuing certificate authority Base64 certificate must be uploaded to appliance. Required: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVApplianceTwoFactorAuthentication</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Disable-HPOVApplianceTwoFactorAuthentication</dev:code> <dev:remarks> <dev:para>Disable two-factor authentication on the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVCERTIFICATEVALIDATION--> <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"> <!--DISABLE-HPOVCERTIFICATEVALIDATION--> <command:details> <command:name>Disable-HPOVCertificateValidation</command:name> <maml:description> <maml:para>Disable appliance TLS/SSL certificate validation.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVCertificateValidation</command:noun> </command:details> <maml:description> <maml:para>HPE OneView performs certificate validation for all Transport Layer Security (TLS) communications between the appliance and external servers or devices. These checks guarantee confidentiality, integrity, and authentication with the remote end-point. In production environments, Hewlett Packard Enterprise strongly recommends that certificate validation be enabled. In environments where security is not a concern, such as a testing environment, certificate validation can optionally be disabled. If certificate validation is disabled, any sensitive data such as credentials are transmitted insecurely. Make sure to use only local user accounts and not enterprise directory-based accounts to avoid transmitting enterprise login credentials over the network when certificate validation is disabled. NOTE: When upgrading from earlier releases, the certificates in use by the currently monitored or managed devices are imported into the HPE OneView trust store and alerts are generated for issues such as expired certificates. These automatically added certificates are either a device"s self signed certificate or the leaf certificate for a certificate authority (CA) signed certificate. Using CA-signed certificates can simplify the device trust process. Certificate checking is enabled by default, but some of the stricter validation checks are relaxed to maintain communications with all devices, even those with certificate issues. The relaxed checking includes: * Not performing expiration checks for self signed certificates * For certificate authority (CA) signed certificates, relaxed certificate revocation list (CRL) checking. The relaxed checking gives the administrator time to address any expired certificates, to upload trusted CA root and intermediate certificates, and upload the appropriate CRLs. Hewlett Packard Enterprise strongly recommends that you enable strict certificate validation checks after completing an update as appropriate for your enterprise security policies. See Manage Certificates for additional information on certificate management. HPE OneView supports devices using self signed certificates and devices using formal CA-signed certificates. CA-signed certificates offer benefits such as revocation checking and overall simplified management. HPE OneView enables users to import a CA CRL file and to perform the appropriate revocation checking on existing certificates in the trust store and for certificates received during communication with a managed device or external server. WARNING: Modifying the appliance setting will require the appliance to be rebooted. WARNING: If 2-factor authentication is configured, this policy cannot be disabled. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVCertificateValidation</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Disable-HPOVCertificateValidation</dev:code> <dev:remarks> <dev:para>Disable certificate validation on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVCertificateValidation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVDEBUG--> <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"> <!--DISABLE-HPOVDEBUG--> <command:details> <command:name>Disable-HPOVDebug</command:name> <maml:description> <maml:para>Disable specific appliance-level component debug logging.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVDebug</command:noun> </command:details> <maml:description> <maml:para>FOR HP SUPPORT USE ONLY. This cmdlet will disable appliance level component debug logging for during issue triage, by setting the Level to INFO. Do not use this cmdlet unless otherwise instructed by HP Support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVDebug</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope of the LoggerName.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>LoggerName</maml:name> <maml:description> <maml:para>The internal component name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>LoggerName</maml:name> <maml:description> <maml:para>The internal component name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope of the LoggerName.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView Appliance Connection object. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The returned object global setting.</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>This Cmdlets does not have a public example.</dev:code> <dev:remarks> <dev:para>This Cmdlet does not have a public example.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVDebug</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVDEVICEUID--> <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"> <!--DISABLE-HPOVDEVICEUID--> <command:details> <command:name>Disable-HPOVDeviceUid</command:name> <maml:description> <maml:para>Disable unit identification (UID) of a device.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVDeviceUid</command:noun> </command:details> <maml:description> <maml:para>Authorized users can control the unit identification (UID) light on an HPE Synergy frame and its servers, interconnects, and frame link modules through the UI. Illuminating the UID light on the front of a device helps an on-site technician to locate the hardware in the data center. A UID icon is displayed on the Enclosures screen, the Server Hardware screen, and the Interconnects screen. On the Enclosures screen, the enclosure overview displays the UID icon on its frame link modules, servers, and interconnects. WARNING: The UID light blinks automatically to indicate that a critical operation is underway, such as Remote Console access for server hardware or a firmware update. Do not remove power from a device when its UID light is blinking. Minimum required privileges: Infrastructure administrator, Server administrator (for enclosure, server, and frame link module UID lights), Network administrator (for interconnect UID lights)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVDeviceUid</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object to turn off the UID. Supported resources are server hardware, enclosures and interconnects.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Server, Enclosure, Frame, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object to turn off the UID. Supported resources are server hardware, enclosures and interconnects.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware or Enclosure resource.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Enclosure resource.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.Interconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Interconnect resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Async Task object to monitor.</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>Get-HPOVServer "MyEncl, Bay 1" | Disable-HPOVDeviceUid | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Disable the UID for "MyEncl, Bay 1" server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVDeviceUid</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVLDAPLOCALLOGIN--> <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"> <!--DISABLE-HPOVLDAPLOCALLOGIN--> <command:details> <command:name>Disable-HPOVLdapLocalLogin</command:name> <maml:description> <maml:para>Disable local authentication logins.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVLdapLocalLogin</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. If you want to authenticate all logins to the appliance through a directory service, you must disable local logins. Also, if a directory is inaccessible in some special cases, you can enable the emergency local login. To enable emergency local login, you must disable local logins. NOTE: Local logins cannot be disabled until you log in using an authentication directory service as an Infrastructure administrator. Verify that you can log in to the appliance as an Infrastructure administrator from the authentication directory service before continuing. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVLdapLocalLogin</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance Authentication Directory setting.</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>Disable-HPOVLdapLocalLogin</dev:code> <dev:remarks> <dev:para>Disable local logins on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVLdapLocalLogin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVLOGICALINTERCONNECTPORTMONITORING--> <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"> <!--DISABLE-HPOVLOGICALINTERCONNECTPORTMONITORING--> <command:details> <command:name>Disable-HPOVLogicalInterconnectPortMonitoring</command:name> <maml:description> <maml:para>Disable port monitoring for a logical interconnect.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVLogicalInterconnectPortMonitoring</command:noun> </command:details> <maml:description> <maml:para>Port monitoring enables you to send a copy of every Ethernet or Fibre Channel frame coming in and going out of a downlink (server-facing) port to another port. To evaluate network traffic between ports, you can connect debugging equipment, such as a network analyzer. This capability is important in a server environment where there is limited physical access to the network interfaces on the servers. Restrictions: * You cannot use Virtual Connect to forward captured traffic to a server. For more information, see the HPE Virtual Connect for c-Class BladeSystem User Guide in the Hewlett Packard Enterprise Information Library. * You can configure one network analyzer port (the uplink port) for up to 16 downlink server ports within a logical interconnect. * The HPE Virtual Connect 16Gb 24-Port Fibre Channel Module monitors 1 downlink server port. * HPE Virtual Connect 16Gb 24-Port Fibre Channel Module firmware must be 4.00 or later Minimum required privileges: Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVLogicalInterconnectPortMonitoring</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Networking.LogicalInterconnect resource from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, li, name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Networking.LogicalInterconnect resource from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect resource object from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Get-HPOVLogicalInterconnect -Name "Encl1" -ErrorAction Stop | Disable-HPOVLogicalInterconnectPortMonitoring</dev:code> <dev:remarks> <dev:para>Disable port monitoring for the specified logical interconnect resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVMSDSC--> <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"> <!--DISABLE-HPOVMSDSC--> <command:details> <command:name>Disable-HPOVMSDSC</command:name> <maml:description> <maml:para>Disable Microsoft DSC Support</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVMSDSC</command:noun> </command:details> <maml:description> <maml:para>Using this Cmdlet will create and/or modify UseMSDSC (REG_DWORD) located at HKCU:\Software\Hewlett-Packard\HPOneView, to 0 (False). By disabling support, the module will no longer overload Write-Host. Use Enable-HPOVMsDSC to enable support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVMSDSC</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet does not return any object.</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>Disable-HPOVMSDSC</dev:code> <dev:remarks> <dev:para>Configures Registry value to no longer overload Write-Host.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVMSDSC</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVREMOTESUPPORT--> <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"> <!--DISABLE-HPOVREMOTESUPPORT--> <command:details> <command:name>Disable-HPOVRemoteSupport</command:name> <maml:description> <maml:para>Disable Remote Support for a supported resource.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVRemoteSupport</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Hewlett Packard Enterprise recommends enabling all features and benefits provided by HPE OneView Remote Support so you can receive fast, accurate 'phone home' support and service per your contractual terms with Hewlett Packard Enterprise. Hewlett Packard Enterprise securely collects your HPE IT hardware diagnostics, configuration and telemetry information to provide you with remote support and services. The data is handled and managed to respect your privacy. For more information, Hewlett Packard Enterprise's Privacy Statement can be found at http://privacy.hpe.com. Enabling Remote Support configures your devices being remotely supported to securely send support or service events, IT configuration information, diagnostic, and telemetry information to Hewlett Packard Enterprise, together with your support contact information. No other business information is collected and the data is managed according to the Hewlett Packard Enterprise's Privacy Statement. This Cmdlet will disable Remote Support for a compute or enclosure resource. If Remote Support has been disabled globally on the appliance, this Cmdlet is unnecessary. Minimum required privileges: Infrastructure administrator, Server administrator, or Server firmware operator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>An enclosure from Get-HPOVEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring.</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>Get-HPOVServer -Name Prod* | Disable-HPOVRemoteSupport</dev:code> <dev:remarks> <dev:para>Get the servers with their name matching "Prod" and disable Remote Support for those resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Enclosure = Get-HPOVEnclosure -Name Enclosure-1A Disable-HPOVRemoteSupport -InputObject $Enclosure</dev:code> <dev:remarks> <dev:para>Get the specific enclosure resource and disable Remote Support.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVRemoteSupportCollection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRemoteSupportEntitlement</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISABLE-HPOVREMOTESYSLOG--> <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"> <!--DISABLE-HPOVREMOTESYSLOG--> <command:details> <command:name>Disable-HPOVRemoteSyslog</command:name> <maml:description> <maml:para>Disable remote syslog.</maml:para> </maml:description> <command:verb>Disable</command:verb> <command:noun>HPOVRemoteSyslog</command:noun> </command:details> <maml:description> <maml:para>The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles disabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically. Minimum required privileges: Infrastructure administrator, Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disable-HPOVRemoteSyslog</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Async Task object to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Async Task objects to monitor.</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>Disable-HPOVRemoteSyslog</dev:code> <dev:remarks> <dev:para>Disable remote syslog configuration on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Disable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Disable remote syslog configuration on the specific connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--DISCONNECT-HPOVMGMT--> <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"> <!--DISCONNECT-HPOVMGMT--> <command:details> <command:name>Disconnect-HPOVMgmt</command:name> <maml:description> <maml:para>Logoff from the appliance.</maml:para> </maml:description> <command:verb>Disconnect</command:verb> <command:noun>HPOVMgmt</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will logoff the current user, which terminates the user session, on the specified HPE OneView appliance. When logging off of an appliance, and multiple connections have been established, the next appliance connection within ${Global:ApplianceConnections} is made the default connection. To change the default connection to a different appliance, use Set-HPOVApplianceDefaultConnection.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Disconnect-HPOVMgmt</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Appliance, ApplianceSession, Hostname"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>$ConnectedSessions | Where-Object Default</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Library.ApplianceConnection</maml:name> </dev:type> <maml:description> <maml:para>The appliance library connection object from ${Global:ConnectedSessions} global variable.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet does not return any object.</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>$Connection1 = Connect-HPOVMgmt MyAppliance.domain.com Disconnect-HPOVMgmt -Hostname $Connection1</dev:code> <dev:remarks> <dev:para>Disconnect from the specific appliance session.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Disconnect-HPOVMgmt -Hostname 1</dev:code> <dev:remarks> <dev:para>Disconnect ConnectionID 1 appliance session.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ConnectedSessions | Disconnect-HPOVMgmt</dev:code> <dev:remarks> <dev:para>Disconnect all appliance sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Connect-HPOVMgmt</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVAPPLIANCECOMPLEXPASSWORDS--> <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"> <!--ENABLE-HPOVAPPLIANCECOMPLEXPASSWORDS--> <command:details> <command:name>Enable-HPOVApplianceComplexPasswords</command:name> <maml:description> <maml:para>Enable appliance complex password policy.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVApplianceComplexPasswords</command:noun> </command:details> <maml:description> <maml:para>Enables whether users are required to have complex passwords. This option does not force existing users to change their passwords, nor has any impact on directory accounts. By default, the appliance does not enforce complex passwords during creating or modifying internal user account passwords. Use this Cmdlet to enable the policy. Complex passwords must contain the following: * Minimum of 14 characters * Minimum of one uppercase character * Minimum of one lowercase character * Minimum one number * Minimum of one special character. For example: !@#$^*_-=+,.? * No whitespace Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVApplianceComplexPasswords</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Enable-HPOVApplianceComplexPasswords</dev:code> <dev:remarks> <dev:para>Enable appliance complex password policy.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <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"> <!--ENABLE-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <command:details> <command:name>Enable-HPOVApplianceDataAtRestEncryption</command:name> <maml:description> <maml:para>Turn on HPE Synergy Composer data at rest encryption.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVApplianceDataAtRestEncryption</command:noun> </command:details> <maml:description> <maml:para>HPE OneView encrypts sensitive data, such as managed device credentials, when it is stored on-disk in the appliance. The HPE OneView appliance encryption key (AEK) is used internally to encrypt the credentials for managed devices (such as, iLO, onboard administrator, frame link module). By default, the AEK is stored on the HPE Synergy Composer disk and also included in the appliance backup. This could pose a security risk in case the disk is stolen. The secure data-at-rest option, when enabled, stores the AEK off-disk in Composer NVRAM, and does not include the key in the appliance backup. Enabling this option requires the administrator to save a copy of the AEK (recovery AEK) for use in the following circumstances: When restoring a backup taken when a different AEK was in effect. To successfully boot the system in the unlikely event that the system copy of the key is corrupted. A backup is being restored to a different new Composer or to the same Composer that has been factory reset. The administrator must store the recovery AEK in a secure location, where it can be only accessed by authorized personnel. In the rare circumstance where the key cannot be read from the Composer NVRAM or the key gets corrupted, the administrator must use the appliance maintenance console to upload the AEK recovery copy, based on the error resolution message displayed. In the rare circumstance where the Composer NVRAM itself becomes inaccessible, users can choose to disable secure-data-at-rest option until the hardware issue itself is resolved. If the downloaded recovery key and the AEK stored in the Composer NVRAM are both lost, the appliance data cannot be recovered. Using this Cmdlet will enable data at rest encryption for supported HPE Synergy composers. The appliance encryption key (AEK) will automatically be downloaded and saved to the value of the -Location parameter. By default, this will be the working directory where the Cmdlet is executed in. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVApplianceDataAtRestEncryption</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>The file location where to save the appliance encription key (AEK). The AEK should be stored in a secure location.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>The file location where to save the appliance encription key (AEK). The AEK should be stored in a secure location.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue>(get-location).Path</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Enable-HPOVApplianceDataAtRestEncryption</dev:code> <dev:remarks> <dev:para>Enable data at rest encryption, where the AEK is saved to the working directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVAPPLIANCESERVICECONSOLEACCESS--> <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"> <!--ENABLE-HPOVAPPLIANCESERVICECONSOLEACCESS--> <command:details> <command:name>Enable-HPOVApplianceServiceConsoleAccess</command:name> <maml:description> <maml:para>Enable appliance service console access.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVApplianceServiceConsoleAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView contains a technical feature that will allow an on-site Authorized technical support to access your system, through the system console, to assess problems that you have reported. This access will be controlled by a password generated by HPE that will only be provided to the Authorized technical support. You can enable or disable access at any time while the system is running. Hewlett Packard Enterprise recommends that you enable service console access so that an Authorized technical support can diagnose your system in the event of a a system failure. Use this Cmdlet to enable service console access. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVApplianceServiceConsoleAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Enable-HPOVApplianceServiceConsoleAccess</dev:code> <dev:remarks> <dev:para>Enable appliance service console access.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVAPPLIANCESSHACCESS--> <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"> <!--ENABLE-HPOVAPPLIANCESSHACCESS--> <command:details> <command:name>Enable-HPOVApplianceSshAccess</command:name> <maml:description> <maml:para>Enable appliance SSH access.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVApplianceSshAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView supports Secure Shell (SSH) to remotely access the appliance to perform maintenance and recovery operations. Without SSH access, you must access the virtual machine system console. To avoid requiring a console access, SSH access is enabled by default. However, remote access to maintenance and recovery operations is considered a security risk by some users. Therefore, HPE OneView provides the option to disable remote access to the appliance via SSH. Use this Cmdlet to enable appliance SSH access. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVApplianceSshAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Enable-HPOVApplianceSshAccess</dev:code> <dev:remarks> <dev:para>Enable appliance SSH access.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVCERTIFICATEVALIDATION--> <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"> <!--ENABLE-HPOVCERTIFICATEVALIDATION--> <command:details> <command:name>Enable-HPOVCertificateValidation</command:name> <maml:description> <maml:para>Enable appliance TLS/SSL certificate validation.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVCertificateValidation</command:noun> </command:details> <maml:description> <maml:para>HPE OneView performs certificate validation for all Transport Layer Security (TLS) communications between the appliance and external servers or devices. These checks guarantee confidentiality, integrity, and authentication with the remote end-point. In production environments, Hewlett Packard Enterprise strongly recommends that certificate validation be enabled. In environments where security is not a concern, such as a testing environment, certificate validation can optionally be disabled. If certificate validation is disabled, any sensitive data such as credentials are transmitted insecurely. Make sure to use only local user accounts and not enterprise directory-based accounts to avoid transmitting enterprise login credentials over the network when certificate validation is disabled. NOTE: When upgrading from earlier releases, the certificates in use by the currently monitored or managed devices are imported into the HPE OneView trust store and alerts are generated for issues such as expired certificates. These automatically added certificates are either a device"s self signed certificate or the leaf certificate for a certificate authority (CA) signed certificate. Using CA-signed certificates can simplify the device trust process. Certificate checking is enabled by default, but some of the stricter validation checks are relaxed to maintain communications with all devices, even those with certificate issues. The relaxed checking includes: * Not performing expiration checks for self signed certificates * For certificate authority (CA) signed certificates, relaxed certificate revocation list (CRL) checking. The relaxed checking gives the administrator time to address any expired certificates, to upload trusted CA root and intermediate certificates, and upload the appropriate CRLs. Hewlett Packard Enterprise strongly recommends that you enable strict certificate validation checks after completing an update as appropriate for your enterprise security policies. See Manage Certificates for additional information on certificate management. HPE OneView supports devices using self signed certificates and devices using formal CA-signed certificates. CA-signed certificates offer benefits such as revocation checking and overall simplified management. HPE OneView enables users to import a CA CRL file and to perform the appropriate revocation checking on existing certificates in the trust store and for certificates received during communication with a managed device or external server. WARNING: Modifying the appliance setting will require the appliance to be rebooted. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVCertificateValidation</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CheckForSelfSignedExpiry</maml:name> <maml:description> <maml:para>Enable ($true) or Disable ($false) the option to check for expiration of self signed certificates if you want to perform expiration checks for self signed certificates. By default, self signed certificate expiry is not enabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>CheckForSelfSignedExpiry</maml:name> <maml:description> <maml:para>Enable ($true) or Disable ($false) the option to check for expiration of self signed certificates if you want to perform expiration checks for self signed certificates. By default, self signed certificate expiry is not enabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Enable-HPOVCertificateValidation</dev:code> <dev:remarks> <dev:para>Enable certificate validation setting on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVCertificateValidation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVCOMPOSERHANODE--> <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"> <!--ENABLE-HPOVCOMPOSERHANODE--> <command:details> <command:name>Enable-HPOVComposerHANode</command:name> <maml:description> <maml:para>Promote Standby Composer node to Active.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVComposerHANode</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help transition the Standby Composer node to the Active Role. Use this Cmdlet in order to perform maintenance on the Active node, or to remove the Active node from the Synergy management ring. The standby appliance must be accessible to and fully synchronized with the active appliance. NOTE: The appliance is unavailable during the role exchange and unable to respond to requests while services are reassigned. HPE OneView services will be stopped on the active appliance and restarted on the standby appliance. Operations in progress might fail and need to be restarted. Minimum required privileges: Infrastructure administrator or Software administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVComposerHANode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Async task resource of the role transition request</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>Enable-HPOVComposerHANode</dev:code> <dev:remarks> <dev:para>Transition the Standby Composer node in the default Appliance Connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVDEBUG--> <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"> <!--ENABLE-HPOVDEBUG--> <command:details> <command:name>Enable-HPOVDebug</command:name> <maml:description> <maml:para>Enable specific appliance-level component debug logging.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVDebug</command:noun> </command:details> <maml:description> <maml:para>FOR HP SUPPORT USE ONLY. This cmdlet will enable appliance level component debug logging for during issue triage. Do not use this cmdlet unless otherwise instructed by HP Support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVDebug</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope of the LoggerName.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>LoggerName</maml:name> <maml:description> <maml:para>The internal component name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Level</maml:name> <maml:description> <maml:para>The verbose level to enable. Allowed values are: * ERROR * WARN * DEBUG * TRACE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Level</maml:name> <maml:description> <maml:para>The verbose level to enable. Allowed values are: * ERROR * WARN * DEBUG * TRACE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>LoggerName</maml:name> <maml:description> <maml:para>The internal component name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope of the LoggerName.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView Appliance Connection object. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The returned object global setting.</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>This Cmdlets does not have a public example.</dev:code> <dev:remarks> <dev:para>This Cmdlet does not have a public example.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVDebug</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVDEVICEUID--> <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"> <!--ENABLE-HPOVDEVICEUID--> <command:details> <command:name>Enable-HPOVDeviceUid</command:name> <maml:description> <maml:para>Enable unit identification (UID) of a device.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVDeviceUid</command:noun> </command:details> <maml:description> <maml:para>Authorized users can control the unit identification (UID) light on an HPE Synergy frame and its servers, interconnects, and frame link modules through the UI. Illuminating the UID light on the front of a device helps an on-site technician to locate the hardware in the data center. A UID icon is displayed on the Enclosures screen, the Server Hardware screen, and the Interconnects screen. On the Enclosures screen, the enclosure overview displays the UID icon on its frame link modules, servers, and interconnects. Use this Cmdlet to enable the UID light on a resource. NOTE: The UID light blinks automatically to indicate that a critical operation is underway, such as Remote Console access for server hardware or a firmware update. Do not remove power from a device when its UID light is blinking. Minimum required privileges: Infrastructure administrator, Server administrator (for enclosure, server, and frame link module UID lights), Network administrator (for interconnect UID lights)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVDeviceUid</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object to turn on the UID. Supported resources are Server Hardware and Enclosures.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Server, Enclosure, Frame, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource object to turn on the UID. Supported resources are Server Hardware and Enclosures.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject] or HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware or Enclosure resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Async Task object to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Async Task objects to monitor.</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>Get-HPOVServer "MyEncl, Bay 1" | Enable-HPOVDeviceUid | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Enable the UID for "MyEncl, Bay 1" server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVDeviceUid</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVLDAPLOCALLOGIN--> <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"> <!--ENABLE-HPOVLDAPLOCALLOGIN--> <command:details> <command:name>Enable-HPOVLdapLocalLogin</command:name> <maml:description> <maml:para>Enable local authentication logins.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVLdapLocalLogin</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. If you want to authenticate all logins to the appliance through a directory service, you must disable local logins. Also, if a directory is inaccessible in some special cases, you can enable the emergency local login. To enable emergency local login, you must disable local logins. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVLdapLocalLogin</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance Authentication Directory setting.</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>Enable-HPOVLdapLocalLogin</dev:code> <dev:remarks> <dev:para>Enable local logins on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVLdapLocalLogin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVLOGICALINTERCONNECTPORTMONITORING--> <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"> <!--ENABLE-HPOVLOGICALINTERCONNECTPORTMONITORING--> <command:details> <command:name>Enable-HPOVLogicalInterconnectPortMonitoring</command:name> <maml:description> <maml:para>Enable port monitoring for a logical interconnect.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVLogicalInterconnectPortMonitoring</command:noun> </command:details> <maml:description> <maml:para>Port monitoring enables you to send a copy of every Ethernet or Fibre Channel frame coming in and going out of a downlink (server-facing) port to another port. To evaluate network traffic between ports, you can connect debugging equipment, such as a network analyzer. This capability is important in a server environment where there is limited physical access to the network interfaces on the servers. * You cannot use Virtual Connect to forward captured traffic to a server. For more information, see the HPE Virtual Connect for c-Class BladeSystem User Guide in the Hewlett Packard Enterprise Information Library. * You can configure one network analyzer port (the uplink port) for up to 16 downlink server ports within a logical interconnect. * The HPE Virtual Connect 16Gb 24-Port Fibre Channel Module monitors 1 downlink server port. * HPE Virtual Connect 16Gb 24-Port Fibre Channel Module firmware must be 4.00 or later Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVLogicalInterconnectPortMonitoring</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Networking.LogicalInterconnect from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>AnalyzerPort</maml:name> <maml:description> <maml:para>Specifies the network analyzer port (the mirrored-to uplink port) for the downlink server ports within a single enclosure. There is a single "mirrored-to port" per logical interconnect. Allowed string value: "Bay1:X6" or "Enclosure1:Bay6:Q1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>MonitoredPorts</maml:name> <maml:description> <maml:para>An Array of Hashtable or PSCustomObject with the following format: @{Port = "Bay1:D2"; Direction = "toserver"} The "Port" property format must be "BayID:ServerDownlinkPortID". For HPE Synergy, the "Port" property must be "EnclosureID:BayID:ServerDownlinkPortID". The "Direction" property value must be one of the following: * ToServer * FromServer * Both</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>AnalyzerPort</maml:name> <maml:description> <maml:para>Specifies the network analyzer port (the mirrored-to uplink port) for the downlink server ports within a single enclosure. There is a single "mirrored-to port" per logical interconnect. Allowed string value: "Bay1:X6" or "Enclosure1:Bay6:Q1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, li, name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Networking.LogicalInterconnect from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>MonitoredPorts</maml:name> <maml:description> <maml:para>An Array of Hashtable or PSCustomObject with the following format: @{Port = "Bay1:D2"; Direction = "toserver"} The "Port" property format must be "BayID:ServerDownlinkPortID". For HPE Synergy, the "Port" property must be "EnclosureID:BayID:ServerDownlinkPortID". The "Direction" property value must be one of the following: * ToServer * FromServer * Both</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect resource object from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>$LogicalInterconnect = Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" Enable-HPOVLogicalInterconnectPortMonitoring -InputObject $LogicalInterconnect -AnalyzerPort "Bay1:Q1.1" -MonitoredPorts @{Port = "Bay1:d2"; Direction = "toserver"}, @{Port = "Bay1:D3"; Direction = "MonitoredFromServer"}, @{Port = "Bay2:D7"; Direction = "Both"}</dev:code> <dev:remarks> <dev:para>Enable port monitoring for the specific logical interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect -Name "LE1-Default VC LIG" | Enable-HPOVLogicalInterconnectPortMonitoring -AnalyzerPort "Enclosure1:Bay3:Q1.1" -MonitoredPorts @{Port = "Enclosure1:Bay3:d1"; Direction = "Both"}, @{Port = "Enclosure1:Bay6:d1"; Direction = "Both"}</dev:code> <dev:remarks> <dev:para>Enable port monitoring for the specific logical interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVMSDSC--> <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"> <!--ENABLE-HPOVMSDSC--> <command:details> <command:name>Enable-HPOVMSDSC</command:name> <maml:description> <maml:para>Enable Microsoft DSC Support</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVMSDSC</command:noun> </command:details> <maml:description> <maml:para>Using this Cmdlet will create and/or modify UseMSDSC (REG_DWORD) located at HKCU:\Software\Hewlett-Packard\HPOneView, to 1 (True). By enabling support, the module will overload Write-Host, and instead issue Write-Verbose commands. Use Disable-HPOVMsDSC to disable support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVMSDSC</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet does not return any response.</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>Enable-HPOVMSDSC</dev:code> <dev:remarks> <dev:para>Configures Registry value to overload Write-Host, which then uses Write-Verbose.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVMSDSC</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVREMOTESUPPORT--> <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"> <!--ENABLE-HPOVREMOTESUPPORT--> <command:details> <command:name>Enable-HPOVRemoteSupport</command:name> <maml:description> <maml:para>Enable Remote Support for a supported resource.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVRemoteSupport</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Hewlett Packard Enterprise recommends enabling all features and benefits provided by HPE OneView Remote Support so you can receive fast, accurate 'phone home' support and service per your contractual terms with Hewlett Packard Enterprise. Hewlett Packard Enterprise securely collects your HPE IT hardware diagnostics, configuration and telemetry information to provide you with remote support and services. The data is handled and managed to respect your privacy. For more information, Hewlett Packard Enterprise's Privacy Statement can be found at http://privacy.hpe.com. Enabling Remote Support configures your devices being remotely supported to securely send support or service events, IT configuration information, diagnostic, and telemetry information to Hewlett Packard Enterprise, together with your support contact information. No other business information is collected and the data is managed according to the Hewlett Packard Enterprise's Privacy Statement. This Cmdlet will enable Remote Support for a compute or enclosure resource. Remote Support must be enabled globally on the appliance in order to use this Cmdlet. Minimum required privileges: Infrastructure administrator, Server administrator, or Server firmware operator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring.</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>Get-HPOVServer -Name Prod* | Enable-HPOVRemoteSupport</dev:code> <dev:remarks> <dev:para>Get the servers with their name matching "Prod" and enable Remote Support for those resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Enclosure = Get-HPOVEnclosure -Name Enclosure-1A Enable-HPOVRemoteSupport -InputObject $Enclusre</dev:code> <dev:remarks> <dev:para>Get the specific enclosure resource and enable Remote Support.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVRemoteSupportCollection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRemoteSupportEntitlement</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENABLE-HPOVREMOTESYSLOG--> <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"> <!--ENABLE-HPOVREMOTESYSLOG--> <command:details> <command:name>Enable-HPOVRemoteSyslog</command:name> <maml:description> <maml:para>Enable remote syslog.</maml:para> </maml:description> <command:verb>Enable</command:verb> <command:noun>HPOVRemoteSyslog</command:noun> </command:details> <maml:description> <maml:para>The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles enabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically. Minimum required privileges: Infrastructure administrator, Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enable-HPOVRemoteSyslog</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Async Task object to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Async Task objects to monitor.</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>Enable-HPOVRemoteSyslog</dev:code> <dev:remarks> <dev:para>Enable remote syslog configuration on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Enable-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com -Async | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Enable remote syslog configuration on the specific connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--ENTER-HPOVCLUSTERNODEMAINTENANCEMODE--> <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"> <!--ENTER-HPOVCLUSTERNODEMAINTENANCEMODE--> <command:details> <command:name>Enter-HPOVClusterNodeMaintenanceMode</command:name> <maml:description> <maml:para>Request a cluster node member to enter maintenance mode.</maml:para> </maml:description> <command:verb>Enter</command:verb> <command:noun>HPOVClusterNodeMaintenanceMode</command:noun> </command:details> <maml:description> <maml:para>A cluster in an active state runs a shared workload, like virtual machines within a Hypervisor Cluster. When you place a cluster node into maintenance mode, the workload running on the cluster member is migrated to other available cluster member. While in maintenance state the server administrator can perform updates on the host software, server hardware, or both, preventing business downtime. After the maintenance operation on the cluster member completes, you must release it from maintenance mode to resume hosting the shared workload. Minimum required privileges: Infrastructure administrator, Server administrator, Server Profile administrator, Server Profile architect, or Server Profile operator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Enter-HPOVClusterNodeMaintenanceMode</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster member from Get-HPOVClusterNode</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster member from Get-HPOVClusterNode</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Cluster.ClusterNode [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Cluster node member from Get-HPOVClusterNode.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVClusterNode -Name Cluster1-Node1 | Enter-HPOVClusterNodeMaintenanceMode</dev:code> <dev:remarks> <dev:para>Request to put the specific node into maintenance mode.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Exit-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--EXIT-HPOVCLUSTERNODEMAINTENANCEMODE--> <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"> <!--EXIT-HPOVCLUSTERNODEMAINTENANCEMODE--> <command:details> <command:name>Exit-HPOVClusterNodeMaintenanceMode</command:name> <maml:description> <maml:para>Request a cluster node member to exit maintenance mode.</maml:para> </maml:description> <command:verb>Exit</command:verb> <command:noun>HPOVClusterNodeMaintenanceMode</command:noun> </command:details> <maml:description> <maml:para>A cluster in an active state runs a shared workload, like virtual machines within a Hypervisor Cluster. When you place a cluster node into maintenance mode, the workload running on the cluster member is migrated to other available cluster member. While in maintenance state the server administrator can perform updates on the host software, server hardware, or both, preventing business downtime. After the maintenance operation on the cluster member completes, you must release it from maintenance mode to resume hosting the shared workload. Minimum required privileges: Infrastructure administrator, Server administrator, Server Profile administrator, Server Profile architect, or Server Profile operator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Exit-HPOVClusterNodeMaintenanceMode</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster member from Get-HPOVClusterNode</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster member from Get-HPOVClusterNode</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Cluster.ClusterNode [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Cluster node member from Get-HPOVClusterNode.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVClusterNode -Name Cluster1-Node1 | Exit-HPOVClusterNodeMaintenanceMode</dev:code> <dev:remarks> <dev:para>Request to the specific node exit maintenance mode.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Enter-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVADDRESSPOOL--> <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"> <!--GET-HPOVADDRESSPOOL--> <command:details> <command:name>Get-HPOVAddressPool</command:name> <maml:description> <maml:para>Retrieve address pool information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAddressPool</command:noun> </command:details> <maml:description> <maml:para>An ID pool is a collection of one or more ranges that you can be randomly generate or specify to provide large address spaces. By default, one virtual ID pool each of contiguous MAC addresses, WWNs, and serial numbers are created automatically when you initialize the appliance. The pools are composed of address and ID ranges. You can individually enable or disable a range, or delete any unused ranges. ID pool ranges do not conflict with physical IDs, provided the virtual ranges you create exclude the physical ID ranges. This Cmdlet will get the available and configured address pools, and their associated Ranges from the appliance. Currently, the appliance supports the following address pools: * VMAC * VWWN * VSN * IPv6 * IPv4 You can specify one, some or all of the Pool types. A Range switch is provided to include the associated Range objects. A report switch is provided to display a report of each address pool type. Minimum required privileges: Network administrator (virtual MAC addresses and virtual WWNs), Infrastructure administrator (all ID types)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAddressPool</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>The address pool type. Accepted values are VMAC, VWWN, VSN, IPv4, IPv6, or All.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>The address pool type. Accepted values are VMAC, VWWN, VSN, IPv4, IPv6, or All.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue>all</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AddressPool [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single address pool and its contents.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.AddressPool></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of address pools and their contents.</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>Get-HPOVAddressPool</dev:code> <dev:remarks> <dev:para>Get the address pools.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAddressPool -type vmac</dev:code> <dev:remarks> <dev:para>Get the vmac address pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVADDRESSPOOLRANGE--> <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"> <!--GET-HPOVADDRESSPOOLRANGE--> <command:details> <command:name>Get-HPOVAddressPoolRange</command:name> <maml:description> <maml:para>Retrieve address pool range information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAddressPoolRange</command:noun> </command:details> <maml:description> <maml:para>An ID pool is a collection of one or more ranges that you can be randomly generate or specify to provide large address spaces. By default, one virtual ID pool each of contiguous MAC addresses, WWNs, and serial numbers are created automatically when you initialize the appliance. The pools are composed of address and ID ranges. You can individually enable or disable a range, or delete any unused ranges. ID pool ranges do not conflict with physical IDs, provided the virtual ranges you create exclude the physical ID ranges. This Cmdlet will display configured address pool ranges defined on an HPE OneView appliance. Currently, the appliance supports the following address pool ranges: * VMAC * VWWN * VSN * IPv6 * IPv4 You can specify one, some or all of the pool types. Minimum required privileges: Network administrator (virtual MAC addresses and virtual WWNs), Infrastructure administrator (all ID types)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAddressPoolRange</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para> Specify the type of address pool. Allowed values are: * IPv4 * VMAC * VWWN * VSN * All</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVAddressPoolRange</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para> Specify the address pool object from Get-HPOVAddressPool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para> Specify the address pool object from Get-HPOVAddressPool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Pool"> <maml:name>Type</maml:name> <maml:description> <maml:para> Specify the type of address pool. Allowed values are: * IPv4 * VMAC * VWWN * VSN * All</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue>all</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.AddressPool [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Address pool resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AddressPoolRange [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Address pool range object.</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-HPOVAddressPoolRange Name Enabled Category Total Allocated Available Reserved Start End ---- ------- -------- ----- --------- --------- -------- ----- --- VMAC True Generated 1048576 2 1048574 0 62:79:84:50:00:00 62:79:84:5F:FF:FF VWWN True Generated 1048576 0 1048576 0 10:00:92:5a:1f:b0:00:00 10:00:92:5a:1f:bf:ff:ff VSN True Generated 46656 1 46655 0 VCGBWAB000 VCGBWABZZZ VMAC True Generated 1048576 0 1048576 0 F6:38:E6:90:00:00 F6:38:E6:9F:FF:FF VWWN True Generated 1048576 0 1048576 0 10:00:ce:58:fa:50:00:00 10:00:ce:58:fa:5f:ff:ff VSN True Generated 46656 0 46656 0 VCGA290000 VCGA290ZZZ</dev:code> <dev:remarks> <dev:para>Get all configured address pool ranges from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>[PS] C:\> Get-HPOVAddressPoolRange -Type vmac Name Enabled Category Total Allocated Available Reserved Start End ---- ------- -------- ----- --------- --------- -------- ----- --- VMAC True Generated 1048576 2 1048574 0 62:79:84:50:00:00 62:79:84:5F:FF:FF VMAC True Generated 1048576 0 1048576 0 F6:38:E6:90:00:00 F6:38:E6:9F:FF:FF</dev:code> <dev:remarks> <dev:para>Get a specific address pool range type (VMAC) from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVADDRESSPOOLSUBNET--> <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"> <!--GET-HPOVADDRESSPOOLSUBNET--> <command:details> <command:name>Get-HPOVAddressPoolSubnet</command:name> <maml:description> <maml:para>Retrieve address pool subnet information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAddressPoolSubnet</command:noun> </command:details> <maml:description> <maml:para>An ID pool is a collection of one or more ranges that you can be randomly generate or specify to provide large address spaces. By default, one virtual ID pool each of contiguous MAC addresses, WWNs, and serial numbers are created automatically when you initialize the appliance. The pools are composed of address and ID ranges. You can individually enable or disable a range, or delete any unused ranges. ID pool ranges do not conflict with physical IDs, provided the virtual ranges you create exclude the physical ID ranges. IPv4 or IPv6 address pools can be used in a variety of application. Create an IPv4 or IPv6 subnet with one or more IPv4 or IPv6 address ranges you define. To assign static IP addresses to device bays, associate these IP ranges with an enclosure group, in which case IP addresses are assigned to the iLOs of server hardware populating these bays. IP ranges are also associated with interconnect bays, in which case IP addresses are assigned to the interconnect modules. Interconnects and iLOs share the same IP address pool. Associate an IPv4 or IPv6 subnet with an Ethernet network. If this is an iSCSI network used as a deployment network, Image Streamer appliances can consume an IP address from one of the ranges for management of the appliance. Use this Cmdlet to retrieve the configured IPv4 or IPv6 address pool subnets. Minimum required privileges: Network administrator, Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAddressPoolSubnet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>Specify the Network ID of the subnet in order to filter the results.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>Specify the Network ID of the subnet in order to filter the results.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. This Cmdlet does not support pipeline operations.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single IPv4 Subnet address pool range.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.IPAddressSubnet></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of IPv4 Subnet address pool range(s).</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>Get-HPOVAddressPoolSubnet</dev:code> <dev:remarks> <dev:para>Get the configured IPv4 and IPv6 address pools.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0</dev:code> <dev:remarks> <dev:para>Get the specified IPv4 address pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVALERT--> <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"> <!--GET-HPOVALERT--> <command:details> <command:name>Get-HPOVAlert</command:name> <maml:description> <maml:para>Get an alert.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAlert</command:noun> </command:details> <maml:description> <maml:para>The appliance uses alert messages to report issues with the resources it manages and monitors. The resources generate alerts to notify you that some meaningful event occurred and that an action might be required. An event describes a single problem or change that occurred on a resource. For example, an event might be an SNMP trap received from a server's (iLO) management processor. Each alert includes the following information about the event it reports: severity, state, description, and urgency. You can clear alerts, assign owners to alerts, and add notes to alerts. While alerts have an active or locked state, they contribute to the overall displayed status for a resource. After you change their state to Cleared, they no longer affect the displayed status. You can filter the display of the activity list to help you locate and view specific activities. However, you cannot customize filters to otherwise manage the display of the activities. This Cmdlet allows the administrator to get an alert. Alerts can be filtered by using the -State parameter. If a resource object is supplied using the -InputObject parameter, all associated alerts will be returned. This Cmdlet also supports additional filtering by state, assigned to user, severity, count and date range. Minimum required privileges: Network administrator, Server administrator, Infrastructure administrator, Backup administrator, Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAlert</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Alerts for the specified resource will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Alerts with given severity will be returned. Allowed severity values are: * Unknown * Ok * Disabled * Warning * Critical</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>HealthCategory</maml:name> <maml:description> <maml:para>Alerts with given health category will be returned. Allowed health category values are: * Appliance * DeviceBay * Enclosure * Fan * Firmware * Host * Instance * InterconnectBay * LogicalSwitch * Logs * ManagementProcessor * Memory * Network * Operational * Power * Processor * RemoteSupport * Storage * Thermal * Unknown</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AssignedToUser</maml:name> <maml:description> <maml:para>Alerts assigned to the given user will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AlertState</maml:name> <maml:description> <maml:para>Alerts with given alert state will be returned. State values include Active and Cleared</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return only the number of alerts from the appliance. Can be combined with other parameters to return a pruned list of alerts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Return the number of alerts created from today to the defined number of days.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Timespan</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Start</maml:name> <maml:description> <maml:para>Return alerts that were created starting from the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the DateTime value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>End</maml:name> <maml:description> <maml:para>Return alerts that were created on the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the DateTime value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="State"> <maml:name>AlertState</maml:name> <maml:description> <maml:para>Alerts with given alert state will be returned. State values include Active and Cleared</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AssignedToUser</maml:name> <maml:description> <maml:para>Alerts assigned to the given user will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return only the number of alerts from the appliance. Can be combined with other parameters to return a pruned list of alerts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>End</maml:name> <maml:description> <maml:para>Return alerts that were created on the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the DateTime value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>HealthCategory</maml:name> <maml:description> <maml:para>Alerts with given health category will be returned. Allowed health category values are: * Appliance * DeviceBay * Enclosure * Fan * Firmware * Host * Instance * InterconnectBay * LogicalSwitch * Logs * ManagementProcessor * Memory * Network * Operational * Power * Processor * RemoteSupport * Storage * Thermal * Unknown</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="resourceUri, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Alerts for the specified resource will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Alerts with given severity will be returned. Allowed severity values are: * Unknown * Ok * Disabled * Warning * Critical</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>Return alerts that were created starting from the specified date. Hour, Min and Seconds will not be used, only Month, Day and Year of the DateTime value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Return the number of alerts created from today to the defined number of days.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Timespan</command:parameterValue> <dev:type> <maml:name>Timespan</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Resource object (i.e. Get-HPOVServer).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Alert [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>HPE OneView alert.</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>$alerts = Get-HPOVAlert -severity CRITICAL</dev:code> <dev:remarks> <dev:para>Return all the critical alerts.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name "Encl1, Bay 2" | Get-HPOVAlert -severity CRITICAL</dev:code> <dev:remarks> <dev:para>Return all the critical alerts for server "Encl1, Bay 2".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -Name "Profile 1" | Get-HPOVAlert</dev:code> <dev:remarks> <dev:para>Return all the alerts for server profile "Profile 1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -Name "Encl1, interconnect 2" | Get-HPOVAlert</dev:code> <dev:remarks> <dev:para>Get all alerts for "Encl1, interconnect 2" interconnect module.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -Name "Encl1, interconnect 2" | Get-HPOVAlert -severity Critical</dev:code> <dev:remarks> <dev:para>Get "critical" severity alerts for "Encl1, interconnect 2" interconnect module.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAlert -severity Critical -Count 5</dev:code> <dev:remarks> <dev:para>Return the first 5 "critical" severity alerts.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAlert -severity Critical -Timespan (New-TimeSpan -Days 8)</dev:code> <dev:remarks> <dev:para>Return "critical" severity alerts for the past 8 days.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAlert -severity Critical -Start "2016-12-01"</dev:code> <dev:remarks> <dev:para>Return "critical" severity alerts Starting at 2016-12-01 to now.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAlert -Start "2016-12-01" -End "2016-12-09</dev:code> <dev:remarks> <dev:para>Return all alerts Starting at 2016-12-01 to 2016-12-09.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Clear-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEAUDITLOGFORWARDING--> <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"> <!--GET-HPOVAPPLIANCEAUDITLOGFORWARDING--> <command:details> <command:name>Get-HPOVApplianceAuditLogForwarding</command:name> <maml:description> <maml:para>Get the appliance remote Syslog audit log forwarding configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceAuditLogForwarding</command:noun> </command:details> <maml:description> <maml:para>Audit log forwarding enables the Infrastructure administrator to forward audit logs to remote Security Information and Event Management (SIEM) systems. Such systems enable centralized audit compliance, monitoring, log analysis, and controlled retention policies. The forwarding protocol used is the standard UDP-based syslog protocol described in RFC5424 and RFC5426. The syslog protocol is supported by all common syslog servers such as rsyslog, syslog-ng and SIEM products. NOTE: Ensure that any firewalls between HPE OneView and the remote syslog server allow UDP traffic. The default UDP port used is 514. As audit log entries are forwarded over UDP, the entries are not encrypted and delivery is not guaranteed. Even when you have HPE OneView and all managed devices on a dedicated, isolated management LAN, forwarding audit log entries to external systems can pose a security risk. In an environment where encryption is required, use the REST API /rest/audit-logs to schedule a job to download the appliance audit logs. This Cmdlet will return the current status, remote Syslog destination and port currently configured on the appliance. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceAuditLogForwarding</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuditLogForwardingConfig</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The appliance audit log forwarding configuration.</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>Get-HPOVApplianceAuditLogForwarding</dev:code> <dev:remarks> <dev:para>Get the appliance audit log configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEAVAILABLESECURITYMODE--> <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"> <!--GET-HPOVAPPLIANCEAVAILABLESECURITYMODE--> <command:details> <command:name>Get-HPOVApplianceAvailableSecurityMode</command:name> <maml:description> <maml:para>Get appliance available security cryptography modes.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceAvailableSecurityMode</command:noun> </command:details> <maml:description> <maml:para>HPE OneView allows you to change the Cryptography Settings of a specific appliance. These setting modes change the available cryptography algorithms, allowed ciphers and disabling unsecure protocols. Available cryptography modes include: * Legacy - This is the default cryptography mode. In the legacy mode all TLS protocol versions (1.0, 1.1, and 1.2) and associated cipher suites for those versions are supported. TLS certificates are not required to have FIPS or CNSA minimum key lengths nor strong digital signatures. * FIPS - Federal Information Processing Standard (FIPS) Publication 140-2 is a U.S. government computer security standard for products performing cryptography. The FIPS 140-2 Cryptographic Module Validation Program has validated the cryptography libraries of HPE OneView. When in the FIPS mode: * The cryptographic modules of the appliance are configured to operate in accordance with the FIPS 140-2 level 1 specification. This setting ensures that the required FIPS self-tests are run while loading these cryptographic modules. * The ciphers and algorithms used for cryptographic operations by the appliance are restricted to only those approved by FIPS. * The appliance allows only TLS1.1 and TLS 1.2 protocols for all TLS communications * All SSH and SNMPv3 communication use only cipher suites and algorithms approved by FIPS. * For additional information, see the FIPS-140 site. * CNSA - The Commercial National Security Algorithm (CNSA) cryptography mode restricts HPE OneView to use only those algorithms included in the CNSA suite. The CNSA suite is a subset of the general FIPS support and includes a set of algorithms used to protect national security systems, including information classified as 'top secret.' In the CNSA mode, the appliance uses only TLS 1.2 protocol and a CNSA-strength subset of the TLS 1.2 ciphers. Similarly, SSH and SNMP communication uses CNSA-compliant ciphers and algorithms. For additional information, see the CNSA standards site (https://www.iad.gov/iad/programs/iad-initiatives/cnsa-suite.cfm). This website uses a US Government Certificate Authority-signed certificate which is not present, by default, in most browser trust stores. See Establishing Site Trust (https://www.iad.gov/NSCAP/warnings.cfm) for more information on establishing trust with this website. NOTE: In HPE OneView releases prior to version 4.0, local user passwords are hashed using SHA256. Starting with release version 4.0, the first time the user logs in, irrespective of the appliance cryptography mode, the password gets rehashed and stored as SHA384. When the iLO of a managed server is in the CNSA mode, the iLO user interface or console is not accessible from HPE OneView console user interface. For a complete list of ciphers and algorithms supported in the legacy, FIPS and CNSA modes, see Algorithm and ciphers for securing the appliance in the HPE OneView User Guide available on the Hewlett Packard Enterprise Information Library. The installation scenarios and the default behavior during a mode switch are: * Fresh installation - The appliance defaults to the legacy mode. * Upgrade - Cryptography mode of the appliance prior to upgrade is retained after the upgrade. For an appliance upgraded from a release that did not support cryptography modes, the appliance is configured to be in legacy mode after the upgrade. * Factory reset - A factory reset or the Preserve network settings option does not change the cryptography mode. The cryptography mode of the appliance prior to the reset is retained. Verify that the Cryptography setting is set to required mode in the Security settings panel. * Backup and restore - A restore operation restores the appliance to the same cryptography mode as the backed up appliance. For HPE OneView to operate in FIPS or CNSA mode, it is not required that all systems or devices that are managed or monitored by HPE OneView (for example, blade ILO) or the external servers that communicate with HPE OneView (for example, MicroSoft Active Directory Server) also operate in FIPS or CNSA-approved mode only. However, HPE OneView must be abl e to communicate with these managed or monitored devices and external servers with the protocols and cipher suites supported by the chosen mode. For example, as long as a device supports FIPS-compliant TLS protocols, ciphers and certificates, HPE OneView in FIPS or CNSA modes can manage that device. For information on the support for various devices and supported cryptography modes, see the HPE OneView Support Matrix on the Hewlett Packard Enterprise Information Library. Additionally, using a higher mode of cryptography requires that you use stronger certificates for all TLS communications. For example, in the CNSA mode, managed devices using RSA certificates need a minimum key length of 3072 bits and a digital signature using SHA-384 or greater. Not all devices that HPE OneView manages or monitors support these stronger cryptography modes. Some examples are: * ProLiant Gen 6 systems have iLO versions that only support TLS 1.0. These servers are not supported when the appliance is in the FIPS or CNSA modes. * Gen7 systems have iLO versions that only support TLS 1.0 and 1.1. These servers are not supported when the appliance is in the CNSA mode. * ProLiant Gen8 systems have iLO versions that support TLS 1.1 and 1.2, and are compatible with both FIPS and CNSAmodes. When opting for a higher security mode, use the Show-HPOVApplianceSecurityModeCompatibilityReport Cmdlet to generate a Compatibility report to get a complete report of any currently managed or monitored devices that are not compatible with the target mode. NOTE: Changing the cryptography mode might regenerate the web server or RabbitMQ certificates. The newly generated RabbitMQ client certificate, along with the CA and key pair, must be applied to the RabbitMQ client. When using CA-signed certificates you might need to issue a new certificate signing request (CSR), obtain a stronger certificate and re-import the certificate into your appliance. Check the compatibility report for details. The appliance automatically reboots as part of configuring the appliance in a different cryptographic mode. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceAvailableSecurityMode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ModeName</maml:name> <maml:description> <maml:para>The name of the mode to return. Allowed values: * Legacy * FIPS * CNSA Default: Return all available security modes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ModeName</maml:name> <maml:description> <maml:para>The name of the mode to return. Allowed values: * Legacy * FIPS * CNSA Default: Return all available security modes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The available appliance security mode, including which mode is set as the current value.</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>Get-HPOVApplianceAvailableSecurityMode</dev:code> <dev:remarks> <dev:para>Return all available security modes on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA</dev:code> <dev:remarks> <dev:para>Return the CNSA available security mode on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCECERTIFICATESTATUS--> <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"> <!--GET-HPOVAPPLIANCECERTIFICATESTATUS--> <command:details> <command:name>Get-HPOVApplianceCertificateStatus</command:name> <maml:description> <maml:para>Get the appliance SSL certificate status.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceCertificateStatus</command:noun> </command:details> <maml:description> <maml:para>HPE OneView uses HTTPS to communicate with managed devices and remote servers. HTTPS is based on Transport Layer Security (TLS). HTTPS and TLS offer the following benefits: * Confidentiality: Data is encrypted on the wire using symmetric key cryptography. * Message integrity: Secure hash functions guarantee integrity. * Authentication: HPE OneView authenticates the remote end point of the HTTPS connection. Public key cryptography is used to authenticate HTTPS and TLS. The certificate that gets generated by default on a newly installed appliance is an RSA certificate. Currently, only RSA certificates are supported for the appliance certificate. Public key cryptography uses public and private key pairs to encrypt and decrypt data. In a public key system, digital certificates certify the ownership of the public key. Digital certificates also certify the allowed usage of that key (for example, digital signatures, certificate signing, encryption). HPE OneView supports the use of both self signed certificates and certificate authority issued (CA) certificates in a formal public key infrastructure (PKI). This Cmdlet will return the appliance HTTPS certificate. The certificate can then be examined for validity, or to import the public certificate into a certificate trust store. Minimum required privileges: No minimum required</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceCertificateStatus</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ApplianceSslCertificateStatus [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Formatted table display of the SSL Certificate object.</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>Get-HPOVApplianceCertificateStatus</dev:code> <dev:remarks> <dev:para>Returns appliance certificate status.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCECURRENTSECURITYMODE--> <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"> <!--GET-HPOVAPPLIANCECURRENTSECURITYMODE--> <command:details> <command:name>Get-HPOVApplianceCurrentSecurityMode</command:name> <maml:description> <maml:para>Get the appliance current security mode.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceCurrentSecurityMode</command:noun> </command:details> <maml:description> <maml:para>HPE OneView allows you to change the Cryptography Settings of a specific appliance. These setting modes change the available cryptography algorithms, allowed ciphers and disabling unsecure protocols. Available cryptography modes include: * Legacy - This is the default cryptography mode. In the legacy mode all TLS protocol versions (1.0, 1.1, and 1.2) and associated cipher suites for those versions are supported. TLS certificates are not required to have FIPS or CNSA minimum key lengths nor strong digital signatures. * FIPS - Federal Information Processing Standard (FIPS) Publication 140-2 is a U.S. government computer security standard for products performing cryptography. The FIPS 140-2 Cryptographic Module Validation Program has validated the cryptography libraries of HPE OneView. When in the FIPS mode: * The cryptographic modules of the appliance are configured to operate in accordance with the FIPS 140-2 level 1 specification. This setting ensures that the required FIPS self-tests are run while loading these cryptographic modules. * The ciphers and algorithms used for cryptographic operations by the appliance are restricted to only those approved by FIPS. * The appliance allows only TLS1.1 and TLS 1.2 protocols for all TLS communications * All SSH and SNMPv3 communication use only cipher suites and algorithms approved by FIPS. * For additional information, see the FIPS-140 site. * CNSA - The Commercial National Security Algorithm (CNSA) cryptography mode restricts HPE OneView to use only those algorithms included in the CNSA suite. The CNSA suite is a subset of the general FIPS support and includes a set of algorithms used to protect national security systems, including information classified as 'top secret.' In the CNSA mode, the appliance uses only TLS 1.2 protocol and a CNSA-strength subset of the TLS 1.2 ciphers. Similarly, SSH and SNMP communication uses CNSA-compliant ciphers and algorithms. For additional information, see the CNSA standards site (https://www.iad.gov/iad/programs/iad-initiatives/cnsa-suite.cfm). This website uses a US Government Certificate Authority-signed certificate which is not present, by default, in most browser trust stores. See Establishing Site Trust (https://www.iad.gov/NSCAP/warnings.cfm) for more information on establishing trust with this website. NOTE: In HPE OneView releases prior to version 4.0, local user passwords are hashed using SHA256. Starting with release version 4.0, the first time the user logs in, irrespective of the appliance cryptography mode, the password gets rehashed and stored as SHA384. When the iLO of a managed server is in the CNSA mode, the iLO user interface or console is not accessible from HPE OneView console user interface. For a complete list of ciphers and algorithms supported in the legacy, FIPS and CNSA modes, see Algorithm and ciphers for securing the appliance in the HPE OneView User Guide available on the Hewlett Packard Enterprise Information Library. The installation scenarios and the default behavior during a mode switch are: * Fresh installation - The appliance defaults to the legacy mode. * Upgrade - Cryptography mode of the appliance prior to upgrade is retained after the upgrade. For an appliance upgraded from a release that did not support cryptography modes, the appliance is configured to be in legacy mode after the upgrade. * Factory reset - A factory reset or the Preserve network settings option does not change the cryptography mode. The cryptography mode of the appliance prior to the reset is retained. Verify that the Cryptography setting is set to required mode in the Security settings panel. * Backup and restore - A restore operation restores the appliance to the same cryptography mode as the backed up appliance. For HPE OneView to operate in FIPS or CNSA mode, it is not required that all systems or devices that are managed or monitored by HPE OneView (for example, blade ILO) or the external servers that communicate with HPE OneView (for example, MicroSoft Active Directory Server) also operate in FIPS or CNSA-approved mode only. However, HPE OneView must be abl e to communicate with these managed or monitored devices and external servers with the protocols and cipher suites supported by the chosen mode. For example, as long as a device supports FIPS-compliant TLS protocols, ciphers and certificates, HPE OneView in FIPS or CNSA modes can manage that device. For information on the support for various devices and supported cryptography modes, see the HPE OneView Support Matrix on the Hewlett Packard Enterprise Information Library. Additionally, using a higher mode of cryptography requires that you use stronger certificates for all TLS communications. For example, in the CNSA mode, managed devices using RSA certificates need a minimum key length of 3072 bits and a digital signature using SHA-384 or greater. Not all devices that HPE OneView manages or monitors support these stronger cryptography modes. Some examples are: * ProLiant Gen 6 systems have iLO versions that only support TLS 1.0. These servers are not supported when the appliance is in the FIPS or CNSA modes. * Gen7 systems have iLO versions that only support TLS 1.0 and 1.1. These servers are not supported when the appliance is in the CNSA mode. * ProLiant Gen8 systems have iLO versions that support TLS 1.1 and 1.2, and are compatible with both FIPS and CNSAmodes. When opting for a higher security mode, use the Show-HPOVApplianceSecurityModeCompatibilityReport Cmdlet to generate a Compatibility report to get a complete report of any currently managed or monitored devices that are not compatible with the target mode. NOTE: Changing the cryptography mode might regenerate the web server or RabbitMQ certificates. The newly generated RabbitMQ client certificate, along with the CA and key pair, must be applied to the RabbitMQ client. When using CA-signed certificates you might need to issue a new certificate signing request (CSR), obtain a stronger certificate and re-import the certificate into your appliance. Check the compatibility report for details. The appliance automatically reboots as part of configuring the appliance in a different cryptographic mode. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceCurrentSecurityMode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current appliance security mode.</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>Get-HPOVApplianceCurrentSecurityMode</dev:code> <dev:remarks> <dev:para>Get the appliances current security mode.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAvailableSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <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"> <!--GET-HPOVAPPLIANCEDATAATRESTENCRYPTION--> <command:details> <command:name>Get-HPOVApplianceDataAtRestEncryption</command:name> <maml:description> <maml:para>Get the appliance configured data at rest encryption state.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceDataAtRestEncryption</command:noun> </command:details> <maml:description> <maml:para>HPE OneView encrypts sensitive data, such as managed device credentials, when it is stored on-disk in the appliance. The HPE OneView appliance encryption key (AEK) is used internally to encrypt the credentials for managed devices (such as, iLO, onboard administrator, frame link module). By default, the AEK is stored on the HPE Synergy Composer disk and also included in the appliance backup. This could pose a security risk in case the disk is stolen. The secure data-at-rest option, when enabled, stores the AEK off-disk in Composer NVRAM, and does not include the keyin the appliance backup. Enabling this option requires the administrator to save a copy of the AEK (recovery AEK) for use in the following circumstances: * When restoring a backup taken when a different AEK was in effect. * To successfully boot the system in the unlikely event that the system copy of the key is corrupted. * A backup is being restored to a different new Composer or to the same Composer that has been factory reset. The administrator must store the recovery AEK in a secure location, where it can be only accessed by authorized personnel. In the rare circumstance where the key cannot be read from the Composer NVRAM or the key gets corrupted, the administrator must use the appliance maintenance console to upload the AEK recovery copy, based on the error resolution message displayed. In the rare circumstance where the Composer NVRAM itself becomes inaccessible, users can choose to disable secure-data-at-rest option until the hardware issue itself is resolved. If the downloaded recovery key and the AEK stored in the Composer NVRAM are both lost, the appliance data cannot be recovered. Using this Cmdlet will get the data at rest encryption current configuration from supported HPE Synergy Composer appliances. Minimum required privileges: Infrastructure administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceDataAtRestEncryption</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>THe data at rest encryption configuration state of the appliance.</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>Get-HPOVApplianceDataAtRestEncryption</dev:code> <dev:remarks> <dev:para>Get the appliance data at rest encryption state.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEDATETIME--> <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"> <!--GET-HPOVAPPLIANCEDATETIME--> <command:details> <command:name>Get-HPOVApplianceDateTime</command:name> <maml:description> <maml:para>Get Appliance Date/Time Configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceDateTime</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet displays the appliance or connected appliances Date and Time configuration. Part of this is the actual Date and Time of the appliance, Time Zone, NTP Servers, NTP polling, and Locale. When querying a Virtual Machine Appliance and the NTPServersproperty or field is Null, the appliance will retrieve its Date and Time from the Hypervisor Host. When querying a Synergy Composer appliance and the NTPServersproperty or field is Null, the appliance will retrieve its Date and Time from the System ROM. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceDateTime</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ApplianceServerDateTime [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Date/Time object.</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>Get-HPOVApplianceDateTime Appliance Time Time Zone NTP Servers NTP Polling --------- ---- --------- ----------- ----------- hpov1.domain.com 2/11/2016 2:12:46 PM UTC {10.55.1.1,10.54.1.1} hpov2.domain.com 2/11/2016 2:12:45 PM UTC {}</dev:code> <dev:remarks> <dev:para>This example passes in updated values to set for the appliance networking configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEGLOBALSETTING--> <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"> <!--GET-HPOVAPPLIANCEGLOBALSETTING--> <command:details> <command:name>Get-HPOVApplianceGlobalSetting</command:name> <maml:description> <maml:para>(Reserved for future use) Retrieve appliance global settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceGlobalSetting</command:noun> </command:details> <maml:description> <maml:para>(Reserved for future use) Retrieves the list of global settings or a specific global setting by name.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceGlobalSetting</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the global setting to be retrieved.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the global setting to be retrieved.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name, value, description, and uri for the global setting(s)</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>Get-HPOVApplianceGlobalSetting</dev:code> <dev:remarks> <dev:para>Return appliance Global Settings and their values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCENETWORKCONFIG--> <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"> <!--GET-HPOVAPPLIANCENETWORKCONFIG--> <command:details> <command:name>Get-HPOVApplianceNetworkConfig</command:name> <maml:description> <maml:para>Retrieves the configuration of the primary NIC of the appliance</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceNetworkConfig</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will return the appliance network settings configuration parameters of the primary network interface on the appliance, which can be captured into a customer object for further operation, or captured to a text file in JSON format. NOTE: Any time the IP address or hostname of the appliance changes, any CA-signed appliance certificate associated with the appliance is erased, and a new self signed appliance certificate is generated. In this case, you must generate a new Certificate Signing Request (CSR), have it signed by a CA, and import it into the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceNetworkConfig</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Location</maml:name> <maml:description> <maml:para>Directory to where the appliance network configuration will be exported to. Exported file name will be "{$ApplianceConnection.Name}_ApplianceNetConf.json".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="x, export, exportFile"> <maml:name>Location</maml:name> <maml:description> <maml:para>Directory to where the appliance network configuration will be exported to. Exported file name will be "{$ApplianceConnection.Name}_ApplianceNetConf.json".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ApplianceServerConfiguration [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A collection object containing the properties and values of the primary network interface of the appliance.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ApplianceServerConfiguration.ApplianceNetworks [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The applianceNetworks property will display the appliance Networking in either a Format-Table (default) or Format-List view.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.IO.FileSystemInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If exporting the appliance network configuration, the file object created will be returned.</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>Get-HPOVApplianceNetworkConfig Hostname IPv4Type IPv4Address IPv4DNS IPv6Type IPv6Address IPv6DNS -------- -------- ----------- ------- -------- ----------- ------- hpov1.domain.com STATIC 172.20.51.4\24 {172.20.10.41, 172.20.10.42} UNCONFIGURE {} hpov2.domain.com STATIC 172.20.52.4\24 {172.20.10.41, 172.20.10.42} UNCONFIGURE {}</dev:code> <dev:remarks> <dev:para>Outputs the configuration of the primary network interface to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com | fl Hostname : hpov1.domain.com IPv4Type : STATIC IPv4Address : 172.20.51.4 IPv4Mask : 255.255.255.0 IPv4Gateway : 172.20.51.1 IPv4DNS : {172.20.10.41, 172.20.10.42} IPv6Type : UNCONFIGURE IPv6Address : IPv6Mask : IPv6Gateway : IPv6DNS : {}</dev:code> <dev:remarks> <dev:para>Outputs the configuration of the primary network interface and pipe to Format-List for more information about the network configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myAppNetConfig = Get-HPOVApplianceNetworkConfig -Appliance hpov1.domain.com</dev:code> <dev:remarks> <dev:para>Outputs the configuration of the primary network interface of the appliance to the object variable $myAppNetConfig</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceNetworkConfig -Location .</dev:code> <dev:remarks> <dev:para>Outputs the configuration of the primary network interface of the appliance to the current directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCEPROXY--> <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"> <!--GET-HPOVAPPLIANCEPROXY--> <command:details> <command:name>Get-HPOVApplianceProxy</command:name> <maml:description> <maml:para>Get appliance configured HTTP proxy.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceProxy</command:noun> </command:details> <maml:description> <maml:para>The setting an appliance proxy allows you to set the HTTP/HTTPS proxy, port number for client connections, and whether authentication requires a username and a password. The appliance HTTP or HTTPS proxy configuration is used for HPE OneView Remote Support, and HPE OneView Remote Technician. This Cmdlet will return the configured appliance HTTP/HTTPS proxy configuration. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceProxy</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ProxyServer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance proxy server settings.</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>Get-HPOVApplianceProxy</dev:code> <dev:remarks> <dev:para>Get the appliance configured HTTP/HTTPS proxy configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCESECURITYPROTOCOL--> <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"> <!--GET-HPOVAPPLIANCESECURITYPROTOCOL--> <command:details> <command:name>Get-HPOVApplianceSecurityProtocol</command:name> <maml:description> <maml:para>Get appliance supported security protocols and ciphers.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceSecurityProtocol</command:noun> </command:details> <maml:description> <maml:para>Get the appliance available security protocols, and their active state. By default the appliance current security mode will return the available security protocols and their configuration state. Use the -SecurityMode parameter to specify one or more modes. Use the -TlsVersion to specify one or more security protocols to return. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceSecurityProtocol</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TlsVersion</maml:name> <maml:description> <maml:para>Filter for specific TLS version(s). By default, will return all TLS Versions. Allowed values: * TLSv1 TLSv1.1 TLSv1.2</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecurityMode</maml:name> <maml:description> <maml:para>Specify the Security Mode to return supported security protocols and encryption ciphers. By default, will return the current appliance security mode. Allowed values: * Legacy * FIPS *CNSA</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecurityMode</maml:name> <maml:description> <maml:para>Specify the Security Mode to return supported security protocols and encryption ciphers. By default, will return the current appliance security mode. Allowed values: * Legacy * FIPS *CNSA</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TlsVersion</maml:name> <maml:description> <maml:para>Filter for specific TLS version(s). By default, will return all TLS Versions. Allowed values: * TLSv1 TLSv1.1 TLSv1.2</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityProtocol</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Available appliance security protocol, mode enabled and associated encryption ciphers.n</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>Get-HPOVApplianceSecurityProtocol</dev:code> <dev:remarks> <dev:para>Get the appliance FIPS security mode and associated security protocols.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceSecurityProtocol -SecurityMode FIPS, CNSA -TlsVersion TLSv1.1, TLSv1.2</dev:code> <dev:remarks> <dev:para>Get the appliance FIPS security mode and TLSv1.1 and TLSv1.2 security protocols.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCESERVICECONSOLEACCESS--> <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"> <!--GET-HPOVAPPLIANCESERVICECONSOLEACCESS--> <command:details> <command:name>Get-HPOVApplianceServiceConsoleAccess</command:name> <maml:description> <maml:para>Get the appliance service console access configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceServiceConsoleAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView contains a technical feature that you can use to allow an authorized technical support to access your system, through the system console, to assess and troubleshoot problems that you have reported. This access is controlled by a password generated and provided by you to the authorized technical support. You can disable the access at any time while the system is running. Hewlett Packard Enterprise recommends that you enable service console access so that an authorized technical support can diagnose your system in the event of a system failure. This Cmdlet will return the existing configuration state of the appliance service console. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceServiceConsoleAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ServiceConsoleAccess</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current service console configuration status.</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>Get-HPOVApplianceServiceConsoleAccess</dev:code> <dev:remarks> <dev:para>Get the service console access status.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCESNMPV3ENGINEID--> <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"> <!--GET-HPOVAPPLIANCESNMPV3ENGINEID--> <command:details> <command:name>Get-HPOVApplianceSnmpV3EngineId</command:name> <maml:description> <maml:para>Get appliance SNMPv3 Engine ID.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceSnmpV3EngineId</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers, enclosures, and Synergy compute modules to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Additionally, HPE OneView will also send alerts received from a Synergy Frame Link Module (FLM) as SNMPv1 or SNMPv3 traps to the configured destinations. Use this Cmdlet to get the appliance SNMPv3 Engine ID that is automatically generated upon first time boot of the appliance, or configured by an Infrastructure Administrator. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceSnmpV3EngineId</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3EngineId</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 Engine ID.</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>Get-HPOVApplianceSnmpV3EngineId</dev:code> <dev:remarks> <dev:para>Get the SNMPv3 Engine ID of the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCESSHACCESS--> <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"> <!--GET-HPOVAPPLIANCESSHACCESS--> <command:details> <command:name>Get-HPOVApplianceSshAccess</command:name> <maml:description> <maml:para>Get the current SSH console access state.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceSshAccess</command:noun> </command:details> <maml:description> <maml:para>HPE OneView supports Secure Shell (SSH) to remotely access the appliance to perform maintenance and recovery operations. Without SSH access, you must access the virtual machine system console. To avoid requiring a console access, SSH access is enabled by default. However, remote access to maintenance and recovery operations is considered a security risk by some users. Therefore, HPE OneView provides the option to disable remote access to the appliance via SSH. Use this Cmdlet to enable appliance SSH access. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceSshAccess</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SshAccess</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured state of the appliance SSH console.</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>Get-HPOVApplianceSshAccess</dev:code> <dev:remarks> <dev:para>Get the current state of the appliance SSH console.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCETRAPDESTINATION--> <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"> <!--GET-HPOVAPPLIANCETRAPDESTINATION--> <command:details> <command:name>Get-HPOVApplianceTrapDestination</command:name> <maml:description> <maml:para>Get configured appliance SNMP trap destinations.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceTrapDestination</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers, enclosures, and Synergy compute modules to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Additionally, HPE OneView will also send alerts received from a Synergy Frame Link Module (FLM) as SNMPv1 or SNMPv3 traps to the configured destinations. Use this Cmdlet to retrieve configured SNMPv1 and/or SNMPv3 appliance trap destinations, configured by an Infrastructure Administrator. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceTrapDestination</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Filter trap destinations by the destination value. Supports wildcard.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter based on SNMP version. Supported values: * SNMPv1 *SNMPv3</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Filter trap destinations by the destination value. Supports wildcard.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter based on SNMP version. Supported values: * SNMPv1 *SNMPv3</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV1TrapDestination</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance SNMPv1 trap destination, including trap community and target.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3TrapDestination</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 trap destination, including type, SNMPv3 user and target.</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>Get-HPOVApplianceTrapDestination</dev:code> <dev:remarks> <dev:para>Get trap destinations from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceTrapDestination -Destination 172.17.8.8</dev:code> <dev:remarks> <dev:para>Get the specific appliance trap destination.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <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"> <!--GET-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <command:details> <command:name>Get-HPOVApplianceTrustedCertificate</command:name> <maml:description> <maml:para>Get X.509 SSL certificates from the appliace trusted store.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceTrustedCertificate</command:noun> </command:details> <maml:description> <maml:para>HPE OneView uses HTTPS to communicate with managed devices and remote servers. HTTPS is based on Transport Layer Security (TLS). HTTPS and TLS offer the following benefits: * Confidentiality: Data is encrypted on the wire using symmetric key cryptography. * Message integrity: Secure hash functions guarantee integrity. * Authentication: HPE OneView authenticates the remote end point of the HTTPS connection. Public key cryptography is used to authenticate HTTPS and TLS. The certificate that gets generated by default on a newly installed appliance is an RSA certificate. Currently, only RSA certificates are supported for the appliance certificate. Public key cryptography uses public and private key pairs to encrypt and decrypt data. In a public key system, digital certificates certify the ownership of the public key. Digital certificates also certify the allowed usage of that key (for example, digital signatures, certificate signing, encryption). HPE OneView supports the use of both self signed certificates and certificate authority issued (CA) certificates in a formal public key infrastructure (PKI). This Cmdlet will get X.509 compliant certificates and/or certificate authority trusted certificates an Infrastructure Administrator or other administrator who has added a trusted device from the appliance trusted store. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceTrustedCertificate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Alias Name of the certificate. Please know that wildcard is not supported.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CertificateAuthoritiesOnly</maml:name> <maml:description> <maml:para>This parameter will filter for trusted certificate authorities only.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Resource, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVApplianceTrustedCertificate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide an HPOneView.ServerHardware or HPOneView.Enclosure resource to return associated appliance trusted certificate(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Resource, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Resource, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="CASOnly"> <maml:name>CertificateAuthoritiesOnly</maml:name> <maml:description> <maml:para>This parameter will filter for trusted certificate authorities only.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Resource" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide an HPOneView.ServerHardware or HPOneView.Enclosure resource to return associated appliance trusted certificate(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Alias Name of the certificate. Please know that wildcard is not supported.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware</maml:name> </dev:type> <maml:description> <maml:para>Server hardware resource from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure</maml:name> </dev:type> <maml:description> <maml:para>Enclosure resource from Get-HPOVEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TrustedCertificate</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance trusted certificate object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TrustedCertificateAuthority</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance trusted certificate authority object.</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>Get-HPOVApplianceTrustedCertificate</dev:code> <dev:remarks> <dev:para>Return all trusted certificates from the appliance trusted store.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name MyServer.domain.com -ErrorAction SilentlyContinue | Get-HPOVApplianceTrustedCertificate</dev:code> <dev:remarks> <dev:para>Return the trusted certificate of the provided server hardware resource in the appliance trusted store.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <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"> <!--GET-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <command:details> <command:name>Get-HPOVApplianceTwoFactorAuthentication</command:name> <maml:description> <maml:para>Get appliance two-factor configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVApplianceTwoFactorAuthentication</command:noun> </command:details> <maml:description> <maml:para>Enabling two-factor authentication allows you to use smart cards - for example, Common Access Cards (CAC), or Personal Identity Verification (PIV) cards - to authenticate within HPE OneView. The client certificate embedded in the smart card is presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority (CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in HPE OneView. When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned by the user to access an Active Directory entry for the user, rather than using an account associated with the user name received during first time login. Use this Cmdlet to get two factor authentication state of the connected appliance. Infrastructure administrator role is required. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVApplianceTwoFactorAuthentication</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Security.TwoFactorAuthConfiguration</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance two-factor security settings.</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>Get-HPOVApplianceTwoFactorAuthentication</dev:code> <dev:remarks> <dev:para>Get the appliance two-factor authentication configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAUDITLOG--> <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"> <!--GET-HPOVAUDITLOG--> <command:details> <command:name>Get-HPOVAuditLog</command:name> <maml:description> <maml:para>Get appliance audit log entries.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAuditLog</command:noun> </command:details> <maml:description> <maml:para>The audit log contains a record of actions performed on the appliance, which you can use for individual accountability. Because the logs are rolled over periodically to prevent them from getting too large, Hewlett Packard Enterprise recommends downloading the audit logs to monitor the actions being performed. You can also download the audit logs periodically to maintain a long-term audit history. Each user has a unique logging ID per session, enabling you to follow a user?s trail in the audit log. Some actions are performed by the appliance and might not have a logging ID. A breakdown of an audit entry follows: * Date/time - The date and time of the event * Internal component ID - The unique identifier of an internal component * Reserved - The organization ID. Reserved for internal use * User domain - The login domain name of the user * User name/ID - The user name * Session ID - The user session ID associated with the message * Task ID - The URI of the task resource associated with the message * Client host/IP - The client (browser) IP address identifies the client machine that initiated the request * Result - The result of the action, which can be one of the following values: * SUCCESS * FAILURE * SOME_FAILURES * CANCELED * KILLED * Action - A description of the action, which can be one of the following values: * ADD * MODIFY * DELETE * ACCESS * RUN * LIST * ENABLE * DISABLE * SAVE * SETUP * UNSETUP * DEPLOY * START * DONE * KILLED * CANCELED * LOGIN * LOGOUT * DOWNLOAD_START * Severity - A description of the severity of the event, which can be one of the following values, listed in descending order of importance: * INFO * NOTICE * WARNING * ERROR * ALERT * CRITICAL * Resource category - For REST API category information, see the HPE OneView API Reference. * Resource URI/name - The resource URI/name associated with the task * Message - The output message that appears in the audit log The audit log includes entries for all Maintenance console events except for viewing. Use this Cmdlet to retrieve appliance audit log entries. Audit log entries can be filtered based on number of entries to return, and a date range. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAuditLog</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVAuditLog</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the number of audit log entries to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specify the time span of to filter results on. Cannot be combined with Start or End.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Timespan</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Start</maml:name> <maml:description> <maml:para>Specify the Start datetime object to begin the search. Can be combined with End parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>End</maml:name> <maml:description> <maml:para>Specify the End datetime object to begin the search. Should be combined with Start parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the number of audit log entries to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>End</maml:name> <maml:description> <maml:para>Specify the End datetime object to begin the search. Should be combined with Start parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue>[DateTime]::Now</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>Specify the Start datetime object to begin the search. Can be combined with End parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specify the time span of to filter results on. Cannot be combined with Start or End.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Timespan</command:parameterValue> <dev:type> <maml:name>Timespan</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuditLogEntry [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Appliance Audit Log Entry</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Appliance Audit Log Entries</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>Get-HPOVAuditLog Appliance : hpov.mydomain.com Date : 2015-10-05 18:14:17.679 UTC Source : AUTHENTICATION Action : LOGIN Result : SUCCESS Severity : INFO Details : Login Message Acknowledgment is "false". Source IP : 172.20.253.1 Appliance : hpov.mydomain.com Date : 2015-10-05 18:14:17.761 UTC Source : AUTHENTICATION Action : LOGIN Result : SUCCESS Severity : INFO Details : Authentication SUCCESS. User "Administrator" logged in successfully from client "172.20.253.1" and directory "LOCAL" on server "". [logID:LTY4ODgyMTcyMTMz] Source IP : 172.20.253.1 Appliance : hpov.mydomain.com Date : 2015-10-05 20:51:45.754 UTC Source : firmware-drivers Action : ADD Result : SUCCESS Severity : INFO Details : Add firmware bundle /rest/firmware-drivers/CP026527</dev:code> <dev:remarks> <dev:para>Return the audit logs from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAuditLog -Start ([DateTime]::Now).AddDays("-5")</dev:code> <dev:remarks> <dev:para>Return the audit logs from the appliance from 5 days ago from today.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAuditLogArchive</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAUDITLOGARCHIVE--> <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"> <!--GET-HPOVAUDITLOGARCHIVE--> <command:details> <command:name>Get-HPOVAuditLogArchive</command:name> <maml:description> <maml:para>Download archive of appliance audit logs.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAuditLogArchive</command:noun> </command:details> <maml:description> <maml:para>The audit log contains a record of actions performed on the appliance, which you can use for individual accountability. Because the logs are rolled over periodically to prevent them from getting too large, Hewlett Packard Enterprise recommends downloading the audit logs to monitor the actions being performed. You can also download the audit logs periodically to maintain a long-term audit history. Each user has a unique logging ID per session, enabling you to follow a user?s trail in the audit log. Some actions are performed by the appliance and might not have a logging ID. A breakdown of an audit entry follows: * Date/time - The date and time of the event * Internal component ID - The unique identifier of an internal component * Reserved - The organization ID. Reserved for internal use * User domain - The login domain name of the user * User name/ID - The user name * Session ID - The user session ID associated with the message * Task ID - The URI of the task resource associated with the message * Client host/IP - The client (browser) IP address identifies the client machine that initiated the request * Result - The result of the action, which can be one of the following values: * SUCCESS * FAILURE * SOME_FAILURES * CANCELED * KILLED * Action - A description of the action, which can be one of the following values: * ADD * MODIFY * DELETE * ACCESS * RUN * LIST * ENABLE * DISABLE * SAVE * SETUP * UNSETUP * DEPLOY * START * DONE * KILLED * CANCELED * LOGIN * LOGOUT * DOWNLOAD_START * Severity - A description of the severity of the event, which can be one of the following values, listed in descending order of importance: * INFO * NOTICE * WARNING * ERROR * ALERT * CRITICAL * Resource category - For REST API category information, see the HPE OneView API Reference. * Resource URI/name - The resource URI/name associated with the task * Message - The output message that appears in the audit log The audit log includes entries for all Maintenance console events except for viewing. Use this Cmdlet to retrieve appliance audit log archive, which contains all available audit log entries, in ZIP format. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAuditLogArchive</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>The full path to where the audit log will be saved to. If omitted, current directory location will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.DirectoryInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>One or more Appliance Connection Objects, Connection ID, or Connection Name. If omitted, all connected appliances will be processed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>One or more Appliance Connection Objects, Connection ID, or Connection Name. If omitted, all connected appliances will be processed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>The full path to where the audit log will be saved to. If omitted, current directory location will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.DirectoryInfo</command:parameterValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> </dev:type> <dev:defaultValue>(get-location).Path</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The generated audit log File</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>Get-HPOVAuditLogArchive -Location C:\Temp</dev:code> <dev:remarks> <dev:para>Save the Appliance audit log archive to C:\Temp</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAuditLog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAUTOMATICBACKUPCONFIG--> <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"> <!--GET-HPOVAUTOMATICBACKUPCONFIG--> <command:details> <command:name>Get-HPOVAutomaticBackupConfig</command:name> <maml:description> <maml:para>Retrieve automatic appliance backup configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAutomaticBackupConfig</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure. The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file. This Cmdlet will get the automatic backup configuration from the connected appliance(s). Use Set-HPOVAutomaticBackupConfig to set a new automatic backup policy for the appliance(s). Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAutomaticBackupConfig</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AutomaticBackupConfig [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance automatic backup configuration object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Arraylist <HPOneView.Appliance.AutomaticBackupConfig></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple appliance automatic backup configuration objects.</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>Get-HPOVAutomaticBackupConfig Appliance Enabled Server Protocol Directory Interval Days Time --------- ------- ------ -------- --------- -------- ---- ---- Appliance True scphost.domain.com SCP WEEKLY {MO, WE, FR} 18:00</dev:code> <dev:remarks> <dev:para>Get the configured automatic backup setting of the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVAutomaticBackupConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVAVAILABLEDRIVETYPE--> <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"> <!--GET-HPOVAVAILABLEDRIVETYPE--> <command:details> <command:name>Get-HPOVAvailableDriveType</command:name> <maml:description> <maml:para>Return a collection of available D3940 disks.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVAvailableDriveType</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet will return a collection of available disk drives from a specified SAS Logical Interconnect or Drive Enclosure. The returned value will contain available quantity of drives based on interface, media type and capacity, organized by SAS Logical Interconnect. The object can then be used to define the drive selection criteria for New-HPOVServerProfileLogicalDisk using the -AvailableDriveType parameter. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVAvailableDriveType</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A SAS Logical Interconnect or D3940 Drive Enclosure resource. If providing a SAS Logical Interconnect, the Cmdlet will automatically locate the available drive enclosures.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A SAS Logical Interconnect or D3940 Drive Enclosure resource. If providing a SAS Logical Interconnect, the Cmdlet will automatically locate the available drive enclosures.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.SASLogicalInterconnect</maml:name> </dev:type> <maml:description> <maml:para>A SAS Logical Interconnect resource from Get-HPOVSasLogicalInterconnect Cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.DiskEnclosure</maml:name> </dev:type> <maml:description> <maml:para>A D3940 Drive Enclosure from Get-HPOVSasLogicalInterconnect Cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.AvailableDriveType</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A disk type object that defines available quantity of drives based on interface, media type and capacity, organized by SAS Logical Interconnect.</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>Get-HPOVSasLogicalInterconnect | Get-HPOVAvailableDriveType</dev:code> <dev:remarks> <dev:para>Return all available disk drives from all SAS Logical Interconnects.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | Get-HPOVAvailableDriveType</dev:code> <dev:remarks> <dev:para>Return all available disk drives from the specific SAS Logical Interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVDriveEnclosure -Name "EnclosureName, Bay 1" -ErrorAction Stop | Get-HPOVAvailableDriveType</dev:code> <dev:remarks> <dev:para>Return all available disk drives from the specific D3940 Drive Enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVBACKUP--> <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"> <!--GET-HPOVBACKUP--> <command:details> <command:name>Get-HPOVBackup</command:name> <maml:description> <maml:para>List appliance backups.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVBackup</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure. The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file. Use this Cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVBackup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Before</maml:name> <maml:description> <maml:para>Specify the DateTime object of when to locate backups created before.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>After</maml:name> <maml:description> <maml:para>Specify the DateTime object of when to locate backups created after.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>After</maml:name> <maml:description> <maml:para>Specify the DateTime object of when to locate backups created after.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Before</maml:name> <maml:description> <maml:para>Specify the DateTime object of when to locate backups created before.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Backup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Created backup resource from the appliance that was created with New-HPOVBackup. </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>Get-HPOVBackup</dev:code> <dev:remarks> <dev:para>This command will return any appliance backs present on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVBackup -Before [datetime]"2017/01/01"</dev:code> <dev:remarks> <dev:para>This command will return appliance backups that were created before 2017/01/01.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVBASELINE--> <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"> <!--GET-HPOVBASELINE--> <command:details> <command:name>Get-HPOVBaseline</command:name> <maml:description> <maml:para>Retrieve available SPP baseline and hotfix information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVBaseline</command:noun> </command:details> <maml:description> <maml:para>The appliance provides reliable and simplified firmware management across the data center. Using the firmware management features built in to the appliance, you can define firmware baselines and perform firmware updates across many resources. When you add a resource to the appliance, the appliance automatically updates the resource firmware to the minimum version required to be managed by the appliance or version defined to be a baseline. A firmware bundle, also known as an HPE Service Pack for ProLiant (SPP), is a comprehensive collection of firmware and system software components, all tested together as a single solution stack that includes drivers, agents, utilities, and firmware packages. Firmware bundles enable you to update firmware on HPE ProLiant servers, controllers, storage, servers, interconnects, and enclosures. Retrieve the list of SPPs or hotfixes which have been uploaded to the appliance, and their detail. You can examine the included components and their versions reported by the baseline. Please note that any file name that contains the . (period, CHAR46) character will be replaced with _ (underscore, CHAR95). Example: My.Spp.To.Upload.201605.iso will become My_Spp_To_Upload_201605.iso. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVBaseline</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISOFileName"> <maml:name>File</maml:name> <maml:description> <maml:para>The file name of an SPP or hotfix component</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVBaseline</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BaselineName"> <maml:name>SppName</maml:name> <maml:description> <maml:para>The SPP/Baseline or hotfix name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BaselineName"> <maml:name>Version</maml:name> <maml:description> <maml:para>If multiple SPP/Baselines with the same name exist, use the Version parameter to filter to the specific SPP/Baseline version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVBaseline</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly"> <maml:name>HotfixesOnly</maml:name> <maml:description> <maml:para>Display only the available hotfixes present with in the repository.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISOFileName" aliases="isoFileName, FileName"> <maml:name>File</maml:name> <maml:description> <maml:para>The file name of an SPP or hotfix component</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly" aliases="None"> <maml:name>HotfixesOnly</maml:name> <maml:description> <maml:para>Display only the available hotfixes present with in the repository.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HotFixesOnly, BaselineName, ISOFileName" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BaselineName" aliases="name"> <maml:name>SppName</maml:name> <maml:description> <maml:para>The SPP/Baseline or hotfix name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BaselineName" aliases="None"> <maml:name>Version</maml:name> <maml:description> <maml:para>If multiple SPP/Baselines with the same name exist, use the Version parameter to filter to the specific SPP/Baseline version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Baseline</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>SPP baseline resource object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.BaselineHotfix : HPOneView.Appliance.Baseline</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Baseline hotfix resource. Class derived from HPOneView.Appliance.Baseline base class.</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>$sppCollection = Get-HPOVBaseline</dev:code> <dev:remarks> <dev:para>Retrieves all baseline objects from the appliance and stores them in the sppCollection variable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$sppObject = Get-HPOVBaseline -Filename SPP2012060B.2012_0525.1.iso</dev:code> <dev:remarks> <dev:para>Retrieves an baseline object with the filename SPP2012060B.2012_0525.1.iso</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$sppObject = Get-HPOVBaseline -SppName "HP Service Pack for ProLiant"</dev:code> <dev:remarks> <dev:para>Retrieves an baseline object with the SPP Name "HP Service Pack for ProLiant".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVBaselineRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVBaselineRepositorySize</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVBASELINEREPOSITORY--> <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"> <!--GET-HPOVBASELINEREPOSITORY--> <command:details> <command:name>Get-HPOVBaselineRepository</command:name> <maml:description> <maml:para>Retrieve available baseline repository information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVBaselineRepository</command:noun> </command:details> <maml:description> <maml:para>A firmware repository enables you to store firmware file and deploy them across your environment. Selecting a firmware file from the repository displays its release date, supported languages and operating systems, and the file components. The screen also displays the amount of storage space available for additional firmware file on the appliance. You cannot add a firmware file that is larger than the amount of space available in the repository. Two types of repositories are supported: * Internal Repository: The internal embedded firmware repository in an HPE Synergy Composer has a maximum size limit of 12 GB to store and upload firmware files for use by components managed by HPE OneView. NOTE: You cannot add, edit, or remove the internal repository. * External Repository: An additional externally managed HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You can upload firmware file in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This functionality is supported for Linux and Windows systems. The Cmdlet will get the appliance repositories. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVBaselineRepository</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Return the repository with the name or matching name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify "Internal" or "External" to filter the repository type.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Return the repository with the name or matching name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify "Internal" or "External" to filter the repository type.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.BaselineRepository [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Either and Internal or External repository object.</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>$Repositories = Get-HPOVBaselineRepository</dev:code> <dev:remarks> <dev:para>Retrieves all repository objects from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVBaselineRepository -Type External</dev:code> <dev:remarks> <dev:para>Retrieves only the configured external repository on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Show-HPOVBaselineRepositorySize</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVCLUSTERMANAGER--> <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"> <!--GET-HPOVCLUSTERMANAGER--> <command:details> <command:name>Get-HPOVClusterManager</command:name> <maml:description> <maml:para>Get configured hypervisor managers.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVClusterManager</command:noun> </command:details> <maml:description> <maml:para>A hypervisor is software deployed on a server node that creates and runs virtual machines. Hypervisors are clustered to ensure high availability, to optimize resource utilization, and to be fault tolerant. A hypervisor cluster profile enables you to deploy and manage a cluster of hypervisors running on servers managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A hypervisor cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to hypervisors in the cluster. The server profiles define physical server configurations for server nodes in the cluster, which are derived from hypervisor cluster profile and the associated server profile template. The hypervisor profiles define network and storage configurations for hypervisors in the cluster, which are derived from hypervisor cluster profile. Hypervisor network and storage configurations in the hypervisor cluster profile are defined based on physical server configuration to ensure consistent configuration from server node to hypervisor. You can register a hypervisor manager with HPE OneView by using Add-HPOVClusterManager. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences when adding, or using Set-HPOVClusterManager. You can override these values when creating a hypervisor cluster profile. This Cmdlet will get the configured hypervisor cluster manager on the appliance. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVClusterManager</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for vCenter name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Version</maml:name> <maml:description> <maml:para>Filter for specific vCenter version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for vCenter name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Version</maml:name> <maml:description> <maml:para>Filter for specific vCenter version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Cluster.HypervisorManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured hypervisor cluster manager and its properties</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>Get-HPOVClusterManager -Name vcenter.domain.com</dev:code> <dev:remarks> <dev:para>Get the specified hypervisor manager by resource name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVClusterManager -Version 5.5.0</dev:code> <dev:remarks> <dev:para>Get all of the configured hypervisor managers that are vSphere 5.5.0.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVCLUSTERNODE--> <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"> <!--GET-HPOVCLUSTERNODE--> <command:details> <command:name>Get-HPOVClusterNode</command:name> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVClusterNode</command:noun> </command:details> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVClusterNode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Cluster.ClusterNode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A cluster node that is a member of a cluster profile.</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>Get-HPOVClusterNode</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enter-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exit-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVCLUSTERPROFILE--> <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"> <!--GET-HPOVCLUSTERPROFILE--> <command:details> <command:name>Get-HPOVClusterProfile</command:name> <maml:description> <maml:para>Get a deployed cluster profile.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVClusterProfile</command:noun> </command:details> <maml:description> <maml:para>A cluster profile enables you to deploy and manage a cluster of servers (nodes) managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to members in the cluster. The associated server profiles define physical server configurations for server nodes in the cluster, which are derived from parent cluster profile and its associated server profile template. NOTE: The server profile template must have a configured connection to the hypervisor management network for the template to be valid for use by a hypervisor cluster profile. The cluster profile helps you manage life cycle operations, such as growing or shrinking the cluster, modifying configurations based on needs, consistency checks, and nondisruptive firmware updates on the member nodes. For example, you can grow or shrink a cluster by adding or removing members from the cluster profile. Any change in the configuration of the cluster profile will be reported as an inconsistency. When inconsistencies are remediated, the changed configurations can be applied on cluster and member nodes. A cluster profile can manage VMware ESXi-based hypervisor clusters by leveraging VMware vCenter server. A hypervisor cluster must be managed by one instance of HPE OneView to avoid inconsistencies. Use this Cmdlet to get created cluster profiles within OneView. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVClusterProfile</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a string value to filter for the specific resource</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a string value to filter for the specific resource</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Cluster.ClusterProfile [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The returned cluster profile resource.</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>Get-HPOVClusterProfile</dev:code> <dev:remarks> <dev:para>Get the available and managed cluster profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVClusterProfile -NonCompliant</dev:code> <dev:remarks> <dev:para>Get the non compliant and managed cluster profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfileMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVCOMMANDTRACE--> <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"> <!--GET-HPOVCOMMANDTRACE--> <command:details> <command:name>Get-HPOVCommandTrace</command:name> <maml:description> <maml:para>Start an HPOV Library Verbose Trace.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVCommandTrace</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist the user in setting up the PowerShell environment to generate and capture Verbose output from HPOV Library Cmdlets. Once this Cmdlet has been executed, the prior HPOV Cmdlets can be executed, without the need of using the `-Cerbose` switch. Cmdlet output will be captured using the built-in Microsoft PowerShell Start-Transcript provider. A transcript trace file will be saved in either the current working directory, or specified using the `-Location` parameter. Please know that this Cmdlet is currently not supported in the Windows PowerShell ISE, unless using PowerShell v5 or newer.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVCommandTrace</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The command within a ScriptBlock to execute. The Cmdlet will add the -Verbose switch end of the command.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory where the output file will be created. A file with the following format will be created: "{Date}_HPOV_transcript.log", where date is derived from `Get-Date -UFormat %y%m%d%H%M` Default Value: (PWD).Path</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory where the output file will be created. A file with the following format will be created: "{Date}_HPOV_transcript.log", where date is derived from `Get-Date -UFormat %y%m%d%H%M` Default Value: (PWD).Path</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>(pwd).path</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Command"> <maml:name>ScriptBlock</maml:name> <maml:description> <maml:para>The command within a ScriptBlock to execute. The Cmdlet will add the -Verbose switch end of the command.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> </dev:type> <maml:description> <maml:para>ScriptBlock of the command or commands to generate verbose output for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>FileInfo object where the "{Date}_HPOV_transcript.log" file is generated.</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>Get-HPOVCommandTrace -ScriptBlock { Get-HPOVNetwork -Name MyNet } -Location C:\Temp</dev:code> <dev:remarks> <dev:para>Start a new library trace, which will create a file in the `C:\Temp` directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVCOMPOSERNODE--> <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"> <!--GET-HPOVCOMPOSERNODE--> <command:details> <command:name>Get-HPOVComposerNode</command:name> <maml:description> <maml:para>Retrieve Synergy Composer node information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVComposerNode</command:noun> </command:details> <maml:description> <maml:para>The Composer is an appliance that runs HPE OneView and manages the group of Synergy frames cabled together. You select the initial, active Composer during hardware setup by connecting the Synergy monitor port to a frame link module in the same bay number as the Composer you want to configure. A second Composer is automatically selected to create a high-availability (HA) cluster for managing the Synergy frame in a standby role. If the active Composer fails, the standby Composer automatically becomes the active Composer. This Cmdlet will report the installed and configured Synergy Composer nodes. This includes status, state, model, firmware version, and role. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVComposerNode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ComposerNode [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Synergy Compose node.</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>Get-HPOVComposerNode Appliance Name State Status Model Version Role --------- ---- ----- ------ ----- ------- ---- zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75160607 appliance bay 1 OK OK Synergy Composer 3.00.00-0251673 Active zpo-s18r18s3-ov.vse.rdlabs.hpecorp.net CN75140CPW appliance bay 1 OK OK Synergy Composer 3.00.00-0251673 Standby</dev:code> <dev:remarks> <dev:para>Return all Synergy Composer nodes</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVDATACENTER--> <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"> <!--GET-HPOVDATACENTER--> <command:details> <command:name>Get-HPOVDataCenter</command:name> <maml:description> <maml:para>Retrieve a defined DataCenter.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVDataCenter</command:noun> </command:details> <maml:description> <maml:para>A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server, enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and cooling management of your servers, enclosures, and power delivery devices together in a single management system. When you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects. This Cmdlet will retrieve all or a specific DataCenter resource object. If Remote Support has been enabled on the appliance, the DataCenter object will contain a RemoteSupportLocation property that contains the site location (if different from the Default DataCenter), and both the Primary and Secondary contacts. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVDataCenter</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>DataCenter name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>DataCenter name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.DataCenter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A DataCenter resource object.</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>Get-HPOVDataCenter</dev:code> <dev:remarks> <dev:para>Retrieve all defined DataCenters on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVDataCenter -Name DC*</dev:code> <dev:remarks> <dev:para>Locate all DataCenter objects that begin with "DC".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVDataCenter | Select -ExpandProperty RemoteSupportLocation</dev:code> <dev:remarks> <dev:para>Retrieve the Remote Support Location property from the found DataCenter resource objects.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenterRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVDRIVEENCLOSURE--> <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"> <!--GET-HPOVDRIVEENCLOSURE--> <command:details> <command:name>Get-HPOVDriveEnclosure</command:name> <maml:description> <maml:para>List Synergy DAS Enclosures.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVDriveEnclosure</command:noun> </command:details> <maml:description> <maml:para>Drive enclosures are hardware devices that contain a set of drive bays. A drive enclosure is installed in a device bay of an enclosure, and provides composable storage to servers. Composable storage is a group of physical drives that you can dynamically define as virtual drives. These virtual drives are called logical JBODs. A JBOD (just a bunch of disks) is a group of physical disk drives that are assigned to server hardware. Unlike a RAID configuration, a JBOD is a not redundant configuration. You can specify a RAID configuration when you create a logical JBOD. Logical JBODs are created and assigned to server hardware from server profiles or server profile templates. This Cmdlet will help display the available Synergy DAS Enclosures, and their associated inventory data. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVDriveEnclosure</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Synergy DAS enclosure. Omit to return all devices.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Synergy DAS enclosure. Omit to return all devices.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.DriveEnclosure [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DAS enclosure resource object.</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>Get-HPOVDriveEnclosure Appliance Name State Status Serial Number Drive Bays I/O Adapters --------- ---- ----- ------ ------------- ---------- ------------ appliance 0000A66101, bay 1 On Monitored SN123100 40/40 2 appliance 0000A66102, bay 1 On Monitored SN123101 40/40 2 appliance 0000A66103, bay 1 On Monitored SN123102 40/40 2</dev:code> <dev:remarks> <dev:para>Get all available Synergy Drive Enclosures.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAvailableDriveType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosureInventory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVDRIVEENCLOSUREINVENTORY--> <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"> <!--GET-HPOVDRIVEENCLOSUREINVENTORY--> <command:details> <command:name>Get-HPOVDriveEnclosureInventory</command:name> <maml:description> <maml:para>Get the HPE Synergy D3940 drive enclosure inventory.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVDriveEnclosureInventory</command:noun> </command:details> <maml:description> <maml:para>Drive enclosures are hardware devices that contain a set of drive bays. A drive enclosure is installed in a device bay of an enclosure, and provides composable storage to servers. Composable storage is a group of physical drives that you can dynamically define as virtual drives. These virtual drives are called logical JBODs. A JBOD (just a bunch of disks) is a group of physical disk drives that are assigned to server hardware. Unlike a RAID configuration, a JBOD is a not redundant configuration. You can specify a RAID configuration when you create a logical JBOD. Using this Cmdlet will get the drive inventory from the connected appliance. Inventory can be filtered on SAS logical interconnects and SAS drive enclosures. Minimum required privileges: Infrastructure administrator, server administrator, server profile architect, server profile administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVDriveEnclosureInventory</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a drive name, or wild card value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Assigned, Default"> <maml:name>DriveEnclosure</maml:name> <maml:description> <maml:para>Provide a drive enclosure from Get-HPOVDriveEnclosure to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default"> <maml:name>SasLogicalInterconnect</maml:name> <maml:description> <maml:para>Provide a SAS Logical Interconnect from Get-HPOVSasLogicalInterconnect to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return a specific number of drives. Will return in order from system inventory.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Available</maml:name> <maml:description> <maml:para>Return drives that are available for assignment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Assigned, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVDriveEnclosureInventory</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a drive name, or wild card value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Assigned, Default"> <maml:name>DriveEnclosure</maml:name> <maml:description> <maml:para>Provide a drive enclosure from Get-HPOVDriveEnclosure to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default"> <maml:name>SasLogicalInterconnect</maml:name> <maml:description> <maml:para>Provide a SAS Logical Interconnect from Get-HPOVSasLogicalInterconnect to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned"> <maml:name>Assigned</maml:name> <maml:description> <maml:para>Return only drives that are assigned to a Logical JBOD.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Assigned, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Assigned, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned" aliases="None"> <maml:name>Assigned</maml:name> <maml:description> <maml:para>Return only drives that are assigned to a Logical JBOD.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Available</maml:name> <maml:description> <maml:para>Return drives that are available for assignment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return a specific number of drives. Will return in order from system inventory.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Assigned, Default" aliases="None"> <maml:name>DriveEnclosure</maml:name> <maml:description> <maml:para>Provide a drive enclosure from Get-HPOVDriveEnclosure to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a drive name, or wild card value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Assigned, Default" aliases="None"> <maml:name>SasLogicalInterconnect</maml:name> <maml:description> <maml:para>Provide a SAS Logical Interconnect from Get-HPOVSasLogicalInterconnect to filter for associated drives.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.DriveEnclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Drive enclosure resource from Get-HPOVDriveEnclosure Cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.Drive</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The drive class object from the API.</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>Get-HPOVDriveEnclosureInventory</dev:code> <dev:remarks> <dev:para>Get all drive enclosure inventory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVDriveEnclosureInventory -Assigned</dev:code> <dev:remarks> <dev:para>Get inventory of drives that are assigned.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$DriveEnclosure = Get-HPOVDriveEnclosure -Name "Enclosure1, bay 1" Get-HPOVDriveEnclosureInventory -DriveEnclosure $DriveEnclosure</dev:code> <dev:remarks> <dev:para>Get the drive enventory from the specified drive enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SasLogicalInterconnect = Get-SasLogicalInterconnect -Name "LE1-SAS Synergy LIG-1" Get-HPOVDriveEnclosureInventory -SasLogicalInterconnect $SasLogicalInterconnect -Available</dev:code> <dev:remarks> <dev:para>Get the drive enventory from the specified SAS logical interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVENCLOSURE--> <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"> <!--GET-HPOVENCLOSURE--> <command:details> <command:name>Get-HPOVEnclosure</command:name> <maml:description> <maml:para>Retrieve Enclosure resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVEnclosure</command:noun> </command:details> <maml:description> <maml:para>An enclosure (HPE c-Class BladeSystem enclosure or Synergy frame) is a physical structure with device bays supporting compute, networking, and storage building blocks. These building blocks share the enclosure's common power, cooling, and management infrastructure. This Cmdlet will get the managed and/or monitored enclosure resources from an appliance. This can include HPE BladeSystem c7000, HPE Synergy or HPE Superdome X enclosure resources. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVEnclosure</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVEnclosure</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report"> <maml:name>Report</maml:name> <maml:description> <maml:para>Generate report of enclosure, including device bays, interconnect bays, and reported firmware for components.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVEnclosure</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Full path and file name to save the output .</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the enclosure hardware resource to be returned. All enclosure hardware resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report" aliases="None"> <maml:name>Report</maml:name> <maml:description> <maml:para>Generate report of enclosure, including device bays, interconnect bays, and reported firmware for components.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="report, export, default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="export" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Full path and file name to save the output .</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Enclosure Report</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The matching enclosure hardware resources.</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>$enclosures = Get-HPOVEnclosure</dev:code> <dev:remarks> <dev:para>Return all the enclosure hardware managed by this appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$enclosure = Get-HPOVEnclosure -Name "A"</dev:code> <dev:remarks> <dev:para>Return the enclosure hardware resource with name "A".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure Enclosure Name Serial Number Enclosure Model Rack Name State EG Populated Bays -------------- ------------- --------------- --------- ----- -- -------------- Encl1 SGH100X6J1 BladeSystem c7000 Enclosure G2 Rack-173 Monitored Default EG1 16/16 Encl2 SGH102X6J1 BladeSystem c7000 Enclosure G2 Rack-173 Monitored Default EG1 9/16</dev:code> <dev:remarks> <dev:para>Display a brief list of the enclosures managed or monitored by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure -Name Encl1 -report Enclosure Name Serial Number Enclosure Model Rack Name FW Managed Baseline Name -------------- ------------- --------------- --------- ---------- ------------- Encl1 SGH100X6J1 BladeSystem c7000 Enclosure G2 Rack-173 False Licensing --------- OneView OA Bay Role IP Address Firmware Version ------ ---- ---------- ---------------- 1 Active 172.18.1.11 4.01 April 01 2013 2 Standby 172.18.1.12 4.01 April 01 2013 Server Name Serial Number Model System ROM iLO Firmware Version Server Profile Licensing ----------- ------------- ----- ---------- -------------------- -------------- --------- Encl1, bay 1 SGH100X5RN BL660c Gen8 I32 05/30/2012 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 11 SGH106X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 11 OneView Encl1, bay 12 SGH107X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 12 OneView Encl1, bay 13 SGH108X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 13 OneView Encl1, bay 14 SGH109X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 14 OneView Encl1, bay 15 SGH110X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 15 OneView Encl1, bay 16 SGH111X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 Profile 16 OneView Encl1, bay 2 SGH101X5RN BL660c Gen8 I32 05/30/2012 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 3 SGH100X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 test 2 OneView Encl1, bay 4 SGH101X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 5 SGH102X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 6 SGH103X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 7 SGH104X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 No Profile OneView Encl1, bay 8 SGH105X8RN BL460c Gen8 I27 09/30/2011 iLO4 1.30 Jul 02 2013 No Profile OneView Interconnect Name Module Serial Number Firmware Version ----------------- ------ ------------- ---------------- Encl1, interconnect 1 HP VC FlexFabric 10Gb/24-Port Module WECFSED100 4.10 Encl1, interconnect 2 HP VC FlexFabric 10Gb/24-Port Module WECFSED101 4.10 Interconnect Name Logical Interconnect State Status Consistency state ----- ----------------- -------------------- ----- ------ ----------------- Encl1, interconnect 1 Encl1-LI Configured OK Consistent Encl1, interconnect 2 Encl1-LI Configured OK Consistent </dev:code> <dev:remarks> <dev:para>Generate a report of Encl1.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureActiveFLM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVENCLOSUREGROUP--> <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"> <!--GET-HPOVENCLOSUREGROUP--> <command:details> <command:name>Get-HPOVEnclosureGroup</command:name> <maml:description> <maml:para>Retrieve Enclosure Group resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVEnclosureGroup</command:noun> </command:details> <maml:description> <maml:para>An enclosure group is a logical resource that defines a consistent configuration for an enclosure or a set of enclosures making up a logical enclosure. The network connectivity for an enclosure group is defined by the logical interconnect groups associated with the enclosure group. This Cmdlet will get all available enclosure group resources configured on an appliance. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVEnclosureGroup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Enclosure Group resource to be returned. All enclosure group resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Full path and file name to save the output of Get-HPOVEnclosureGroup</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>${Global:ConnectedSessions}</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Enclosure Group resource to be returned. All enclosure group resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Full path and file name to save the output of Get-HPOVEnclosureGroup</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Enclosure Group resource.</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>$enclosures = Get-HPOVEnclosureGroup</dev:code> <dev:remarks> <dev:para>Return all the enclosure groups managed by this appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$enclosure = Get-HPOVEnclosureGroup "A"</dev:code> <dev:remarks> <dev:para>Return the enclosure group resource with name "A".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVEULASTATUS--> <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"> <!--GET-HPOVEULASTATUS--> <command:details> <command:name>Get-HPOVEulaStatus</command:name> <maml:description> <maml:para>Get the appliance end user license agreement (EULA) status.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVEulaStatus</command:noun> </command:details> <maml:description> <maml:para>The appliance has a EULA (End-User License agreement) that you must accept before using the appliance for the first time. This Cmdlet supports an unauthenticated request. If attempting to get the EULA status of an appliance not yet configured, provide the IP Address or FQDN of the appliance. A temporary ApplianceConnection will be created then removed in the ${Global:ConnectedSessions} tracker. Minimum required privileges: None</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVEulaStatus</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>The FQDN, IP Address or HPOneView.Appliance.Connection of an HPE OneView appliance must be provided.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>The FQDN, IP Address or HPOneView.Appliance.Connection of an HPE OneView appliance must be provided.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.EulaStatus</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object that returns the Appliance Name and if the EULA has been accepted with a boolean "Accepted" property.</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>Get-HPOVEulaStatus -Appliance myappliance.domain.com Appliance Accepted --------- -------- myappliance.domain.com False</dev:code> <dev:remarks> <dev:para>Get the EULA status from myappliance.domain.com</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Connection = Connect-HPOVMgmt -Appliance myappliance.domain.com -Username Administrator -Password MyPassw0rd Get-HPOVEulaStatus -Appliance $Connection Appliance Accepted --------- -------- myappliance.domain.com False</dev:code> <dev:remarks> <dev:para>Connect to an appliance, then get the EULA status from myappliance.domain.com</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVEulaStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVFABRICMANAGER--> <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"> <!--GET-HPOVFABRICMANAGER--> <command:details> <command:name>Get-HPOVFabricManager</command:name> <maml:description> <maml:para>Get configured fabric manager(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVFabricManager</command:noun> </command:details> <maml:description> <maml:para>Fabric Managers is a resource manager in HPE OneView that enables integration of a Cisco ACI fabric (an external entity) with HPE Synergy. A fabric manager aligns HPE OneView resources as defined by Cisco Application Policy Infrastructure Controller (APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric. You can operate a fabric manager after adding it in HPE OneView and configure a list of tenants to cover policies necessary for HPE Synergy and Cisco APIC integration. Remediation of networks, network sets, and logical interconnects Remediation is a process to convert a noncompliant health state of an HPE OneView resource to a compliant health state with respect to APIC policy definitions. The following conditions cause the fabric manager to be unable to synchronize with network policies: * One or more networks connected across uplink sets in a logical interconnect within HPE Synergy have the same VLAN tag * The two networks are shared across tenants When a fabric manager is non compliant with APIC network policies, a software remediation enables a fabric manager to synchronize with network policies. A compliance report is generated immediately after adding a fabric manager and is updated again after remediation. The compliance report details actions that you can perform to remediate inconsistencies. There are indicators for compliant, noncompliant, and compliance-check progress for each resource. Every tenant has a list of consistent and inconsistent reports based on the compliance records generated for a tenant. An inconsistency appears in the form of an alert, which contains an action choice: auto-remediate or manual. If you choose to auto-remediate, an automatic update of the selected HPE OneView resource will initiate. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVFabricManager</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the fabric manager name to filter for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the fabric manager name to filter for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.FabricManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Configured fabric manager resource object.</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>Get-HPOVFabricManager</dev:code> <dev:remarks> <dev:para>Get all defined fabric managers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVFIXMEINSTALLATIONLOG--> <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"> <!--GET-HPOVFIXMEINSTALLATIONLOG--> <command:details> <command:name>Get-HPOVFixMeInstallationLog</command:name> <maml:description> <maml:para>Get fixme installation log file.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVFixMeInstallationLog</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will Retrieve any fixme patch installation log files needed by HPE Support to analyze for installation completion or errors. Minimum required privileges: Infrastructure Administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVFixMeInstallationLog</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>The directory location where to save the generated file to. If omitted, will use the current working directory.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.DirectoryInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>Location</maml:name> <maml:description> <maml:para>The directory location where to save the generated file to. If omitted, will use the current working directory.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.IO.DirectoryInfo</command:parameterValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The downloaded log file.</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>Get-HPOVFixMeInstallationLog</dev:code> <dev:remarks> <dev:para>Get the fixme installation logs for the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVHEALTHSTATUS--> <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"> <!--GET-HPOVHEALTHSTATUS--> <command:details> <command:name>Get-HPOVHealthStatus</command:name> <maml:description> <maml:para>Display appliance health.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVHealthStatus</command:noun> </command:details> <maml:description> <maml:para>Display the HPE OneView appliance health status. This includes CPU, Memory and Disk Space. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVHealthStatus</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.HealthStatus [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance health report in table format.</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>Get-HPOVHealthStatus</dev:code> <dev:remarks> <dev:para>Get the HPE OneView appliance health.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVILOSSO--> <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"> <!--GET-HPOVILOSSO--> <command:details> <command:name>Get-HPOVIloSso</command:name> <maml:description> <maml:para>Generate iLO SSO Token.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVIloSso</command:noun> </command:details> <maml:description> <maml:para>Obtain an iLO SSO Token URL to authenticate to an iLO. If the server hardware is unsupported, the resulting URL will not use SSO and the iLO web interface will prompt for credentials. Note: this is not supported on G7 or earlier servers. The generated SSO object or URL can be used with other HPE libraries that support iLO session tokens. Minimum required privileges: Read-only. Know that your user account role within OneView will be mapped to a specific iLO role. Please review the HPE OneView online help for more information, searching for "Mapping of SSO roles".</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVIloSso</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IloRestSession, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>RemoteConsoleOnly</maml:name> <maml:description> <maml:para>Generate an SSO URL Token for accessing the Remote Console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IloRestSession, Default"> <maml:name>IloRestSession</maml:name> <maml:description> <maml:para>Generate an HPRESTCmdlets compliant IloSession object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IloRestSession, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVIloSso</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IloRestSession, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IloRestSession, Default"> <maml:name>IloRestSession</maml:name> <maml:description> <maml:para>Generate an HPRESTCmdlets compliant IloSession object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IloRestSession, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IloRestSession, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IloRestSession, Default" aliases="None"> <maml:name>IloRestSession</maml:name> <maml:description> <maml:para>Generate an HPRESTCmdlets compliant IloSession object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IloRestSession, Default" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server Hardware or Server Profile resource object from Get-HPOVServer or Get-HPOVServerProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>RemoteConsoleOnly</maml:name> <maml:description> <maml:para>Generate an SSO URL Token for accessing the Remote Console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>SSO Url Object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple SSO URL objects.</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>$SSOObjects = Get-HPOVServer | Get-HPOVIloSso</dev:code> <dev:remarks> <dev:para>Generate iLO SSO Objects for all managed server resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SSOObject = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso</dev:code> <dev:remarks> <dev:para>Generate iLO SSO Object for the specified managed server resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SSOObject = Get-HPOVServerProfile -Name "My Server Profile" | Get-HPOVIloSso</dev:code> <dev:remarks> <dev:para>Generate iLO SSO Object for the specified managed server resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$IloSession = Get-HPOVServer -Name "Enc1, bay 1" | Get-HPOVIloSso -IloRestSession</dev:code> <dev:remarks> <dev:para>Generate iLO SSO Object that can then be used with the HPRESTCmdlets.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVIMAGESTREAMERAPPLIANCE--> <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"> <!--GET-HPOVIMAGESTREAMERAPPLIANCE--> <command:details> <command:name>Get-HPOVImageStreamerAppliance</command:name> <maml:description> <maml:para>Retrieve HPE Synergy Image Streamer appliances.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVImageStreamerAppliance</command:noun> </command:details> <maml:description> <maml:para>An Image Streamer appliance is an HPE Synergy add-on solution that forms an OS Deployment Server. An OS deployment server is a resource that enables you to deploy (install and configure) operating systems for use by servers. HPE OneView connects to an OS deployment server and configures it for deploying operating systems. The default selection is HPE Synergy Image Streamer, when an Image Streamer is discovered in an HPE Synergy configuration. You can add only a single Image Streamer deployment server. The Image Streamer OS deployment server supports the deployment of plans that define the operating system artifacts necessary for server hardware operation. Adding a deployment server causes Image Streamer appliances to be clustered and configured to manage OS deployment artifacts. This Cmdlet will retrieve populated and discovered HPE Synergy Image Streamer appliances within the Synergy Management fabric. Image Streamer appliances can be in either a Claimed or Unclaimed state. Appliances will only belong in a single redundant High Availability (H/A) Pair, and all H/A pairs will participate within the same HPE Synergy OS Deployment Server. Redundant H/A pairs will automatically be created during the Create Logical Enclosure task. Minimum required privileges: Read-only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVImageStreamerAppliance</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Image Streamer resource name. Supported the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Image Streamer resource name. Supported the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject [HPOneView.Appliance.ImageStreamerAppliance]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An HPE Synergy Image Streamer appliance object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<HPOneView.Appliance.ImageStreamerAppliance></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A collection of HPE Synergy Image Streamer appliance objects.</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>Get-HPOVImageStreamerAppliance</dev:code> <dev:remarks> <dev:para>List all HPE Synergy Image Streamer appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVImageStreamerAppliance -Name "0000A66102, appliance 2"</dev:code> <dev:remarks> <dev:para>Retrieve the Image Streamer Appliance "0000A66102, appliance 2".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVINTERCONNECT--> <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"> <!--GET-HPOVINTERCONNECT--> <command:details> <command:name>Get-HPOVInterconnect</command:name> <maml:description> <maml:para>Retrieve Interconnect resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVInterconnect</command:noun> </command:details> <maml:description> <maml:para>Interconnects enable communication between the server hardware in the enclosure and the data center networks. Interconnects that are managed are put in a Configured state when the Synergy frame is configured by creating a logical enclosure. An unmanaged interconnect remains in the Monitored state when the Synergy frame is configured by creating a logical enclosure. Retrieves a list of all Interconnects (Ethernet, FC, Converged Network, and/or SAS) or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the Export parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVInterconnect</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="x, exportFile"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.Interconnect [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Interconnect object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SasInterconnect [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single SAS Interconnect object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Interconnect objects.</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>Get-HPOVInterconnect</dev:code> <dev:remarks> <dev:para>Returns all Interconnects managed by all connected appliances to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -Name "Encl1, Interconnect 1"</dev:code> <dev:remarks> <dev:para>Returns just the Encl1, Interconnect 1 Interconnect object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -exportFile "c:\myApplianceConfig\ICs.json"</dev:code> <dev:remarks> <dev:para>Returns the Get-HPOVInterconnect query results to the file c:\myApplianceConfig\ICs.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVInterconnectType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVInterconnectNetOpPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVINTERCONNECTTYPE--> <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"> <!--GET-HPOVINTERCONNECTTYPE--> <command:details> <command:name>Get-HPOVInterconnectType</command:name> <maml:description> <maml:para>Retrieve Interconnect Type resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVInterconnectType</command:noun> </command:details> <maml:description> <maml:para>Interconnects enable communication between the server hardware in the enclosure and the data center networks. Interconnects and their configuration are derived from either a Logical Switch Group or Logical Interconnect Group. When configuring either resource, you will need to specify an interconnect type that is supported by the appliance. This Cmdlet will retrieve a list of all supported interconnect types (Ethernet, FC, Converged Network, and/or SAS) or specific ones via a query if the name parameter is provided. The output can be sent to a file using the Export parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVInterconnectType</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect type model name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVInterconnectType</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an Interconnect Type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect type model name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber" aliases="None"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an Interconnect Type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.InterconnectType [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Interconnect Type resource.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.InterconnectType></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Interconnect Type resources or formatted table dispalying basic Interconnect Type information.</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>Get-HPOVInterconnectType</dev:code> <dev:remarks> <dev:para>Returns all Interconnect Types available from all connected appliances to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -Name "HP VC FlexFabric 10Gb/24-Port Module"</dev:code> <dev:remarks> <dev:para>Returns just the "HP VC FlexFabric 10Gb/24-Port Module" Interconnect Type object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVInterconnect -Partnumber "571956-B21"</dev:code> <dev:remarks> <dev:para>Returns just the partnumber "571956-B21" Interconnect Type object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLABEL--> <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"> <!--GET-HPOVLABEL--> <command:details> <command:name>Get-HPOVLabel</command:name> <maml:description> <maml:para>Return created label resources.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLabel</command:noun> </command:details> <maml:description> <maml:para>Labels identify resources so you can organize them into groups. For example, you might want to identify the servers that are used primarily by the Finance team, or identify the storage systems assigned to the Asia/Pacific division. This Cmdlet will return all of the created labels on the specifed appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLabel</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label to associate resources to. If Label does not exist, a new one will be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label to associate resources to. If Label does not exist, a new one will be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Label</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Label resource.</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>Get-HPOVLabel</dev:code> <dev:remarks> <dev:para>Return all labels from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLDAP--> <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"> <!--GET-HPOVLDAP--> <command:details> <command:name>Get-HPOVLdap</command:name> <maml:description> <maml:para>List Global Authentication Directory settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLdap</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. This Cmdlet will display the global authentication directory settings configured on the appliance. It will show if local logins are enabled, default authentication directory name, and configured authentication directory names. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLdap</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLdap</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configured directories to individual files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Save</maml:name> <maml:description> <maml:para>Directory where the exported configured directories will be saved to. A filename of "{appliance_name}_globalSettings.json" will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configured directories to individual files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="location"> <maml:name>Save</maml:name> <maml:description> <maml:para>Directory where the exported configured directories will be saved to. A filename of "{appliance_name}_globalSettings.json" will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthGlobalDirectoryConfiguration [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Global Authentication Settings object</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>Get-HPOVLdap Allow Local Login Default Directory Configured Directories ----------------- ----------------- ---------------------- True domain1 {domain1, domain2} True domain2 {domain1, domain2}</dev:code> <dev:remarks> <dev:para>View the Global Authentication Directory configuration for all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdap -export -save c:\directory</dev:code> <dev:remarks> <dev:para>Export the Global Authentication Directory configuration settings.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVLdapLocalLogin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVLdapLocalLogin</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLdapDefaultDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLdapGroupRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLdapGroups</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLDAPDIRECTORY--> <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"> <!--GET-HPOVLDAPDIRECTORY--> <command:details> <command:name>Get-HPOVLdapDirectory</command:name> <maml:description> <maml:para>Get configured Authentication Directories</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLdapDirectory</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. This Cmdlet will retrieve the configured authentication directory(ies) configured on the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLdapDirectory</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The specific authentication directory name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLdapDirectory</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configured directories to individual files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configured directories to individual files.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="directory, domain"> <maml:name>Name</maml:name> <maml:description> <maml:para>The specific authentication directory name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Authentication Directory settings object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Authentication Directory settings objects</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>Get-HPOVLdapDirectory Appliance Name Type Root Search Context Directory Servers --------- ---- ---- ---- -------------- ----------------- MyAppliance1 domain1 AD dc=domain1,dc=com ou=Admins,ou=domain1.. {dc1.domain1.com:636, dc2.domain1.com:636} MyAppliance1 domain2 AD dc=domain2,dc=com ou=Admins,ou=domain2.. {dc1.domain2.com:636, 10.1.2.1:636} MyAppliance2 domain1 AD dc=domain1,dc=com ou=Admins,ou=domain1.. {dc1.domain1.com:636, dc2.domain1.com:636} MyAppliance2 domain2 AD dc=domain2,dc=com ou=Admins,ou=domain2.. {dc1.domain2.com:636, 10.1.2.1:636}</dev:code> <dev:remarks> <dev:para>View the configured authentication directories, for all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdap -export -save c:\directory</dev:code> <dev:remarks> <dev:para>Export the Global Directory Configuration settings.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLDAPGROUP--> <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"> <!--GET-HPOVLDAPGROUP--> <command:details> <command:name>Get-HPOVLdapGroup</command:name> <maml:description> <maml:para>List Directory Group role assignment.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLdapGroup</command:noun> </command:details> <maml:description> <maml:para>You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services: * Active Directory * OpenLDAP When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance. This Cmdlet will display the configured directory groups on the appliance, and display their assigned role(s). Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLdapGroup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Configured Directory Group Name. If omitted, all configured Directory Groups will be displayed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLdapGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export JSON content to file</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export JSON content to file</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="group, GroupName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Configured Directory Group Name. If omitted, all configured Directory Groups will be displayed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectoryGroupRoleMapping [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Configured Directory Group role mapping</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple configured Directory Group role mappings</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>Get-HPOVLdapGroup Name Directory Roles ---- --------- ----- My Directory Group1 domain1 {Storage administrator} My Directory Group2 domain1 {Network administrator} </dev:code> <dev:remarks> <dev:para>Get list of configured Directory Groups.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdapGroup -Name "My Directory Group1" Name Directory Roles ---- --------- ----- My Directory Group1 domain1 {Storage administrator}</dev:code> <dev:remarks> <dev:para>Display "My Directroy Group1" and the assigned roles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdapGroup -export C:\dir\directorygroups.json</dev:code> <dev:remarks> <dev:para>Export configured Directory Groups to c:\dir\directorygroups.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLdapGroupRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLdapGroups</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLICENSE--> <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"> <!--GET-HPOVLICENSE--> <command:details> <command:name>Get-HPOVLicense</command:name> <maml:description> <maml:para>Gets the installed licenses on the appliance.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLicense</command:noun> </command:details> <maml:description> <maml:para>HPE OneView requires a license for all server hardware that it manages or monitors. HPE Synergy requires fibre channel license for the Virtual Connect SE 40Gb F8 Module for Synergy. The following HPE OneView Advanced licenses provide support as listed below, and in addition, enable integration with other products. * HPE OneView Advanced * Provides an HPE OneView Advanced license and an iLO Advanced license. * This license is intended for server hardware and enclosures you want to manage with HPE OneView. * HPE OneView Advanced w/o iLO * Provides an HPE OneView Advanced license only. This license is intended for server hardware you want to manage with HPE OneView. This license is for servers with iLOs that are already licensed, or server hardware for which you do not require an iLO license. An HPE OneView Advanced w/o iLO license provides support for all server hardware features on the appliance, with the following exceptions: * Server hardware without an iLO Advanced license does not display utilization data. * Rack mount servers without an iLO Advanced license cannot access the remote console. * HPE OneView Standard * Provides an HPE OneView Standard license for all monitored server hardware. * This license is automatically selected: * for the enclosure when adding a monitored enclosure * for the server when adding a monitored server * for all ProLiant G6 server blades or G7 BL680c server blades when adding a managed enclosure HPE OneView does not manage the hardware running with an HPE OneView Standard license. When you add an enclosure or rack mount server to the appliance, you must specify one of these licenses. When you add a rack manager, either the HPE OneView Standard license or the HPE OneView Advanced license is automatically applied based on the firmware version installed on the rack manager. If you purchase HPE OneView Advanced and HPE OneView Advanced w/o iLO licenses separately from the hardware (standalone, nonintegrated), you must add them to the HPE OneView license pool in order for them to be available to assign to your server hardware. This Cmdlet will retrieve licenses installed on the appliance. You can use this to get an inventory of what's installed and what licenses are consumed. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLicense</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the type of License to retrieve. Valid options are "HP_ONE_VIEW" or "HP_ONE_VIEW_WO_ILO".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>Specify the license state to retrieve. Valid options are "Unlicensed" or "Permanent".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Summary</maml:name> <maml:description> <maml:para>Display a condensed summary view of the installed or required licenses. This does not return a License object that can be used with Remove-HPOVLicense.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Report</maml:name> <maml:description> <maml:para>PARAMETER IS DEPRECATED. Generate a report of installed or required licenses, their type and assigned Nodes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Report</maml:name> <maml:description> <maml:para>PARAMETER IS DEPRECATED. Generate a report of installed or required licenses, their type and assigned Nodes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>State</maml:name> <maml:description> <maml:para>Specify the license state to retrieve. Valid options are "Unlicensed" or "Permanent".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Summary</maml:name> <maml:description> <maml:para>Display a condensed summary view of the installed or required licenses. This does not return a License object that can be used with Remove-HPOVLicense.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the type of License to retrieve. Valid options are "HP_ONE_VIEW" or "HP_ONE_VIEW_WO_ILO".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.License</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>HPE OneView License</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>Get-HPOVLicense Product : HPE OneView Advanced Type : Permanent Capacity : 64 Allocated : 30 Available : 34 Nodes : {Encl2, bay 7, Encl2, bay 4, Encl2, bay 13, Encl1, bay 8..}</dev:code> <dev:remarks> <dev:para>Retrieve all installed license objects on the connected appliance(s).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALENCLOSURE--> <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"> <!--GET-HPOVLOGICALENCLOSURE--> <command:details> <command:name>Get-HPOVLogicalEnclosure</command:name> <maml:description> <maml:para>Retrieve Logical Enclosure resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalEnclosure</command:noun> </command:details> <maml:description> <maml:para>A logical enclosure contains the configuration intended for a set of physical enclosures. Its initial values are taken from an enclosure group and applied to the physical enclosures. If the intended configuration in the logical enclosure does not match the actual configuration on the enclosures, the logical enclosure becomes inconsistent. Use the Logical Enclosures screen to manage firmware, create a support dump, and to apply updates made from the Enclosure Groups screen to the enclosures in the logical enclosure. A logical enclosure is automatically created when a c7000 enclosure is added. After Synergy frames are discovered automatically during hardware setup, you must manually create a logical enclosure. The logical enclosure must contain the number of Synergy frames that are connected together with interconnect link cables. For example, if you have three Synergy frames cabled together, create a logical enclosure that contains all three Synergy frames. This Cmdlet will retrieve a collection of Logical Enclosure resources, or a single Logical Enclosure with the specified name. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalEnclosure</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Enclosure resource to be returned. All Logical Enclosure resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Filter resources based on provided EnclosureGroup association.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Filter resources based on provided EnclosureGroup association.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Enclosure resource to be returned. All Logical Enclosure resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Enclosure Group</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Enclosure Groups</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>Get-HPOVLogicalEnclosure</dev:code> <dev:remarks> <dev:para>Return all the Logical Enclosure resources managed by all appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$EnclosureGroup = Get-HPOVEnclosureGroup -Name CorpEG1 Get-HPOVLogicalEnclosure -EnclosureGroup $EnclosureGroup</dev:code> <dev:remarks> <dev:para>Return the associated logical enclosures that were created from the specific enclosure group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosureFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALINTERCONNECT--> <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"> <!--GET-HPOVLOGICALINTERCONNECT--> <command:details> <command:name>Get-HPOVLogicalInterconnect</command:name> <maml:description> <maml:para>Retrieve Logical Interconnect resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalInterconnect</command:noun> </command:details> <maml:description> <maml:para>A logical interconnect is a single administrative entity that consists of the configuration for a set of interconnects in a single enclosure or an HPE Synergy frame link topology, and includes: * The uplink sets, which connect to data center networks. * The mapping of networks to physical uplink ports, which is defined by the uplink sets for a logical interconnect. * The internal networks, which are used for server-to-server communications without traffic egressing any uplinks. * The downlink ports, which connect through the enclosure midplane to the servers in the enclosure. * The connections between interconnects, which are called stacking links. * Stacking links can be internal cables (through the enclosure) or external cables between the external ports of interconnects. See the appropriate support or compatibility matrix on the Hewlett Packard Enterprise Information Library for the maximum number of networks that can be provisioned on a logical interconnect. A logical interconnect derives its configuration from a logical interconnect group, which serves as a template to ensure that the logical interconnects being created are configured consistently. For a server administrator, a logical interconnect represents the available networks through the interconnect uplinks and the interconnect downlink capabilities through a physical server?s interfaces. For a network administrator, a logical interconnect represents an Ethernet stacking configuration, aggregation layer connectivity, stacking topology, network reachability, statistics, and troubleshooting tools. This Cmdlet retrieves a list of all Logical Interconnect or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the exportFile parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalInterconnect</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="x, ExportFile"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Filter resources based on their non-compliant state.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Logical Interconnect resource object from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPoneView.Networking.LogicalInterconnect> </maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Logical Interconnects</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>Get-HPOVLogicalInterconnect</dev:code> <dev:remarks> <dev:para>Returns all Logical Interconnect defined on the appliance to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect -Name "Production"</dev:code> <dev:remarks> <dev:para>Returns just the Production Logical Interconnect object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myLogicalICs = Get-HPOVLogicalInterconnect -NonCompliant</dev:code> <dev:remarks> <dev:para>Returns non-compliant logical interconnect resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect -Export "c:\myApplianceConfig\LogicalInterconnects.json"</dev:code> <dev:remarks> <dev:para>Returns the query results to the file c:\myApplianceConfig\LogicalInterconnects.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPOVLogicalInterconnectFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLogicalInterconnectMacTable</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalInterconnect</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALINTERCONNECTGROUP--> <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"> <!--GET-HPOVLOGICALINTERCONNECTGROUP--> <command:details> <command:name>Get-HPOVLogicalInterconnectGroup</command:name> <maml:description> <maml:para>Retrieve Logical Interconnect Group resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalInterconnectGroup</command:noun> </command:details> <maml:description> <maml:para>A logical interconnect group acts as a recipe for creating a logical interconnect representing the available networks, uplink sets, and interconnect settings for a set of physical interconnects in a set of enclosures. One or more logical interconnect groups are associated with an enclosure group and are used to define the logical interconnect configuration for every enclosure that is using that enclosure group. There are different kinds of logical interconnect groups: * A multiple-enclosure logical interconnect group must match the interconnect link topology within the set of linked enclosures. All bays must be properly populated in all enclosures in the interconnect link topology. A multiple-enclosure logical interconnect group must include a Virtual Connect SE 40Gb F8 Module for Synergy and/or a HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy and the Interconnect Link Module configuration. * Single-enclosure logical interconnect groups, such as an HPE Synergy Serial Attached SCSI (SAS) or HPE BladeSystem c7000 logical interconnect group, pertain only to the enclosure in which they are applied. A single-enclosure logical interconnect group can be applied to individual fabric module bays in individual enclosures in the HPE Synergy interconnect link topology or HPE BladeSystem c7000 enclosure. Virtual Connect SE Fibre Channel modules support single-enclosure logical interconnect groups. All references to a logical interconnect group by an enclosure group or logical interconnect must be removed before you can delete the logical interconnect group. This Cmdlet retrieves a list of all Logical Interconnect Group or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the exportFile parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Interconnect Group to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>Provide the type of Logical Interconnect Group to return. Omit to return all Logical Interconnect Group resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnectGroup.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Pipeline input resource generated from Wait-HPOVTaskComplete, or successfully completed Async Task resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Pipeline input resource generated from Wait-HPOVTaskComplete, or successfully completed Async Task resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Logical Interconnect Group to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Provide the type of Logical Interconnect Group to return. Omit to return all Logical Interconnect Group resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnectGroup.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnectGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A logical interconnect resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A Logical Interconnect Group or collection of Logical Interconnect Groups</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>Get-HPOVLogicalInterconnectGroup</dev:code> <dev:remarks> <dev:para>Returns all Logical Interconnect Groups defined on the appliance to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnectGroup -Name "Production"</dev:code> <dev:remarks> <dev:para>Returns just the Production Logical Interconnect Group object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LigName = "VC FF Virt Prod" $CreatedLig = New-HPOVLogicalInterconnectGroup -Name $LigName -bays @{1 = "FlexFabric";2 = "FlexFabric"} -EnableIgmpSnooping $True -InternalNetworks "VMMigration Network" | Wait-HPOVTaskComplete | Get-HPOVLogicalInterconnectGroup $CreatedLig Name Enclosure Groups ---- ---------------- VC FF Virt Prod</dev:code> <dev:remarks> <dev:para>Create a new Logical Interconnect Group resource, wait for the task to complete, then retrieve the created resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnectGroup -exportFile "c:\myApplianceConfig\LogicaICGs.json"</dev:code> <dev:remarks> <dev:para>Returns the Get-HPOVLogicalInterconnectGroup query results to the file c:\myApplianceConfig\LogicaICGs.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALINTERCONNECTPORTMONITORING--> <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"> <!--GET-HPOVLOGICALINTERCONNECTPORTMONITORING--> <command:details> <command:name>Get-HPOVLogicalInterconnectPortMonitoring</command:name> <maml:description> <maml:para>Get port monitoring configuration from provided logical interconnect.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalInterconnectPortMonitoring</command:noun> </command:details> <maml:description> <maml:para>Port monitoring enables you to send a copy of every Ethernet or Fibre Channel frame coming in and going out of a downlink (server-facing) port to another port. To evaluate network traffic between ports, you can connect debugging equipment, such as a network analyzer. This capability is important in a server environment where there is limited physical access to the network interfaces on the servers. Use this Cmdlet to get the current port monitoring configuration from a specified logical interconnect resource. NOTE: * You cannot use Virtual Connect to forward captured traffic to a server. For more information, see the HPE Virtual Connect for c-Class BladeSystem User Guide in the Hewlett Packard Enterprise Information Library. * You can configure one network analyzer port (the uplink port) for up to 16 downlink server ports within a logical interconnect. * The HPE Virtual Connect 16Gb 24-Port Fibre Channel Module monitors 1 downlink server port. * HPE Virtual Connect 16Gb 24-Port Fibre Channel Module firmware must be 4.00 or later Minimum required privileges: Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalInterconnectPortMonitoring</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Networking.LogicalInterconnect from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, li, name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Networking.LogicalInterconnect from Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPoneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect resource object from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnect+PortMonitoringConfig</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current port monitor configuration of the provided logical interconnect(s).</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>Get-HPOVLogicalInterconnect -Name "Encl1-Default VC FF LIG" -ErrorAction Stop | Get-HPOVLogicalInterconnectPortMonitoring</dev:code> <dev:remarks> <dev:para>Get the port monitoring configuration from the specified Logical Interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALJBOD--> <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"> <!--GET-HPOVLOGICALJBOD--> <command:details> <command:name>Get-HPOVLogicalJBOD</command:name> <maml:description> <maml:para>Get defined logical JBODs.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalJBOD</command:noun> </command:details> <maml:description> <maml:para>A logical JBOD is a group of physical drives that are dynamically defined as virtual drives. Logical JBOD uses the drives from the drive enclosures that are installed in the device bays of the enclosure and are associated with a SAS logical interconnect. You can assign or unassign a logical JBOD to a server hardware through the server profile. If the logical drive settings in the server profile indicate that the data in the logical JBOD is to be retained when you delete the server profile, then the data is retained and you can assign this logical JBOD to a different server profile. Using this Cmdlet will return defined logical JBOD resources from the connected appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalJBOD</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify to filter resources by the specific name or wildcard search.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify to filter resources by the specific name or wildcard search.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.LogicalJBOD</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The defined logical JBOD resource from the appliance.</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>Get-HPOVLogicalJBOD</dev:code> <dev:remarks> <dev:para>Get the defined logical JBOD resources from an appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALSWITCH--> <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"> <!--GET-HPOVLOGICALSWITCH--> <command:details> <command:name>Get-HPOVLogicalSwitch</command:name> <maml:description> <maml:para>Retrieve Logical Switch resources.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalSwitch</command:noun> </command:details> <maml:description> <maml:para>A logical switch is added into HPE OneView as a managed or monitored logical switch. The logical switch can consist of a maximum of two physical top-of-rack switches (external to the HPE Synergy frame) configured in a single stacking domain. There is a connectivity limitation of one logical interconnect to one logical switch. Interconnects within a logical interconnect cannot be connected to more than one logical switch. A logical switch is based on a logical switch group configuration. If the logical switch transitions to an Inconsistent with group state (due to the changes in either the logical switch or the logical switch group), update the logical switch configuration based on the logical switch group to return to a consistent state. About assigning Arista switches to a logical switch (HPE Synergy only) You can create a logical switch with a maximum of two Arista switches. When there are two Arista switches in a logical switch, they must be in a multichassis link aggregation (MLAG) environment. MLAG must be configured on both the switches, and they must belong to the same MLAG domain. About assigning Cisco Nexus switches to a logical switch (HPE BladeSystem only) You can create a logical switch with a maximum of two Cisco Nexus switches. When there are two Cisco Nexus switches in a logical switch, they must be in a virtual PortChannel (vPC) environment. vPC must be configured on both the switches, and they must belong to the same vPC domain. A virtual PortChannel (vPC) allows links that are physically connected to two different switches to appear as a single port channel to a third switch. vPC domain ID, vPC primary MAC address, vPC member ID, vPC role in a vPC domain can be configured for Cisco Nexus switches. Stacking links can be set from the originating peer or the destination peer when two switches are participating in the vPC environment. Also, stacking links can be set to the destination end of the peer link between two vPC switches. About assigning rack connectivity modules to a logical switch You can create a logical switch that pairs two rack connectivity modules. You can assign rack servers and server profiles to the two rack connectivity modules that are associated with the logical switch. When rack servers are assigned to the rack connectivity modules that are associated with the logical switch, the following configurations are checked: * The rack servers are consistently connected with the two rack connectivity modules. * The rack server is connected to the same port on both rack connectivity modules. If there are issues during the initial server profile assignment, validation errors are displayed during server profile creation. If the cabling configuration is changed after the server profile assignment, alerts are displayed on the Logical Switches, Server Profiles, and Switches screens as applicable. Stacking links can be set from the originating peer or from the destination peer when two switches are participating in the MLAG environment. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalSwitch</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Save the Logical Switch resource(s) to the specified JSON file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.TaskResource object and the Cmdlet will return the associated Logical Switch resource created from the New-HPOVLogicalSwitch Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.TaskResource object and the Cmdlet will return the associated Logical Switch resource created from the New-HPOVLogicalSwitch Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Save the Logical Switch resource(s) to the specified JSON file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Async Task resource object, from New-HPOVLogicalSwitch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitch [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Logical Switch resource.</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>Get-HPOVLogicalSwitch</dev:code> <dev:remarks> <dev:para>Retrieve all Logical Switch resources from the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalSwitch -Name MyLogicalSwitch1</dev:code> <dev:remarks> <dev:para>Retrieve the specified MyLogicalSwitch1 resource from the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGICALSWITCHGROUP--> <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"> <!--GET-HPOVLOGICALSWITCHGROUP--> <command:details> <command:name>Get-HPOVLogicalSwitchGroup</command:name> <maml:description> <maml:para>Retrieve Logical Switch Group resources.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLogicalSwitchGroup</command:noun> </command:details> <maml:description> <maml:para>The logical switch group is a template for creating logical switches. Logical switches are an aggregation of up to two physical top-of-rack switches. Once constructed from a logical switch group, a logical switch continues to be associated with its logical switch group. Any change in consistency between the logical switch group and its associated logical switches is monitored and made visible on the associated logical switch screen in HPE OneView. A logical switch is added into HPE OneView as a managed or monitored logical switch. The logical switch can consist of a maximum of two physical top-of-rack switches (external to the HPE Synergy frame) configured in a single stacking domain. There is a connectivity limitation of one logical interconnect to one logical switch. Interconnects within a logical interconnect cannot be connected to more than one logical switch. A logical switch is based on a logical switch group configuration. If the logical switch transitions to an Inconsistent with group state (due to the changes in either the logical switch or the logical switch group), update the logical switch configuration based on the logical switch group to return to a consistent state. About assigning Arista switches to a logical switch (HPE Synergy only) You can create a logical switch with a maximum of two Arista switches. When there are two Arista switches in a logical switch, they must be in a multichassis link aggregation (MLAG) environment. MLAG must be configured on both the switches, and they must belong to the same MLAG domain. About assigning Cisco Nexus switches to a logical switch (HPE BladeSystem only) You can create a logical switch with a maximum of two Cisco Nexus switches. When there are two Cisco Nexus switches in a logical switch, they must be in a virtual PortChannel (vPC) environment. vPC must be configured on both the switches, and they must belong to the same vPC domain. A virtual PortChannel (vPC) allows links that are physically connected to two different switches to appear as a single port channel to a third switch. vPC domain ID, vPC primary MAC address, vPC member ID, vPC role in a vPC domain can be configured for Cisco Nexus switches. Stacking links can be set from the originating peer or the destination peer when two switches are participating in the vPC environment. Also, stacking links can be set to the destination end of the peer link between two vPC switches. About assigning rack connectivity modules to a logical switch You can create a logical switch that pairs two rack connectivity modules. You can assign rack servers and server profiles to the two rack connectivity modules that are associated with the logical switch. When rack servers are assigned to the rack connectivity modules that are associated with the logical switch, the following configurations are checked: * The rack servers are consistently connected with the two rack connectivity modules. * The rack server is connected to the same port on both rack connectivity modules. If there are issues during the initial server profile assignment, validation errors are displayed during server profile creation. If the cabling configuration is changed after the server profile assignment, alerts are displayed on the Logical Switches, Server Profiles, and Switches screens as applicable. Stacking links can be set from the originating peer or from the destination peer when two switches are participating in the MLAG environment. This Cmdlet retrieves a list of all Logical Switch Groups or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the exportFile parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLogicalSwitchGroup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Switch Group resource Name. Supports the * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Export the Logical Switch Group resource(s) to the specified JSON file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVLogicalSwitchGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Pipeline" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Async task object after a Logical Switch Group resource is created, the Cmdlet will return the associated object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Switch Group resource Name. Supports the * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>Export the Logical Switch Group resource(s) to the specified JSON file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Async task resource after a Logical Switch Group has been created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object to monitor (if -Async was used) or results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.LogicalSwitchGroup></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Logical Switch Group resources.</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>Get-HPOVLogicalSwitchGroup</dev:code> <dev:remarks> <dev:para>Get all logical switch group resources found on the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1"</dev:code> <dev:remarks> <dev:para>Get the "My Logical Switch Group Policy 1" resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVLOGINMESSAGE--> <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"> <!--GET-HPOVLOGINMESSAGE--> <command:details> <command:name>Get-HPOVLoginMessage</command:name> <maml:description> <maml:para>Get appliance configured login message.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVLoginMessage</command:noun> </command:details> <maml:description> <maml:para>Retrieve the current Login Message for the connected appliance(s).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVLoginMessage</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.LoginMessage</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns a resource</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>Get-HPOVLoginMessage Appliance : hpov1.domain.com Message : ************************************ ***** WARNING ******** ************************************ This management appliance is a company owned asset and provided for the exclusive use of authorized personnel. Unauthorized use or abuse of this system may lead to corrective action including termination, civil and/or criminal penalties. Acknowledge : True Appliance : hpov2.domain.com Message : ************************************ ***** WARNING ******** ************************************ This management appliance is a company owned asset and provided for the exclusive use of authorized personnel. Unauthorized use or abuse of this system may lead to corrective action including termination, civil and/or criminal penalties. Acknowledge : False</dev:code> <dev:remarks> <dev:para>Get the Login Message from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVLoginMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVMANAGEDSAN--> <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"> <!--GET-HPOVMANAGEDSAN--> <command:details> <command:name>Get-HPOVManagedSan</command:name> <maml:description> <maml:para>Retrieve Managed SAN resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVManagedSan</command:noun> </command:details> <maml:description> <maml:para>SANs are Fibre Channel (FC) or Fibre Channel over Ethernet (FCoE) storage area networks that connect servers to storage systems. The possible states for SANs are: * Discovered - A SAN that is not associated with a network. SANs are automatically discovered when a SAN manager is added to HPE OneView. * Managed - A SAN that is associated with one or more networks in HPE OneView. Only managed SANs can be configured to be automatically zoned by HPE OneView. Direct attach SANs HPE OneView creates a direct attach SAN (flat SAN) automatically when you configure an enclosure with a logical interconnect that contains a direct attach uplink set. HPE OneView names the direct attach SAN using the format <interconnect><uplink set>. The created SAN is a Fibre Channel (FC) direct attach SAN that is not zoned, and cannot be edited. NOTE: HPE OneView creates a SAN for each interconnect module that is connected to a direct attach Fibre Channel network. Zoning policy A SAN zone enables communication between devices connected to the SAN. SAN zoning policies determine how zoning should be configured on a SAN. SAN zoning policies define whether or not zoning is automated as well as the naming format of zones and aliases. In HPE OneView, you can specify the name format of the zones and aliases that will be created when you associate a storage volume to a server profile via a volume attachment. By specifying zone name and alias formats using text strings and server profile objects, you can create names that are meaningful and conform with your naming conventions. NOTE: HPE OneView performs zoning only when you add a connection to a server profile and attach a SAN storage volume to it. When you do this, HPE OneView will determine if the current zoning allows connectivity. If current zoning does not allow connectivity, HPE OneView will create the necessary zoning based on the specified zoning policy. Automate zoning Automated zoning enables HPE OneView to automatically create, edit, and delete zones on a zoned SAN when you attach storage volumes to servers through a volume attachment in a server profile. * Yes/True - Zoning is automated. HPE OneView takes full control of the zone naming and contents based on the zoning policy for the SAN. Use automated zoning when you want HPE OneView to configure new zones for volume attachments to server profiles. Existing zones are not modified unless the SAN storage attributes defined in a server profile change. * No/False - Zoning is not modified by HPE OneView. You must manually manage zoning. This Cmdlet is used to display or list the discovered and available Managed SAN resources in the appliance once a supported SAN manager has been added to the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVManagedSan</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Managed SAN Name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Fabric"> <maml:name>Name</maml:name> <maml:description> <maml:para>Managed SAN Name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Resources</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>Get-HPOVManagedSan Name State Status Network Zoned Automated Zoning ---- ----- ------ ------- ----- ---------------- Fabric A Ready OK BNA Managed Fabric A Zoned True</dev:code> <dev:remarks> <dev:para>Return all managed SAN resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVManagedSan -Name "Fabric A"</dev:code> <dev:remarks> <dev:para>Show the "Fabric A" Managed SAN resource object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSanZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVManagedSan</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVNETWORK--> <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"> <!--GET-HPOVNETWORK--> <command:details> <command:name>Get-HPOVNetwork</command:name> <maml:description> <maml:para>Retrieve Network resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVNetwork</command:noun> </command:details> <maml:description> <maml:para>A virtual connect interconnect in an enclosure supports the following types of data center networks: * Fibre Channel for storage networks, including fabric-attach (SAN) Fibre Channel (FC) connections and direct-attach (Flat SAN) Fibre Channel connections. * Ethernet for data networks, including tagged, untagged, or tunnel networks. * Fibre Channel over Ethernet (FCoE) for storage networks where storage traffic is carried over a dedicated Ethernet VLAN. NOTE: The networking features described here apply to enclosures and servers only. The appliance does not monitor or manage the network features and hardware for rack mount servers or networking equipment outside the enclosures without using a supported logical switch or fabric manager. NOTE: You can associate a network to both an IPv4 subnet. The details of your networks and any alerts associated with them appear on the Networks screen. If no resources are listed, you must add a resource. See Create networks. About creating networks Before creating networks, be aware of the networking maximums. See the HPE OneView Support Matrix for more information. You can create networks before you add an enclosure, which is known as preprovisioning. About provisioning networks An Ethernet network is provisioned to an interconnect when the network is associated with an uplink set or internal networks in a logical interconnect. An FC or FCoE network is provisioned to an interconnect when the network is associated with an uplink set in a logical interconnect. An Ethernet and FCoE network must be provisioned to a logical interconnect and be consistent with the logical interconnect group to be deployed in a server profile connection. This Cmdlet is used to retrieve a collection of network resources which have the specified type and/or name. The default connection information is included in the returned network resources. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVNetwork</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the network resource to be returned. All network resources will be returned if omitted. Supports "*" wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for Fibre Channel networks. All network resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Specify the Ethernet Purpose value to filter on. Supported Values: * General * Management * VMMigration * FaultTolerance * ISCSI Note: When using this parameter, only Ethernet networks will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label name the network resource is associated with. Cannot be combined with Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the JSON formatted definition of the networks to a file. The directory for the file is validated prior to execution and the function returns an error is the directory does not exist.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label name the network resource is associated with. Cannot be combined with Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the network resource to be returned. All network resources will be returned if omitted. Supports "*" wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Specify the Ethernet Purpose value to filter on. Supported Values: * General * Management * VMMigration * FaultTolerance * ISCSI Note: When using this parameter, only Ethernet networks will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for Fibre Channel networks. All network resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the JSON formatted definition of the networks to a file. The directory for the file is validated prior to execution and the function returns an error is the directory does not exist.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Network Resource Name(s)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.EthernetNetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Ethernet Network resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.FibreChannelNetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Fibre Channel Network resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.FCoENetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single FCoE Network resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Network Object resources</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>$net41 = Get-HPOVNetwork -name "Net-41"</dev:code> <dev:remarks> <dev:para>Return the network resource with the name "Net-41"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ethNets = Get-HPOVNetwork -type Ethernet</dev:code> <dev:remarks> <dev:para>Return all the Ethernet network resources</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ethNets = Get-HPOVNetwork -Name VLAN_19*</dev:code> <dev:remarks> <dev:para>Return all Ethernet Networks that match "VLAN_19*".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ethNets = "Net1","Net2","Net3" | Get-HPOVNetwork -Type Ethernet</dev:code> <dev:remarks> <dev:para>Return Net1, Net2, and Net3 Ethernet Networks from the specified appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetwork -exportFile "c:\myApplianceConfig\myNets.json"</dev:code> <dev:remarks> <dev:para>Exports all networks to the file myNets.json in JSON format.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetwork -x "c:\myApplianceConfig\myNets.json" -type Ethernet</dev:code> <dev:remarks> <dev:para>Exports only the ethernet networks to the file myNets.json.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetwork Type: Ethernet Name Type VLAN ID Purpose Smartlink Private Network Status Preferred Bandwidth Max Bandwidth ---- ---- ------- ------- --------- --------------- ------ ------------------- ------------- VLAN 1-A Tagged 1 Management True False OK 2500 10000 VLAN 1-B Tagged 1 Management True False OK 2500 10000 VLAN 10-A Tagged 10 VMMigration True False OK 2500 10000 VLAN 10-B Tagged 10 VMMigration True False OK 2500 10000 VLAN 101-A Tagged 101 General True False OK 2500 10000 VLAN 101-B Tagged 101 General True False OK 2500 10000 VLAN 102-A Tagged 102 General True False OK 2500 10000 VLAN 102-B Tagged 102 General True False OK 2500 10000 VLAN 103-A Tagged 103 General True False OK 2500 10000 VLAN 103-B Tagged 103 General True False OK 2500 10000 VLAN 104-A Tagged 104 General True False OK 2500 10000 VLAN 104-B Tagged 104 General True False OK 2500 10000 VLAN 105-A Tagged 105 General True False OK 2500 10000 VLAN 105-B Tagged 105 General True False OK 2500 10000 VLAN 20-A Tagged 20 General True False OK 2500 10000 VLAN 20-B Tagged 20 General True False OK 2500 10000 VLAN 201-A Tagged 201 General True False OK 2500 10000 VLAN 201-B Tagged 201 General True False OK 2500 10000 VLAN 30-A Tagged 30 General True False OK 2500 10000 VLAN 30-B Tagged 30 General True False OK 2500 10000 VLAN 301-A Tagged 301 General True False OK 2500 10000 VLAN 301-B Tagged 301 General True False OK 2500 10000 VLAN 40-A Tagged 40 General True False OK 2500 10000 VLAN 40-B Tagged 40 General True False OK 2500 10000 VLAN 401-A Tagged 401 General True False OK 2500 10000 VLAN 401-B Tagged 401 General True False OK 2500 10000 VLAN 50-A Tagged 50 General True False OK 2500 10000 VLAN 50-B Tagged 50 General True False OK 2500 10000 VLAN 501-A Tagged 501 General True False OK 2500 10000 VLAN 501-B Tagged 501 General True False OK 2500 10000 Type: Fibre Channel Name Status Type Typical Bandwidth Max Bandwidth Auto Login Redistribution Link Stability Interval ---- ------ ---- ----------------- ------------- ------------------------- ----------------------- 3PAR SAN DA A OK DirectAttach 4000 8000 False 0 3PAR SAN DA B OK DirectAttach 4000 8000 False 0 3PAR SAN Fabric A OK FabricAttach 4000 8000 True 30 3PAR SAN Fabric B OK FabricAttach 4000 8000 True 30 Type: FCoE Name Status vlanId Typical Bandwidth Max Bandwidth Associated SAN ---- ------ ------ ----------------- ------------- -------------- fcoe1 OK 134 2500 20000 FCOE3 OK 11 2500 10000 FCOE2 OK 10 2500 10000 FCOE12 OK 12 2500 10000</dev:code> <dev:remarks> <dev:para>Get all available networks.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVNETWORKSET--> <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"> <!--GET-HPOVNETWORKSET--> <command:details> <command:name>Get-HPOVNetworkSet</command:name> <maml:description> <maml:para>Retrieve Network Set resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVNetworkSet</command:noun> </command:details> <maml:description> <maml:para>A network set is a collection of tagged Ethernet networks that form a named group to simplify server profile creation. Network sets are useful in virtual environments where each server profile connection needs to access multiple networks. Use network sets in server profile connections to make all networks on a connection's downlink port available. Network sets define how packets will be delivered to the server when a server Ethernet connection is associated with the network set. Network sets also enable you to define a VLAN trunk and associate it with a server connection. Instead of assigning a single network to a connection in a server profile, you can assign a network set to that connection. * Using network sets, you can quickly deploy changes to the network environment to multiple servers. For example, you have 16 servers connected to a network set. To add a new network to all 16 servers, you only need to add it to the network set instead of each server individually. * You can create a network set for your production networks and one for your development networks. * You can configure a hypervisor with a vSwitch to access multiple VLANs by creating a network set as a trunk that includes these networks. Network set prerequisites * All networks in a network set must be Ethernet networks and must have unique external VLAN IDs. Untagged and tunnel networks are single networks and do not use network sets. * All networks in a network set must be configured in the same appliance. * A network can be a member of multiple network sets. * All networks in a network set must be added to uplink sets or internal networks in the logical interconnect group (and its logical interconnects) to be used in server profiles with connections to the logical interconnect. * A network set can be empty (contain no networks) or can contain one or more of the networks configured in the logical interconnect group and logical interconnect. Empty network sets enable you to create network sets in the configuration before you create the member networks, or to remove all the member networks before you add their replacements. However, if a server profile adds a connection to an empty network set, the server cannot connect to any data center networks using that connection. Network set types You can select either a Regular or Large network set type. You can deploy Large network sets on rack servers or using the HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy. You cannot deploy Large network sets on blade servers. If the network set type is selected for blade server profiles or server profile templates, you cannot convert the network set type from Regular to Large. For rack or blade servers: Regular network sets can contain up to 162 networks. Large network sets can contain up to a maximum of 4,000 networks. Network sets with more than 4,000 networks are not supported on rack servers. VLANs with VLAN IDs above 4,000 are reserved for use by the HPE Composable Fabric Manager. For HPE Synergy: Regular network sets can contain up to 1,000 networks. Large network sets can contain up to 4,094 networks minus the number of networks that are in the reserved VLAN range, which can range from 60 to 128 networks. The default is 128 networks. Generally, the maximum number of networks is 3,966 networks. A maximum of 60 distinct large network sets can be simultaneously deployed per logical interconnect. This Cmdlet is used to retrieve a collection of network set resources which have the specified type and/or name. The default connection information is included in the returned network resources. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVNetworkSet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Network Set to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVNetworkSet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Network Set to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>ExportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x, export"> <maml:name>ExportFile</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Network Set to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.NetworkSet [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Network Set</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.NetworkSet></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Network Sets</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>Get-HPOVNetworkSet</dev:code> <dev:remarks> <dev:para>Returns all Network Sets defined on the appliance to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetworkSet -Name "Production"</dev:code> <dev:remarks> <dev:para>Returns just the Production Network Set object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myNetSets = Get-HPOVNetworkSet</dev:code> <dev:remarks> <dev:para>Returns the Get-HPOVNetworkSet query and stores it in the object $myNetSets</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetworkSet -exportFile "c:\myApplianceConfig\Network-Sets.json"</dev:code> <dev:remarks> <dev:para>Returns the Get-HPOVNetworkSet query results to the file c:\myApplianceConfig\Network-Sets.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVOSDEPLOYMENTPLAN--> <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"> <!--GET-HPOVOSDEPLOYMENTPLAN--> <command:details> <command:name>Get-HPOVOSDeploymentPlan</command:name> <maml:description> <maml:para>Retrieve OS deployment server deployment plan.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVOSDeploymentPlan</command:noun> </command:details> <maml:description> <maml:para>An OS Deployment Plan is a recipe on how to deploy and configure an operating system, which has been created and is managed from on the associated OS deployment server. It will contain custom attributes that are necessary to personalize the OS deployment plan. The supported OS deployment server is HPE Image Streamer for Synergy. Use this Cmdlet to return defined OS Deployment Plans on an HPE Synergy Image Streamer appliance. The resource object will also provide the custom attributes allowed. Use the Get-HPOVOSDeploymentPlanAttribute to return the collection object of attributes. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVOSDeploymentPlan</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS Deployment Plan name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS Deployment Plan name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.OSDeploymentPlan</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An HPE Synergy Image Streamer OS Deployment plan object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentPlan></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A collection or HPE Synergy Image Streamer OS Deployment plan objects.</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>Get-HPOVOSDeploymentPlan</dev:code> <dev:remarks> <dev:para>Retrieve all defined OS Deployment Plans found on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVOSDeploymentPlan -Name "My OS Deployment Plan"</dev:code> <dev:remarks> <dev:para>Retrieve the specified OS Deployment Plan on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVOSDeploymentPlanAttribute</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVOSDEPLOYMENTPLANATTRIBUTE--> <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"> <!--GET-HPOVOSDEPLOYMENTPLANATTRIBUTE--> <command:details> <command:name>Get-HPOVOSDeploymentPlanAttribute</command:name> <maml:description> <maml:para>Get OS deployment plan parameters and attributes.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVOSDeploymentPlanAttribute</command:noun> </command:details> <maml:description> <maml:para>An OS Deployment Plan is a recipe on how to deploy and configure an operating system, which has been created and is managed from on the associated OS deployment server. It will contain custom attributes that are necessary to personalize the OS deployment plan. The supported OS deployment server is HPE Image Streamer for Synergy. Use this Cmdlet to return defined OS deployment plan custom attributes from a specified OS deployment plan. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVOSDeploymentPlanAttribute</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The OS Deployment Plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The OS Deployment Plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.OSDeploymentPlan [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The OS Deployment Plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerProfile.OSDeployment.OSDeploymentParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object contained the Name of the parameter, and its default Value.</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>Get-HPOVOSDeploymentPlan -Name "RHEL 7.2 OS" -ErrorAction Stop | Get-HPOVOSDeploymentPlanAttribute</dev:code> <dev:remarks> <dev:para>Return OS Deployment Plan parameters from the "RHEL 7.2 OS" deployment plan.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$OSDeploymentAttributes = Get-HPOVOSDeploymentPlanAttributes -InputObject $MyDeploymentPlan $OSDeploymentAttributes = $OSDeploymentAttributes | Where-Object name -NotMatch 'dns|gateway|ipaddress|netmask' ($OSDeploymentAttributes | Where-Object name -eq "NIC1.connectionid").value = 3 ($OSDeploymentAttributes | Where-Object name -eq "NIC1.networkuri").value = $I3SCon3.networkUri ($OSDeploymentAttributes | Where-Object name -eq "NIC1.constraint").value = 'dhcp' ($OSDeploymentAttributes | Where-Object name -eq "NIC1.dhcp").value = $true ($OSDeploymentAttributes | Where-Object name -eq "NIC2.connectionid").value = 4 ($OSDeploymentAttributes | Where-Object name -eq "NIC2.networkuri").value = $I3SCon4.networkUri ($OSDeploymentAttributes | Where-Object name -eq "NIC2.constraint").value = 'dhcp' ($OSDeploymentAttributes | Where-Object name -eq "NIC2.dhcp").value = $true</dev:code> <dev:remarks> <dev:para>Get OS deployment plan attributes, and set DHCP for the two network connections.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVOSDeploymentPlan</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVOSDEPLOYMENTSERVER--> <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"> <!--GET-HPOVOSDEPLOYMENTSERVER--> <command:details> <command:name>Get-HPOVOSDeploymentServer</command:name> <maml:description> <maml:para>Retrieve HPE Synergy OS Deployment Server.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVOSDeploymentServer</command:noun> </command:details> <maml:description> <maml:para>An OS deployment server is a resource that enables you to deploy (install and configure) operating systems for use by servers. HPE OneView connects to an OS deployment server and configures it for deploying operating systems. The default selection is HPE Synergy Image Streamer, when an Image Streamer is discovered in an HPE Synergy configuration. The HPE OneView Infrastructure administrator can add an OS deployment server. HPE OneView manages the OS deployment server after it is configured and displays the list of attributes, management settings, the OS deployment plans, and the server profiles that reference the available OS deployment plans. This Cmdlet will return the discovered OS deployment servers. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVOSDeploymentServer</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS deployment server resource name. Supported the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS deployment server resource name. Supported the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.OSDeploymentServer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An HPE Synergy Image Streamer appliance object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<HPOneView.Appliance.OSDeploymentServer></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A collection of HPE Synergy Image Streamer appliance objects.</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>Get-HPOVOSDeploymentServer</dev:code> <dev:remarks> <dev:para>List all HPE Synergy OS Deployment servers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVPENDINGUPDATE--> <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"> <!--GET-HPOVPENDINGUPDATE--> <command:details> <command:name>Get-HPOVPendingUpdate</command:name> <maml:description> <maml:para>Verify pending appliance update has been staged.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVPendingUpdate</command:noun> </command:details> <maml:description> <maml:para>The appliance runs a combination of software and firmware. Maintaining up-to-date appliance software and firmware fixes problems, improves performance, and adds new features to the appliance. The appliance does not automatically notify you when an update is available. You must determine if an appliance update file has been released. To view the installed version of appliance firmware, use Get-HPOVVersion Cmdlet. Verify if a newer version of an appliance update file is available for download at www.hpe.com/info/hpeoneview/updates. Before you update the appliance, examine the HPE OneView Release Notes to learn about supported upgrade paths, new features delivered in the update, limitations, troubleshooting hints and tips, and if you must restart the appliance after it is updated. NOTE: When you download the appliance update file, a link to the HPE OneView Release Notes appears in the download dialog box. Hewlett Packard Enterprise recommends that you click the link to read, save, and print the information for future reference. Once the download starts, you cannot access the link again. When you install an appliance update, the appliance restarts and goes offline. When the appliance is offline, it does not affect the managed resources. The managed resources continue to operate while the appliance is offline. Minimum required privileges: Infrastructure administrator or Software administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVPendingUpdate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Update.Pending [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Pending appliance update</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>Get-HPOVPendingUpdate</dev:code> <dev:remarks> <dev:para>Retrieve pending update from all connected appliance sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVVersion</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPOVUpdate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVPendingUpdate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVPOWERDEVICE--> <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"> <!--GET-HPOVPOWERDEVICE--> <command:details> <command:name>Get-HPOVPowerDevice</command:name> <maml:description> <maml:para>Retrieve Power Device (iPDU) resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVPowerDevice</command:noun> </command:details> <maml:description> <maml:para>Power delivery devices provide power to IT hardware. A typical power topology in a data center includes power delivery devices such as power feeds, breaker panels, branch circuits, and power distribution units (PDUs), as well as the load segments, outlet bars, and outlet components of these devices. Adding your power delivery devices to the appliance enables power management using thermal limits, rated capacity, and derated capacity. This Cmdlet will retrieve the following classes of devices: * Intelligent Power Distribution Units (iPDUs), which the appliance can automatically discover and control. * Other power delivery devices that the appliance cannot discover. By manually adding these devices to the appliance, they become available for tracking, inventory, and power management purposes. Regardless of how power delivery devices are added to the appliance, the appliance automatically generates the same types of analysis (capacity, redundancy, and configuration). For iPDUs, the appliance gathers statistical data and reports errors. Connectivity and synchronization with the appliance The appliance monitors the connectivity status of iPDUs. If the appliance loses connectivity with an iPDU, an alert displays until connectivity is restored. The appliance will try to resolve connectivity issues and clear the alert automatically, but if it cannot, you must resolve the issue and manually refresh the iPDU to bring it in synchronization with the appliance. The appliance also monitors iPDU to remain synchronized with changes to hardware and power connections. However, some changes to devices made outside of the control of the appliance (from iLO or the OA, for example) may cause them to become out of synchronization with the appliance. You may have to manually refresh devices that lose synchronization with the appliance. NOTE: Hewlett Packard Enterprise recommends that you do not use iLO or the OA to make changes to a device. Making changes to a device from its iLO or OA could cause it to lose synchronization with the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVPowerDevice</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the power device resource to be returned. All power device resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the Power Delivery Device type. Allowed values: * HPIpduCore * HPIpduAcModule * LoadSegment * HPIpduOutletBar * HPIpduOutlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the power device resource to be returned. All power device resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the Power Delivery Device type. Allowed values: * HPIpduCore * HPIpduAcModule * LoadSegment * HPIpduOutletBar * HPIpduOutlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.PowerDeliveryDevice [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The matching power device resources</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.PowerDeliveryDevice></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The matching power device resources</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>$powerDevices = Get-HPOVPowerDevice</dev:code> <dev:remarks> <dev:para>Return all the power devices managed by this appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$powerDeviceA = Get-HPOVPowerDevice -Name "iPDU_A"</dev:code> <dev:remarks> <dev:para>Return the power device resource with name "iPDU_A".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVPOWERPOTENTIALDEVICECONNECTION--> <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"> <!--GET-HPOVPOWERPOTENTIALDEVICECONNECTION--> <command:details> <command:name>Get-HPOVPowerPotentialDeviceConnection</command:name> <maml:description> <maml:para>Retrieve power device (mPDU/Rack PDU) potential connections.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVPowerPotentialDeviceConnection</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of potential managed and unmanaged device power connections for the provided power device resource. The returned value(s) will include the potential power connections that can be manually associated when not using iPDU devices.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVPowerPotentialDeviceConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>PowerDevice</maml:name> <maml:description> <maml:para>The name of the power device resource. Can provide Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name"> <maml:name>PowerDevice</maml:name> <maml:description> <maml:para>The name of the power device resource. Can provide Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Potential managed/unmanaged device Power Delivery Device connection object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of matching potential power device connection objects</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>Get-HPOVPowerDevice "iPDU_A" | Get-HPOVPowerPotentialDeviceConnection</dev:code> <dev:remarks> <dev:para>Return the potential power device connections for the "iPDU_A" power delivery device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVPowerPotentialDeviceConnection "iPDU_A"</dev:code> <dev:remarks> <dev:para>Return the potential power device connections for the "iPDU_A" power delivery device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVRACK--> <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"> <!--GET-HPOVRACK--> <command:details> <command:name>Get-HPOVRack</command:name> <maml:description> <maml:para>Retrieve a defined Rack.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRack</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will retrieve all or a specific Rack resource object. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRack</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Rack name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Datacenter</maml:name> <maml:description> <maml:para>Filter racks that are a member of a data center. Provide the data center object from Get-HPOVDatacenter Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Datacenter</maml:name> <maml:description> <maml:para>Filter racks that are a member of a data center. Provide the data center object from Get-HPOVDatacenter Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Rack name. Supports wildcard (*) character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.Rack</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A Rack resource object.</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>Get-HPOVRack</dev:code> <dev:remarks> <dev:para>Retrieve all defined DataCenters on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVRack -Name Rack22*</dev:code> <dev:remarks> <dev:para>Locate all racks objects that begin with "Rack22".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackToDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRackMemberLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVRACKMANAGER--> <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"> <!--GET-HPOVRACKMANAGER--> <command:details> <command:name>Get-HPOVRackManager</command:name> <maml:description> <maml:para>Get claimed rack manage resource.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRackManager</command:noun> </command:details> <maml:description> <maml:para>A rack manager platform is a multinode system. The nodes are housed within a rack or across racks, and are centrally managed by a management controller. The Rack Managers screen enables you to manage and visualize the physical location of rack manager platforms within a rack. A rack manager platform consists of the following: * One or more chassis - The chassis are individual nodes that are used to build logical components such as systems or partitions. Each chassis is a physical container for system components like the compute, storage, or network nodes. In an HPE Superdome Flex Server, the chassis are 5U nodes that represent the compute nodes with CPU, memory, I/O, power supplies, and fans. * One or more systems or partitions - The system is a logical entity that functions as a server, and runs a single instance of an operating system to host services. In HPE OneView, the partition is modeled as a server hardware resource. In an HPE Superdome Flex Server, the systems are also called partitions. A partition consists of one or more compute chassis that are interconnected through an ultra-fast fabric. Each partition starts with a base chassis and can be extended using expansion chassis to form a large system. * One or more managers - The manager component manages the rack manager platform, and hosts the management controller function. HPE OneView communicates with the rack manager through this management controller enabling system administration, control, and platform management of the rack manager platform. Some platforms have multiple manager components to support redundancy. In an HPE Superdome Flex Server, the manager component is called the Rack Management Controller (RMC). The RMC hosts the DMTF Redfish APIs. * One or more racks - The racks physically contain all the rack manager platform components. This Cmdlet will retrieve available rack managers added to the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRackManager</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a resource name to filter for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a resource name to filter for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Servers.RackManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Rack manager resource object, with associated sub components like managers, chassis and rack.</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>Get-HPOVRackManager</dev:code> <dev:remarks> <dev:para>Get all added rack manager resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVRackManager -Name manager1.domain.com -ErrorAction Stop</dev:code> <dev:remarks> <dev:para>Get the specified rack manager resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVRACKMEMBER--> <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"> <!--GET-HPOVRACKMEMBER--> <command:details> <command:name>Get-HPOVRackMember</command:name> <maml:description> <maml:para>Get a member device from a defined Rack.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRackMember</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will return members within a specified rack. Minimum required privileges: Read only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRackMember</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack resource from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of a member within the Rack. Supports (*) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack resource from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of a member within the Rack. Supports (*) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.Rack</maml:name> </dev:type> <maml:description> <maml:para>Rack resource object from Get-HPOVRack.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.RackMember</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The individual rack member resource object.</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>Get-HPOVRack -Name Rack-221 | Get-HPOVRackMember</dev:code> <dev:remarks> <dev:para>Retrieve all rack members from the specified rack.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Rack = Get-HPOVRack -Name Rack-221 Get-HPOVRackMember -InputObject $Rack -Name ProdDL380*</dev:code> <dev:remarks> <dev:para>Retrieve rack members that begin with "ProdDL380" within the "Rack-221" rack resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRackMemberLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORT--> <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"> <!--GET-HPOVREMOTESUPPORT--> <command:details> <command:name>Get-HPOVRemoteSupport</command:name> <maml:description> <maml:para>Retrieve appliance Remote Support configuration.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupport</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Eligible devices are Gen8 and newer blades and enclosures. WARNING: Servers must be at iLO 2.1 firmware level or above to be enabled for remote support Hewlett Packard Enterprise will contact you to ship a replacement part or send an engineer for devices that are under warranty or support contract. Remote support enables Proactive Care services including Proactive Scan reports and Firmware/Software Analysis reports with recommendations that are based on collected configuration data. Remote support is secure. No business data is collected, only device-specific configuration and fault data. All communications are outbound only and use industry standard TLS encryption ensuring confidentiality and integrity of the information. Once the appliance is configured, it cannot be unauthorized or disabled. Use this Cmdlet to get the appliance"s current Remote Support configuration. This Cmdlet does not return device collection data or schedules. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupport</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Configuration</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The setting object with updated parameters.</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>Get-HPOVRemoteSupport Appliance Enabled Company AutoEnableDevices MarketingOptIn InsightOnlineEnabled --------- ------- ------- ----------------- -------------- -------------------- myappliance.domain.com True MyCompany False False False</dev:code> <dev:remarks> <dev:para>Returns the existing Remote Support configuration of the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVRemoteSupportCollection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRemoteSupportEntitlement</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTCONTACT--> <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"> <!--GET-HPOVREMOTESUPPORTCONTACT--> <command:details> <command:name>Get-HPOVRemoteSupportContact</command:name> <maml:description> <maml:para>Retrieve configured Remote Support contacts.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportContact</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. HPE OneView automatically checks if your hardware has a valid entitlement to Hewlett Packard Enterprise support. A valid entitlement is a Hewlett Packard Enterprise warranty or an active contract. If a valid entitlement to support is found, HPE OneView Remote Support opens a support case for a hardware failure. Eligible devices are Gen8 and newer blades and enclosures. WARNING: Servers must be at iLO 2.1 firmware level or above to be enabled for remote support Hewlett Packard Enterprise will contact you to ship a replacement part or send an engineer for devices that are under warranty or support contract. Hewlett Packard Enterprise uses contact information when a support case is created. You can add, remove, and specify primary and secondary contacts. Primary and secondary contacts are applied to the devices by default. Remote support enables Proactive Care services including Proactive Scan reports and Firmware/Software Analysis reports with recommendations that are based on collected configuration data. Remote support is secure. No business data is collected, only device-specific configuration and fault data. All communications are outbound only and use industry standard TLS encryption ensuring confidentiality and integrity of the information. Once the appliance is configured, it cannot be unauthorized or disabled. Use this Cmdlet to get the configured Remote Support contacts defined on the appliance. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportContact</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Full ("Bob Smith") or partial ("Bob*") name of the contact. When using partial names, please include the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Full ("Bob Smith") or partial ("Bob*") name of the contact. When using partial names, please include the * (asterisk) wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured Remote Support Contact.</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>Get-HPOVRemoteSupportContact</dev:code> <dev:remarks> <dev:para>List all configured Remote Support Contacts.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVRemoteSupportContact -Name "Bob*"</dev:code> <dev:remarks> <dev:para>List all contacts with the name Bob, using the * wildcard character.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTDATACOLLECTIONSCHEDULE--> <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"> <!--GET-HPOVREMOTESUPPORTDATACOLLECTIONSCHEDULE--> <command:details> <command:name>Get-HPOVRemoteSupportDataCollectionSchedule</command:name> <maml:description> <maml:para>Retrieve Remote Support Schedule settings on an appliance.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportDataCollectionSchedule</command:noun> </command:details> <maml:description> <maml:para>Remote support collects hardware diagnostic and system configuration information. It also stores administrator contact information. This information can be sent to Hewlett Packard Enterprise and used to troubleshoot and resolve system issues. Basic collection sends configuration information to Hewlett Packard Enterprise for analysis and proactive services in accordance with your warranty and service agreements. This data is transmitted every 30 days. Active health sends information about the server?s health, configuration, and run-time telemetry to Hewlett Packard Enterprise. This information is used to troubleshoot issues and closed-loop quality analysis. This data is transmitted every 7 days. To perform basic device monitoring, configuration and diagnostic collections, and to maintain the health of the remote support solution, on a periodic and event driven basis remote support sends certain information to Hewlett Packard Enterprise. This information is used in accordance with the Software License Documents (https://www.hpe.com/us/en/software/licensing) and the HPE Online Privacy Statement (https://www.hpe.com/us/en/privacy/ww-privacy-statement.html). To ensure that Hewlett Packard Enterprise can respond effectively to a required repair and to provide services and recommendations to reduce downtime, remote support collects service delivery information which includes device administrator contact details such as name, phone number, and email address, and site location information such as postal address. To properly identify monitored devices and to synchronize the local remote support software with the Hewlett Packard Enterprise support automation services, remote support sends periodic data to Hewlett Packard Enterprise which includes service delivery information as well as basic device identification information such as IP addresses, MAC addresses, hostname and FQDN. To automate service delivery when a failure is detected on a monitored device, remote support sends information about the failure event which includes diagnostic sense data, firmware information, model number, serial number, failure details, as well as service delivery information and basic device identifiers as mentioned above. Remote support sends detailed configuration, telemetry and diagnostic information to Hewlett Packard Enterprise. This information can be used by Hewlett Packard Enterprise for troubleshooting, repair and internal closed loop quality purposes. Configuration collections may be required to deliver additional services. Information sent to Hewlett Packard Enterprise varies by device type, but in addition to data noted above it can include component configuration, firmware versions, OS type and version, DNS configuration, Windows domain, and diagnostic information. Configuration, telemetry and diagnostic information can also be utilized by Hewlett Packard Enterprise or its affiliates to provide recommendations to optimize your environment and minimize downtime. You must provide permission to use this information in this manner by choosing to do so in the remote support. If you choose to 'Opt-In' to be contacted by Hewlett Packard Enterprise or your Hewlett Packard Enterprise authorized reseller to optimize your IT environment, Hewlett Packard Enterprise or Hewlett Packard Enterprise authorized resellers may use the collected configuration data to provide you with recommendations, and sell or deliver solutions, to optimize your IT environment. These providers may be located in countries other than your Hewlett Packard Enterprise IT hardware locations. Hewlett Packard Enterprise's providers are required to keep confidential information received from Hewlett Packard Enterprise and may use it only for the purpose of providing advisories and recommendations on behalf of Hewlett Packard Enterprise. You will have the option to specify your Hewlett Packard Enterprise authorized reseller(s) or support provider(s) during setup of remote support software. Only the Hewlett Packard Enterprise authorized resellers and support providers you associate with your devices can receive your configuration data to individually contact you for making IT environment recommendations, sell, or deliver solutions. Some of the information collected is also used for optional display in Insight Online. This information can be associated with your HPE Passport credentials and viewable by you in Insight Online. For more details on the data items transmitted, see the security white paper in the Insight Remote Support (http://www.hpe.com/info/insightremotesupport/docs) section. Use this Cmdlet to retrieve configured schedules to collect Remote Support logs. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportDataCollectionSchedule</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the schedule type to modify. Allowed value is: * AHS *Basic If no value is provided, both schedules will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the schedule type to modify. Allowed value is: * AHS *Basic If no value is provided, both schedules will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemtoeSupport.Schedule [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured Remote Support data collection schedule.</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>Get-HPOVRemoteSupportDataCollectionSchedule</dev:code> <dev:remarks> <dev:para>Get the Remote Support data collection schedules.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTDEFAULTSITE--> <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"> <!--GET-HPOVREMOTESUPPORTDEFAULTSITE--> <command:details> <command:name>Get-HPOVRemoteSupportDefaultSite</command:name> <maml:description> <maml:para>Retrieve Remote Support Default Site.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportDefaultSite</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Hewlett Packard Enterprise recommends enabling all features and benefits provided by HPE OneView Remote Support so you can receive fast, accurate 'phone home' support and service per your contractual terms with Hewlett Packard Enterprise. Hewlett Packard Enterprise securely collects your HPE IT hardware diagnostics, configuration and telemetry information to provide you with remote support and services. The data is handled and managed to respect your privacy. For more information, Hewlett Packard Enterprise's Privacy Statement can be found at http://privacy.hpe.com. Enabling Remote Support configures your devices being remotely supported to securely send support or service events, IT configuration information, diagnostic, and telemetry information to Hewlett Packard Enterprise, together with your support contact information. No other business information is collected and the data is managed according to the Hewlett Packard Enterprise's Privacy Statement. This Cmdlet will get the address of the data center where the devices are located for support. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportDefaultSite</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Configured Remote Support default site.</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>Get-HPOVRemoteSupportDefaultSite</dev:code> <dev:remarks> <dev:para>Get the configured Remote Support default site.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTENTITLEMENTSTATUS--> <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"> <!--GET-HPOVREMOTESUPPORTENTITLEMENTSTATUS--> <command:details> <command:name>Get-HPOVRemoteSupportEntitlementStatus</command:name> <maml:description> <maml:para>Get Remote Support for a supported resource.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportEntitlementStatus</command:noun> </command:details> <maml:description> <maml:para>Remote support collects hardware diagnostic and system configuration information. It also stores administrator contact information. This information can be sent to Hewlett Packard Enterprise and used to troubleshoot and resolve system issues. Basic collection sends configuration information to Hewlett Packard Enterprise for analysis and proactive services in accordance with your warranty and service agreements. This data is transmitted every 30 days. Active health sends information about the server?s health, configuration, and run-time telemetry to Hewlett Packard Enterprise. This information is used to troubleshoot issues and closed-loop quality analysis. This data is transmitted every 7 days. To perform basic device monitoring, configuration and diagnostic collections, and to maintain the health of the remote support solution, on a periodic and event driven basis remote support sends certain information to Hewlett Packard Enterprise. This information is used in accordance with the Software License Documents (https://www.hpe.com/us/en/software/licensing) and the HPE Online Privacy Statement (https://www.hpe.com/us/en/privacy/ww-privacy-statement.html). To ensure that Hewlett Packard Enterprise can respond effectively to a required repair and to provide services and recommendations to reduce downtime, remote support collects service delivery information which includes device administrator contact details such as name, phone number, and email address, and site location information such as postal address. To properly identify monitored devices and to synchronize the local remote support software with the Hewlett Packard Enterprise support automation services, remote support sends periodic data to Hewlett Packard Enterprise which includes service delivery information as well as basic device identification information such as IP addresses, MAC addresses, hostname and FQDN. To automate service delivery when a failure is detected on a monitored device, remote support sends information about the failure event which includes diagnostic sense data, firmware information, model number, serial number, failure details, as well as service delivery information and basic device identifiers as mentioned above. Remote support sends detailed configuration, telemetry and diagnostic information to Hewlett Packard Enterprise. This information can be used by Hewlett Packard Enterprise for troubleshooting, repair and internal closed loop quality purposes. Configuration collections may be required to deliver additional services. Information sent to Hewlett Packard Enterprise varies by device type, but in addition to data noted above it can include component configuration, firmware versions, OS type and version, DNS configuration, Windows domain, and diagnostic information. Configuration, telemetry and diagnostic information can also be utilized by Hewlett Packard Enterprise or its affiliates to provide recommendations to optimize your environment and minimize downtime. You must provide permission to use this information in this manner by choosing to do so in the remote support. If you choose to 'Opt-In' to be contacted by Hewlett Packard Enterprise or your Hewlett Packard Enterprise authorized reseller to optimize your IT environment, Hewlett Packard Enterprise or Hewlett Packard Enterprise authorized resellers may use the collected configuration data to provide you with recommendations, and sell or deliver solutions, to optimize your IT environment. These providers may be located in countries other than your Hewlett Packard Enterprise IT hardware locations. Hewlett Packard Enterprise's providers are required to keep confidential information received from Hewlett Packard Enterprise and may use it only for the purpose of providing advisories and recommendations on behalf of Hewlett Packard Enterprise. You will have the option to specify your Hewlett Packard Enterprise authorized reseller(s) or support provider(s) during setup of remote support software. Only the Hewlett Packard Enterprise authorized resellers and support providers you associate with your devices can receive your configuration data to individually contact you for making IT environment recommendations, sell, or deliver solutions. Some of the information collected is also used for optional display in Insight Online. This information can be associated with your HPE Passport credentials and viewable by you in Insight Online. For more details on the data items transmitted, see the security white paper in the Insight Remote Support (http://www.hpe.com/info/insightremotesupport/docs) section. This Cmdlet will return the Remote Support entitlement status for a compute or enclosure resource. If remote support has not been globally enabled and configured on the appliance, this Cmdlet will fail. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportEntitlementStatus</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.RemoteSupport.ContractAndWarrantyStatus</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object with the current contract and warranty status.</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>Get-HPOVServer -Name Prod* | Get-HPOVRemoteSupportEntitlementStatus</dev:code> <dev:remarks> <dev:para>Get the servers with their name matching "Prod" and get their Remote Support entitlement status.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Enclosure = Get-HPOVEnclosure -Name Enclosure-1A Get-HPOVRemoteSupportEntitlementStatus -InputObject $Enclusre</dev:code> <dev:remarks> <dev:para>Get the specific enclosure resource and get Remote Support entitlement status.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTPARTNER--> <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"> <!--GET-HPOVREMOTESUPPORTPARTNER--> <command:details> <command:name>Get-HPOVRemoteSupportPartner</command:name> <maml:description> <maml:para>Retrieve defined Support and Reseller partners.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportPartner</command:noun> </command:details> <maml:description> <maml:para>The Partner ID uniquely identifies a partner as an HPE Authorized Partner. Hewlett Packard Enterprise is the default channel partner if no other channel partner is assigned. HPE Authorized Resellers By enabling remote support, you enable the reseller to access configuration reports and contract warranty reports in Insight Online in the HPE Support Center, as well as configuration details and some contract and warranty details. HPE Authorized Service Partners In addition to the above information provided to Authorized Resellers, the Service Partner has access to service event status and reports, with links into the HPE Channel Services Network portal. Use this Cmdlet to Retrieve defined Remote Support partners that are authorized HPE Resellers and/or Support. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportPartner</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the HPE Partner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the HPE Partner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Partner [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Defined HPE authorized reseller and/or support partners.</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>Get-HPOVRemoteSupportPartner</dev:code> <dev:remarks> <dev:para>Get all configured report support partners.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESUPPORTSETTING--> <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"> <!--GET-HPOVREMOTESUPPORTSETTING--> <command:details> <command:name>Get-HPOVRemoteSupportSetting</command:name> <maml:description> <maml:para>Get supported resource Remote Support settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSupportSetting</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Eligible devices are Gen8 and newer blades and enclosures. WARNING: Servers must be at iLO 2.1 firmware level or above to be enabled for remote support Hewlett Packard Enterprise will contact you to ship a replacement part or send an engineer for devices that are under warranty or support contract. Remote support enables Proactive Care services including Proactive Scan reports and Firmware/Software Analysis reports with recommendations that are based on collected configuration data. Remote support is secure. No business data is collected, only device-specific configuration and fault data. All communications are outbound only and use industry standard TLS encryption ensuring confidentiality and integrity of the information. Once the appliance is configured, it cannot be unauthorized or disabled. Use this Cmdlet to retrieve a supported resources Remote Support settings of an enabled resource (compute or enclosure), defined Parimary and Secondary contact, and authorized reseller or support partners. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSupportSetting</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server hardware resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Enclosure resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.ResourceSetting [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Remote Support Settings object.</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>Get-HPOVEnclosure -Name Encl1 | Get-HPOVRemoteSupportSetting Appliance ResourceName SalesChannelPartner SupportChannelPartner PrimaryContact SecondaryContact --------- ------------ ------------------- --------------------- -------------- ---------------- MyAppliance.domain.com Encl1 Hewlett Packard Enterprise Hewlett Packard Enterprise Mark Jones</dev:code> <dev:remarks> <dev:para>Get the configured Remote Support collection settings for "Encl1" Enclosure resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name PROD* | Get-HPOVRemoteSupportSetting | ? supportEnabled -eq $false</dev:code> <dev:remarks> <dev:para>Return all PROD servers, and return only those where remote support is not enabled.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVREMOTESYSLOG--> <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"> <!--GET-HPOVREMOTESYSLOG--> <command:details> <command:name>Get-HPOVRemoteSyslog</command:name> <maml:description> <maml:para>Get the configured remote syslog settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRemoteSyslog</command:noun> </command:details> <maml:description> <maml:para>The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles disabling the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRemoteSyslog</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.RemoteSyslog [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Syslog settings</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.RemoteSyslog></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Syslog settings</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>Get-HPOVRemoteSyslog Appliance Destination Port Enabled --------- ----------- ---- ------- appliance1.domain.com False appliance2.domain.com 10.150.20.1 514 True</dev:code> <dev:remarks> <dev:para>Get the current configuration from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVRemoteSyslog -ApplianceConnection appliance1.domain.com Appliance Destination Port Enabled --------- ----------- ---- ------- appliance1.domain.com False</dev:code> <dev:remarks> <dev:para>Get the current configuration from specified connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVRESERVEDVLANRANGE--> <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"> <!--GET-HPOVRESERVEDVLANRANGE--> <command:details> <command:name>Get-HPOVReservedVlanRange</command:name> <maml:description> <maml:para>Get the reserved VLAN range for HPE Synergy.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVReservedVlanRange</command:noun> </command:details> <maml:description> <maml:para>A reserved VLAN pool is a range of VLANs used for allocation of non-tagged networks: * Tunnel * Untagged Tagged networks and FCoE networks use VLANs outside of the reserved pool. You cannot use a reserved VLAN for tagged or FCoE networks. The VLAN pool allows the number of available VLANs to be segregated between tagged and non-tagged networks. Because non-tagged networks use VLANs for internal translation resources, a reserved VLAN pool can provide a sufficient number of VLANs available for allocation of those internal VLANs. In addition, the reserved pool range removes the need for translation resources to be used on tagged networks. For the maximum number of VLANs per physical downlink port, see the HPE OneView Support Matrix for HPE Synergy (https://www.hpe.com/info/synergy-docs). Use this Cmdlet to get the configured reserved VLAN range pool. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVReservedVlanRange</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.ReservedVlanRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The reserved VLAN range object</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>Get-HPOVReservedVlanRange</dev:code> <dev:remarks> <dev:para>Get the defined reserved VLAN range on the connected HPE Synergy appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVReservedVlanRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVROLE--> <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"> <!--GET-HPOVROLE--> <command:details> <command:name>Get-HPOVRole</command:name> <maml:description> <maml:para>Get role of user.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVRole</command:noun> </command:details> <maml:description> <maml:para>Deprecated Cmdlet as of v2.0. Please use the Get-HPOVUser Cmdlet to retrieve User Roles.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVRole</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> </command:returnValues> <command:examples> <!--Examples--> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSANMANAGER--> <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"> <!--GET-HPOVSANMANAGER--> <command:details> <command:name>Get-HPOVSanManager</command:name> <maml:description> <maml:para>Retrieve SAN Manager resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSanManager</command:noun> </command:details> <maml:description> <maml:para>SAN managers are a resource in HPE OneView that represent a connection to an external entity through which SANs are discovered and managed. The external entity can be vendor-specific management software or a physical switch. SANs are created outside of HPE OneView in the SAN manager vendor?s management interface. Once created, SANs can be discovered and managed in HPE OneView using the SAN Manager resource. When managing SAN managers, HPE OneView does not permit a SAN to be managed through more than one SAN manager. When associating an HPE OneView network to the SAN, the choice of which SAN to associate determines which SAN manager will be used to manage the SAN. Any subsequent change to a new SAN manager application requires to go through a phased migration process. HPE OneView supports SAN managers from different vendors. See the HPE OneView Support Matrix (http://www.hpe.com/info/oneview/docs) for a list of supported SAN managers. This Cmdlet will return the configured SAN Manager(s). Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSanManager</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the name of the SAN Manager to display.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="SanManager"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the name of the SAN Manager to display.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.SanManager [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single SAN Manager resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.SanManager></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple SAN Manager resources</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>Get-HPOVSanManager Name Status State Type Version Managed SANs ---- ------ ----- ---- ------- ------------ bna1.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_A, Fabric_B} bna2.domain.com OK Managed Brocade Network Advisor 12.3.4.5 {Fabric_C, Fabric_D}</dev:code> <dev:remarks> <dev:para>Display all SAN Managers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSANZONE--> <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"> <!--GET-HPOVSANZONE--> <command:details> <command:name>Get-HPOVSanZone</command:name> <maml:description> <maml:para>View Managed SAN Zones.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSanZone</command:noun> </command:details> <maml:description> <maml:para>SANs are Fibre Channel (FC) or Fibre Channel over Ethernet (FCoE) storage area networks that connect servers to storage systems. The possible states for SANs are: * Discovered - A SAN that is not associated with a network. SANs are automatically discovered when a SAN manager is added to HPE OneView. * Managed - A SAN that is associated with one or more networks in HPE OneView. Only managed SANs can be configured to be automatically zoned by HPE OneView. The SAN Endpoints, or SAN zones, contain all device ports actively logged into or configured to log in to a SAN. This Cmdlet will display the Managed SAN Zone details, which include Zone Name, state, status, Managed SAN and Alias members with their WWN(s). By default, all SAN Zones will be returned. You can filter the results based on Managed SAN resource. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSanZone</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>The Managed SAN Resource Object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>The Managed SAN Resource Object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneview.Storage.ManagedSan [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Managed SAN resource from Get-HPOVManagedSan</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.ManagedSan.Zone [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Managed SAN Zone resource object</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>Get-HPOVSanZone Appliance SAN Name State Status Members --------- --- ---- ----- ------ ------- appliance SAN1_1 dummy_zone Managed OK appliance SAN1_0 dummy_zone Managed OK appliance SAN1_1 Node_1_8 Managed OK {Target_ThreePAR72004506_0_2_2, Initiator_Node_1_8, Target_ThreePAR72004506_1_2_2} appliance SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR72004506_1_2_1}</dev:code> <dev:remarks> <dev:para>Return all SAN Zones from the appliance(s).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVManagedSan -Name SAN1_0 | Get-HPOVSanZone Appliance SAN Name State Status Members --------- --- ---- ----- ------ ------- appliance SAN1_0 dummy_zone Managed OK appliance SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR72004506_1_2_1}</dev:code> <dev:remarks> <dev:para>Return the specific SAN Zone for the specified Managed SAN resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Zones = Get-HPOVManagedSan -Name SAN1_0 | Get-HPOVSanZone $Zones | ? Name -eq "Node_1_7" Appliance SAN Name State Status Members --------- --- ---- ----- ------ ------- hpov-tot2 SAN1_0 Node_1_7 Managed OK {Initiator_Node_1_7, Target_ThreePAR72004506_0_2_1, Target_ThreePAR72004506_1_2_1} ($Zones | ? Name -eq "Node_1_7").members Name WWN ---- --- Initiator_Node_1_7 {10:00:F6:9F:5F:70:00:00} Target_ThreePAR72004506_0_2_1 {20:00:00:02:AC:00:08:DE} Target_ThreePAR72004506_1_2_1 {20:00:00:02:AC:00:08:E2}</dev:code> <dev:remarks> <dev:para>Get the Zone information from the specific Managed SAN, then display the associated aliases including their WWNs.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVManagedSan</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSASINTERCONNECTTYPE--> <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"> <!--GET-HPOVSASINTERCONNECTTYPE--> <command:details> <command:name>Get-HPOVSasInterconnectType</command:name> <maml:description> <maml:para>Retrieve SAS Interconnect Type resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSasInterconnectType</command:noun> </command:details> <maml:description> <maml:para>Interconnects enable communication between the server hardware in the enclosure and the data center networks. Interconnects and their configuration are derived from either a Logical Switch Group or Logical Interconnect Group. When configuring either resource, you will need to specify an interconnect type that is supported by the appliance. This Cmdlet will retrieve a list of supported SAS interconnect type or specific ones via a query if the name parameter is provided. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSasInterconnectType</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect type model name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVSasInterconnectType</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an Interconnect Type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the interconnect type model name to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber" aliases="None"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an Interconnect Type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SasInterconnectType [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single SAS Interconnect Type resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.SasInterconnectType></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple SAS Interconnect Type resources or formatted table dispalying basic Interconnect Type information</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>Get-HPOVSasInterconnectType</dev:code> <dev:remarks> <dev:para>Returns all SAS Interconnect Types available from all connected appliances to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSasInterconnectType -Name "Synergy 12Gb SAS Connection Module"</dev:code> <dev:remarks> <dev:para>Returns just the "Synergy 12Gb SAS Connection Module" SAS Interconnect Type object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVInterconnectType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSASLOGICALINTERCONNECT--> <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"> <!--GET-HPOVSASLOGICALINTERCONNECT--> <command:details> <command:name>Get-HPOVSasLogicalInterconnect</command:name> <maml:description> <maml:para>Retrieve SAS Logical Interconnect resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSasLogicalInterconnect</command:noun> </command:details> <maml:description> <maml:para>A logical interconnect is a single administrative entity that consists of the configuration for a set of interconnects in a single enclosure or an HPE Synergy frame link topology. A logical interconnect derives its configuration from a logical interconnect group, which serves as a template to ensure that the logical interconnects being created are configured consistently. A SAS Logical Interconnect represents a single SAS fabric local to the physical HPE Synergy Frame (Enclosure). Which compute modules can be assigned one or more physical drives as a Logical JBOD, or RAID configuration. This Cmdlet retrieves a list of all SAS Logical Interconnect or just specific ones via a query if the name parameter is provided. The output can be sent to a file using the exportFile parameter. Minimum required privileges: Read-only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSasLogicalInterconnect</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SAS Logical Interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="x, ExportFile"> <maml:name>Export</maml:name> <maml:description> <maml:para>The full path and file name to export the contents retrieved from the call to Get-HPOVLogicalInterconnect.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the SAS Logical Interconnect to retrieve.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPoneView.Storage.SasLogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Logical Interconnect resource object from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPoneView.Storage.SasLogicalInterconnect> </maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Logical Interconnects</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>Get-HPOVSasLogicalInterconnect</dev:code> <dev:remarks> <dev:para>Returns all SAS Logical Interconnect defined on the appliance to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSasLogicalInterconnect -Name "LE1-SasProduction" -ErrorAction Stop</dev:code> <dev:remarks> <dev:para>Returns just the specific SAS Logical Interconnect object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSCMBCERTIFICATES--> <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"> <!--GET-HPOVSCMBCERTIFICATES--> <command:details> <command:name>Get-HPOVScmbCertificates</command:name> <maml:description> <maml:para>Get State Change Message Bus certificates.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVScmbCertificates</command:noun> </command:details> <maml:description> <maml:para>HPE OneView uses a state change message bus (SCMB) for internal components to notify each other of resource state changes. External users can connect and consume these same messages for monitoring purposes. The HPE OneView SCMB is built upon the RabbitMQ provider. In order to connect to connect to the HPE OneView SCMB, a proper message queue client is needed, in which it must support certificate authentication. The HPE OneView SCMB does not support standard username and password authentication. This Cmdlet will retrieve and store the certificates necessary to register with the State Change Message Bus. If the SCMB certificate has not been created, a new one will be generated. The generated certificate is mapped to a private, internal user account with Read-Only permissions. In order to write changes, a REST API bind-back is necessary. The generated and/or downloaded SCMB certificate can also be exported to PFX format for secure storage, using the -ConvertToPFx parameter. Minimum required privileges: Infrastructure Administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVScmbCertificates</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>Location</maml:name> <maml:description> <maml:para>Directory to store the SSL certificates. If the directory doesn"t exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>InstallApplianceRootCA</maml:name> <maml:description> <maml:para>hoose to install the appliance root certificate to the current users Trusted Root Authorities store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVScmbCertificates</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="convert"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password that will be used to encrypt the PFX client certificate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>Location</maml:name> <maml:description> <maml:para>Directory to store the SSL certificates. If the directory doesn"t exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert"> <maml:name>ConvertToPFx</maml:name> <maml:description> <maml:para>Aliases [-pfx] Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>InstallApplianceRootCA</maml:name> <maml:description> <maml:para>hoose to install the appliance root certificate to the current users Trusted Root Authorities store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="convert" aliases="pfx"> <maml:name>ConvertToPFx</maml:name> <maml:description> <maml:para>Aliases [-pfx] Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default" aliases="None"> <maml:name>InstallApplianceRootCA</maml:name> <maml:description> <maml:para>hoose to install the appliance root certificate to the current users Trusted Root Authorities store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="convert, default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>Directory to store the SSL certificates. If the directory doesn"t exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>($pwd).path</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="convert" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password that will be used to encrypt the PFX client certificate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para>Password for PFX file</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>3 files will be created:</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> * {ApplianceConnection_Name}_ca.cer - Appliance internal Root Certificate Authority * {ApplianceConnection_Name}_cert.cer - Appliance managed rabbitmq_readonly user Public Key * {ApplianceConnection_Name}_privateKey.key - Appliance managed rabbitmq_readonly user Client Certificate</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Pkcs12/PFX certificate file</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If ConvertToPfX is used, the Pkcs12/PFX compliant certificate file is created, {ApplianceConnection_Name}_privateKey.pfx</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>Get-HPOVScmbCertificates</dev:code> <dev:remarks> <dev:para>Get the HPE OneView appliance SCMB SSL certificates, and save them in the current directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Read-hHst "Password" -AsSecureString | Get-HPOVScmbCertificates -Location C:\scmbcerts -ConvertToPFx</dev:code> <dev:remarks> <dev:para>Prompt for secure password input and pipe the value to convert the cert.pem to PFX format. </dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSCOPE--> <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"> <!--GET-HPOVSCOPE--> <command:details> <command:name>Get-HPOVScope</command:name> <maml:description> <maml:para>Get Scope resource(s)</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVScope</command:noun> </command:details> <maml:description> <maml:para>A scope is a grouping of resources that can be used to restrict the range of an operation or action. For example, you can create scopes based on: * Organizations (Marketing, Research and Development, Finance) * Usage (Production, Development, Testing) * Skills (Linux, Windows) The resources are arranged by categories. All the resources in these categories can be added to or removed from a scope: * Enclosures * Server Hardware * Networks (Ethernet, FC, and FCoE) * Network Sets * Interconnects, excluding SAS resources * Logical Interconnects, excluding SAS resources * Logical Interconnect Groups, excluding SAS resources * OS Deployment Plans * Switches * Logical Switches * Logical Switch Groups * Rack Managers * Storage Pools * Volumes * Volume Templates * Volume Sets NOTE: Resources in other categories are considered to be included in all scopes, and they cannot be removed. WARNING: For email notification of alerts, resources that are not categorized here are included in any scope. An email notification filter that specifies one or more scopes does not eliminate alerts generated by resources that are not currently categorized here. Inhibiting alerts from non-scope resources requires the use of associated resource categories, which is described in "Edit an email recipient and filter entry" online help chapter. When scopes are defined and resources assigned to them, you can: * Restrict the resources displayed in the user interface (UI) to those assigned to the scope. * Restrict user permissions to grant access only to the resources in a scope. * Configure filtered email notifications for alerts based on previously-defined scopes. Returned Scope object(s) will contain a collection of associated resources. Minimum Minimum required privileges: Read-Only</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVScope</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scope to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scope to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Scope resource objects.</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>Get-HPOVScope</dev:code> <dev:remarks> <dev:para>List all available scopes on the connected default appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVScope -Name MyFinanceScope</dev:code> <dev:remarks> <dev:para>Return the "MyFinanceScope" scope resource from the conncted default appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVScope -Name My* -ApplianceConnection $ConnectedSessions</dev:code> <dev:remarks> <dev:para>Use wildcard search for a specific scope on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVER--> <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"> <!--GET-HPOVSERVER--> <command:details> <command:name>Get-HPOVServer</command:name> <maml:description> <maml:para>Retrieve Server Hardware resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of server hardware resources, a specific server with the specified name, or server hardware resources without an assigned Server Profile. Returned resources will display: * Device Name * Serial Number * Model * System ROM * iLO and its firmware * Server Profile * Status * Licensing</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServer</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server hardware resource to be returned. All server hardware resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specify the Server OS Name that is reported by the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter resources based on their current status. Allowed values: * Ok * Warning * Critical * Unknown * Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NoProfile</maml:name> <maml:description> <maml:para>Optional parameter that can be used with the report parameter to display Servers without a Server Profile assigned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-ServerHardwareType, -ServerProfileTemplate] Provide the Server Hardware Type or Server Profile Template Object to filter for available server hardware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return no more than the provided value. Combining other parameters to filter may not return the requested count value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Return no more than the provided value. Combining other parameters to filter may not return the requested count value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="ServerHardwareType, ServerProfileTemplate"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-ServerHardwareType, -ServerProfileTemplate] Provide the Server Hardware Type or Server Profile Template Object to filter for available server hardware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server hardware resource to be returned. All server hardware resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NoProfile</maml:name> <maml:description> <maml:para>Optional parameter that can be used with the report parameter to display Servers without a Server Profile assigned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specify the Server OS Name that is reported by the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter resources based on their current status. Allowed values: * Ok * Warning * Critical * Unknown * Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardwareType [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Type resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfileTemplate [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Template resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Server Hardware resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Server Hardware resources</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>Get-HPOVServer Name Status Power Serial Number Model ROM iLO Server Profile License ---- ------ ----- ------------- ----- --- --- -------------- ------- 172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiLO 172.18.6.16 Unknown Unknown MXQ1000307 DL380p Gen8 No Profile OneViewNoiLO 172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiLO 172.18.6.32 Unknown Unknown MXQ1020307 DL380p Gen8 No Profile OneViewNoiLO Encl1, bay 1 OK Off SGH100X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 Server Profile 1 OneView Encl1, bay 11 OK Off SGH100X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 Server Profile 2 OneView Encl1, bay 12 Disabled Off SGH101X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 13 Disabled Off SGH102X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 14 Disabled Off SGH103X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 15 Disabled Off SGH104X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 16 Disabled Off SGH105X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 2 OK Off SGH101X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 My Profile OneView Encl1, bay 3 OK Off SGH100X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 Server Profile 3 OneView Encl1, bay 4 OK Off SGH101X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 Server Profile 4 OneView Encl1, bay 5 OK Off SGH102X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 Server Profile 5 OneView Encl1, bay 6 Disabled Off SGH103X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl1, bay 7 Disabled Off SGH104X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl1, bay 8 Disabled Off SGH105X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 1 Disabled Off SGH102X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 No Profile OneView Encl2, bay 11 Disabled Off SGH106X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 12 Disabled Off SGH107X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 13 Disabled Off SGH108X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 14 Disabled Off SGH109X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 15 Disabled Off SGH110X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 16 Disabled Off SGH111X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 2 Disabled Off SGH103X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 No Profile OneView Encl2, bay 3 Disabled Off SGH106X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 4 Disabled Off SGH107X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 5 Disabled Off SGH108X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 6 Disabled Off SGH109X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 7 Disabled Off SGH110X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 8 Disabled Off SGH111X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView</dev:code> <dev:remarks> <dev:para>Return all the server hardware managed by this appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$bay1 = Get-HPOVServer -Name "Encl1, bay 1"</dev:code> <dev:remarks> <dev:para>Return the server hardware resource with name "Encl1, bay 1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -NoProfile Name Status Power Serial Number Model ROM iLO Server Profile License ---- ------ ----- ------------- ----- --- --- -------------- ------- 172.18.6.15 Disabled Off MXQ1000207 DL360p Gen8 P71 02/10/2014 iLO4 2.03 No Profile OneViewNoiLO 172.18.6.16 Unknown Unknown MXQ1000307 DL380p Gen8 No Profile OneViewNoiLO 172.18.6.31 Disabled Off MXQ1000208 DL360 Gen9 P89 07/11/2014 iLO4 2.03 No Profile OneViewNoiLO 172.18.6.32 Unknown Unknown MXQ1020307 DL380p Gen8 No Profile OneViewNoiLO Encl1, bay 12 Disabled Off SGH101X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 13 Disabled Off SGH102X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 14 Disabled Off SGH103X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 15 Disabled Off SGH104X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 16 Disabled Off SGH105X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl1, bay 6 Disabled Off SGH103X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl1, bay 7 Disabled Off SGH104X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl1, bay 8 Disabled Off SGH105X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 1 Disabled Off SGH102X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 No Profile OneView Encl2, bay 11 Disabled Off SGH106X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 12 Disabled Off SGH107X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 13 Disabled Off SGH108X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 14 Disabled Off SGH109X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 15 Disabled Off SGH110X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 16 Disabled Off SGH111X5RN BL460c Gen9 I36 08/26/2014 iLO4 2.03 No Profile OneView Encl2, bay 2 Disabled Off SGH103X7RN BL660c Gen9 I32 08/03/2014 iLO4 2.03 No Profile OneView Encl2, bay 3 Disabled Off SGH106X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 4 Disabled Off SGH107X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 5 Disabled Off SGH108X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 6 Disabled Off SGH109X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 7 Disabled Off SGH110X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView Encl2, bay 8 Disabled Off SGH111X8RN BL460c Gen8 I31 08/02/2014 iLO4 2.03 No Profile OneView</dev:code> <dev:remarks> <dev:para>Display all server hardware resources without an assigned Server Profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$sht = Get-HPOVServerHardwareType -Name "BL460c Gen9 1" $AvailableServer = Get-HPOVServer -NoProfile -ServerHardwareType $sht | Select -first 1</dev:code> <dev:remarks> <dev:para>Return the first available server hardware of the Server Hardware Type requested.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$AvailableServer = Get-HPOVServerProfileTemplate -Name "My Template 1" | Get-HPOVServer -NoProfile | Select -first 1</dev:code> <dev:remarks> <dev:para>Return the first available server hardware designed for the specific Server Profile Template.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Status Warning, Critical</dev:code> <dev:remarks> <dev:para>Return only servers that are currently reporting Warning or Critical status.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERHARDWARETYPE--> <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"> <!--GET-HPOVSERVERHARDWARETYPE--> <command:details> <command:name>Get-HPOVServerHardwareType</command:name> <maml:description> <maml:para>Retrieve Server Hardware Type resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerHardwareType</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of server hardware types. This includes information about the type of server, adapter layout and features, and possible server BIOS settings. This Cmdlet is also used with the New-HPOVServerProfile Cmdlet to retrieve the list of BIOS settings and adapters to configure.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerHardwareType</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server hardware type resource to be returned. All server hardware type resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Model</maml:name> <maml:description> <maml:para>Filter based on Model name. Supports wildcard search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The path where the resource will be exported to, in JSON text format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Model</maml:name> <maml:description> <maml:para>Filter based on Model name. Supports wildcard search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server hardware type resource to be returned. All server hardware type resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="x, export"> <maml:name>exportFile</maml:name> <maml:description> <maml:para>The path where the resource will be exported to, in JSON text format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerHardwareType [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Server Hardware type</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Server Hardware types</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>$sht = Get-HPOVServerHardwareType</dev:code> <dev:remarks> <dev:para>Return all the server hardware types on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$shtBL460Gen81 = Get-HPOVServerHardwareType -name "BL460 Gen8 1"</dev:code> <dev:remarks> <dev:para>Return the "BL460 Gen8 1" server hardware type on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERONETIMEBOOT--> <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"> <!--GET-HPOVSERVERONETIMEBOOT--> <command:details> <command:name>Get-HPOVServerOneTimeBoot</command:name> <maml:description> <maml:para>Get a servers current One Time Boot setting.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerOneTimeBoot</command:noun> </command:details> <maml:description> <maml:para>HPE OneView allows you to set a one-time boot option for the server hardware. You can set the one-time boot option to any of the following: * Keep current settings—Keeps the previously chosen settings. * No one-time boot—Normal boot is used when this option is selected. * PXE—Boots from the PXE server on the network. * Hard disk—Boots from the first local disk. * CD—Boots from a local or virtual optical drive. * USB—Boots from a physical or virtual USB drive. Other one-time boot options are available through the HPE iLO interface; however, HPE OneView offers only a common subset of one-time boot options. The one-time boot option requires the server hardware to be powered off and powered back on. If you set the one-time boot option while the server power is on, the one-time boot value is remembered until the server is powered off and then powered back on. HPE OneView does not support setting of the one-time boot option while the server is in power-on self-test (POST). After setting the one-time boot option, when the server hardware is powered off and powered on, HPE iLO attempts to boot the server using the selected boot option. If the selected boot option is not available, HPE iLO attempts to boot the server using the boot order defined in the server profile. After using or attempting to use the one-time boot value, the one-time boot value is reset to No one-time boot and the server boots using the boot order defined in its server profile or through HPE iLO. Minimum required privileges: Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerOneTimeBoot</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The server hardware or server profile resource object from Get-HPOVServer or Get-HPOVServerProfile. If providing a server profile resource, it must be assigned to a server in order for one time boot settings to be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The server hardware or server profile resource object from Get-HPOVServer or Get-HPOVServerProfile. If providing a server profile resource, it must be assigned to a server in order for one time boot settings to be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server profile resource object from Get-HPOVServerProfile.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Servers.ServerHardware+OneTimeBoot</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current One Time Boot setting of the server hardware resource.</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>Get-HPOVServer -Name MyServer1 | Get-HPOVServerOneTimeBoot</dev:code> <dev:remarks> <dev:para>Get the one time boot setting from the provided server hardware resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -Name 'My Prod Node 1' | Get-HPOVServerOneTimeBoot</dev:code> <dev:remarks> <dev:para>Get the one time boot setting from the provided server profile resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERPROFILE--> <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"> <!--GET-HPOVSERVERPROFILE--> <command:details> <command:name>Get-HPOVServerProfile</command:name> <maml:description> <maml:para>Retrieve Server Profile resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will obtain a collection of Server Profile resources, or a specific Server Profile the specified name. It returns all aspects of the Server Profile. This will also provide the ability to export Server Profile objects to their own JSON encoded file. All appliance unique properties (minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection layout, assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address types will change from Virtual to UserDefined in order to retain their assignment.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerProfile</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no Template association.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Unassigned</maml:name> <maml:description> <maml:para>Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be combined with the name parameter for Server Profile wildcard name search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>export</maml:name> <maml:description> <maml:para>Switch used to export Server Profile object to JSON encoded file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>location</maml:name> <maml:description> <maml:para>Location where to save the Server Profile</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default"> <maml:name>Unassigned</maml:name> <maml:description> <maml:para>Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be combined with the name parameter for Server Profile wildcard name search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Detailed"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Display detailed report list of Server Profiles</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Detailed" aliases="None"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Display detailed report list of Server Profiles</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Profile a Server Hardware or Server Profile Template resource, and the associated Server Hardware will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="profile"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if omitted. Supports * wildcard character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NonCompliant</maml:name> <maml:description> <maml:para>Return collection of Server Profiles that are not compliant with their template. Will not return Server Profiles that have no Template association.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Default" aliases="None"> <maml:name>Unassigned</maml:name> <maml:description> <maml:para>Optional parameter that can be included with the List switch parameter to only display unassigned Server Profiles. Can also be combined with the name parameter for Server Profile wildcard name search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x"> <maml:name>export</maml:name> <maml:description> <maml:para>Switch used to export Server Profile object to JSON encoded file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="save"> <maml:name>location</maml:name> <maml:description> <maml:para>Location where to save the Server Profile</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Servers.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The server profile resource object.</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>Get-HPOVServerProfile Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Copy of test 2 False False Unassigned Normal Profile 11 True True Encl1, bay 11 Normal Profile 12 False False Encl1, bay 12 Normal Profile 13 False False Encl1, bay 13 Normal Profile 14 False False Encl1, bay 14 Normal Profile 15 False False Encl1, bay 15 Normal Profile 16 False False Encl1, bay 16 Normal Test 1 False False Unassigned Normal test 2 False False Encl1, bay 3 Normal test 3 False False Unassigned Normal</dev:code> <dev:remarks> <dev:para>Generate a list of all server profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profile = Get-HPOVServerProfile -Name "SA"</dev:code> <dev:remarks> <dev:para>Return the server profile resource with name "SA".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profiles = Get-HPOVServerProfile -Name profile*</dev:code> <dev:remarks> <dev:para>Return server profile resources that match "profile*".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -name "test 1" -list Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Test 1 False False Unassigned Normal</dev:code> <dev:remarks> <dev:para>Generate a report of a specific server profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -unassigned Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Copy of test 2 False False Unassigned Normal Test 1 False False Unassigned Normal test 3 False False Unassigned Normal</dev:code> <dev:remarks> <dev:para>Generate a list of all Unassigned server profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -export -location c:\profiles</dev:code> <dev:remarks> <dev:para>Save all Server Profile objects to their own backup file to C:\profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -name Profile1 -export -location c:\profiles</dev:code> <dev:remarks> <dev:para>Save Profile1 Server Profile object to its own backup file in C:\profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERPROFILECONNECTIONLIST--> <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"> <!--GET-HPOVSERVERPROFILECONNECTIONLIST--> <command:details> <command:name>Get-HPOVServerProfileConnectionList</command:name> <maml:description> <maml:para>Retrieve Server Profile Connections</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerProfileConnectionList</command:noun> </command:details> <maml:description> <maml:para>Obtain a formatted list of server profile connection IDs, include hardware address, device mapping, and boot settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerProfileConnectionList</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if name is omitted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be returned. All server profile resources will be returned if name is omitted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Formatted table of Server Profile Connections</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>Get-HPOVServerProfileConnectionList "test" serverProfile portId cid networkType macAddress wwpn boot arrayTarget lun ------------- -------- --- ----------- ---------- ---- ---- ----------- --- test Flb 1:1-a 1 Ethernet 36:37:6B:90:00:08 1000378079e00011 Primary test Flb 1:1-b 2 Ethernet 36:37:6B:90:00:06 1000378079e0000d Secondary </dev:code> <dev:remarks> <dev:para>List Server Profile connections for Test.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERPROFILEMESSAGE--> <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"> <!--GET-HPOVSERVERPROFILEMESSAGE--> <command:details> <command:name>Get-HPOVServerProfileMessage</command:name> <maml:description> <maml:para>Display Server Profile alert messages.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerProfileMessage</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to display alert or other activity messages that are not tracked as Alerts or Tasks. For instance, failed Connection will be reported as a Server Profile Message. Firmware update status (using HPSUT) wil be displayed as messages.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerProfileMessage</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="ServerProfile"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource object from Get-HPOVServerProfile</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerProfileMessage [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Server Profile message object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.ServerProfileMessage></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Server Profile message object.</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>Get-HPOVServerProfile MyProfile | Get-HPOVServerProfileMessage</dev:code> <dev:remarks> <dev:para>Display the Server Profile messages for the provided resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVERPROFILETEMPLATE--> <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"> <!--GET-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>Get-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Retrieve Server Profile Template resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will obtain a collection of Server Profile Template resources, or a specific Server Profile Template with the specified name. It returns all aspects of the Server Profile Template. This will also provide the ability to export Server Profile Template objects to their own JSON encoded file. All appliance unique properties (minus the Server Hardware Type, Enclosure Group, and Connection Network assignment) are removed. Connection layout, assigned addresses, networks, bandwidth, BIOS, Boot Order, Firmware settings will all be retained. Assigned Address types will change from Virtual to UserDefined in order to retain their assignment.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServerProfileTemplate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific Server Profile Template resource to retrieve</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Export</maml:name> <maml:description> <maml:para>Switch used to export Server Profile Template object to JSON encoded file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Export"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where to save the Server Profile Template file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific Server Profile Template resource to retrieve</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Detailed"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Displays detailed information about the Server Profile Template in tabular format</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific Server Profile Template resource to retrieve</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Export, Detailed, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Detailed" aliases="None"> <maml:name>Detailed</maml:name> <maml:description> <maml:para>Displays detailed information about the Server Profile Template in tabular format</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="x"> <maml:name>Export</maml:name> <maml:description> <maml:para>Switch used to export Server Profile Template object to JSON encoded file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where to save the Server Profile Template file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="profile"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific Server Profile Template resource to retrieve</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Export, Detailed, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Export, Detailed, Default" aliases="None"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>Provide the Server Hardware Type resource object or name to return Server Profile Templates designed for it.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.ServerHardwareType [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The server hardware type resource to filter server profilte templates modeled for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerProfileTemplate [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Server Profile template resource</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>$templates = Get-HPOVServerProfileTemplate</dev:code> <dev:remarks> <dev:para>Return all the server profile templates managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$template = Get-HPOVServerProfileTemplate "SA"</dev:code> <dev:remarks> <dev:para>Return the server profile template resource with name "SA".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profiletemplates = Get-HPOVServerProfileTemplate profile*</dev:code> <dev:remarks> <dev:para>Return server profile template resources that match "profile*".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfileTemplate Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Copy of test 2 False False Unassigned Normal Test 1 False False Unassigned Normal test 3 False False Unassigned Normal</dev:code> <dev:remarks> <dev:para>Generate a list of all server profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfileTemplate -name "test 1" Profile Name Managing BIOS Managing Firmware Assigned State ------------ ------------- ----------------- -------- ----- Test 1 False False Unassigned Normal</dev:code> <dev:remarks> <dev:para>Show a specific Server Profile Template, "test 1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfileTemplate -export -location c:\profiles</dev:code> <dev:remarks> <dev:para>Save all Server Profile Template objects to their own backup file to C:\profiles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfileTemplate -name Profile1 -export -location c:\profiles</dev:code> <dev:remarks> <dev:para>Save Profile1 Server Profile template object to its own backup file in C:\pro</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSERVICEALERT--> <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"> <!--GET-HPOVSERVICEALERT--> <command:details> <command:name>Get-HPOVServiceAlert</command:name> <maml:description> <maml:para>Generate report of HPE OneView Remote Support service events.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVServiceAlert</command:noun> </command:details> <maml:description> <maml:para>HPE OneView automatically checks if your hardware has a valid entitlement to Hewlett Packard Enterprise support. A valid entitlement is a Hewlett Packard Enterprise warranty or an active contract. If a valid entitlement to support is found, HPE OneView Remote Support opens a support case for a hardware failure. This Cmdlet allows administrators to display and/or export service events logged by the HPE OneView appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVServiceAlert</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Use to filter for the supported hardware resource object. Enclosures, Server Hardware and Server Profile objects are supported. If an Enclosure resource is provided, only the Enclosure service events are queried. Associated Server Hardare within the enclosure is not. If providing a Server Profile object, it must be assigned to a supported hardware platform. If the Server Profile has moved between hardware resources, only the currently assigned server hardware resource object will be used to query for service events.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>Specify the state of the Service Alert. The state is not correlated to the associated Alert. * Closed - The state of Service event when the service call is closed. * Error - The Service request has some error None This is a default state. * Open - The state of Service event when the service call is open. * Pending - The state of Service event when the service call is pending. * Received - The state of Service event when the service call is received. * Submitted - The state of Service event when the service call is submitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the number of service alerts to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specify a TimeSpan object in number of days. Cannot be combined with -Start and -End parameters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Start</maml:name> <maml:description> <maml:para>DateTime object of the start date and time to being query.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>End</maml:name> <maml:description> <maml:para>DateTime object of the end date and time accompanied with the -Start parameter. If omitted, the current time of the PC is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the number of service alerts to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>End</maml:name> <maml:description> <maml:para>DateTime object of the end date and time accompanied with the -Start parameter. If omitted, the current time of the PC is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Use to filter for the supported hardware resource object. Enclosures, Server Hardware and Server Profile objects are supported. If an Enclosure resource is provided, only the Enclosure service events are queried. Associated Server Hardare within the enclosure is not. If providing a Server Profile object, it must be assigned to a supported hardware platform. If the Server Profile has moved between hardware resources, only the currently assigned server hardware resource object will be used to query for service events.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>DateTime object of the start date and time to being query.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>State</maml:name> <maml:description> <maml:para>Specify the state of the Service Alert. The state is not correlated to the associated Alert. * Closed - The state of Service event when the service call is closed. * Error - The Service request has some error None This is a default state. * Open - The state of Service event when the service call is open. * Pending - The state of Service event when the service call is pending. * Received - The state of Service event when the service call is received. * Submitted - The state of Service event when the service call is submitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TimeSpan</maml:name> <maml:description> <maml:para>Specify a TimeSpan object in number of days. Cannot be combined with -Start and -End parameters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware</maml:name> </dev:type> <maml:description> <maml:para>A Server Hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile</maml:name> </dev:type> <maml:description> <maml:para>A Server Profile resource object from Get-HPOVServerProfile. If the Server Profile is not associated with a server hardware resource, an excpetion is thrown. If the Server Profile has moved from one server hardware resource to another, only the currently assigned server hardware resource will be queried.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure</maml:name> </dev:type> <maml:description> <maml:para>An Enclosure resource object from Get-HPOVEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ServiceAlert</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Service Alert object that contains the CaseID, associated resource name, URI and serial number, and description of the service event.</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>Get-HPOVServiceAlert</dev:code> <dev:remarks> <dev:para>Get all Service Alerts from the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServiceAlert -Count 10 </dev:code> <dev:remarks> <dev:para>Get the first 10 Service Alerts from the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$TimeSpan = New-TimeSpan -Days 30 Get-HPOVServiceAlert -Count 10 -TimeSpan $TimeSpan</dev:code> <dev:remarks> <dev:para>Get the first 10 Service Alerts within the last 30 days from the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -End ([DateTime]"2018-01-30")</dev:code> <dev:remarks> <dev:para>Get the Service Alerts within the specified date range from the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name "Encl1, Bay 1" -ErrorAction Stop | Get-HPOVServiceAlert -Start ([DateTime]"2018-01-05") -End ([DateTime]"2018-01-30")</dev:code> <dev:remarks> <dev:para>Get the Service Alerts within the specified date range for the specified server hardware resource from the connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSMTPCONFIG--> <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"> <!--GET-HPOVSMTPCONFIG--> <command:details> <command:name>Get-HPOVSMTPConfig</command:name> <maml:description> <maml:para>Configure appliance SMTP Reporting settings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSMTPConfig</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will retrieve the SMTP settings for the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSMTPConfig</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns SMTP Email Configurtion object from the specified appliance(s).</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>Get-HPOVSMTPConfig</dev:code> <dev:remarks> <dev:para>Get SMTP Email Alert configuration from the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVSMTPConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSNMPREADCOMMUNITY--> <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"> <!--GET-HPOVSNMPREADCOMMUNITY--> <command:details> <command:name>Get-HPOVSnmpReadCommunity</command:name> <maml:description> <maml:para>GRetrieve Appliance SNMP Read Community.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSnmpReadCommunity</command:noun> </command:details> <maml:description> <maml:para>Get the configured appliance SNMP Read Community string.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSnmpReadCommunity</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The SNMP Read Community</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>Get-HPOVSnmpReadCommunity</dev:code> <dev:remarks> <dev:para>Retrieve the SNMP Read Community string the appliance is configured to use from all connected sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVSnmpReadCommunity</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSNMPV3USER--> <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"> <!--GET-HPOVSNMPV3USER--> <command:details> <command:name>Get-HPOVSnmpV3User</command:name> <maml:description> <maml:para>Get defined SNMPv3 user from appliance.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSnmpV3User</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers and enclosures (OA) to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Appliance SNMP settings allow you to add destinations to which the traps need to be forwarded. You can configure each destination as an SNMPv1 or SNMPv3 destination, depending on whether the traps are sent in SNMPv1 or SNMPv3 formats. Additionally, if you have Gen6 or Gen7 servers being monitored by HPE OneView in your environment, you can configure the read community string that HPE OneView uses for monitoring these servers with SNMPv1. NOTE: To configure SNMP trap forwarding for network devices (interconnects and switches), use the New-HPOVSnmpV3User and include it within the New-HPOVSnmpTrapDestination Cmdlet. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSnmpV3User</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for the SNMPv3 user. Supports wildcard characters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for the SNMPv3 user. Supports wildcard characters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 user object.</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>Get-HPOVSnmpV3User</dev:code> <dev:remarks> <dev:para>Get the defined SNMPv3 users on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEPOOL--> <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"> <!--GET-HPOVSTORAGEPOOL--> <command:details> <command:name>Get-HPOVStoragePool</command:name> <maml:description> <maml:para>Retrieve Storage Pool resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStoragePool</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of storage pools (i.e. CPG"s) from discovered and managed storage systems.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStoragePool</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific storage pool resource to be returned. All storage pool resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The name or Storage System object of the specific storage system to return storage pool resource from. Can be combined with the PoolName parameter to single out a specific storage pool in a specific storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the Label to filter on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Only returned storage pools that are managed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>Only returned storage pools that are unmanaged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="4" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the Label to filter on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Only returned storage pools that are managed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="pool, PoolName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific storage pool resource to be returned. All storage pool resources will be returned if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="1" parameterSetName="(All)" aliases="systemName, system"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>The name or Storage System object of the specific storage system to return storage pool resource from. Can be combined with the PoolName parameter to single out a specific storage pool in a specific storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Unmanaged</maml:name> <maml:description> <maml:para>Only returned storage pools that are unmanaged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System</maml:name> </dev:type> <maml:description> <maml:para>Managed Storage System from Get-HPOVStorageSystem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.Pool [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Storage Pool resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Storage Pool resources</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>Get-HPOVStoragePool Status Name Storage System Storage Domain Drive Type RAID Total Allocated Free ------ ---- -------------- -------------- ---------- ---- -------- ----------- ------- OK FC_NO_DN ThreePAR7200-5706 NoDomain FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB OK FC_NO_DN ThreePAR7200-2870 NoDomain FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB </dev:code> <dev:remarks> <dev:para>Get all available storage pools.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool | format-list Name : FC_NO_DN Status : OK Storage System : ThreePAR7200-5706 Domain : NoDomain Drive Type : FC RAID : RAID5 Total : 1,048,576.00 GB Allocated : 22.13 GB Free : 1,048,553.88 GB Volumes : 0 Volume Templates : 0 Name : FC_NO_DN Status : OK Storage System : ThreePAR7200-2870 Domain : NoDomain Drive Type : FC RAID : RAID5 Total : 1,048,576.00 GB Allocated : 22.13 GB Free : 1,048,553.88 GB Volumes : 0 Volume Templates : 0</dev:code> <dev:remarks> <dev:para>Get all available storage pools, display using Format-List to see extended information.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myPool = Get-HPOVStoragePool -name "HP_CPG1"</dev:code> <dev:remarks> <dev:para>Return the storage pool resource(s) with the name "HP_CPG1"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$myPools = Get-HPOVStoragePool</dev:code> <dev:remarks> <dev:para>Return all the storage pool resources</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool -StorageSystem "HP_3PAR_1"</dev:code> <dev:remarks> <dev:para>Returns all managed storage pool resources on the storage system "HP_3PAR_1"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool -poolName "HP_CPG1" -systemName "HP_3PAR_1"</dev:code> <dev:remarks> <dev:para>Returns the storage pool resource "HP_CPG1" on the storage system "HP_3PAR_1"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGESYSTEM--> <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"> <!--GET-HPOVSTORAGESYSTEM--> <command:details> <command:name>Get-HPOVStorageSystem</command:name> <maml:description> <maml:para>Retrieve Storage System resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageSystem</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will display all or a specific storage system configured on the HPE OneView appliance. A specific Storage System can be searched for by using the System Name (not FQDN) or Serial Number. Use the List switch to display a report of the requested storage system(s).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageSystem</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display the specific Storage System by its system name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Display the specific Storage System by its hostname (IP Address or FQDN).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>List</maml:name> <maml:description> <maml:para>Generate a report of the specific or all storage systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVStorageSystem</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Search for the Storage System based on the resource serial number instead of the name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name"> <maml:name>List</maml:name> <maml:description> <maml:para>Generate a report of the specific or all storage systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name" aliases="None"> <maml:name>Family</maml:name> <maml:description> <maml:para>Specify the type of Storage System to add: Nimble, StorageVirtual, StoreServ or Primera.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Display the specific Storage System by its hostname (IP Address or FQDN).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial, Name" aliases="Report"> <maml:name>List</maml:name> <maml:description> <maml:para>Generate a report of the specific or all storage systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="SystemName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display the specific Storage System by its system name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Serial" aliases="SN"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Search for the Storage System based on the resource serial number instead of the name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Storage System</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.System></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Storage Systems</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>Get-HPOVStorageSystem</dev:code> <dev:remarks> <dev:para>Get all storage system resource objects managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageSystem HP3Par_1 Status Name Serial Number Model Storage Domain WWN Firmware ------ ---- ------------- ----- -------------- --- -------- Ok HP3Par_1 TXQ1020307 HP_3PAR 7200 NoDomain 28:11:00:02:AC:00:08:7D 3.1.3</dev:code> <dev:remarks> <dev:para>Get "HP3Par_1" storage system resource object managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageSystem HP3Par_1 -report Status Name Serial Number Model Storage Domain WWN Firmware ------ ---- ------------- ----- -------------- --- -------- Ok HP3Par_1 TXQ1020307 HP_3PAR 7200 NoDomain 28:11:00:02:AC:00:08:7D 3.1.3 [Credentials] Username Address ------------- -------- ------- 3paradm 172.18.11.13 [Capacity] Status Total Allocated Free ---------- ------ -------- ----------- ------- Ok 90.00TB 0.01TB 90.00TB [Storage Pools] Status Name Drive Type RAID Total Allocated Free --------------- ------ ------- ---------- ---- -------- ----------- ------- OK FC_NO_DN FC RAID5 1,048,576.00GB 22.13GB 1,048,553.88GB [Host Ports] Status Port WWPN Expected Network Actual Network Port Group Name ------------ ------ ------- ----------------------- ---------------- -------------- --------------- Ok 0:1:1 01:00:4A:2B:21:E1:00:11 Fabric A (DA) Fabric A (DA) Auto Ok 0:2:2 01:02:4A:2B:21:E1:00:12 Fabric A (DA) Fabric A (DA) Auto </dev:code> <dev:remarks> <dev:para>Show a report of the managed storage system(s).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVStorageSystemPerformancePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEVOLUME--> <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"> <!--GET-HPOVSTORAGEVOLUME--> <command:details> <command:name>Get-HPOVStorageVolume</command:name> <maml:description> <maml:para>Retrieve Storage Volume resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will display all or a specific storage volume(s) created on the HPE OneView appliance. A specific storage volume can be searched for by using the Name. Use the List switch to display a report of the requested volume(s), including any assignments to Server Profiles.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageVolume</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specify the name of the Storage Volume to display.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>StorageVolumeTemplate</maml:name> <maml:description> <maml:para>Return a list of provisioned Storage Volumes by their associated Storage Volume Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Available</maml:name> <maml:description> <maml:para>Use to display Storage Volumes that are available for attachment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InputObject, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="InputObject"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide a Server Profile object and all associated Storage Volumes will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="InputObject, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="InputObject, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Available</maml:name> <maml:description> <maml:para>Use to display Storage Volumes that are available for attachment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="InputObject" aliases="ServerProfile, ServerProfileTemplate"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide a Server Profile object and all associated Storage Volumes will be returned.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="VolumeName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specify the name of the Storage Volume to display.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="SVT"> <maml:name>StorageVolumeTemplate</maml:name> <maml:description> <maml:para>Return a list of provisioned Storage Volumes by their associated Storage Volume Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.Volume></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple storage volume resources</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Formatted table view of storage volume resources</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>Get-HPOVStorageVolume</dev:code> <dev:remarks> <dev:para>Return all storage volume resource objects.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEVOLUMESET--> <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"> <!--GET-HPOVSTORAGEVOLUMESET--> <command:details> <command:name>Get-HPOVStorageVolumeSet</command:name> <maml:description> <maml:para>Get available storage volume sets.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageVolumeSet</command:noun> </command:details> <maml:description> <maml:para>A collection of volumes is referred to as volume set in HPE OneView. Volume sets are used to govern data-protection policies, such as snapshot and replication schedules. For HPE Nimble storage, the corresponding terminology for "volume sets" is "data protection volume collections". Volumes that hold multiple components of an application, such as databases and transaction logs, can be grouped into a volume set. This Cmdlet will return the available volume sets from the available storage systems. Volume sets are created on the storage system.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageVolumeSet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for the resource name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:nr * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter for the resource name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:nr * AllResources *AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSet</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The available storage system volume set.</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>Get-HPOVStorageVolumeSet</dev:code> <dev:remarks> <dev:para>Get all available storage sets.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageVolumeSet -Name VolumeSets</dev:code> <dev:remarks> <dev:para>Get the specified "VolumeSets" storage sets.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEVOLUMESNAPSHOT--> <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"> <!--GET-HPOVSTORAGEVOLUMESNAPSHOT--> <command:details> <command:name>Get-HPOVStorageVolumeSnapShot</command:name> <maml:description> <maml:para>Retrieve Storage Volume Snapshot resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageVolumeSnapShot</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will display all of the avialable snapshots for a given Storage Volume or multiple Storage Volumes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageVolumeSnapShot</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Volume] Provide the Storage Volume resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Name, Volume"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Volume] Provide the Storage Volume resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.VolumeSnapshot></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple storage volume snapshot resources</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSnapshot [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Formatted table view of storage volume snapshot resources</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>Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapShot Appliance Name Parent Volume State Capacity --------- ---- ------------- ----- -------- hpov.domain.com Vol1_20160211220746 Vol1 Configured (None) 10.00 GB hpov.domain.com Vol1_20160224235647 Vol1 Configured (None) 10.00 GB hpov.domain.com Vol1_20160224235716 Vol1 Configured (None) 10.00 GB hpov.domain.com Shared 1_20160224232717 Shared 1 Configured (None) 1,000.00 GB hpov.domain.com Shared 1_20160224235621 Shared 1 Configured (None) 1,000.00 GB hpov.domain.com Shared 1 Snapshot Converted_20160225214317 Shared 1 Snapshot Converted Configured (None) 1,000.00 GB</dev:code> <dev:remarks> <dev:para>Return all storage volume snapshot resource objects from all available storage volume resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageVolume "Volume 1" | Get-HPOVStorageVolumeSnapShot</dev:code> <dev:remarks> <dev:para>Get available storage volume snapshots from a specific Storage Volume.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEVOLUMETEMPLATE--> <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"> <!--GET-HPOVSTORAGEVOLUMETEMPLATE--> <command:details> <command:name>Get-HPOVStorageVolumeTemplate</command:name> <maml:description> <maml:para>Retrieve Storage Volume Template (SVT) resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageVolumeTemplate</command:noun> </command:details> <maml:description> <maml:para>Retrieve configured Storage Volume Template(s) from the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Storage Volume Template name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>${Global:ConnectedSessions}</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="TemplateName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Storage Volume Template name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.VolumeTemplate [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Storage Volume Template</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.COllections.ArrayList <HPOneView.Storage.VolumeTemplate></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Storage Volume Template</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>Get-HPOVStorageVolumeTemplate</dev:code> <dev:remarks> <dev:para>Get all available Storage Volume Templates.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageVolumeTemplate -templateName R5SVT-1</dev:code> <dev:remarks> <dev:para>Get the "R5SVT-1" template.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSTORAGEVOLUMETEMPLATEPOLICY--> <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"> <!--GET-HPOVSTORAGEVOLUMETEMPLATEPOLICY--> <command:details> <command:name>Get-HPOVStorageVolumeTemplatePolicy</command:name> <maml:description> <maml:para>Retrieve Storage Volume Template Global Policy.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVStorageVolumeTemplatePolicy</command:noun> </command:details> <maml:description> <maml:para>By default, Storage Volumes can be created without reference to a Storage Volume Template. This Cmdlet will display the global policy setting. Use Set-HPOVStorageVolumeTemplatePolicy to modify the global policy setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVStorageVolumeTemplatePolicy</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.GlobalSetting [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object resource with the global setting value</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>Get-HPOVStorageVolumeTemplatePolicy Appliance Name Value --------- ---- ----- MyAppliance.domain.com StorageVolumeTemplateRequired true MyAppliance2.domain.com StorageVolumeTemplateRequired false</dev:code> <dev:remarks> <dev:para>Get the Storage Volume Template Global Policy setting from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSWITCH--> <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"> <!--GET-HPOVSWITCH--> <command:details> <command:name>Get-HPOVSwitch</command:name> <maml:description> <maml:para>Get a Switch resource.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSwitch</command:noun> </command:details> <maml:description> <maml:para>Retrieve a Switch that is managed by HPE OneView. Currently, HPE OneView can Manage or Monitor Cisco Nexus-family of switches. This Cmdlet will retrieve the specified or all Logical Switch Group resources.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSwitch</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Switch resource Name. Supports the * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVSwitch</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Label, Default" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Switch resource Name. Supports the * wildcard character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values: * AllResources * AllResourcesInScope * HPOneView.Appliance.ScopeCollection * HPOneView.Appliance.ConnectionPermission</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Async task resource after a Logical Switch Group has been created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object to monitor (if -Async was used) or results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.LogicalSwitchGroup></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Logical Switch Group resources.</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>Get-HPOVSwitch</dev:code> <dev:remarks> <dev:para>Get all logical switch group resources found on the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSwitch -Name "10.1.1.1"</dev:code> <dev:remarks> <dev:para>Get the "10.1.1.1" switch resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSwitchType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVSWITCHTYPE--> <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"> <!--GET-HPOVSWITCHTYPE--> <command:details> <command:name>Get-HPOVSwitchType</command:name> <maml:description> <maml:para>Retrieve Switch Type resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVSwitchType</command:noun> </command:details> <maml:description> <maml:para>Retrieves a list of all supported Switch Types or just specific ones via a query if the name or partnumber parameters are provided. </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVSwitchType</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the switch type model name to retrieve. Does not support wildcard search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVSwitchType</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an switch type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber, Name" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the switch type model name to retrieve. Does not support wildcard search.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PartNumber" aliases="None"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>The Part Number of an switch type to search for.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SwitchType</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Switch Type resource.</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>Get-HPOVSwitchType</dev:code> <dev:remarks> <dev:para>Returns all Switch Types available from all connected appliances to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSwitchType -Name "Cisco Nexus 55xx"</dev:code> <dev:remarks> <dev:para>Returns just the "Cisco Nexus 55xx" Switch Type object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSwitchType -Partnumber "DCS-7060X-SERIES"</dev:code> <dev:remarks> <dev:para>Returns just the partnumber "DCS-7060X-SERIES" Switch Type object to standard output.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVTASK--> <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"> <!--GET-HPOVTASK--> <command:details> <command:name>Get-HPOVTask</command:name> <maml:description> <maml:para>Retrieve Task resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVTask</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name, owner, state and status. If the task resource is in either Waiting or Running state, you can pass it to Wait-HPOVTaskComplete to monitor the progression and eventual final state.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVTask</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the task resource to be returned. All names will match if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Related resource Name or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>State</maml:name> <maml:description> <maml:para>The state of the task resource a to be returned. May be one of the following strings: * Unknown * New * Running * Suspended * Terminated * Killed * Completed * Error * Warning All states will match if omitted. All tasks will be returned if both names and state are omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the maximum amount of task objects to return. 0 will return all found task objects.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVTask</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the task resource to be returned. All names will match if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory"> <maml:name>ResourceCategory</maml:name> <maml:description> <maml:para>Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter. Some examples are: * ethernet-networks * fc-networks * power-devices * unmanaged-devices * server-profiles * server-hardware * enclosures * enclosure-groups * interconnects * logical-interconnects * logical-interconnect-groups * appliance * firmware-drivers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>State</maml:name> <maml:description> <maml:para>The state of the task resource a to be returned. May be one of the following strings: * Unknown * New * Running * Suspended * Terminated * Killed * Completed * Error * Warning All states will match if omitted. All tasks will be returned if both names and state are omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the maximum amount of task objects to return. 0 will return all found task objects.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ResourceCategory, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ResourceCategory, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specify the maximum amount of task objects to return. 0 will return all found task objects.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Related resource Name or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default" aliases="TaskName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the task resource to be returned. All names will match if omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory" aliases="Category"> <maml:name>ResourceCategory</maml:name> <maml:description> <maml:para>Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter. Some examples are: * ethernet-networks * fc-networks * power-devices * unmanaged-devices * server-profiles * server-hardware * enclosures * enclosure-groups * interconnects * logical-interconnects * logical-interconnect-groups * appliance * firmware-drivers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ResourceCategory, Default" aliases="None"> <maml:name>State</maml:name> <maml:description> <maml:para>The state of the task resource a to be returned. May be one of the following strings: * Unknown * New * Running * Suspended * Terminated * Killed * Completed * Error * Warning All states will match if omitted. All tasks will be returned if both names and state are omitted.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject ]</maml:name> </dev:type> <maml:description> <maml:para>Resource Object to retrieve task resources of</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Task resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Task resources or formatted table list of tasks</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>$tasks = Get-HPOVTask -state Error</dev:code> <dev:remarks> <dev:para>Return all the tasks with a taskState="Error"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile -Name "Server 1" | Get-HPOVTask -State Completed</dev:code> <dev:remarks> <dev:para>Return completed (successful) tasks associated with the "Server 1" Server Profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVTask -count 10</dev:code> <dev:remarks> <dev:para>Display the 10 most recent tasks from the specified appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Wait-HPOVTaskComplete</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-HPOVTaskStart</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVUNMANAGEDDEVICE--> <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"> <!--GET-HPOVUNMANAGEDDEVICE--> <command:details> <command:name>Get-HPOVUnmanagedDevice</command:name> <maml:description> <maml:para>Get Unmanaged Devices.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVUnmanagedDevice</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides administrators with the capability to define unmanaged devices to them place within Racks, in order to provide a more realistic and complete data center layout. This Cmdlet will retrieve all or a specified Unmanaged Device. A report switch is provided to display the output in an easier to read format.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVUnmanagedDevice</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>List</maml:name> <maml:description> <maml:para>Deprecated parameter. Cmdlet now defaults to Format-Table output.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specify the label associated with resources.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="report"> <maml:name>List</maml:name> <maml:description> <maml:para>Deprecated parameter. Cmdlet now defaults to Format-Table output.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.UnmanagedResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Unmanaged Device resource object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Unmanaged Device resource objects</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>Get-HPOVUnmanagedDevice</dev:code> <dev:remarks> <dev:para>Get all unmanaged devices.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVUPLINKSET--> <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"> <!--GET-HPOVUPLINKSET--> <command:details> <command:name>Get-HPOVUplinkSet</command:name> <maml:description> <maml:para>Retrieve Uplink Set resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVUplinkSet</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will retrieve the list of all Uplink Sets or specific by the name. The Cmdlet will only display provisioned Uplink Sets that are members of a Logical Interconnect resource. To view Uplink Sets of a Logical Interconnect Group, use the Get-HPOVLogicalInterconnectGroup Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVUplinkSet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Uplink Set</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Type, Name"> <maml:name>LogicalInterconnect</maml:name> <maml:description> <maml:para>Name of the Logical Interconnect to show associated Uplink Set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>Report</maml:name> <maml:description> <maml:para>Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>ExportFile</maml:name> <maml:description> <maml:para>Export the found Uplink Set resource objects to JSON files in the specified directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVUplinkSet</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Type, Name"> <maml:name>LogicalInterconnect</maml:name> <maml:description> <maml:para>Name of the Logical Interconnect to show associated Uplink Set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the Uplink Set Type to display. Will display all Uplink Sets of the type provided. Allowed values: * Ethernet * FibreChannel</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>Report</maml:name> <maml:description> <maml:para>Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name"> <maml:name>ExportFile</maml:name> <maml:description> <maml:para>Export the found Uplink Set resource objects to JSON files in the specified directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name" aliases="x, export"> <maml:name>ExportFile</maml:name> <maml:description> <maml:para>Export the found Uplink Set resource objects to JSON files in the specified directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Type, Name" aliases="liname"> <maml:name>LogicalInterconnect</maml:name> <maml:description> <maml:para>Name of the Logical Interconnect to show associated Uplink Set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Name" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Uplink Set</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Type, Name" aliases="None"> <maml:name>Report</maml:name> <maml:description> <maml:para>Generate a report of the defined Uplink Sets. Includes Uplink Set type, networks, redundancy report, and assigned uplink ports.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Type" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the Uplink Set Type to display. Will display all Uplink Sets of the type provided. Allowed values: * Ethernet * FibreChannel</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Uplink Set</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Uplink Sets</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>$UplinkSets = Get-HPOVUplinkSet</dev:code> <dev:remarks> <dev:para>Get list of all Uplink Sets.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUplinkSet -name "Production Networks"</dev:code> <dev:remarks> <dev:para>Get the "Production Networks" Uplink Set(s).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUplinkSet -name "Production Networks" -report</dev:code> <dev:remarks> <dev:para>Get the "Production Networks" Uplink Set(s), and generate a report.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUplinkSet -name "Production Networks" -liname "Encl1-LI" -report</dev:code> <dev:remarks> <dev:para>Get the "Production Networks" Uplink Set that is associated with "Encl1-LI" Logical Interconnect and generate a report.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVUplinkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVUSER--> <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"> <!--GET-HPOVUSER--> <command:details> <command:name>Get-HPOVUser</command:name> <maml:description> <maml:para>Retrieve user account resource(s).</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVUser</command:noun> </command:details> <maml:description> <maml:para>Get a local user account on the management appliance, and display it"s properties. The account password will not be displayed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVUser</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user account to display.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Username"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user account to display.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single User resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple User resourses, or formatted table displaying a report of user accounts</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>Get-HPOVUser</dev:code> <dev:remarks> <dev:para>List all user accounts from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUser "Sally"</dev:code> <dev:remarks> <dev:para>List Sally"s user account from MyAppliance.domain.com.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVUserSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVVERSION--> <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"> <!--GET-HPOVVERSION--> <command:details> <command:name>Get-HPOVVersion</command:name> <maml:description> <maml:para>Display library component versions.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVVersion</command:noun> </command:details> <maml:description> <maml:para>Display either the HPE OneView PowerShell library or appliance version. Displaying the Appliance version will provide the Major, Minor, full version, and X-API Version information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVVersion</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceVer</maml:name> <maml:description> <maml:para>Include the appliance version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="CheckOnlineOnly, Default"> <maml:name>CheckOnline</maml:name> <maml:description> <maml:para>Check the GitHub repository for an updated version of the library.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HPOVVersion</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="CheckOnlineOnly, Default"> <maml:name>CheckOnline</maml:name> <maml:description> <maml:para>Check the GitHub repository for an updated version of the library.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>${Global:ConnectedSessions}</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ApplianceVer</maml:name> <maml:description> <maml:para>Include the appliance version.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="CheckOnlineOnly, Default" aliases="None"> <maml:name>CheckOnline</maml:name> <maml:description> <maml:para>Check the GitHub repository for an updated version of the library.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The HPE OneView PowerShell Library or Appliance version information</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>Get-HPOVVersion</dev:code> <dev:remarks> <dev:para>Get the HPE OneView PowerShell library version</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVVersion -ApplianceVer PowerShell Library Version : 1.20.208.0 Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\HPOneView.120 Appliance Major Version : 1 Appliance Minor Version : 20 Appliance Version Info : 1.20.05-0201918 Appliance X-API Version : 120</dev:code> <dev:remarks> <dev:para>Get the HPE OneView PowerShell library, Appliance and X-API version information</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVVersion -CheckOnline PowerShell Library Version : 1.20.166.0 Library Path : C:\Users\user\Documents\WindowsPowerShell\Modules\hponeview.120 Please Confirm You currently have v1.20.166.0 installed. The HPE OneView PowerShell Library v1.20.208.0 was found that is newer. Do you want to download the current version of the HPE OneView POSH Library (will open your web browser for you to download)? [Y] Yes [N] No [?] Help (default is "Y"):</dev:code> <dev:remarks> <dev:para>Display the installed library version, and check for availability of an updated version online. If an updated version is found, the Cmdlet will prompt if the user would like to download it now. If so, browser window will be opened to current version to download.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--GET-HPOVXAPIVERSION--> <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"> <!--GET-HPOVXAPIVERSION--> <command:details> <command:name>Get-HPOVXApiVersion</command:name> <maml:description> <maml:para>Get appliance API version.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>HPOVXApiVersion</command:noun> </command:details> <maml:description> <maml:para>Returns the API versions supported by the appliance. You do not need to authenticate, or call Connect-HPOVMgmt, to an appliance in order to retrieve the supported REST API Versions by the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-HPOVXApiVersion</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The current and minimum supported API versions on the appliance</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>(Get-HPOVXApiVersion myAppliance.domain.com).minimumversion</dev:code> <dev:remarks> <dev:para>This example retrieves the minimum XApi version supported by the appliance. An existing connection is not needed since the appliance name is provided.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>(Get-HPOVXApiVersion).minimumversion</dev:code> <dev:remarks> <dev:para>This example retrieves the minimum XApi version supported by the appliance and requires that a connection has been established by using Connect-HPOVMgmt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--IMPORT-HPOVSSLCERTIFICATE--> <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"> <!--IMPORT-HPOVSSLCERTIFICATE--> <command:details> <command:name>Import-HPOVSslCertificate</command:name> <maml:description> <maml:para>Import an appliance SSL Certificate.</maml:para> </maml:description> <command:verb>Import</command:verb> <command:noun>HPOVSslCertificate</command:noun> </command:details> <maml:description> <maml:para>By default, the HPE OneView appliance creates a self signed SSL Certificate for its WebUI. There might be a desire to trust the certificate, in case the SHA-1 hash becomes invalid (either due to a certificate change or man-in-the-middle attack) and the caller would like to be notified. This Cmdlet will assist in retrieving and storing the appliance self-generated SSL Certificate into the current users Trusted Root Certification Authorities store. Please note that the Subject Alternate Name (SAN) must match that of the Appliance hostname you use to connect to your appliance. If it does not, an SSL conenction failure will occur. When creating a CSR on the appliance, make sure to include the additional FQDN and IP address(es) in the Alternative Name field.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Import-HPOVSslCertificate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>${Global:ConnectedSessions}</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView Appliance Connection object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet does not return any object.</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>$Connection = Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword Import-HPOVSslCertificate</dev:code> <dev:remarks> <dev:para>Import the SSL certificate from the specific appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Connect-HPOVMgmt Myappliance.domain.com Administrator MyP@ssword Connect-HPOVMgmt Myappliance2.domain.com Administrator MyP@ssword $ConnectedSessions | Import-HPOVSslCertificate </dev:code> <dev:remarks> <dev:para>Import the SSL Certificate from all connected sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--INSTALL-HPOVAPPLIANCECERTIFICATE--> <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"> <!--INSTALL-HPOVAPPLIANCECERTIFICATE--> <command:details> <command:name>Install-HPOVApplianceCertificate</command:name> <maml:description> <maml:para>Install signed private key.</maml:para> </maml:description> <command:verb>Install</command:verb> <command:noun>HPOVApplianceCertificate</command:noun> </command:details> <maml:description> <maml:para>After using New-HPOVApplianceCSR to generate a Certificate Signing Request (CSR), this Cmdlet will install the CA signed and approved SSL private key to the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Install-HPOVApplianceCertificate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Path</maml:name> <maml:description> <maml:para>The private key certificate for the appliance. The source CER file can be passed to the Cmdlet via pipeline or this parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify the HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify the HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="PrivateKey, Certificate"> <maml:name>Path</maml:name> <maml:description> <maml:para>The private key certificate for the appliance. The source CER file can be passed to the Cmdlet via pipeline or this parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>Certificate file path</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource object to monitor committing certificate, and deploying HPE SSO certificate update to managed/monitored devices</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>$Task = C:\dir\hpov.cer | Install-HPOVApplianceCertificate</dev:code> <dev:remarks> <dev:para>Read the signed SSL certificate private key and install it on the appliance, and wait for the task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$cert = Get-ChildItem C:\dir\hpov.cer $TaskToMonitor = Install-HPOVApplianceCertificate -Path $Cert -Async C:\> $TaskToMonitor | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Read the signed SSL certificate private key and install it on the appliance, and wait for the task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCertificateStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--INSTALL-HPOVLOGICALINTERCONNECTFIRMWARE--> <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"> <!--INSTALL-HPOVLOGICALINTERCONNECTFIRMWARE--> <command:details> <command:name>Install-HPOVLogicalInterconnectFirmware</command:name> <maml:description> <maml:para>Install Logical Interconnect Firmware.</maml:para> </maml:description> <command:verb>Install</command:verb> <command:noun>HPOVLogicalInterconnectFirmware</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to install/update the Logical Interconnect (i.e. Virtual Connect) firmware. You can provide the Logical Interconnect Name, URI or Object and must specify a valid SPP Baseline present on the appliance. This Cmdlet will default to performing an Update (Stage + Activate), which will cause an outage. If you wish to avoid an outage, first stage the update usind -method stage, then -method activate. Interconnect activation can be controlled with the -ActivateOrder parameter, which defaults to Odd interconnects. Once the specified interconnect activation is complete, you must then call the Cmdlet again with the alternate ActivateOrder value (i.e. even.)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Install-HPOVLogicalInterconnectFirmware</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>LogicalInterconnect</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware Baseline Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Method</maml:name> <maml:description> <maml:para>Upgrade method to perform. Accepted values are: * UPDATE (Default) * STAGE * ACTIVATE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>EthernetActivateOrder</maml:name> <maml:description> <maml:para>Specify the Ethernet module firmware activation order. Accepted values are: * OddEven (Default) * Parallel * Serial</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>EthernetActivateDelay</maml:name> <maml:description> <maml:para>The amount of time in seconds to delay activating additional modules. Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>FCActivateOrder</maml:name> <maml:description> <maml:para>Specify the Fibre Channel module firmware activation order. Accepted values are: * OddEven * Parallel * Serial (Default)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>FCActivateDelay</maml:name> <maml:description> <maml:para>The amount of time in seconds to delay activating additional modules. Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the firmware update if the update version matches what is already installed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="spp"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware Baseline Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>EthernetActivateDelay</maml:name> <maml:description> <maml:para>The amount of time in seconds to delay activating additional modules. Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Order, ActivateOrder"> <maml:name>EthernetActivateOrder</maml:name> <maml:description> <maml:para>Specify the Ethernet module firmware activation order. Accepted values are: * OddEven (Default) * Parallel * Serial</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>OddEven</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>FCActivateDelay</maml:name> <maml:description> <maml:para>The amount of time in seconds to delay activating additional modules. Default is 5 seconds.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>FCActivateOrder</maml:name> <maml:description> <maml:para>Specify the Fibre Channel module firmware activation order. Accepted values are: * OddEven * Parallel * Serial (Default)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Serial</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the firmware update if the update version matches what is already installed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="name, uri, li"> <maml:name>LogicalInterconnect</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Method</maml:name> <maml:description> <maml:para>Upgrade method to perform. Accepted values are: * UPDATE (Default) * STAGE * ACTIVATE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Update</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns an async task resource to monitor.</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>$li = Get-HPOVLogicalInterconnect Encl1-LI $spp = Get-HPOVSppFile "HP Service Pack for ProLiant" $task = Install-HPOVLogicalInterconnectFirmware Stage $li $spp Wait-HPOVTaskComplete $task $task = Install-HPOVLogicalInterconnectFirmware Activate $li Wait-HPOVTaskComplete $task</dev:code> <dev:remarks> <dev:para>Perform a firmware update of the Encl1-LI Logical Interconnect by first staging the firmware. Then Acitate the firmware using the default OddEven Interconnect Bay order.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect Encl1-LI | Install-HPOVLogicalInterconnectFirmware -method Update -baseline "HP Service Pack for ProLiant" -confirm:$false | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Perform a firmware update of the Encl1-LI Logical Interconnect, do not prompt for confirmation, then wait for the task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--INSTALL-HPOVUPDATE--> <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"> <!--INSTALL-HPOVUPDATE--> <command:details> <command:name>Install-HPOVUpdate</command:name> <maml:description> <maml:para>Install or stage an appliance update.</maml:para> </maml:description> <command:verb>Install</command:verb> <command:noun>HPOVUpdate</command:noun> </command:details> <maml:description> <maml:para>The Install-HPOVUpdate installs an appliance update package to upgrade the platform to the specified version. Use the -Stage switch to stage an update on the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Install-HPOVUpdate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Stage, Update"> <maml:name>File</maml:name> <maml:description> <maml:para>Appliance Update file to install.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StageInstall, Update"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Will display EULA if no value is provided. Pass "accept" to accept and not display EULA.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="List, Stage, Update"> <maml:name>DisplayReleaseNotes</maml:name> <maml:description> <maml:para>Display Release Notes of Update</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StageInstall, List, Stage, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-HPOVUpdate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Stage, Update"> <maml:name>File</maml:name> <maml:description> <maml:para>Appliance Update file to install.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Stage"> <maml:name>Stage</maml:name> <maml:description> <maml:para>Used to upload update to appliance and not apply update.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="List, Stage, Update"> <maml:name>DisplayReleaseNotes</maml:name> <maml:description> <maml:para>Display Release Notes of Update</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StageInstall, List, Stage, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-HPOVUpdate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StageInstall"> <maml:name>InstallNow</maml:name> <maml:description> <maml:para>Install pending update that was previously staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StageInstall, Update"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Will display EULA if no value is provided. Pass "accept" to accept and not display EULA.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StageInstall, List, Stage, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-HPOVUpdate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="List"> <maml:name>ListPending</maml:name> <maml:description> <maml:para>List any pending updates on the appliance that might have been staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="List, Stage, Update"> <maml:name>DisplayReleaseNotes</maml:name> <maml:description> <maml:para>Display Release Notes of Update</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StageInstall, List, Stage, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StageInstall, List, Stage, Update" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="List, Stage, Update" aliases="None"> <maml:name>DisplayReleaseNotes</maml:name> <maml:description> <maml:para>Display Release Notes of Update</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StageInstall, Update" aliases="None"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Will display EULA if no value is provided. Pass "accept" to accept and not display EULA.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Stage, Update" aliases="f"> <maml:name>File</maml:name> <maml:description> <maml:para>Appliance Update file to install.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StageInstall" aliases="None"> <maml:name>InstallNow</maml:name> <maml:description> <maml:para>Install pending update that was previously staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="List" aliases="list"> <maml:name>ListPending</maml:name> <maml:description> <maml:para>List any pending updates on the appliance that might have been staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Stage" aliases="None"> <maml:name>Stage</maml:name> <maml:description> <maml:para>Used to upload update to appliance and not apply update.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>Write-Progress</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Will display a progress bar indicating the Appliance Update status</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList (System.Management.Automation.PSCustomObject)</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When performing stage and install (no switch options provided), the return will include the uploaded patch information from the appliance, and the completed upgrade message</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>Install-HPOVUpdate -file C:\Path\update.bin</dev:code> <dev:remarks> <dev:para>Install the Update.bin package to the appliance. User will be prompted to accept the upgrade EULA, and if a reboot is required also be prompted to confirm.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Install-HPOVUpdate -file C:\Path\update.bin -Stage -DisplayReleaseNotes</dev:code> <dev:remarks> <dev:para>Stage the update on the appliance, and display the Release Notes to the PowerShell console.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Install-HPOVUpdate -file C:\Path\update.bin -Stage Install-HPOVUpdate -EULA Accept -InstallNow</dev:code> <dev:remarks> <dev:para>Stage the Update.bin package to the appliance. After update has been staged, install the update now on specified appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Install-HPOVUpdate -ListPending -DisplayReleaseNotes</dev:code> <dev:remarks> <dev:para>List a pending, staged updates on the appliance, then display the Release Notes to the PowerShell console.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--INVOKE-HPOVVCMMIGRATION--> <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"> <!--INVOKE-HPOVVCMMIGRATION--> <command:details> <command:name>Invoke-HPOVVcmMigration</command:name> <maml:description> <maml:para>Migrate Virtual Connect Manager to HPE OneView.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>HPOVVcmMigration</command:noun> </command:details> <maml:description> <maml:para>This function is used to migrate an existing Virtual Connect Manager configuration to HPE OneView. If an enclosure was added to an HPE OneView appliance as Monitor-Only, then you must first remove the enclosure from the appliance, and then use this Cmdlet to migrate the enclosure. Using the -VCEMCMS, -VCEMUser and -VCEMPassword parameters, the targeted Virtual Connect Domain can be removed from a Virual Connect Enterprise Manager Domain Group first before initiating the VC Migration tool within the HPE OneView appliance. The required VCEM 7.3/7.4 Patch is available here: ftp://ftp.hp.com/pub/softlib2/software1/pubsw-generic/p270829882/v106568. VCEM 7.4.1 or greater users do not require the patch to be installed, as the API is built into 7.4.1 or greater. It is important to also have a Virtual Connect Domain Backup prior to migration. You may also want to gather the output from the "show config -includepoolinfo" VCM CLI command to review or verify resources were migrated successfully. Please read "Chapter 9 Planning for enclosure migration from VCM into HPE OneView" in the HPE OneView 1.20 User Guide for more information about migration and other planning resources.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-HPOVVcmMigration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAIPAddress</maml:name> <maml:description> <maml:para>REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Password for the Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OACredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Username for the administrator account for Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Password for the Administrator account of Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the Serial Number of the Enclosure (Example: "EG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LogicalInterconnectGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group will be created based on the Serial Number of the Enclosure (Example: "LIG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Report, VCEMMigration, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-HPOVVcmMigration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAIPAddress</maml:name> <maml:description> <maml:para>REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration"> <maml:name>VCEMCMS</maml:name> <maml:description> <maml:para>The IP Address or FQDN of the VCEM host.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Password for the Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OACredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Username for the administrator account for Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Password for the Administrator account of Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the Serial Number of the Enclosure (Example: "EG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LogicalInterconnectGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group will be created based on the Serial Number of the Enclosure (Example: "LIG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration"> <maml:name>VCEMUser</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCEMCredential Administrator level account name available on the VCEM host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration"> <maml:name>VCEMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCEMCredential Administrator level account password on the VCEM host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration"> <maml:name>VCEMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the Virtual Connect Enterprise Manager associated with the Virtual Connect Manager Domain.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Report, VCEMMigration, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-HPOVVcmMigration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAIPAddress</maml:name> <maml:description> <maml:para>REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Report"> <maml:name>Report</maml:name> <maml:description> <maml:para>OPTIONAL. Execute the migration report only. Do not execute the migration process.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OAPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Password for the Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>OACredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Username for the administrator account for Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Password for the Administrator account of Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>VCMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the Serial Number of the Enclosure (Example: "EG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report"> <maml:name>LogicalInterconnectGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group will be created based on the Serial Number of the Enclosure (Example: "LIG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Report"> <maml:name>Path</maml:name> <maml:description> <maml:para>The directory path in which to save the report output to a file. * Filename will be created in the format: [path]\{enclsoureName}_{date}.report</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Report, VCEMMigration, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Report, VCEMMigration, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="NoWait"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="eg"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Enclosure Group. If the Enclosure Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Enclosure Group will be created based on the Serial Number of the Enclosure (Example: "EG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="license, l"> <maml:name>LicensingIntent</maml:name> <maml:description> <maml:para>REQUIRED. Specifies whether the intent is to apply either OneView or OneView w/o iLO licenses to the servers in the enclosure being imported. Accepted values are * OneView * OneViewNoiLO</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="lig"> <maml:name>LogicalInterconnectGroup</maml:name> <maml:description> <maml:para>OPTIONAL. The Name, URI or Object of an existing Logical Interconnect Group. If the Logical Interconnect Group Name does not exist, a new resource with the String value provided will be created. If omitted, a new Logical Interconnect Group will be created based on the Serial Number of the Enclosure (Example: "LIG_USE1234567A").</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="None"> <maml:name>OACredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Onboard Administrator.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="oip"> <maml:name>OAIPAddress</maml:name> <maml:description> <maml:para>REQUIRED. IP address or FQDN of the Primary Onboard Administrator in the target enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="op"> <maml:name>OAPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Password for the Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="ou"> <maml:name>OAUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -OACredential. Administrator account of the target OA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Report" aliases="Export"> <maml:name>Path</maml:name> <maml:description> <maml:para>The directory path in which to save the report output to a file. * Filename will be created in the format: [path]\{enclsoureName}_{date}.report</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Report" aliases="None"> <maml:name>Report</maml:name> <maml:description> <maml:para>OPTIONAL. Execute the migration report only. Do not execute the migration process.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration" aliases="None"> <maml:name>VCEMCMS</maml:name> <maml:description> <maml:para>The IP Address or FQDN of the VCEM host.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration" aliases="None"> <maml:name>VCEMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the Virtual Connect Enterprise Manager associated with the Virtual Connect Manager Domain.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration" aliases="None"> <maml:name>VCEMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCEMCredential Administrator level account password on the VCEM host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VCEMMigration" aliases="None"> <maml:name>VCEMUser</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCEMCredential Administrator level account name available on the VCEM host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="None"> <maml:name>VCMCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the username and password details for the c-Class Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="vp"> <maml:name>VCMPassword</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Password for the Administrator account of Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, VCEMMigration, Report" aliases="vu"> <maml:name>VCMUserName</maml:name> <maml:description> <maml:para>Parameter is being deprecated. Please transition to using -VCMCredential. Username for the administrator account for Virtual Connect Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Valid Enclosure Group resource the appliance will migrate the source enclosure into</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process</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>$OACreds = Get-Credential -Username Administrator -Message "Password" $VCMCreds = Get-Credential -Username Administrator -Message "Password" Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -LicensingIntent OneView -Report</dev:code> <dev:remarks> <dev:para>Generate Virtual Connect Manager configuration migration report for the specified enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$OACreds = Get-Credential -Username Administrator -Message "Password" $VCMCreds = Get-Credential -Username Administrator -Message "Password" Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -LicensingIntent OneView</dev:code> <dev:remarks> <dev:para>Migration will occur and create a new Enclosure Group and new Logical Interconnect Group based on the enclosure serial number.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$OACreds = Get-Credential -Username Administrator -Message "Password" $VCMCreds = Get-Credential -Username Administrator -Message "Password" $EnclosureGroup = Get-HPOVEnclosureGroup -Name EnclosureGroup1 -ErrorAction Stop Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -LicensingIntent OneView -EnclosureGroup $EnclosureGroup</dev:code> <dev:remarks> <dev:para>Migration will occur and import the target enclosure into an existing Enclosure Group named "EnclosureGroup1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OAUserName Administrator -OAPassword hpinvent -VCMUserName Administrator -VCMPassword hpinvent -licensingIntent OneView -Report -Path "c:\VCM-MigrationReports" ". </dev:code> <dev:remarks> <dev:para>Migration will not be attempted. The migration report will be executed and the result saved to the file "c:\VCM-MigrationReports\{enclosureName}_{date}.report".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$OACreds = Get-Credential -Username Administrator -Message "Password" $VCMCreds = Get-Credential -Username Administrator -Message "Password" $VCEMCreds = Get-Credential -Username Domain\Adminisrator -Message "Password" $EnclosureGroup = Get-HPOVEnclosureGroup -Name EnclosureGroup1 -ErrorAction Stop Invoke-HPOVVcmMigration -OAIPAddress 192.168.19.40 -OACredential $OACreds -VCMCredential $VCMCreds -VCEMCMS vcemcms.domain.com -VCEMCredential $VCEMCreds -LicensingIntent OneView</dev:code> <dev:remarks> <dev:para>Perform a migration of a VCEM managed enclosure to HPE OneView.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--INVOKE-HPOVWEBBROWSER--> <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"> <!--INVOKE-HPOVWEBBROWSER--> <command:details> <command:name>Invoke-HPOVWebBrowser</command:name> <maml:description> <maml:para>Start default web browser opened to appliance dashboard.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>HPOVWebBrowser</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will open the default web browser to the specified appliance, logged in with the same credentials as the PowerShell library connection is authenticated with. To open multiple browser windows to each appliance connection, use the global $ConnectedSessions variable to override the -ApplianceConnection parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-HPOVWebBrowser</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Use to quickly jump to the specific UI section of the connected appliance. Allowed values: * Dashboard * Enclosures * LogicaInterconnectGroups * LogicalEnclosures * LogicalInterconnects * Networks * RackManagers * ServerHardware * ServerProfiles * ServerProfileTemplates * Settings * StoragePools * StorageSystems * StorageVolumes By default, the Cmdlet will open your default web browser to the appliance dashboard.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Use to quickly jump to the specific UI section of the connected appliance. Allowed values: * Dashboard * Enclosures * LogicaInterconnectGroups * LogicalEnclosures * LogicalInterconnects * Networks * RackManagers * ServerHardware * ServerProfiles * ServerProfileTemplates * Settings * StoragePools * StorageSystems * StorageVolumes By default, the Cmdlet will open your default web browser to the appliance dashboard.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Diagnostics.Process</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet will initiate a new default web browser instance to the default or specified appliance. </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>Connect-HPOVMgmt -Hostname MyAppliance.domain.com -Username MyAccount -Password $MySecurePassword Invoke-HPOVWebBrowser</dev:code> <dev:remarks> <dev:para>Connect to the appliance, then launch default web browser to the appliance dashboard.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Connect-HPOVMgmt -Hostname MyAppliance.domain.com -Username MyAccount -Password $MySecurePassword Invoke-HPOVWebBrowser -Resource ServerProfiles</dev:code> <dev:remarks> <dev:para>Connect to the appliance, then launch default web browser to the appliance dashboard.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--JOIN-HPOVSERVERPROFILETOTEMPLATE--> <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"> <!--JOIN-HPOVSERVERPROFILETOTEMPLATE--> <command:details> <command:name>Join-HPOVServerProfileToTemplate</command:name> <maml:description> <maml:para>Attach an existing server profile to a server profile template</maml:para> </maml:description> <command:verb>Join</command:verb> <command:noun>HPOVServerProfileToTemplate</command:noun> </command:details> <maml:description> <maml:para>Binds a server profile resource to the provided server profile template</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Join-HPOVServerProfileToTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Template</maml:name> <maml:description> <maml:para>A server profile template name, URI, or resource object</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>A server profile name, URI, or resource object</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>$Global:ConnectedSessions</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="p, Profile"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>A server profile name, URI, or resource object</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="t"> <maml:name>Template</maml:name> <maml:description> <maml:para>A server profile template name, URI, or resource object</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A PSCustom object representing a server profile template resource retrieved from the HPE OneView appliance</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of task resource objects</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An HPE OneView task resource object</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>Join-HPOVServerProfileToTemplate -template "MyTemplate" -profile "MyProfile" -appliance hpOneView.contoso.com</dev:code> <dev:remarks> <dev:para>Attaches the server profile template named MyTemplate to the server profile name MyProfile on the OneView appliance hpOneView.contoso.com</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$p = Get-HPOVServerProfile "myProfile" Get-HPOVServerProfileTemplate "myTemplate" | Join-HPOVServerProfileToTemplate -profile $p -appliance hpOneView.contoso.com</dev:code> <dev:remarks> <dev:para>Attaches the server profile template named MyTemplate to the server profile name MyProfile on the OneView appliance hpOneView.contoso.com</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVADDRESSPOOLRANGE--> <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"> <!--NEW-HPOVADDRESSPOOLRANGE--> <command:details> <command:name>New-HPOVAddressPoolRange</command:name> <maml:description> <maml:para>Create an Address Range.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVAddressPoolRange</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist with creating a new address pool range. The support address pool Types are MAC Addresses (VMAC), Fibre Channel/FCoE World Wide Name (VWWN), Server Serial Number (VSN), and IPv4 address pools (IPv4). When creating new address pool ranges, the Generated Range Type will allocate 1,048,576 MAC or WWN addresses, whereas it will allocate 46,656 Serial Numbers. If you specify a Custom Range Type, you must specify a range of addresses no smaller than 128, and no more than 1,048,576 per range. Custom Address Ranges must adhere to the following format rules: * The MAC Address must be IEEE Compliant, and the format must be XH:XX:XX:XX:XX:XX, where H must be 0, 2, 4, 6, 8, A, C or E. Example: 12:22:33:44:55:00 * The WWN Address must be IEEE compliant, and the format must be 10:00:XH:XX:XX:XX:XX:XX, where H must be 0, 2, 4, 6, 8, A, C or E. Example: 10:00:6C:9F:06:B0:00:00 * The Serial Number addresses must start with VCU, and cannot contain more than 10 characters total. Example: VCU1234567 IPv4 Address Subnets do not support Auto Generated, as the RangeType parameter is not required. When creating a new IPv4 Address Subnet, you must provide a unique Name, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]), Start and End IPv4 Address, Gateway and Domain Name. DNS Servers are optional. To add more Address Ranges to a Subnet after creating it, please use the New-HPOVAddressPoolRange Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVAddressPoolRange</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default"> <maml:name>PoolType</maml:name> <maml:description> <maml:para>Specify the Pool Type the new Range will be assinged to. Accepted values are: * VMAC * VWWN * VSN</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default"> <maml:name>RangeType</maml:name> <maml:description> <maml:para>The type of Address Range to create (not applicable for IPv4 address pools/Subnets). Accepted values are: * Generated * Custom</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). When attempting to create a new IPv4 address pool/Subnet, only a single HPOneView.Appliance.Connection object or Name property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVAddressPoolRange</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPPool"> <maml:name>IPSubnet</maml:name> <maml:description> <maml:para>[Aliases -IPv4Subnet] The IPv4 Subnet that the new IPv4 Range will be assigned to. Start and End values must be within the Network ID and Subnet value of the IPv4 Address Subnet Pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the IPv4address pool range Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom"> <maml:name>Start</maml:name> <maml:description> <maml:para>The starting address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom"> <maml:name>End</maml:name> <maml:description> <maml:para>The ending address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPPool, Custom, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). When attempting to create a new IPv4 address pool/Subnet, only a single HPOneView.Appliance.Connection object or Name property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVAddressPoolRange</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default"> <maml:name>PoolType</maml:name> <maml:description> <maml:para>Specify the Pool Type the new Range will be assinged to. Accepted values are: * VMAC * VWWN * VSN</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default"> <maml:name>RangeType</maml:name> <maml:description> <maml:para>The type of Address Range to create (not applicable for IPv4 address pools/Subnets). Accepted values are: * Generated * Custom</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom"> <maml:name>Start</maml:name> <maml:description> <maml:para>The starting address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom"> <maml:name>End</maml:name> <maml:description> <maml:para>The ending address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). When attempting to create a new IPv4 address pool/Subnet, only a single HPOneView.Appliance.Connection object or Name property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPPool, Custom, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). When attempting to create a new IPv4 address pool/Subnet, only a single HPOneView.Appliance.Connection object or Name property value is allowed. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom" aliases="None"> <maml:name>End</maml:name> <maml:description> <maml:para>The ending address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPPool" aliases="Subnet, IPv4Subnet, IPv6Subnet"> <maml:name>IPSubnet</maml:name> <maml:description> <maml:para>[Aliases -IPv4Subnet] The IPv4 Subnet that the new IPv4 Range will be assigned to. Start and End values must be within the Network ID and Subnet value of the IPv4 Address Subnet Pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the IPv4address pool range Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default" aliases="None"> <maml:name>PoolType</maml:name> <maml:description> <maml:para>Specify the Pool Type the new Range will be assinged to. Accepted values are: * VMAC * VWWN * VSN</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Default" aliases="None"> <maml:name>RangeType</maml:name> <maml:description> <maml:para>The type of Address Range to create (not applicable for IPv4 address pools/Subnets). Accepted values are: * Generated * Custom</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Generated</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="IPPool, Custom" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>The starting address in the range. Cannot overlap with other address ranges, and should be unique within the datacenter/infrastructure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>IPv4 Address Subnet resource object from Get-HPOVAddressPoolSubnet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AddressPoolRange [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created and assigned address pool range resource object</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:> New-HPOVAddressPoolRange -PoolType vmac -RangeType Generated</dev:code> <dev:remarks> <dev:para>Create a new Appliance generated VMAC Pool Range.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:> New-HPOVAddressPoolRange -PoolType vwwn -RangeType Custom -Start 10:00:6C:9F:06:B0:00:00 -End 10:00:6C:9F:06:BF:FF:FF</dev:code> <dev:remarks> <dev:para>Create a new VWWN address pool range with the custom addresses, for the MyAppliance1.domain.com appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:> Get-HPOVAddressPoolSubnet -NetworkId 192.168.20.0 | New-HPOVAddressPoolRange -Name "VLAN20 Mgmt" -Start 192.168.20.100 -end 192.168.20.200</dev:code> <dev:remarks> <dev:para>Create a new IPv4 address pool range, for the MyAppliance1.domain.com appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVADDRESSPOOLSUBNET--> <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"> <!--NEW-HPOVADDRESSPOOLSUBNET--> <command:details> <command:name>New-HPOVAddressPoolSubnet</command:name> <maml:description> <maml:para>Create an IPv4 Subnet Pool.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVAddressPoolSubnet</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist with creating a new IPv4 address pool. When creating a new IPv4 Address Subnet, you must provide the Network ID, Subnet Mask (CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]), Gateway and Domain Name. DNS Servers are optional. To add IPv4 Address Ranges to a Subnet after creating it, please use the New-HPOVAddressPoolRange Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVAddressPoolSubnet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>The IPv4 Network ID value of the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 Address of the default gateway for the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Domain</maml:name> <maml:description> <maml:para>DNS Domain Name of the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DNSServers</maml:name> <maml:description> <maml:para>An array of DNS Server IPv4 Addresses.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DNSServers</maml:name> <maml:description> <maml:para>An array of DNS Server IPv4 Addresses.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Domain</maml:name> <maml:description> <maml:para>DNS Domain Name of the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 Address of the default gateway for the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>The IPv4 Network ID value of the subnet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="PrefixLength"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>CIDR [e.g. 24] or IPv4 Address Value [e.g. 255.255.255.0]</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created IPv4 Address Subnet</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:> New-HPOVAddressPoolSubnet -NetworkID 192.168.10.0 -Subnetmask 24 -Gateway 192.168.10.254 -Domain vlan10.domain.com -DNSServers 10.250.33.12,10.250.34.80</dev:code> <dev:remarks> <dev:para>Create a new IPv4 address pool with the specified values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVAPPLIANCECSR--> <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"> <!--NEW-HPOVAPPLIANCECSR--> <command:details> <command:name>New-HPOVApplianceCsr</command:name> <maml:description> <maml:para>Generate appliance CSR</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVApplianceCsr</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will create the CSR for an given appliance, to then be submitted to a CA.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVApplianceCsr</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Country</maml:name> <maml:description> <maml:para>The country code in either Full English or ISO3166-2 two-character format, is a required entry and must contain only two letters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization name is a required entry, can contain up to 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The common name is a required entry, and can be FQDN/hostname or IPv4/IPv6 address. Example: "hpov.example.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>City</maml:name> <maml:description> <maml:para>The city or locality is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The entry for the organizational unit name, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AlternativeName</maml:name> <maml:description> <maml:para>An optional entry containing additional names that apply to the owner of the certificate, possibly including additional e-mail addresses, DNS names, IP addresses and other identifiers. Example: "hpov.example.com,hpov,192.168.1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>The name of the contact person, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Surname</maml:name> <maml:description> <maml:para>The contact person"s family name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>GivenName</maml:name> <maml:description> <maml:para>The contact person"s first name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Initials</maml:name> <maml:description> <maml:para>The contact person"s initials, which may not exceed 20 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DNQualifier</maml:name> <maml:description> <maml:para>The distinguished name qualifier, which further identifies the certificate recipient, which may not exceed 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ChallengePassword</maml:name> <maml:description> <maml:para>The challenge password is a required entry and must contain a minimum of 8 characters. If you wish to be prompted to supply the password, use an asterisk (*) character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>UnstructuredName</maml:name> <maml:description> <maml:para>Defined by the certificate authority, and may contain up to 64 characters. Consult the certificate authority"s administrator or documentation for more information.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CnsaCompliantRequest</maml:name> <maml:description> <maml:para>Specify to create a CNSA compliant certificate request. By default the certificate request will create a 2048bit key length, while CNSA compliant will create a 3072bit key length.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="SAN"> <maml:name>AlternativeName</maml:name> <maml:description> <maml:para>An optional entry containing additional names that apply to the owner of the certificate, possibly including additional e-mail addresses, DNS names, IP addresses and other identifiers. Example: "hpov.example.com,hpov,192.168.1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ChallengePassword</maml:name> <maml:description> <maml:para>The challenge password is a required entry and must contain a minimum of 8 characters. If you wish to be prompted to supply the password, use an asterisk (*) character.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="L, Locality"> <maml:name>City</maml:name> <maml:description> <maml:para>The city or locality is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>CnsaCompliantRequest</maml:name> <maml:description> <maml:para>Specify to create a CNSA compliant certificate request. By default the certificate request will create a 2048bit key length, while CNSA compliant will create a 3072bit key length.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="CN"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The common name is a required entry, and can be FQDN/hostname or IPv4/IPv6 address. Example: "hpov.example.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Contact"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>The name of the contact person, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="C"> <maml:name>Country</maml:name> <maml:description> <maml:para>The country code in either Full English or ISO3166-2 two-character format, is a required entry and must contain only two letters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DNQualifier</maml:name> <maml:description> <maml:para>The distinguished name qualifier, which further identifies the certificate recipient, which may not exceed 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Giv"> <maml:name>GivenName</maml:name> <maml:description> <maml:para>The contact person"s first name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Initials</maml:name> <maml:description> <maml:para>The contact person"s initials, which may not exceed 20 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="O"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization name is a required entry, can contain up to 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="OU"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The entry for the organizational unit name, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="ST, Province"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Sur"> <maml:name>Surname</maml:name> <maml:description> <maml:para>The contact person"s family name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="UN"> <maml:name>UnstructuredName</maml:name> <maml:description> <maml:para>Defined by the certificate authority, and may contain up to 64 characters. Consult the certificate authority"s administrator or documentation for more information.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object that contains the base64data property, which can then be written to a file or submitted to CA</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>$CSR = @{ >> Country = "US"; >> State = "California"; >> City = "Palo Alto"; >> Organization = "Hewlett-Packard"; >> CommonName = "hpov.example.com"; >> AlternativeName = "hpov.example.com,192.168.1.1,hpov" >> } >> $request = New-HPOVApplianceCsr @CSR -ApplianceConnection Appliance.domain.com Set-Content -path C:\dir\hpov.csr -value $request.base64Data -Force</dev:code> <dev:remarks> <dev:para>Create a CSR request to submit to CA.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVAPPLIANCEDATAATRESTENCRYPTIONKEY--> <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"> <!--NEW-HPOVAPPLIANCEDATAATRESTENCRYPTIONKEY--> <command:details> <command:name>New-HPOVApplianceDataAtRestEncryptionKey</command:name> <maml:description> <maml:para>Generate a new HPE Synergy Composer appliance encryption key.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVApplianceDataAtRestEncryptionKey</command:noun> </command:details> <maml:description> <maml:para>HPE OneView encrypts sensitive data, such as managed device credentials, when it is stored on-disk in the appliance. The HPE OneView appliance encryption key (AEK) is used internally to encrypt the credentials for managed devices (such as, iLO, onboard administrator, frame link module). By default, the AEK is stored on the HPE Synergy Composer disk and also included in the appliance backup. This could pose a security risk in case the disk is stolen. The secure data-at-rest option, when enabled, stores the AEK off-disk in Composer NVRAM, and does not include the key in the appliance backup. Enabling this option requires the administrator to save a copy of the AEK (recovery AEK) for use in the following circumstances: * When restoring a backup taken when a different AEK was in effect. * To successfully boot the system in the unlikely event that the system copy of the key is corrupted. * A backup is being restored to a different new Composer or to the same Composer that has been factory reset. The administrator must store the recovery AEK in a secure location, where it can be only accessed by authorized personnel. In the rare circumstance where the key cannot be read from the Composer NVRAM or the key gets corrupted, the administrator must use the appliance maintenance console to upload the AEK recovery copy, based on the error resolution message displayed. In the rare circumstance where the Composer NVRAM itself becomes inaccessible, users can choose to disable secure-data-at-rest option until the hardware issue itself is resolved. If the downloaded recovery key and the AEK stored in the Composer NVRAM are both lost, the appliance data cannot be recovered. This Cmdlet will generate a new encryption key, if the existing encryption key is lost or unknown. Any existing backups that were created with the prior encryption key will become invalid. After creating a new encryption key, it is highly recommended to create a new backup using New-HPOVBackup and save it, along with the new encryption key file that can be generated by this Cmdlet by using the -Location parameter, to a secure and safe location. This Cmdlet can only be used when data at rest encryption has been enabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVApplianceDataAtRestEncryptionKey</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the location where to save the generated encryption key file to.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the location where to save the generated encryption key file to.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The newly created file if the -Location paramter is provided.</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>New-HPOVApplianceDataAtRestEncryptionKey</dev:code> <dev:remarks> <dev:para>Generate a new appliance encryption key, using the current working directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVApplianceDataAtRestEncryptionKey -Location \Fileserver.corp.domain\Share\ApplianceKeys</dev:code> <dev:remarks> <dev:para>Generate a new appliance encryption key, save the created file to a specific location.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Save-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVAPPLIANCESELFSIGNEDCERTIFICATE--> <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"> <!--NEW-HPOVAPPLIANCESELFSIGNEDCERTIFICATE--> <command:details> <command:name>New-HPOVApplianceSelfSignedCertificate</command:name> <maml:description> <maml:para>Create a new appliance self signed Certificate.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVApplianceSelfSignedCertificate</command:noun> </command:details> <maml:description> <maml:para>Use thid Cmdlet to create or recreate a self signed Certificate for the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVApplianceSelfSignedCertificate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Country</maml:name> <maml:description> <maml:para>The country code in either Full English or ISO3166-2 two-character format, is a required entry and must contain only two letters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization name is a required entry, can contain up to 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The common name is a required entry, and can be FQDN/hostname or IPv4/IPv6 address. Example: "hpov.example.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>City</maml:name> <maml:description> <maml:para>The city or locality is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The entry for the organizational unit name, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AlternativeName</maml:name> <maml:description> <maml:para>An optional entry containing additional names that apply to the owner of the certificate, possibly including additional e-mail addresses, DNS names, IP addresses and other identifiers. Example: "hpov.example.com,hpov,192.168.1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>The name of the contact person, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Surname</maml:name> <maml:description> <maml:para>The contact person"s family name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>GivenName</maml:name> <maml:description> <maml:para>The contact person"s first name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Initials</maml:name> <maml:description> <maml:para>The contact person"s initials, which may not exceed 20 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DNQualifier</maml:name> <maml:description> <maml:para>The distinguished name qualifier, which further identifies the certificate recipient, which may not exceed 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="SAN"> <maml:name>AlternativeName</maml:name> <maml:description> <maml:para>An optional entry containing additional names that apply to the owner of the certificate, possibly including additional e-mail addresses, DNS names, IP addresses and other identifiers. Example: "hpov.example.com,hpov,192.168.1.1"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="L, Locality"> <maml:name>City</maml:name> <maml:description> <maml:para>The city or locality is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="CN"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The common name is a required entry, and can be FQDN/hostname or IPv4/IPv6 address. Example: "hpov.example.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Contact"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>The name of the contact person, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="C"> <maml:name>Country</maml:name> <maml:description> <maml:para>The country code in either Full English or ISO3166-2 two-character format, is a required entry and must contain only two letters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DNQualifier</maml:name> <maml:description> <maml:para>The distinguished name qualifier, which further identifies the certificate recipient, which may not exceed 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contact person"s email address, which may not exceed 128 characters and is of the format name@domain.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Giv"> <maml:name>GivenName</maml:name> <maml:description> <maml:para>The contact person"s first name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Initials</maml:name> <maml:description> <maml:para>The contact person"s initials, which may not exceed 20 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="O"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization name is a required entry, can contain up to 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="OU"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The entry for the organizational unit name, may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="ST, Province"> <maml:name>State</maml:name> <maml:description> <maml:para>The state or province is a required entry, can contain up to 128 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Sur"> <maml:name>Surname</maml:name> <maml:description> <maml:para>The contact person"s family name, which may not exceed 64 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object that contains the "base64data" property of the certificate</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>$CSR = @{ >> Country = "US"; >> State = "California"; >> City = "Palo Alto"; >> Organization = "Hewlett-Packard"; >> CommonName = "hpov.example.com"; >> AlternativeName = "hpov.example.com,192.168.1.1,hpov" >> } >> New-HPOVApplianceSelfSignedCertificate @CSR -ApplianceConnection Appliance.domain.com</dev:code> <dev:remarks> <dev:para>Generate self signed Certificate for the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVAPPLIANCETRAPDESTINATION--> <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"> <!--NEW-HPOVAPPLIANCETRAPDESTINATION--> <command:details> <command:name>New-HPOVApplianceTrapDestination</command:name> <maml:description> <maml:para>Create a new appliance SNMP trap destiation.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVApplianceTrapDestination</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers and enclosures (OA) to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Appliance SNMP settings allow you to add destinations to which the traps need to be forwarded. You can configure each destination as an SNMPv1 or SNMPv3 destination, depending on whether the traps are sent in SNMPv1 or SNMPv3 formats. Additionally, if you have Gen6 or Gen7 servers being monitored by HPE OneView in your environment, you can configure the read community string that HPE OneView uses for monitoring these servers with SNMPv1. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVApplianceTrapDestination</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Destination</maml:name> <maml:description> <maml:para>IP Address or Hostname of the target SNMP trap reciever.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CommunityString</maml:name> <maml:description> <maml:para>SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specify the alternate SNMP destination port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>SNMP version type. Allowed values: * SNMPv1 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVApplianceTrapDestination</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Destination</maml:name> <maml:description> <maml:para>IP Address or Hostname of the target SNMP trap reciever.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>The defined SNMPv3 user created on the appliance with Get-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specify the alternate SNMP destination port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>SNMP version type. Allowed values: * SNMPv1 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>CommunityString</maml:name> <maml:description> <maml:para>SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>Destination</maml:name> <maml:description> <maml:para>IP Address or Hostname of the target SNMP trap reciever.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specify the alternate SNMP destination port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3" aliases="None"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>The defined SNMPv3 user created on the appliance with Get-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>SNMP version type. Allowed values: * SNMPv1 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>SNMPv1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV1TrapDestination</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured SNMPv1 Trap Destination on the appliance.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3TrapDestination</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The configured SNMPv3 Trap Destination on the appliance.</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>New-HPOVApplianceTrapDestination -Destination $SnmpV1TrapDestinationAddress -Type SNMPv1 -Port $SnmpV1TrapDestinationPort -CommunityString $SnmpV1Community</dev:code> <dev:remarks> <dev:para>Create a new SNMPv1 trap destination on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SnmpV3Password = ConvertTo-SecureString -String $CommonPassword -AsPlainText -Force $Snmpv3User = New-HPOVSnmpV3User -ApplianceSnmpUser -Username Tr@pUser -SecurityLevel AuthAndPriv -AuthProtocol SHA512 -AuthPassword $SnmpV3Password -PrivProtocol AES192 -PrivPassword $SnmpV3Password New-HPOVApplianceTrapDestination -Type SnmpV3 -SnmpV3User $CreatedSnmpSnmpv3UserV3User -Destination monitor1.contoso.com</dev:code> <dev:remarks> <dev:para>Define a new SNMPv3 user, and associate it with the new SNMPv3 trap destination on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVBACKUP--> <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"> <!--NEW-HPOVBACKUP--> <command:details> <command:name>New-HPOVBackup</command:name> <maml:description> <maml:para>Generate and download or remote save appliance backup.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVBackup</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure. The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file. Use this Cmdlet to generate and download an appliance configuration backup file for backup purposes. The backup file does not contain user account passwords. The backup file is not meant to restore to other appliance for quick provisioning, as it is an encrypted TAR GZIP file. If an automatic backup policy is configured on the appliance, the Cmdlet is instruct the appliance to offload the newly created backup to the remote location. If you wish to download the backup, use the -Location and -Force parameters, which will initiate a download to the value provided.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVBackup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the directory does not exist, it will be created. By default will use current directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>The Cmdlet will validate if the appliance is configured to save backup files to a remote location. Use this option to force download the backup file instead of copying to the remote location.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>The Cmdlet will validate if the appliance is configured to save backup files to a remote location. Use this option to force download the backup file instead of copying to the remote location.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the directory does not exist, it will be created. By default will use current directory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>(get-location).Path</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task to create the backup file.</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>New-HPOVBackup</dev:code> <dev:remarks> <dev:para>This command will generate a new backup, and if a remote location is configured, will initiate the file transfer. If not configured, then the Cmdlet will download the file to the current working directory.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVBackup -Location C:\Temp -Force</dev:code> <dev:remarks> <dev:para>This command will save the Appliance backup file to C:\Temp</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRestore</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVCLUSTERPROFILE--> <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"> <!--NEW-HPOVCLUSTERPROFILE--> <command:details> <command:name>New-HPOVClusterProfile</command:name> <maml:description> <maml:para>Create a new cluster profile resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVClusterProfile</command:noun> </command:details> <maml:description> <maml:para>A cluster profile enables you to deploy and manage a cluster of servers (nodes) managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to members in the cluster. The associated server profiles define physical server configurations for server nodes in the cluster, which are derived from parent cluster profile and its associated server profile template. NOTE: The server profile template must have a configured connection to the hypervisor management network for the template to be valid for use by a hypervisor cluster profile. The cluster profile helps you manage life cycle operations, such as growing or shrinking the cluster, modifying configurations based on needs, consistency checks, and nondisruptive firmware updates on the member nodes. For example, you can grow or shrink a cluster by adding or removing members from the cluster profile. Any change in the configuration of the cluster profile will be reported as an inconsistency. When inconsistencies are remediated, the changed configurations can be applied on cluster and member nodes. A cluster profile can manage VMware ESXi-based hypervisor clusters by leveraging VMware vCenter server. A hypervisor cluster must be managed by one instance of HPE OneView to avoid inconsistencies. Use this Cmdlet to create a new cluster profile within OneView. Any new created clusters within OneView cannot be removed from OneView withour destroying the cluster within the cluster manager. Minimum required privileges: Infrastructure administrator, Server administrator, Server profile architect, or Server profile administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVClusterProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the cluster profile name. If -Prefix is omitted, this value will become the cluster node prefix value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManager</maml:name> <maml:description> <maml:para>Specify the cluster manager that will manage the cluster and associated members, from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Cluster.ClusterManager</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManagerLocation</maml:name> <maml:description> <maml:para>Specify the location where the cluster will be created within the cluster manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template from Get-HPOVServerProfileTemplate that the cluster configuration will be derived from and follow cluster consistency with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPassword</maml:name> <maml:description> <maml:para>Specify the cluster administrator/root account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description of the cluster.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPrefix</maml:name> <maml:description> <maml:para>Specify the cluster member hostname prefix that will be used. A unique numerical value will be appended to the end. If omitted, the clsuter name will be used as the prefix.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Servers</maml:name> <maml:description> <maml:para>One or more server resource objects from New-HPOVClusterProfileMember. Value can be empty to create an empty cluster, if the target cluster manager supports that type of configuration, like VMware vSphere.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Cluster.AddHostRequest[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>UseIPAddressAsHostName</maml:name> <maml:description> <maml:para>Use to indicate if the IP Address allocated or assigned should be used for the cluster manager registration instead of the hostname or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>LeaveHostsInMaintenanceMode</maml:name> <maml:description> <maml:para>Specify if the host should be left in maintenance mode (if applicable) before servicing the cluster.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>One or more storage volumes to assign.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>StorageVolumeFileSystem</maml:name> <maml:description> <maml:para>Specify if the storage volume(s) in the StorageVolume parameter should be formatted with a specific filesystem. Allowed values: * VMFS * Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVClusterProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the cluster profile name. If -Prefix is omitted, this value will become the cluster node prefix value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManager</maml:name> <maml:description> <maml:para>Specify the cluster manager that will manage the cluster and associated members, from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Cluster.ClusterManager</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManagerLocation</maml:name> <maml:description> <maml:para>Specify the location where the cluster will be created within the cluster manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template from Get-HPOVServerProfileTemplate that the cluster configuration will be derived from and follow cluster consistency with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPassword</maml:name> <maml:description> <maml:para>Specify the cluster administrator/root account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch"> <maml:name>UnmanageVSwitch</maml:name> <maml:description> <maml:para>Use to configure the cluster profile to not manage host networking.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description of the cluster.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPrefix</maml:name> <maml:description> <maml:para>Specify the cluster member hostname prefix that will be used. A unique numerical value will be appended to the end. If omitted, the clsuter name will be used as the prefix.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Servers</maml:name> <maml:description> <maml:para>One or more server resource objects from New-HPOVClusterProfileMember. Value can be empty to create an empty cluster, if the target cluster manager supports that type of configuration, like VMware vSphere.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Cluster.AddHostRequest[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>HAEnabled</maml:name> <maml:description> <maml:para>Specify if VMware HA (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>DRSEnabled</maml:name> <maml:description> <maml:para>Specify if DRS (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>MultiNicVMotionEnabled</maml:name> <maml:description> <maml:para>Specify if multi-NIC VMotion (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVClusterProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the cluster profile name. If -Prefix is omitted, this value will become the cluster node prefix value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManager</maml:name> <maml:description> <maml:para>Specify the cluster manager that will manage the cluster and associated members, from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Cluster.ClusterManager</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterManagerLocation</maml:name> <maml:description> <maml:para>Specify the location where the cluster will be created within the cluster manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template from Get-HPOVServerProfileTemplate that the cluster configuration will be derived from and follow cluster consistency with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPassword</maml:name> <maml:description> <maml:para>Specify the cluster administrator/root account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description of the cluster.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ClusterPrefix</maml:name> <maml:description> <maml:para>Specify the cluster member hostname prefix that will be used. A unique numerical value will be appended to the end. If omitted, the clsuter name will be used as the prefix.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Servers</maml:name> <maml:description> <maml:para>One or more server resource objects from New-HPOVClusterProfileMember. Value can be empty to create an empty cluster, if the target cluster manager supports that type of configuration, like VMware vSphere.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Cluster.AddHostRequest[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>OverrideManagementAddressAssignmet</maml:name> <maml:description> <maml:para>Use to indicate address assignment. If the server profile template boot connections are set to require static addresses, the IPAddress value must be used in the New-HPOVClusterProfileMember Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the subnet mask if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the gateway if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the primary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the secondary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>TertiaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the tertiary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the domain name if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>UseIPAddressAsHostName</maml:name> <maml:description> <maml:para>Use to indicate if the IP Address allocated or assigned should be used for the cluster manager registration instead of the hostname or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>LeaveHostsInMaintenanceMode</maml:name> <maml:description> <maml:para>Specify if the host should be left in maintenance mode (if applicable) before servicing the cluster.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>One or more storage volumes to assign.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default"> <maml:name>StorageVolumeFileSystem</maml:name> <maml:description> <maml:para>Specify if the storage volume(s) in the StorageVolume parameter should be formatted with a specific filesystem. Allowed values: * VMFS * Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>OverrideNetworkingConfig</maml:name> <maml:description> <maml:para>Use to indicate if network naming will be overridden.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>ConfigurePortGroups</maml:name> <maml:description> <maml:para>Specify if port groups should also be configured when configuring host networking.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>VSwitchNameOverride</maml:name> <maml:description> <maml:para>Use to specify what the vSwitch name override should be. By default, vSwitch names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format: @{ "NetworkName" = "OverrideName" } Where "NetworkName" is the name of the Ethernet Network assigned to the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>PortGroupNameOverride</maml:name> <maml:description> <maml:para>Use to specify what the PortGroup name override should be. By default, PortGroup names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format: @{ "NetworkName" = "OverrideName" } Where "NetworkName" is the name of the Ethernet Network assigned to the connection.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>OverrideClusterManagerConfig</maml:name> <maml:description> <maml:para>Use to indicate the desire to override the cluster manager default settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>VirtualSwitchType</maml:name> <maml:description> <maml:para>Use to indicate which vSiwtch type to configure when overriding cluster manager networking settings. Allowed values are: * Standard * Distributed</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>DistributedSwitchUsage</maml:name> <maml:description> <maml:para>If overriding the distributed virtual switch configuring set by the cluster manager, specify the switch usage. Allowed values: * Standard * Distributed</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings"> <maml:name>DistributedSwitchVersion</maml:name> <maml:description> <maml:para>If overriding the distributed virtual switch configuring set by the cluster manager, specify the version. To identify the supported versions, look at the AvailableDvsVersions property of the returned cluster manager from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>HAEnabled</maml:name> <maml:description> <maml:para>Specify if VMware HA (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>DRSEnabled</maml:name> <maml:description> <maml:para>Specify if DRS (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings"> <maml:name>MultiNicVMotionEnabled</maml:name> <maml:description> <maml:para>Specify if multi-NIC VMotion (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>ClusterManager</maml:name> <maml:description> <maml:para>Specify the cluster manager that will manage the cluster and associated members, from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Cluster.ClusterManager</command:parameterValue> <dev:type> <maml:name>HPOneView.Cluster.ClusterManager</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>ClusterManagerLocation</maml:name> <maml:description> <maml:para>Specify the location where the cluster will be created within the cluster manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>ClusterPassword</maml:name> <maml:description> <maml:para>Specify the cluster administrator/root account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>ClusterPrefix</maml:name> <maml:description> <maml:para>Specify the cluster member hostname prefix that will be used. A unique numerical value will be appended to the end. If omitted, the clsuter name will be used as the prefix.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>ConfigurePortGroups</maml:name> <maml:description> <maml:para>Specify if port groups should also be configured when configuring host networking.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings" aliases="None"> <maml:name>DRSEnabled</maml:name> <maml:description> <maml:para>Specify if DRS (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description of the cluster.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>DistributedSwitchUsage</maml:name> <maml:description> <maml:para>If overriding the distributed virtual switch configuring set by the cluster manager, specify the switch usage. Allowed values: * Standard * Distributed</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>DistributedSwitchVersion</maml:name> <maml:description> <maml:para>If overriding the distributed virtual switch configuring set by the cluster manager, specify the version. To identify the supported versions, look at the AvailableDvsVersions property of the returned cluster manager from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the domain name if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the gateway if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings" aliases="None"> <maml:name>HAEnabled</maml:name> <maml:description> <maml:para>Specify if VMware HA (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default" aliases="None"> <maml:name>LeaveHostsInMaintenanceMode</maml:name> <maml:description> <maml:para>Specify if the host should be left in maintenance mode (if applicable) before servicing the cluster.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings" aliases="None"> <maml:name>MultiNicVMotionEnabled</maml:name> <maml:description> <maml:para>Specify if multi-NIC VMotion (if supported) should be enabled ($True) or disabled ($false).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide the cluster profile name. If -Prefix is omitted, this value will become the cluster node prefix value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>OverrideClusterManagerConfig</maml:name> <maml:description> <maml:para>Use to indicate the desire to override the cluster manager default settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>OverrideManagementAddressAssignmet</maml:name> <maml:description> <maml:para>Use to indicate address assignment. If the server profile template boot connections are set to require static addresses, the IPAddress value must be used in the New-HPOVClusterProfileMember Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>OverrideNetworkingConfig</maml:name> <maml:description> <maml:para>Use to indicate if network naming will be overridden.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>PortGroupNameOverride</maml:name> <maml:description> <maml:para>Use to specify what the PortGroup name override should be. By default, PortGroup names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format: @{ "NetworkName" = "OverrideName" } Where "NetworkName" is the name of the Ethernet Network assigned to the connection.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>PrimaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the primary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>SecondaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the secondary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template from Get-HPOVServerProfileTemplate that the cluster configuration will be derived from and follow cluster consistency with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch, OverrideSettings, Default" aliases="None"> <maml:name>Servers</maml:name> <maml:description> <maml:para>One or more server resource objects from New-HPOVClusterProfileMember. Value can be empty to create an empty cluster, if the target cluster manager supports that type of configuration, like VMware vSphere.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Cluster.AddHostRequest[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Cluster.AddHostRequest[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default" aliases="None"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>One or more storage volumes to assign.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default" aliases="None"> <maml:name>StorageVolumeFileSystem</maml:name> <maml:description> <maml:para>Specify if the storage volume(s) in the StorageVolume parameter should be formatted with a specific filesystem. Allowed values: * VMFS * Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Unmanaged</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the subnet mask if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>TertiaryDNS</maml:name> <maml:description> <maml:para>Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the tertiary DNS if the management network is not configured to use an IP address pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="UnmanageVSwitch" aliases="None"> <maml:name>UnmanageVSwitch</maml:name> <maml:description> <maml:para>Use to configure the cluster profile to not manage host networking.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings, Default" aliases="None"> <maml:name>UseIPAddressAsHostName</maml:name> <maml:description> <maml:para>Use to indicate if the IP Address allocated or assigned should be used for the cluster manager registration instead of the hostname or FQDN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>VSwitchNameOverride</maml:name> <maml:description> <maml:para>Use to specify what the vSwitch name override should be. By default, vSwitch names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format: @{ "NetworkName" = "OverrideName" } Where "NetworkName" is the name of the Ethernet Network assigned to the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="OverrideSettings" aliases="None"> <maml:name>VirtualSwitchType</maml:name> <maml:description> <maml:para>Use to indicate which vSiwtch type to configure when overriding cluster manager networking settings. Allowed values are: * Standard * Distributed</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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># Get the specific Cluster Manager $ClusterManager = Get-HPOVHypervisorManager -Name ClusterManager1 # Display the allowed locations to place the cluster $ClusterManager.Locations DC1 DC2 DC3 DC3\Folder1 $ClusterPassword = Read-Host -Prompt "Cluster password" -AsSecureString # Get the server profile template the cluster will be created and derived from $ServerProfileTemplate = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Prod" # Get a list of servers based on the SPT, that are available to deploy to $Servers = Get-HPOVServer -NoProfile -InputObject $ServerProfileTemplate -Count 4 # Create the new cluster profile New-HPOVClusterProfile -Name ProdCluster1 -ClusterPrefix ProdClusterNode- -ClusterManager $ClusterManager -ClusterManagerLocation "DC2" -ServerProfileTemplate $ServerProfileTemplate -ClusterPassword $ClusterPassword -Servers $Servers</dev:code> <dev:remarks> <dev:para>Create a new cluster profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Get the specific Cluster Manager $ClusterManager = Get-HPOVHypervisorManager -Name ClusterManager1 # Display the allowed distributed switch versions supported by the cluster manager $ClusterManager.AvailableDvsVersions 4.0 4.10 5.0.0 5.1.0 5.5.0 6.0 6.7 $ClusterPassword = Read-Host -Prompt "Cluster password" -AsSecureString # Get the server profile template the cluster will be created and derived from $ServerProfileTemplate = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Prod" # Get a list of servers based on the SPT, that are available to deploy to $Servers = Get-HPOVServer -NoProfile -InputObject $ServerProfileTemplate -Count 4 # Create new cluster profile overriding the cluster manager settings New-HPOVClusterProfile -Name ProdCluster1 -ClusterPrefix ProdClusterNode- -ClusterManager $ClusterManager -ClusterManagerLocation "DC2" -ServerProfileTemplate $ServerProfileTemplate -ClusterPassword $ClusterPassword -Servers $Servers -OverrideClusterManagerConfig -VirtualSwitchType Distributed -DistributedSwitchUsage AllNetworks -DistributedSwitchVersion 6.0 -HAEnabled $true -DRSEnabled $false </dev:code> <dev:remarks> <dev:para>Create a new cluster profile, overriding clsuter manager settings.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfileMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVCLUSTERPROFILEMEMBER--> <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"> <!--NEW-HPOVCLUSTERPROFILEMEMBER--> <command:details> <command:name>New-HPOVClusterProfileMember</command:name> <maml:description> <maml:para>Helper Cmdlet to create proper add host request for New-HPOVClusterProfile.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVClusterProfileMember</command:noun> </command:details> <maml:description> <maml:para>This is a helper Cmdlet to create a valid resourc object New-HPOVClusterProfile will then use for the -Servers parameter. Minimum required privileges: Infrastructure administrator, Server administrator, Server profile architect, or Server profile administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVClusterProfileMember</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A server hardware resource</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>A valid IPv4 Address for the hypervisor host management interface.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAaddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. Only applicable for HPE Synergy Image Streamer deployment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">OSDeploymentParameter[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>A valid IPv4 Address for the hypervisor host management interface.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAaddress</command:parameterValue> <dev:type> <maml:name>IPAaddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A server hardware resource</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. Only applicable for HPE Synergy Image Streamer deployment.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">OSDeploymentParameter[]</command:parameterValue> <dev:type> <maml:name>OSDeploymentParameter[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>An available server hardware resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Cluster.AddHostRequest</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Properly formatted object for New-HPOVClusterProfile.</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>$Server = Get-HPOVServer -Name "Encl1, Bay 1" New-HPOVClusterProfileMember -InputObject $Server</dev:code> <dev:remarks> <dev:para>Create a basic add host object for New-HPOVClusterProfile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Server = Get-HPOVServer -Name "Encl1, Bay 1" New-HPOVClusterProfileMember -InputObject $Server -IPAddress 192.168.10.1</dev:code> <dev:remarks> <dev:para>Create anadd host object for New-HPOVClusterProfile and specify its managmenet IP Address if the associated Server Profile Template management network is not associated with an IP address pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MyDeploymentPlan = Get-HPOVOSDeploymentPlan -Name "vSphere 6.5 U3 Corp Standard" -ErrorAction Stop $OSDeploymentAttributes = Get-HPOVOSDeploymentPlanAttributes -InputObject $MyDeploymentPlan ($OSDeploymentAttributes | Where-Object name -eq "CustomAttribute1").value = "MySpecialValue" $Server = Get-HPOVServer -Name "Encl1, Bay 1" New-HPOVClusterProfileMember -InputObject $Server -IPAddress 192.168.10.1 -OSDeploymentParameter $OSDeploymentAttributes</dev:code> <dev:remarks> <dev:para>Create a basic add host object for New-HPOVClusterProfile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVCUSTOMBASELINE--> <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"> <!--NEW-HPOVCUSTOMBASELINE--> <command:details> <command:name>New-HPOVCustomBaseline</command:name> <maml:description> <maml:para>Create Custom Baseline from Hotfixes and Source Baseline.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVCustomBaseline</command:noun> </command:details> <maml:description> <maml:para>HPE ProLiant Hotfixes are released out of the main SPP release cycle. Administrators can use HPSUM external to HPE OneView to create a custom baseline, but then need to upload to the appliance. Hotfixes can be directly uploaded to an HPE OneView 2.0 Appliance, with the ability to create a Custom Baseline by using a source Baseline (which must exist in the Baseline Repository) and specified Hotfix(s).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVCustomBaseline</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>SourceBaseline</maml:name> <maml:description> <maml:para>An existing Baseline within the HPE OneView Baseline Repository.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Hotfixes</maml:name> <maml:description> <maml:para>Array of Hotfix filenames, or Component name. Example: @(cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>BaselineName</maml:name> <maml:description> <maml:para>The final custom Baseline name. Example: custom_SPPGen9Snap3_2015_0327_82</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="4" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>BaselineName</maml:name> <maml:description> <maml:para>The final custom Baseline name. Example: custom_SPPGen9Snap3_2015_0327_82</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Hotfixes</maml:name> <maml:description> <maml:para>Array of Hotfix filenames, or Component name. Example: @(cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="None"> <maml:name>SourceBaseline</maml:name> <maml:description> <maml:para>An existing Baseline within the HPE OneView Baseline Repository.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Baseline [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Source HPE OneView Baseline from Get-HPOVBaseline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task object to monitor.</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>cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe | % { Add-HPOVBaseline $_ } Get-HPOVBaseline -BaselineName "MyBaseline" | New-HPOVCustomBaseline -Hotfixes cp111111.exe,cp222222.scexe,cp333333.exe,cp444444.scexe -BaselineName "MyNewBaseline_20160222"</dev:code> <dev:remarks> <dev:para>Upload hotfixes to appliance, then create a new custom baseline from the "MyBaseline" baseline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Restore-HPOVCustomBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVDATACENTER--> <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"> <!--NEW-HPOVDATACENTER--> <command:details> <command:name>New-HPOVDataCenter</command:name> <maml:description> <maml:para>Get a member device from a defined Rack.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVDataCenter</command:noun> </command:details> <maml:description> <maml:para>A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server, enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and cooling management of your servers, enclosures, and power delivery devices together in a single management system. When you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects. This Cmdlet will create a new datacenter. You will need to specify the Name and dimensions. Optionally, you can override the default Electrical Derating, default voltage, local currency (which will aid in power calculation costs) and power cooling capacity. Remote Support settings can only be set when Remote Support has been enabled and configured on the appliance. If omitting Remote Support location settings, then the datacenter will default to the default location set. </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVDataCenter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name to identify the data center. Must not exceed 255 characters; no leading spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If specifying millimeter value for Width and Depth, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ElectricalDerating</maml:name> <maml:description> <maml:para>If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%. Default: 20%</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ElectricalDeratingType</maml:name> <maml:description> <maml:para>The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body temperature, ambient temperature, and type of cooling. You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum power dissipation by specifying None. Default: NA/Jp</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>DefaultVoltage</maml:name> <maml:description> <maml:para>The default power line voltage for the data center. Default: 220</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Currency</maml:name> <maml:description> <maml:para>The currency unit for energy costs.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>PowerCosts</maml:name> <maml:description> <maml:para>The energy cost per kWh, specified by the Currency.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>CoolingCapacity</maml:name> <maml:description> <maml:para>The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>CoolingMultiplier</maml:name> <maml:description> <maml:para>The ratio of cooling cost to power cost for the data center. This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of 1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system. Default: 1.5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVDataCenter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name to identify the data center. Must not exceed 255 characters; no leading spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If specifying millimeter value for Width and Depth, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ElectricalDerating</maml:name> <maml:description> <maml:para>If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%. Default: 20%</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ElectricalDeratingType</maml:name> <maml:description> <maml:para>The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body temperature, ambient temperature, and type of cooling. You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum power dissipation by specifying None. Default: NA/Jp</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>DefaultVoltage</maml:name> <maml:description> <maml:para>The default power line voltage for the data center. Default: 220</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>Currency</maml:name> <maml:description> <maml:para>The currency unit for energy costs.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>PowerCosts</maml:name> <maml:description> <maml:para>The energy cost per kWh, specified by the Currency.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>CoolingCapacity</maml:name> <maml:description> <maml:para>The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>CoolingMultiplier</maml:name> <maml:description> <maml:para>The ratio of cooling cost to power cost for the data center. This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of 1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system. Default: 1.5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance. Must not be the same value as the Primary Contact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>Address1</maml:name> <maml:description> <maml:para>Address of datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>Address2</maml:name> <maml:description> <maml:para>Optional address line.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>City</maml:name> <maml:description> <maml:para>City of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>State</maml:name> <maml:description> <maml:para>State/province of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>PostCode</maml:name> <maml:description> <maml:para>Postal code for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Time Zone of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>Address1</maml:name> <maml:description> <maml:para>Address of datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>Address2</maml:name> <maml:description> <maml:para>Optional address line.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>City</maml:name> <maml:description> <maml:para>City of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>CoolingCapacity</maml:name> <maml:description> <maml:para>The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>CoolingMultiplier</maml:name> <maml:description> <maml:para>The ratio of cooling cost to power cost for the data center. This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of 1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system. Default: 1.5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue>1.5</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>Currency</maml:name> <maml:description> <maml:para>The currency unit for energy costs.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>USD</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>DefaultVoltage</maml:name> <maml:description> <maml:para>The default power line voltage for the data center. Default: 220</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>220</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>ElectricalDerating</maml:name> <maml:description> <maml:para>If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%. Default: 20%</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>ElectricalDeratingType</maml:name> <maml:description> <maml:para>The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body temperature, ambient temperature, and type of cooling. You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum power dissipation by specifying None. Default: NA/Jp</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>NA/Jp</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If specifying millimeter value for Width and Depth, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name to identify the data center. Must not exceed 255 characters; no leading spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>PostCode</maml:name> <maml:description> <maml:para>Postal code for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>PowerCosts</maml:name> <maml:description> <maml:para>The energy cost per kWh, specified by the Currency.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance. Must not be the same value as the Primary Contact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>State</maml:name> <maml:description> <maml:para>State/province of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport" aliases="None"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Time Zone of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoteSupport, Default" aliases="None"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.DataCenter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created datacenter.</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>$DataCenter1Name = "LA DC 12" $DataCenter1Width = 30 $DataCenter1Depth = 30 $DataCenter1Voltage = 220 $DataCenter1PowerCosts = 0.07 $DataCenter1CoolingCapacity = 250 New-HPOVDataCenter -Name $DataCenter1Name -Width $DataCenter1Width -Depth $DataCenter1Depth -DefaultVoltage $DataCenter1Voltage -PowerCosts $DataCenter1PowerCosts -CoolingCapacity $DataCenter1CoolingCapacity</dev:code> <dev:remarks> <dev:para>Create new "LA DC 12" datacenter.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$NewDCParams = @{ Name = "Houston DC1"; Width = 10668; Depth = 13716; Millimeters = $True; DefaultVoltage = 240e; PowerCosts = 0.10; CoolingCapacity = 350; Address1 = "123 Main Place"; Address2 = "Suite 400"; City = "Houston; State = "TX"; Country = "US"; PostCode = "77002"; TimeZone = "US/Central"; PrimaryContact = (Get-HPOVRemoteSupportContact -Name "Joe Ellis" -EA Stop) SecondaryContact = (Get-HPOVRemoteSupportContact -Name "Brandon Pear" -EA Stop) } New-HPOVDataCenter @NewDC2Params</dev:code> <dev:remarks> <dev:para>Create a new datacenter with Remote Support settings.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenterRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVENCLOSUREGROUP--> <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"> <!--NEW-HPOVENCLOSUREGROUP--> <command:details> <command:name>New-HPOVEnclosureGroup</command:name> <maml:description> <maml:para>Create an Enclosure Group.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVEnclosureGroup</command:noun> </command:details> <maml:description> <maml:para>An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. The network connectivity for an enclosure group is defined by the logical interconnect groups associated with the enclosure group. When configuring an HPE Synergy enclosure group, it may contain up to five enclosures. When configuring an HPE BladeSystem C-Class enclosure group, it will only contain a single enclosure. Enclosure groups and logical interconnect groups * A logical interconnect group that is assigned to a bay within an enclosure group must have that bay populated within the logical interconnect group. * All populated bays in a logical interconnect group must be assigned to the enclosure group. For example, a logical interconnect group that has bays 1 and 2 populated must be assigned to bays 1 and 2 of the enclosure group in order for the enclosure group to be created. * An enclosure group can contain logical interconnect groups that are highly available, redundant, A-side only, or A-side and B-side. See About interconnect bay sets. * Synergy multiple-enclosure logical interconnect groups must have the proper bays populated in all enclosures in the interconnect link topology. * Synergy single-enclosure logical interconnect groups, such as a Serial Attached SCSI (SAS) logical interconnect group, can be applied to individual bays in individual enclosures in the interconnect link topology.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new enclosure group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000"> <maml:name>LogicalInterconnectGroupMapping</maml:name> <maml:description> <maml:para>An Enclosure Group can reference multiple Logical Interconnect Groups, once per Interconnect Bay. If a Single Logical Interconnect Group object is provided (either via parameter variable or via Pipeline), the Logical Interconnect Group objects Logical Interconnect Bay configuration will be used. To specify a specific C-Class Logical Interconnect Group(s) for one or more Interconnect Bays, use a Hashtable, with the Bay ID as the Key, and Logical Interconnect Group Name, URI or Object as the Value. Example: $LogicalInterConnectGroupMapping = @{ 1 = "MyLIg1"; 2 = "MyLig1"; 5 = "OtherLIG"; 6 = "OtherLIG"} $MyLig1 = Get-HPOVLogicalInterconnectGroup -Name MyLig1 $OtherLIG = Get-HPOVLogicalInterconnectGroup OtherLIG $LogicalInterConnectGroupMapping = @{ 1 = $MyLig1; 2 = $MyLig1; 5 = $OtherLIG; 6 = $OtherLIG" When attempting to define a Syenrgy-based Enclosure Group, either an Array or Hashtable is allowed. If an Array of Logical Interconnect Groups are provided, the Cmdlet will determine the Interconnect placement automatically. Example: $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $LogicalInterConnectGroupMapping = $MySynergyLig1 #or $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $MySynergyLig2 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig2 $LogicalInterConnectGroupMapping = $MySynergyLig1,$MySynergyLig2 Do know that SAS and VC FC LIGs are bound to a single frame, and will not reference other Frames if FrameCount is greater than 1. Use a Hashtable to bind specific LIGs to specific Frames. The Interconnect placement will be determined automatically based on either the Hashtable Key name "Frame#" (where # is the numerical value of the Frame) or Enclosure Index value (depending if a SAS or Synergy VC FC LIG). Example: $3FrameVCLIG = Get-HPOVLogicalInterconnectGroup -Name "My MultiFrame Synergy LIG 1" $SasLIG = Get-HPOVLogicalInterconnectGroup -Name "My Synergy Sas LIG 1" $LogicalInterconnectGroupMapping = @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG }</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, C7000"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ImportFile, DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, ImportFile, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new enclosure group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure"> <maml:name>DiscoverFromEnclosure</maml:name> <maml:description> <maml:para>Use this parameter for the appliance to create an Enclosure Group and associated Logical Interconnect Group by "discovering" the Enclosure and support interconnects. The target Enclosure must not already be claimed by another external manager (i.e. HPE OneView), as the API will reject the request. No Uplink Sets will be created. They will need to be added using the New-HPOVUplinkSet Cmdlet once the Logical Interconnect Group resource has been created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure"> <maml:name>OAAddress</maml:name> <maml:description> <maml:para>Provide the Onboard Administrator IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide an Onboard Administrator administrator account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide an Onboard Administrator administrator password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, C7000"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure"> <maml:name>LigPrefix</maml:name> <maml:description> <maml:para>If specified, the Logical Interconnect Group that is created will be used in the "{LigPrefix} Logical Interconnect Group".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ImportFile, DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, ImportFile, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new enclosure group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000"> <maml:name>LogicalInterconnectGroupMapping</maml:name> <maml:description> <maml:para>An Enclosure Group can reference multiple Logical Interconnect Groups, once per Interconnect Bay. If a Single Logical Interconnect Group object is provided (either via parameter variable or via Pipeline), the Logical Interconnect Group objects Logical Interconnect Bay configuration will be used. To specify a specific C-Class Logical Interconnect Group(s) for one or more Interconnect Bays, use a Hashtable, with the Bay ID as the Key, and Logical Interconnect Group Name, URI or Object as the Value. Example: $LogicalInterConnectGroupMapping = @{ 1 = "MyLIg1"; 2 = "MyLig1"; 5 = "OtherLIG"; 6 = "OtherLIG"} $MyLig1 = Get-HPOVLogicalInterconnectGroup -Name MyLig1 $OtherLIG = Get-HPOVLogicalInterconnectGroup OtherLIG $LogicalInterConnectGroupMapping = @{ 1 = $MyLig1; 2 = $MyLig1; 5 = $OtherLIG; 6 = $OtherLIG" When attempting to define a Syenrgy-based Enclosure Group, either an Array or Hashtable is allowed. If an Array of Logical Interconnect Groups are provided, the Cmdlet will determine the Interconnect placement automatically. Example: $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $LogicalInterConnectGroupMapping = $MySynergyLig1 #or $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $MySynergyLig2 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig2 $LogicalInterConnectGroupMapping = $MySynergyLig1,$MySynergyLig2 Do know that SAS and VC FC LIGs are bound to a single frame, and will not reference other Frames if FrameCount is greater than 1. Use a Hashtable to bind specific LIGs to specific Frames. The Interconnect placement will be determined automatically based on either the Hashtable Key name "Frame#" (where # is the numerical value of the Frame) or Enclosure Index value (depending if a SAS or Synergy VC FC LIG). Example: $3FrameVCLIG = Get-HPOVLogicalInterconnectGroup -Name "My MultiFrame Synergy LIG 1" $SasLIG = Get-HPOVLogicalInterconnectGroup -Name "My Synergy Sas LIG 1" $LogicalInterconnectGroupMapping = @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG }</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>EnclosureCount</maml:name> <maml:description> <maml:para>Specify the number of Synergy Frames will participate within the Enclosure Group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>IPv4AddressType</maml:name> <maml:description> <maml:para>Use to specify how the IPv4 Addresses will be assigned to Synergy resources management interface(s). Allowed values: * External - The IPv4 address is managed externally, static assignment. * DHCP - The IPv4 address is assigned using DHCP. * AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter, similar to HPE BladeSystem C-Class "Enclosure Bay IP Addressing" (aka EBIPA). Default: DHCP</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>IPv4AddressRange</maml:name> <maml:description> <maml:para>[Alias -AddressPool] The IPv4 address pool object from Get-HPOVAddressPoolRange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>IPv6AddressType</maml:name> <maml:description> <maml:para>Use to specify how the IPv6 Addresses will be assigned to Synergy resources management interface(s). Allowed values: * External - The IPv4 address is managed externally, static assignment. * DHCP - The IPv4 address is assigned using DHCP. * AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter, similar to HPE BladeSystem C-Class "Enclosure Bay IP Addressing" (aka EBIPA). Default: None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>IPv6AddressRange</maml:name> <maml:description> <maml:para>The IPv6 address pool object from Get-HPOVAddressPoolRange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>DeploymentNetworkType</maml:name> <maml:description> <maml:para>Specify the Synergy Image Stream deployment network type. Allowed values: * Internal - Deployment network is an internal, managed by the Frame links, which Logical Intercoonect Group must have an ImageStreamer Uplink Set. * External - Deployment network is connected to an External management switch. * None - No deployment network will be configured. Default: None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>DeploymentNetwork</maml:name> <maml:description> <maml:para>The Ethernet Network with the purpose property set to Management. Must also include DeploymentNetworkType parameter, value must be "External", with the Ethernet Network associated with a non-ImageStreamer Uplink Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ImportFile, DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, ImportFile, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ImportFile"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Provide the full path and file name of the JSON file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ImportFile, DiscoverFromEnclosure, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, ImportFile, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, ImportFile, C7000" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, C7000" aliases="None"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>DeploymentNetwork</maml:name> <maml:description> <maml:para>The Ethernet Network with the purpose property set to Management. Must also include DeploymentNetworkType parameter, value must be "External", with the Ethernet Network associated with a non-ImageStreamer Uplink Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>DeploymentNetworkType</maml:name> <maml:description> <maml:para>Specify the Synergy Image Stream deployment network type. Allowed values: * Internal - Deployment network is an internal, managed by the Frame links, which Logical Intercoonect Group must have an ImageStreamer Uplink Set. * External - Deployment network is connected to an External management switch. * None - No deployment network will be configured. Default: None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure" aliases="None"> <maml:name>DiscoverFromEnclosure</maml:name> <maml:description> <maml:para>Use this parameter for the appliance to create an Enclosure Group and associated Logical Interconnect Group by "discovering" the Enclosure and support interconnects. The target Enclosure must not already be claimed by another external manager (i.e. HPE OneView), as the API will reject the request. No Uplink Sets will be created. They will need to be added using the New-HPOVUplinkSet Cmdlet once the Logical Interconnect Group resource has been created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>EnclosureCount</maml:name> <maml:description> <maml:para>Specify the number of Synergy Frames will participate within the Enclosure Group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="AddressPool"> <maml:name>IPv4AddressRange</maml:name> <maml:description> <maml:para>[Alias -AddressPool] The IPv4 address pool object from Get-HPOVAddressPoolRange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>IPv4AddressType</maml:name> <maml:description> <maml:para>Use to specify how the IPv4 Addresses will be assigned to Synergy resources management interface(s). Allowed values: * External - The IPv4 address is managed externally, static assignment. * DHCP - The IPv4 address is assigned using DHCP. * AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter, similar to HPE BladeSystem C-Class "Enclosure Bay IP Addressing" (aka EBIPA). Default: DHCP</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>DHCP</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>IPv6AddressRange</maml:name> <maml:description> <maml:para>The IPv6 address pool object from Get-HPOVAddressPoolRange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>IPv6AddressType</maml:name> <maml:description> <maml:para>Use to specify how the IPv6 Addresses will be assigned to Synergy resources management interface(s). Allowed values: * External - The IPv4 address is managed externally, static assignment. * DHCP - The IPv4 address is assigned using DHCP. * AddressPool - The IPv4 address is assigned from a pool of IP addresses specified by the AddressPool parameter, similar to HPE BladeSystem C-Class "Enclosure Bay IP Addressing" (aka EBIPA). Default: None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ImportFile" aliases="i, import"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Provide the full path and file name of the JSON file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure" aliases="None"> <maml:name>LigPrefix</maml:name> <maml:description> <maml:para>If specified, the Logical Interconnect Group that is created will be used in the "{LigPrefix} Logical Interconnect Group".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000" aliases="logicalInterconnectGroupUri, logicalInterconnectGroup"> <maml:name>LogicalInterconnectGroupMapping</maml:name> <maml:description> <maml:para>An Enclosure Group can reference multiple Logical Interconnect Groups, once per Interconnect Bay. If a Single Logical Interconnect Group object is provided (either via parameter variable or via Pipeline), the Logical Interconnect Group objects Logical Interconnect Bay configuration will be used. To specify a specific C-Class Logical Interconnect Group(s) for one or more Interconnect Bays, use a Hashtable, with the Bay ID as the Key, and Logical Interconnect Group Name, URI or Object as the Value. Example: $LogicalInterConnectGroupMapping = @{ 1 = "MyLIg1"; 2 = "MyLig1"; 5 = "OtherLIG"; 6 = "OtherLIG"} $MyLig1 = Get-HPOVLogicalInterconnectGroup -Name MyLig1 $OtherLIG = Get-HPOVLogicalInterconnectGroup OtherLIG $LogicalInterConnectGroupMapping = @{ 1 = $MyLig1; 2 = $MyLig1; 5 = $OtherLIG; 6 = $OtherLIG" When attempting to define a Syenrgy-based Enclosure Group, either an Array or Hashtable is allowed. If an Array of Logical Interconnect Groups are provided, the Cmdlet will determine the Interconnect placement automatically. Example: $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $LogicalInterConnectGroupMapping = $MySynergyLig1 #or $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 $MySynergyLig2 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig2 $LogicalInterConnectGroupMapping = $MySynergyLig1,$MySynergyLig2 Do know that SAS and VC FC LIGs are bound to a single frame, and will not reference other Frames if FrameCount is greater than 1. Use a Hashtable to bind specific LIGs to specific Frames. The Interconnect placement will be determined automatically based on either the Hashtable Key name "Frame#" (where # is the numerical value of the Frame) or Enclosure Index value (depending if a SAS or Synergy VC FC LIG). Example: $3FrameVCLIG = Get-HPOVLogicalInterconnectGroup -Name "My MultiFrame Synergy LIG 1" $SasLIG = Get-HPOVLogicalInterconnectGroup -Name "My Synergy Sas LIG 1" $LogicalInterconnectGroupMapping = @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG }</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new enclosure group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure" aliases="None"> <maml:name>OAAddress</maml:name> <maml:description> <maml:para>Provide the Onboard Administrator IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide an Onboard Administrator administrator password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure, Synergy, C7000" aliases="None"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>RedundantPowerFeed</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ImportFile, DiscoverFromEnclosure, Synergy, C7000" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DiscoverFromEnclosure" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide an Onboard Administrator administrator account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnectGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Logical Interconnect Group resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The newly created enclosure group resource</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>$mylig = Get-HPOVLogicalInterconnectGroup -name "myLogicalInterconnectGroup" New-HPOVEnclosureGroup -name "MyGroup" -logicalInterConnectGroup $mylig</dev:code> <dev:remarks> <dev:para>Get the "myLogicalInterconnectGroup" object and pass it to create the "MyGroup" Enclosure Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Prodlig = Get-HPOVLogicalInterconnectGroup -name "Production LIG" $DMZlig = Get-HPOVLogicalInterconnectGroup -name "DMZ LIG" $ConfigurationScript = "#Configure Insight Remote Support CentralConnect >> ENABLE REMOTE_SUPPORT IRS 80.80.1.14 7906" New-HPOVEnclosureGroup -name "Production Enclosure Group 1" -LogicalInterconnectGroupMapping @{1 = $Prodlig; 2 = $Prodlig; 5 = $DMZlig; 6 = $DMZlig} -ConfigurationScript $ConfigurationScript</dev:code> <dev:remarks> <dev:para>Get two different Logical Interconnect Groups, define an OA Configuration Script, then assign the LIGs to the specific Interconnect Bays for appliance "MyAppliance1.domain.com".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVEnclosureGroup -name "MyGroup" -DiscoverFromEnclosure -OAAddress MyOAIP.domain.com -Username Administrator -Password MyPassword</dev:code> <dev:remarks> <dev:para>Connect to the provided Onboard Administrator, detect the Interconnect Bay population to then create both a Logical Interconnect Group and associate it with the Enclosure Group being requested.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVEnclosureGroup -name "MyGroup" -DiscoverFromEnclosure -OAAddress MyOAIP.domain.com -Username Administrator -Password MyPassword -LigPrefix "My LIG Policy"</dev:code> <dev:remarks> <dev:para>Connect to the provided Onboard Administrator, detect the Interconnect Bay population to then create both a Logical Interconnect Group ("My LIG Policy") and associate it with the Enclosure Group being requested.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping $MySynergyLig1 -EnclosureCount 3 -IPv4AddressType DHCP</dev:code> <dev:remarks> <dev:para>Create a 3-Frame Synergy Enclosure Group using a single Logical Interconnect Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType DHCP</dev:code> <dev:remarks> <dev:para>Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId "10.140.51.0" -ErrorAction Stop | Get-HPOVAddressPoolRange $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType AddressPool -AddressPool $AddressPool -DeploymentNetworkType Internal</dev:code> <dev:remarks> <dev:para>Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame, with ImageStreamer support using a LIG with an ImageStreamer Uplink Set (aka Internal).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$AddressPool = Get-HPOVAddressPoolSubnet -NetworkId "10.140.51.0" -ErrorAction Stop | Get-HPOVAddressPoolRange $DeploymentNetwork = Get-HPOVNetwork -Name "Deployment Network" -ErrorAction Stop $MySynergyLig1 = Get-HPOVLogicalInterconnectGroup -Name MySynergyLig1 New-HPOVEnclosureGroup -name "My Synergy Enclosure Group 1" -LogicalInterconnectGroupMapping @{Frame1 = $3FrameVCLIG,$SasLIG; Frame2 = $3FrameVCLIG,$SasLIG; Frame3 = $3FrameVCLIG } -EnclosureCount 3 -IPv4AddressType AddressPool -AddressPool $AddressPool -DeploymentNetworkType External -DeploymentNetwork $DeploymentNetwork</dev:code> <dev:remarks> <dev:para>Create a 3-Frame Synergy Enclosure Group using multiple Logical Interconnect Groups specific to each Frame, with ImageStreamer support using a LIG without an ImageStreamer Uplink Set and specifying which Ethernet Network object is the deployment network (aka External).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVEXTERNALREPOSITORY--> <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"> <!--NEW-HPOVEXTERNALREPOSITORY--> <command:details> <command:name>New-HPOVExternalRepository</command:name> <maml:description> <maml:para>Create a new external baseline repository.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVExternalRepository</command:noun> </command:details> <maml:description> <maml:para>A firmware repository enables you to store firmware bundles and deploy them across your environment. An externally managed HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You can upload firmware bundles in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This functionality is supported for Linux and Windows systems. The recommended types of external web servers to use with the repository follow: * Apache * Internet Information Services (IIS) NOTE: Only one external repository can be added.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a name for the repository.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specify IPv4 Address or FQDN of the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>Specify the parent virtual directory where the baseline components will be kept. Baseline components can be nested within sub directories.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the username to authenticate to the target web server with if required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the username using a System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Http</maml:name> <maml:description> <maml:para>Use to override the default HTTPS protocol used to communicate with the target web server. If this parameter is not used, you must specify the Base64 Certificate of the target web server. If you use this parameter, all authentication requests will be sent as clear text.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a name for the repository.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specify IPv4 Address or FQDN of the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>Specify the parent virtual directory where the baseline components will be kept. Baseline components can be nested within sub directories.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object if the target web server requires authentication. By default, HTTPS will be used and basic authentication is used to communicate with the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Http</maml:name> <maml:description> <maml:para>Use to override the default HTTPS protocol used to communicate with the target web server. If this parameter is not used, you must specify the Base64 Certificate of the target web server. If you use this parameter, all authentication requests will be sent as clear text.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object if the target web server requires authentication. By default, HTTPS will be used and basic authentication is used to communicate with the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Directory</maml:name> <maml:description> <maml:para>Specify the parent virtual directory where the baseline components will be kept. Baseline components can be nested within sub directories.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specify IPv4 Address or FQDN of the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Http</maml:name> <maml:description> <maml:para>Use to override the default HTTPS protocol used to communicate with the target web server. If this parameter is not used, you must specify the Base64 Certificate of the target web server. If you use this parameter, all authentication requests will be sent as clear text.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a name for the repository.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the username using a System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the username to authenticate to the target web server with if required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task for the caller to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async task resource objects.</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>$Params = @{ Name = "MyRepoName"; Hostname = "webserver.domain.local"; Directory = "OneViewRepo"; Credential = (Get-PSCredential -Username "DomainName\MyUser"); Certificate = (Get-Content -Path C:\Directory\Base64.cer -Raw) } New-HPOVExternalRepository @Params</dev:code> <dev:remarks> <dev:para>Create an external repository using a PSCredential object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVExternalRepository -Name MyRepoName -Hostname webserver.domain.local -Directory OneViewRepo -Http</dev:code> <dev:remarks> <dev:para>Configure an external repository using anonymous authentication, and HTTP protocol.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Remove-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVILODIRECTORYGROUP--> <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"> <!--NEW-HPOVILODIRECTORYGROUP--> <command:details> <command:name>New-HPOVIloDirectoryGroup</command:name> <maml:description> <maml:para>Create compliant iLO directory group object for server profile type resources.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVIloDirectoryGroup</command:noun> </command:details> <maml:description> <maml:para>iLO settings enable you to configure and manage the settings in HPE OneView instead of logging into the iLO to apply the needed settings. These settings are included when you move the profile to another server hardware instance. Use a server profile template if you want to maintain consistent management for a specific iLO setting across multiple iLO. This Cmdlet will create and grant access to specific directory groups for the iLO on the server hardware that is associated with a server profile. When managed from HPE OneView, all the directory groups on the iLO are replaced when configuring the directory groups specified in the server profile.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVIloDirectoryGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>GroupDN</maml:name> <maml:description> <maml:para>The Distinguished Name (DN) of the group from the directory to be authorized for iLO access.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>The SID of the directory group to be authorized for iLO access.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AdministerUserAccounts</maml:name> <maml:description> <maml:para>Group has the permission to add, edit, and delete local iLO user accounts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>RemoteConsole</maml:name> <maml:description> <maml:para>Group has the permission to access the iLO remote console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>VirtualMedia</maml:name> <maml:description> <maml:para>Group has the permission to use the Virtual Media features on the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>VirtualPowerAndReset</maml:name> <maml:description> <maml:para>Group has the permission to power-cycle or reset the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ConfigureIloSettings</maml:name> <maml:description> <maml:para>Group has the permission to configure most iLO settings, including security settings, and to update the iLO firmware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AdministerUserAccounts</maml:name> <maml:description> <maml:para>Group has the permission to add, edit, and delete local iLO user accounts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ConfigureIloSettings</maml:name> <maml:description> <maml:para>Group has the permission to configure most iLO settings, including security settings, and to update the iLO firmware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>GroupDN</maml:name> <maml:description> <maml:para>The Distinguished Name (DN) of the group from the directory to be authorized for iLO access.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>The SID of the directory group to be authorized for iLO access.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>RemoteConsole</maml:name> <maml:description> <maml:para>Group has the permission to access the iLO remote console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>VirtualMedia</maml:name> <maml:description> <maml:para>Group has the permission to use the Virtual Media features on the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>VirtualPowerAndReset</maml:name> <maml:description> <maml:para>Group has the permission to power-cycle or reset the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An iLO settings complient object for server profile resources. </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>$Group1 = New-HPOVIloDirectoryGroup -GroupDN "dn=ilogroup1, ou=ou1, dc=domain, dc=com" ` -GroupSID "sid12345" ` -AdministerUserAccounts ` -RemoteConsole ` -VirtualMedia ` -ConfigureIloSettings</dev:code> <dev:remarks> <dev:para>Create a directory group, with the specific privileges.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileIloPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVIloLocalUserAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVILOLOCALUSERACCOUNT--> <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"> <!--NEW-HPOVILOLOCALUSERACCOUNT--> <command:details> <command:name>New-HPOVIloLocalUserAccount</command:name> <maml:description> <maml:para>Create compliant local iLO account object for server profile type resources.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVIloLocalUserAccount</command:noun> </command:details> <maml:description> <maml:para>iLO settings enable you to configure and manage the settings in HPE OneView instead of logging into the iLO to apply the needed settings. These settings are included when you move the profile to another server hardware instance. Use a server profile template if you want to maintain consistent management for a specific iLO setting across multiple iLO. This Cmdlet will allow you to create a new local account that can then be passed into the LocalAccounts parameter of New-HPOVServerProfileIloPolicy Cmdlet. When managed from HPE OneView, all the local accounts on the iLO are replaced when configuring the accounts specified in the server profile.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVIloLocalUserAccount</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username of the account that will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>Password</maml:name> <maml:description> <maml:para>The securestring object of the user account password to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Optional display name of the user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>AdministerUserAccounts</maml:name> <maml:description> <maml:para>User has the permission to add, edit, and delete local iLO user accounts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>RemoteConsole</maml:name> <maml:description> <maml:para>User has the permission to access the iLO remote console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>VirtualMedia</maml:name> <maml:description> <maml:para>User has the permission to use the Virtual Media features on the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>VirtualPowerAndReset</maml:name> <maml:description> <maml:para>User has the permission to power-cycle or reset the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>ConfigureIloSettings</maml:name> <maml:description> <maml:para>User has the permission to configure most iLO settings, including security settings, and to update the iLO firmware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVIloLocalUserAccount</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username of the account that will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>Password</maml:name> <maml:description> <maml:para>The securestring object of the user account password to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Optional display name of the user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>AdministerUserAccounts</maml:name> <maml:description> <maml:para>User has the permission to add, edit, and delete local iLO user accounts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>RemoteConsole</maml:name> <maml:description> <maml:para>User has the permission to access the iLO remote console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>VirtualMedia</maml:name> <maml:description> <maml:para>User has the permission to use the Virtual Media features on the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>VirtualPowerAndReset</maml:name> <maml:description> <maml:para>User has the permission to power-cycle or reset the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4"> <maml:name>ConfigureIloSettings</maml:name> <maml:description> <maml:para>User has the permission to configure most iLO settings, including security settings, and to update the iLO firmware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5"> <maml:name>Login</maml:name> <maml:description> <maml:para>User has the permission to log into the iLO. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5"> <maml:name>HostBIOS</maml:name> <maml:description> <maml:para>User has the permission to change host system BIOS configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5"> <maml:name>HostNIC</maml:name> <maml:description> <maml:para>User has the permission to change host system NIC configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5"> <maml:name>HostStorage</maml:name> <maml:description> <maml:para>User has the permission to change host system storage configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>AdministerUserAccounts</maml:name> <maml:description> <maml:para>User has the permission to add, edit, and delete local iLO user accounts.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>ConfigureIloSettings</maml:name> <maml:description> <maml:para>User has the permission to configure most iLO settings, including security settings, and to update the iLO firmware.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Optional display name of the user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5" aliases="None"> <maml:name>HostBIOS</maml:name> <maml:description> <maml:para>User has the permission to change host system BIOS configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5" aliases="None"> <maml:name>HostNIC</maml:name> <maml:description> <maml:para>User has the permission to change host system NIC configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5" aliases="None"> <maml:name>HostStorage</maml:name> <maml:description> <maml:para>User has the permission to change host system storage configuration. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5" aliases="None"> <maml:name>Login</maml:name> <maml:description> <maml:para>User has the permission to log into the iLO. This permission is specific to iLO5-based systems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The securestring object of the user account password to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>RemoteConsole</maml:name> <maml:description> <maml:para>User has the permission to access the iLO remote console.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username of the account that will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>VirtualMedia</maml:name> <maml:description> <maml:para>User has the permission to use the Virtual Media features on the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="iLO5, iLO4" aliases="None"> <maml:name>VirtualPowerAndReset</maml:name> <maml:description> <maml:para>User has the permission to power-cycle or reset the host system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An iLO settings complient object for server profile resources. </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>New-HPOVIloLocalUserAccount -Username "localuser1" ` -Password (Read-Host "localuser1 password" -AsSecureString) ` -DisplayName "localuser1" ` -AdministerUserAccounts ` -RemoteConsole ` -VirtualMedia ` -VirtualPowerAndReset ` -ConfigureIloSettings</dev:code> <dev:remarks> <dev:para>Create an iLO user account specific to iLO4, or does not include the additional iLO5 permissions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVIloLocalUserAccount -Username "localuser1" ` -Password (Read-Host "localuser1 password" -AsSecureString) ` -DisplayName "localuser1" ` -AdministerUserAccounts ` -RemoteConsole ` -VirtualMedia ` -VirtualPowerAndReset ` -ConfigureIloSettings ` -Login ` -HostBIOS ` -HostNIC ` -HostStorage</dev:code> <dev:remarks> <dev:para>Create an iLO user account that includes iLO5 permissions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileIloPolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVIloDirectoryGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLDAPDIRECTORY--> <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"> <!--NEW-HPOVLDAPDIRECTORY--> <command:details> <command:name>New-HPOVLdapDirectory</command:name> <maml:description> <maml:para>Add a new Directory for Authentication</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLdapDirectory</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer Cmdlet is used to assist defining directory servers address, public SSL certificate and LDAP over SSL TCP port.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLdapDirectory</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Name</maml:name> <maml:description> <maml:para>Directory name to add. Does not need to match LDAP/AD Directory Name, but should.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="AD"> <maml:name>AD</maml:name> <maml:description> <maml:para>Using Active Directory, which sets the authProtocol to AD and userNameField to CN</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>BaseDN</maml:name> <maml:description> <maml:para>Directory Base DN (E.g. dc=domian,dc=local)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Array of Directory Servers and their settings. Must include the following: * Server Name (FQDN or IP) * Public SSL Certificate * SSL Port, if not default 636</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory Username password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="LDAP, AD"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Use to indicate the provided credential is a Service Account. Required for when configuring an Active Directory auth directory for two-factor authentication.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLdapDirectory</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Name</maml:name> <maml:description> <maml:para>Directory name to add. Does not need to match LDAP/AD Directory Name, but should.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP"> <maml:name>OpenLDAP</maml:name> <maml:description> <maml:para>Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>BaseDN</maml:name> <maml:description> <maml:para>Directory Base DN (E.g. dc=domian,dc=local)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP"> <maml:name>OrganizationalUnits</maml:name> <maml:description> <maml:para>OpenLDAP OU"s to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Array of Directory Servers and their settings. Must include the following: * Server Name (FQDN or IP) * Public SSL Certificate * SSL Port, if not default 636</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP"> <maml:name>UserNamingAttribute</maml:name> <maml:description> <maml:para>Specify the naming attribute for OpenLDAP directories. Allowed values: * CN * UID Default Value: CN</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory Username password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="LDAP, AD"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Use to indicate the provided credential is a Service Account. Required for when configuring an Active Directory auth directory for two-factor authentication.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="AD" aliases="None"> <maml:name>AD</maml:name> <maml:description> <maml:para>Using Active Directory, which sets the authProtocol to AD and userNameField to CN</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="root, rootdn"> <maml:name>BaseDN</maml:name> <maml:description> <maml:para>Directory Base DN (E.g. dc=domian,dc=local)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="LDAP, AD" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Directory name to add. Does not need to match LDAP/AD Directory Name, but should.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP" aliases="LDAP"> <maml:name>OpenLDAP</maml:name> <maml:description> <maml:para>Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP" aliases="None"> <maml:name>OrganizationalUnits</maml:name> <maml:description> <maml:para>OpenLDAP OU"s to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="p, pass"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory Username password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="None"> <maml:name>Servers</maml:name> <maml:description> <maml:para>Array of Directory Servers and their settings. Must include the following: * Server Name (FQDN or IP) * Public SSL Certificate * SSL Port, if not default 636</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="None"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Use to indicate the provided credential is a Service Account. Required for when configuring an Active Directory auth directory for two-factor authentication.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP" aliases="None"> <maml:name>UserNamingAttribute</maml:name> <maml:description> <maml:para>Specify the naming attribute for OpenLDAP directories. Allowed values: * CN * UID Default Value: CN</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue>CN</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="LDAP, AD" aliases="u, user"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para>Account Password that will be used to validate the directory</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Configured Authentication Directory</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple configured Authentication Directories</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>$ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer New-HPOVLdapDirectory -name Domain1 -AD -basedn "dc=domain,dc=com" -servers $ServerA,$ServerB -Username MyAdminAccount@domain.com</dev:code> <dev:remarks> <dev:para>Add a new directory with two directory servers, and be prompted for your directory account password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerA = New-HPOVLdapServer -Name contoso.com New-HPOVLdapDirectory -name Domain1 -AD -basedn "dc=domain,dc=com" -servers $ServerA -Username MyAdminAccount@domain.com -ServiceAccount</dev:code> <dev:remarks> <dev:para>Add a new Active Directory authentication directory, using SRV domain name, and specify to use the account as a service account.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLDAPGROUP--> <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"> <!--NEW-HPOVLDAPGROUP--> <command:details> <command:name>New-HPOVLdapGroup</command:name> <maml:description> <maml:para>Add a new Directory Group to appliance.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLdapGroup</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to add a new Directory Group to the appliance. You can use the Show-HPOVLdapGroups to retrieve a list of avialable Directory Groups from the specified Directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLdapGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Scope, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>LDAP/Active Directory Domain object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Group</maml:name> <maml:description> <maml:para>Directroy Group to add. Can either be a string value of a Cononical Name of directory group, or object from Show-HPOVLdapGroups.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory User account password. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLdapGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Scope, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>LDAP/Active Directory Domain object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Group</maml:name> <maml:description> <maml:para>Directroy Group to add. Can either be a string value of a Cononical Name of directory group, or object from Show-HPOVLdapGroups.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory User account password. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Scope, Default" aliases="d, domain, authProvider"> <maml:name>Directory</maml:name> <maml:description> <maml:para>LDAP/Active Directory Domain object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default" aliases="g, GroupName, name"> <maml:name>Group</maml:name> <maml:description> <maml:para>Directroy Group to add. Can either be a string value of a Cononical Name of directory group, or object from Show-HPOVLdapGroups.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory User account password. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="r, role"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope" aliases="None"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Scope, Default" aliases="u"> <maml:name>Username</maml:name> <maml:description> <maml:para>Warning: This parameter is now obsolete. Please transition to using the -Credential parameter. Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.DirectoryGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The external authentication directory object from -Get-HPOVLdapDirectory.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New LDAP Group object with role assignment(s)</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>New-HPOVLdapGroup -d Domain1 -GroupName "MY Directory Group1" -roles @("Server administrator") -u "Sarah Peterson"</dev:code> <dev:remarks> <dev:para>Add "MY Directory Group1" from Domain1 with Server Administrator role and prompt for password for group validation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Get the defined directory group from the appliance. $Directory = Get-HPOVLdapDirectory -Name "Domain1" -ErrorAction Stop # Collect the users AD password. This does not require Domain Admins or an administrator level account. Only a standard user account that can query the directory. $Password = ConvertTo-SecureString -AsPlainText "password123890" -force # Get the directory group object. $Group = Show-HPOVLdapDirectoryGroup -Name "Domain1" -Directory $Directory -Username "Sarah.Peterson@domain1.com" -Password $Password -ErrorAction Stop # Specify the roles needed to be assigned to the directory group. $Roles = "Server administrator","Backup administrator" # Create the directory group resource on the appliance, and associate with the SBAC permissions. New-HPOVLdapGroup -Directory $Directory -GroupName "MY Directory Group1" -Roles $Roles -Username "Sarah.Peterson@domain1.com" -Password $Password</dev:code> <dev:remarks> <dev:para>Add "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group validation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Get the defined directory group from the appliance. $Directory = Get-HPOVLdapDirectory -Name "Domain1" -ErrorAction Stop # Collect the scope needed to assign permissions. $VirtAdminsScope = Get-HPOVScope -Name CorpVirtAdmins -ErrorAction Stop # Create a hashtable of the roles to scopes (SBAC) which would then be assigned to the directory group. $ScopeRoles = @{Role = "Server administrator"; Scope = $VirtAdminsScope},@{Role = "Storage administrator"; Scope = $VirtAdminsScope} # Collect the users AD credentials. This does not require Domain Admins or an administrator level account. Only a standard user account that can query the directory. $MyAdCreds = Get-Credential # Get the directory group object. $Group = Show-HPOVLdapDirectoryGroup -Name "CorpVirtAdmins" -Directory $Directory -Credential $MyAdCreds -ErrorAction Stop # Create the directory group resource on the appliance, and associate with the SBAC permissions. New-HPOVLdapGroup -Directory Directory -GroupName CorpVirtAdmins -ScopePermissions $ScopeRoles -Credential $MyAdCreds</dev:code> <dev:remarks> <dev:para>Add the new directory group with specific scope permissions, and using a PSCredential object for authentication directory validation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLdapGroupRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLdapGroups</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLDAPSERVER--> <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"> <!--NEW-HPOVLDAPSERVER--> <command:details> <command:name>New-HPOVLdapServer</command:name> <maml:description> <maml:para>Define LDAP Directory Server object.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLdapServer</command:noun> </command:details> <maml:description> <maml:para>A helper Cmdlet that will define an LDAP Directory Server object to be used with the New-HPOVLdapDirectory Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLdapServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Directory server name or IP Address to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>SSLPort</maml:name> <maml:description> <maml:para>Directory Server"s LDAP SSL Port.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Directory Server SSL Certificate, either location to Base64 Cert or multiline string value. If omitted, the Cmdlet will attempt to retrieve the Directory Servers Secure LDAP Certiciate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>Use to specify if the certificate should be explicitly trusted, like a self signed certificate or where the root or issuing certificate authority has not been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="cert"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Directory Server SSL Certificate, either location to Base64 Cert or multiline string value. If omitted, the Cmdlet will attempt to retrieve the Directory Servers Secure LDAP Certiciate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="Name"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Directory server name or IP Address to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="port"> <maml:name>SSLPort</maml:name> <maml:description> <maml:para>Directory Server"s LDAP SSL Port.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>636</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>TrustLeafCertificate</maml:name> <maml:description> <maml:para>Use to specify if the certificate should be explicitly trusted, like a self signed certificate or where the root or issuing certificate authority has not been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Directory Server Name or IP Address</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Mutlple Directory Server Name or IP Address System.String values</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectoryServer [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New LDAP Server Resource Object to be used with New-HPOVLdapDirectory Cmdlet</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>$ServerA = New-HPOVLdapServer -Name servera.domain.com -Certificate C:\dir\servera.cer</dev:code> <dev:remarks> <dev:para>Define a new Directory Server, ServerA, specifying the Base64 Public Certificate and using the default LDAP SSL port 636.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerA = New-HPOVLdapServer -Name servera.domain.com -Port 2636 -Certificate C:\dir\servera.cer</dev:code> <dev:remarks> <dev:para>Define a new Directory Server, ServerA, specifying the Base64 Public Certificate, using a custom LDAP SSL port.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$dc1,$dc2 = "dc1.mydomain.com","dc2.mydomain.com" | New-HPOVLdapServer</dev:code> <dev:remarks> <dev:para>Create two new authentication directory servers, with the Cmdlet retrieving the certificate directly from the auth servers.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLICENSE--> <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"> <!--NEW-HPOVLICENSE--> <command:details> <command:name>New-HPOVLicense</command:name> <maml:description> <maml:para>Install license on the appliance</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLicense</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will install licenses on the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLicense</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="licenseKey"> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Used for adding license keys one at a time, or if only a single license key needs to be added.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InputFile, licenseKey"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLicense</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InputFile"> <maml:name>File</maml:name> <maml:description> <maml:para>A text file with each license key on a new line that will be installed on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InputFile, licenseKey"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InputFile, licenseKey" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InputFile" aliases="None"> <maml:name>File</maml:name> <maml:description> <maml:para>A text file with each license key on a new line that will be installed on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="licenseKey" aliases="None"> <maml:name>LicenseKey</maml:name> <maml:description> <maml:para>Used for adding license keys one at a time, or if only a single license key needs to be added.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>License key in String Format, from Get-Content or an Array of String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The License resource just added to the apliance</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>$license = "FC9E D9MA H9PA GTVZ C7B5 HWWB Y9JL KHPL B89H MZVU DXAU 9CSM GHTG L762 2F25 HJF9 KJVT D5TM EFVW TZNJ FGTM NQ6G 2P2J 9G82 ZJKZ EWLR VW8A Y5A4 N2SK H1MQ XJJL LUQH ZUWD 9ATC NJ79 CEJC 5S86 FC4X EKSZ X4CP XZLU FSXS FKS6 KKCE 4NMU FPN5 N82E Z2RX 3QTM EFQC 29JK 29MC "ORDER_101613 E1Y94A HP_OV_3yr_24x7_Supp_Phys_1_Svr_Lic EONEJTCDT4FJ"_35HZP-CYMTH-W414S-2DGKZ-S6MPH" New-HPOVlicense $license</dev:code> <dev:remarks> <dev:para>Install license on the appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVlicense -file c:\licenses.txt Install licenses from a file. Get-Content C:\licenses.txt | New-HPOVlicense</dev:code> <dev:remarks> <dev:para>Install licenses read from a file by Get-Content.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLOGICALENCLOSURE--> <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"> <!--NEW-HPOVLOGICALENCLOSURE--> <command:details> <command:name>New-HPOVLogicalEnclosure</command:name> <maml:description> <maml:para>Create a Logical Enclosure.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLogicalEnclosure</command:noun> </command:details> <maml:description> <maml:para>A logical enclosure represents a logical view of a single enclosure with an enclosure group serving as a template. If the intended configuration in the logical enclosure does not match the actual configuration on the enclosures, the logical enclosure becomes inconsistent. Use the Logical Enclosures screen to manage firmware, configuration scripts, create a support dump, and to apply updates made from the Enclosure Groups screen to the enclosures in the logical enclosure. A logical enclosure is automatically created when a c7000 enclosure is added. Use this Cmdlet to define a new Logical Enclosure that will include multiple Synergy Frames that share the same Virtual Connect Fabric Domain.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new Logical Enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>One of the connected Frames. The Interlink Topology will be discovered to include the other Frame members.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource to deploy the policy from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>FirmwareBaseline</maml:name> <maml:description> <maml:para>Provide the Firmware Baseline object to use with the Logical Enclosure is being created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ForceFirmwareBaseline</maml:name> <maml:description> <maml:para>Specify to force the installation of firmware if the same version is found or if you wish to downgrade from a newer installed version.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Return the object created by the Cmdlet, and not to the API. This is useful when you want to modify additional properties the Cmdlet does not yet support.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>One of the connected Frames. The Interlink Topology will be discovered to include the other Frame members.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="eg"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource to deploy the policy from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>FirmwareBaseline</maml:name> <maml:description> <maml:para>Provide the Firmware Baseline object to use with the Logical Enclosure is being created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ForceFirmwareBaseline</maml:name> <maml:description> <maml:para>Specify to force the installation of firmware if the same version is found or if you wish to downgrade from a newer installed version.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name for the new Logical Enclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Return the object created by the Cmdlet, and not to the API. This is useful when you want to modify additional properties the Cmdlet does not yet support.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Enclosure (Synergy Frame) resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource</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>$EG = Get-HPOVEnclosureGroup -Name "Prod Synergy EG 1" Get-HPOVEnclosure -Name 0000A66101 | New-HPOVLogicalEnclosure "My Synergy LE 1" -EnclosureGroup $EG</dev:code> <dev:remarks> <dev:para>Create a new Logical Enclosure, "My Synergy LE 1", using the specified Enclosure Group and a specific Synergy Frame.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosureFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLOGICALINTERCONNECTGROUP--> <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"> <!--NEW-HPOVLOGICALINTERCONNECTGROUP--> <command:details> <command:name>New-HPOVLogicalInterconnectGroup</command:name> <maml:description> <maml:para>Create new Logical Interconnect Group.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLogicalInterconnectGroup</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to create a Logical Interconnect Group. Bays 1 and 2 are required, and need to be identical.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Interconnect Group Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000"> <maml:name>Bays</maml:name> <maml:description> <maml:para>HPE BladeSystem C7000 Support - A [System.Collections.Hashtable] object of each Interconnect Bay. Accepted values are: * FlexFabric - HP VC FlexFabric 10Gb/24-Port Module * Flex10 - HP VC Flex-10 Enet Module * Flex1010D - HP VC Flex-10/10D Module * Flex2040f8 - HP VC FlexFabric-20/40 F8 Module * VCFC20 - HP VC 8Gb 20-Port FC Module * VCFC24 - HP VC 8Gb 24-Port FC Module * FEX - Cisco Fabric Extender for HP BladeSystem E.g. @{1 = "Flex10";2 = "Flex10";3 = "FlexFabric";4 = "Flexfabric";5 = "";6 = "";7 = "";8 = "";} HPE Synergy Support - A [System.Collection.Hashtable] object, with Frame and Fabric Bay definitions. Accepted values are: * SEVC100F32 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVC40f8 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVCFC or SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy * SE20ILM - Synergy 20Gb Interconnect Link Module * SE10ILM - Synergy 10Gb Interconnect Link Module * SE12SAS - Synergy 12Gb SAS Connection Module $Bays = @{ Frame1 = @{Bay3 = "SEVC40f8"; Bay6 = "SE20ILM"}; Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8"} } Note: When configuring Synergy SAS Connection Module, no other device bays can be specified, and only a Single Frame can be configured.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InterconnectConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableIgmpSnooping</maml:name> <maml:description> <maml:para>The IGMP snooping feature allows interconnects to monitor the IGMP IP multicast membership activities and configure hardware Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently, only IGMP v1 and v2 (RFC 2236) are supported. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>IgmpIdleTimeoutInterval</maml:name> <maml:description> <maml:para>The Group Membership Interval value, as specified by the IGMP v2 specification (RFC 2236). For optimum network resource usage, set the timeout interval to match your network"s multicast router settings. Data type: Numeric; unit of measure is seconds Default value: 260 Required: Yes, if IGMP snooping is enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="C7000"> <maml:name>EnableFastMacCacheFailover</maml:name> <maml:description> <maml:para>When an uplink that was in standby mode becomes active, it can take several minutes for external Ethernet interconnects to recognize that the server blades can now be reached on this newly active connection. Enabling Fast MAC Cache Failover causes Ethernet packets to be transmitted on the newly active connection, which enables the external Ethernet interconnects to identify the new connection (and update their MAC caches). The transmission sequence is repeated a few times at the MAC refresh interval and completes in about 1 minute. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="C7000"> <maml:name>MacRefreshInterval</maml:name> <maml:description> <maml:para>The time interval at which MAC caches are refreshed Data type: Numeric; unit of measure is seconds Default value: 5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableNetworkLoopProtection</maml:name> <maml:description> <maml:para>Enables or disables network loop protection. Network loop protection: The loop protection feature enables detection of loops on downlink ports, which can be Flex-10 logical ports or physical ports. The feature applies when Device Control Channel (DCC) protocol is running on the Flex-10 port. If DCC is not available, the feature applies to the physical downlink port. Network loop protection uses two methods to detect loops: 1. It periodically injects a special probe frame into the VC domain and monitors downlink ports for the looped back probe frame. If this special probe frame is detected on downlink ports, the port is considered to cause the loop condition. 2. It monitors and intercepts common loop detection frames used in other switches. In network environments where the upstream switches send loop detection frames, the VC interconnects must ensure that any downlink loops do not cause these frames to be sent back to the uplink ports. Even though the probe frames ensure loops are detected, there is a small time window depending on the probe frame transmission interval in which the loop detection frames from the external switch might loop through down link ports and reach uplink ports. By intercepting the external loop detection frames on downlinks, the possibility of triggering loop protection on the upstream switch is eliminated. When network loop protection is enabled, VC interconnects intercept loop detection frames from various switch vendors, such as Cisco and HP Networking. When the network loop protection feature is enabled, any probe frame or other supported loop detection frame received on a downlink port is considered to be causing the network loop, and the port is disabled immediately until an administrative action is taken. The administrative action involves resolving the loop condition and clearing the loop protection error condition. The loop detected status on a port can be cleared by un-assigning all networks from the profile connect corresponding to the port in the loop detected state. The SNMP agent supports trap generation when a loop condition is detected or cleared. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnablePauseFloodProtection</maml:name> <maml:description> <maml:para>Enables or disables pause flood protection. Pause flood protection: Ethernet switch interfaces use pause frame based flow control mechanisms to control data flow. When a pause frame is received on a flow control enabled interface, the transmit operation is stopped for the pause duration specified in the pause frame. All other frames destined for this interface are queued up. If another pause frame is received before the previous pause timer expires, the pause timer is refreshed to the new pause duration value. If a steady stream of pause frames is received for extended periods of time, the transmit queue for that interface continues to grow until all queuing resources are exhausted. This condition severely impacts the switch operation on other interfaces. In addition, all protocol operations on the switch are impacted because of the inability to transmit protocol frames. Both port pause and priority-based pause frames can cause the same resource exhaustion condition. VC interconnects provide the ability to monitor server downlink ports for pause flood conditions and take protective action by disabling the port. The default polling interval is 10 seconds and is not customer configurable. The SNMP agent supports trap generation when a pause flood condition is detected or cleared. This feature operates at the physical port level. When a pause flood condition is detected on a Flex-10 physical port, all Flex-10 logical ports associated with physical ports are disabled. When the pause flood protection feature is enabled, this feature detects pause flood conditions on server downlink ports and disables the port. The port remains disabled until an administrative action is taken. The administrative action involves the following steps: 1. Resolve the issue with the NIC on the server causing the continuous pause generation. This might include updating the NIC firmware and device drivers. Rebooting the server might not clear the pause flood condition if the cause of the pause flood condition is in the NIC firmware. In this case, the server must be completely disconnected from the power source to reset the NIC firmware. 2. Re-enable the disabled ports on the VC interconnect modules. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableLLDPTagging</maml:name> <maml:description> <maml:para>When enabled, tagged LLDP frames are transmitted over downlink ports to server hardware. The management IP address of the interconnect in the lowest numbered bay location in the logical interconnect will be advertised as the LLDP management address TLV. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableEnhancedLLDPTLV</maml:name> <maml:description> <maml:para>When enabled, the enclosure name and serial number are encapsulated in the Chassis ID TLV LLDPDU transmitted by interconnect uplink ports. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>LldpAddressingMode</maml:name> <maml:description> <maml:para>Specify the IP address format type to support. Allowed values: * IPv4 * IPv6 * IPv4AndIPv6</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SNMP</maml:name> <maml:description> <maml:para>SNMP Settings to define SNMP configruation. Use New-HPOVSnmpConfiguration and New-HPOVSnmpTrapDestination Cmdlets to create the necessary SNMP Configuration object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SNMPConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv1.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv3.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>Provide the SNMPv3 user object from New-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InternalNetworks</maml:name> <maml:description> <maml:para>An Array collection of Networks that will be marked as Internal only.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InternalNetworkConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>QosConfiguration</maml:name> <maml:description> <maml:para>A collection of QOS configurations that are created using the New-HPOVQosConfig helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>QoSConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>UplinkSet</maml:name> <maml:description> <maml:para>A collection of uplink sets from New-HPOVUplinkSet using the -Passthru parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Interconnect Group Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>FrameCount</maml:name> <maml:description> <maml:para>The number of Synergy Frames to participate in the Logical Stack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>InterconnectBaySet</maml:name> <maml:description> <maml:para>Which Synergy Interconnect Bay Set ID will the interconnects be populated in. Allowed value: * 1 - Interconnect Bay set 1 & 4 * 2 - Interconnect Bay set 2 & 5 * 3 - Interconnect Bay set 3 & 6</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>FabricModuleType</maml:name> <maml:description> <maml:para>Specify the Synergy Fabric Module type the Logical Interconnect Group will be modeled for. Allowed value: * SEVC100F32 - Virtual Connect SE 100Gb F32 Module for Synergy * SEVC40F8 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVCFC or SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy * SEVC32FC - Virtual Connect SE 32Gb FC Module for Synergy * SAS - Synergy 12Gb SAS Connection Module</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000"> <maml:name>Bays</maml:name> <maml:description> <maml:para>HPE BladeSystem C7000 Support - A [System.Collections.Hashtable] object of each Interconnect Bay. Accepted values are: * FlexFabric - HP VC FlexFabric 10Gb/24-Port Module * Flex10 - HP VC Flex-10 Enet Module * Flex1010D - HP VC Flex-10/10D Module * Flex2040f8 - HP VC FlexFabric-20/40 F8 Module * VCFC20 - HP VC 8Gb 20-Port FC Module * VCFC24 - HP VC 8Gb 24-Port FC Module * FEX - Cisco Fabric Extender for HP BladeSystem E.g. @{1 = "Flex10";2 = "Flex10";3 = "FlexFabric";4 = "Flexfabric";5 = "";6 = "";7 = "";8 = "";} HPE Synergy Support - A [System.Collection.Hashtable] object, with Frame and Fabric Bay definitions. Accepted values are: * SEVC100F32 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVC40f8 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVCFC or SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy * SE20ILM - Synergy 20Gb Interconnect Link Module * SE10ILM - Synergy 10Gb Interconnect Link Module * SE12SAS - Synergy 12Gb SAS Connection Module $Bays = @{ Frame1 = @{Bay3 = "SEVC40f8"; Bay6 = "SE20ILM"}; Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8"} } Note: When configuring Synergy SAS Connection Module, no other device bays can be specified, and only a Single Frame can be configured.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InterconnectConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>FabricRedundancy</maml:name> <maml:description> <maml:para>Define the expected Synergy Fabric Interconnect Redundancy type. Allowed value: * HighlyAvailable * Redundant * ASide * BSide</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>DownlinkSpeedMode</maml:name> <maml:description> <maml:para>Specify the port downlink speed to be configured for HPE Virtual Connect SE 100Gb F32 module for Synergy. Allowed values: * 25 * 50 Default: 25</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>EnableCutThroughSwitching</maml:name> <maml:description> <maml:para>Enables or disables the Cut-Through switching mode. When enabled, the switch starts forwarding the frame as soon as the switch has read the destination details in the packet header. When enabled, Pause flood protection is disabled. NOTE: This option is available for HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>EnableStormControl</maml:name> <maml:description> <maml:para>Enables or disables the suppression of excessive inbound broadcast, multicast, or DLF (Destination Lookup Failure) packets when a threshold is reached. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>StormControlPacketsPerSecondThreshold</maml:name> <maml:description> <maml:para>The Storm Control packet threshold at which traffic is suppressed. Valid range: 1-262143 packets per second</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>StormControlPollingInterval</maml:name> <maml:description> <maml:para>When enabling Storm Control, Specify a value between 5 and 30 seconds.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>EnableDdns</maml:name> <maml:description> <maml:para>When enabled, Domain Name System (DNS) server will be updated automatically when either the IP address or hostname change for the interconnect module. Must provide -DdnsDomainNameSuffix parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>DdnsDomainNameSuffix</maml:name> <maml:description> <maml:para>When enabled, Domain Name System (DNS) server will be updated automatically when either the IP address or hostname change for the interconnect module.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableIgmpSnooping</maml:name> <maml:description> <maml:para>The IGMP snooping feature allows interconnects to monitor the IGMP IP multicast membership activities and configure hardware Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently, only IGMP v1 and v2 (RFC 2236) are supported. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy"> <maml:name>IgmpVLANs</maml:name> <maml:description> <maml:para>Specify values or range of VLAN IDs, from 1-4094, associated with networks defined in the logical interconnect. Use comma or hyphens as separator, for example: 10-15, 52, 100-200.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>IgmpIdleTimeoutInterval</maml:name> <maml:description> <maml:para>The Group Membership Interval value, as specified by the IGMP v2 specification (RFC 2236). For optimum network resource usage, set the timeout interval to match your network"s multicast router settings. Data type: Numeric; unit of measure is seconds Default value: 260 Required: Yes, if IGMP snooping is enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableNetworkLoopProtection</maml:name> <maml:description> <maml:para>Enables or disables network loop protection. Network loop protection: The loop protection feature enables detection of loops on downlink ports, which can be Flex-10 logical ports or physical ports. The feature applies when Device Control Channel (DCC) protocol is running on the Flex-10 port. If DCC is not available, the feature applies to the physical downlink port. Network loop protection uses two methods to detect loops: 1. It periodically injects a special probe frame into the VC domain and monitors downlink ports for the looped back probe frame. If this special probe frame is detected on downlink ports, the port is considered to cause the loop condition. 2. It monitors and intercepts common loop detection frames used in other switches. In network environments where the upstream switches send loop detection frames, the VC interconnects must ensure that any downlink loops do not cause these frames to be sent back to the uplink ports. Even though the probe frames ensure loops are detected, there is a small time window depending on the probe frame transmission interval in which the loop detection frames from the external switch might loop through down link ports and reach uplink ports. By intercepting the external loop detection frames on downlinks, the possibility of triggering loop protection on the upstream switch is eliminated. When network loop protection is enabled, VC interconnects intercept loop detection frames from various switch vendors, such as Cisco and HP Networking. When the network loop protection feature is enabled, any probe frame or other supported loop detection frame received on a downlink port is considered to be causing the network loop, and the port is disabled immediately until an administrative action is taken. The administrative action involves resolving the loop condition and clearing the loop protection error condition. The loop detected status on a port can be cleared by un-assigning all networks from the profile connect corresponding to the port in the loop detected state. The SNMP agent supports trap generation when a loop condition is detected or cleared. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnablePauseFloodProtection</maml:name> <maml:description> <maml:para>Enables or disables pause flood protection. Pause flood protection: Ethernet switch interfaces use pause frame based flow control mechanisms to control data flow. When a pause frame is received on a flow control enabled interface, the transmit operation is stopped for the pause duration specified in the pause frame. All other frames destined for this interface are queued up. If another pause frame is received before the previous pause timer expires, the pause timer is refreshed to the new pause duration value. If a steady stream of pause frames is received for extended periods of time, the transmit queue for that interface continues to grow until all queuing resources are exhausted. This condition severely impacts the switch operation on other interfaces. In addition, all protocol operations on the switch are impacted because of the inability to transmit protocol frames. Both port pause and priority-based pause frames can cause the same resource exhaustion condition. VC interconnects provide the ability to monitor server downlink ports for pause flood conditions and take protective action by disabling the port. The default polling interval is 10 seconds and is not customer configurable. The SNMP agent supports trap generation when a pause flood condition is detected or cleared. This feature operates at the physical port level. When a pause flood condition is detected on a Flex-10 physical port, all Flex-10 logical ports associated with physical ports are disabled. When the pause flood protection feature is enabled, this feature detects pause flood conditions on server downlink ports and disables the port. The port remains disabled until an administrative action is taken. The administrative action involves the following steps: 1. Resolve the issue with the NIC on the server causing the continuous pause generation. This might include updating the NIC firmware and device drivers. Rebooting the server might not clear the pause flood condition if the cause of the pause flood condition is in the NIC firmware. In this case, the server must be completely disconnected from the power source to reset the NIC firmware. 2. Re-enable the disabled ports on the VC interconnect modules. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableLLDPTagging</maml:name> <maml:description> <maml:para>When enabled, tagged LLDP frames are transmitted over downlink ports to server hardware. The management IP address of the interconnect in the lowest numbered bay location in the logical interconnect will be advertised as the LLDP management address TLV. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>EnableEnhancedLLDPTLV</maml:name> <maml:description> <maml:para>When enabled, the enclosure name and serial number are encapsulated in the Chassis ID TLV LLDPDU transmitted by interconnect uplink ports. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>LldpAddressingMode</maml:name> <maml:description> <maml:para>Specify the IP address format type to support. Allowed values: * IPv4 * IPv6 * IPv4AndIPv6</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SNMP</maml:name> <maml:description> <maml:para>SNMP Settings to define SNMP configruation. Use New-HPOVSnmpConfiguration and New-HPOVSnmpTrapDestination Cmdlets to create the necessary SNMP Configuration object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SNMPConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv1.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv3.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>Provide the SNMPv3 user object from New-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InternalNetworks</maml:name> <maml:description> <maml:para>An Array collection of Networks that will be marked as Internal only.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>InternalNetworkConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>QosConfiguration</maml:name> <maml:description> <maml:para>A collection of QOS configurations that are created using the New-HPOVQosConfig helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>QoSConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>UplinkSet</maml:name> <maml:description> <maml:para>A collection of uplink sets from New-HPOVUplinkSet using the -Passthru parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import"> <maml:name>Import</maml:name> <maml:description> <maml:para>Specify JSON source file to create Logical Interconnect Group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>Bays</maml:name> <maml:description> <maml:para>HPE BladeSystem C7000 Support - A [System.Collections.Hashtable] object of each Interconnect Bay. Accepted values are: * FlexFabric - HP VC FlexFabric 10Gb/24-Port Module * Flex10 - HP VC Flex-10 Enet Module * Flex1010D - HP VC Flex-10/10D Module * Flex2040f8 - HP VC FlexFabric-20/40 F8 Module * VCFC20 - HP VC 8Gb 20-Port FC Module * VCFC24 - HP VC 8Gb 24-Port FC Module * FEX - Cisco Fabric Extender for HP BladeSystem E.g. @{1 = "Flex10";2 = "Flex10";3 = "FlexFabric";4 = "Flexfabric";5 = "";6 = "";7 = "";8 = "";} HPE Synergy Support - A [System.Collection.Hashtable] object, with Frame and Fabric Bay definitions. Accepted values are: * SEVC100F32 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVC40f8 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVCFC or SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy * SE20ILM - Synergy 20Gb Interconnect Link Module * SE10ILM - Synergy 10Gb Interconnect Link Module * SE12SAS - Synergy 12Gb SAS Connection Module $Bays = @{ Frame1 = @{Bay3 = "SEVC40f8"; Bay6 = "SE20ILM"}; Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8"} } Note: When configuring Synergy SAS Connection Module, no other device bays can be specified, and only a Single Frame can be configured.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>DdnsDomainNameSuffix</maml:name> <maml:description> <maml:para>When enabled, Domain Name System (DNS) server will be updated automatically when either the IP address or hostname change for the interconnect module.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>DownlinkSpeedMode</maml:name> <maml:description> <maml:para>Specify the port downlink speed to be configured for HPE Virtual Connect SE 100Gb F32 module for Synergy. Allowed values: * 25 * 50 Default: 25</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>EnableCutThroughSwitching</maml:name> <maml:description> <maml:para>Enables or disables the Cut-Through switching mode. When enabled, the switch starts forwarding the frame as soon as the switch has read the destination details in the packet header. When enabled, Pause flood protection is disabled. NOTE: This option is available for HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>EnableDdns</maml:name> <maml:description> <maml:para>When enabled, Domain Name System (DNS) server will be updated automatically when either the IP address or hostname change for the interconnect module. Must provide -DdnsDomainNameSuffix parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>EnableEnhancedLLDPTLV</maml:name> <maml:description> <maml:para>When enabled, the enclosure name and serial number are encapsulated in the Chassis ID TLV LLDPDU transmitted by interconnect uplink ports. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="C7000" aliases="FastMAC"> <maml:name>EnableFastMacCacheFailover</maml:name> <maml:description> <maml:para>When an uplink that was in standby mode becomes active, it can take several minutes for external Ethernet interconnects to recognize that the server blades can now be reached on this newly active connection. Enabling Fast MAC Cache Failover causes Ethernet packets to be transmitted on the newly active connection, which enables the external Ethernet interconnects to identify the new connection (and update their MAC caches). The transmission sequence is repeated a few times at the MAC refresh interval and completes in about 1 minute. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="IGMPSnoop"> <maml:name>EnableIgmpSnooping</maml:name> <maml:description> <maml:para>The IGMP snooping feature allows interconnects to monitor the IGMP IP multicast membership activities and configure hardware Layer 2 switching behavior of multicast traffic to optimize network resource usage. Currently, only IGMP v1 and v2 (RFC 2236) are supported. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>EnableLLDPTagging</maml:name> <maml:description> <maml:para>When enabled, tagged LLDP frames are transmitted over downlink ports to server hardware. The management IP address of the interconnect in the lowest numbered bay location in the logical interconnect will be advertised as the LLDP management address TLV. This parameter is only available for 2.00.07 or newer appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="LoopProtect"> <maml:name>EnableNetworkLoopProtection</maml:name> <maml:description> <maml:para>Enables or disables network loop protection. Network loop protection: The loop protection feature enables detection of loops on downlink ports, which can be Flex-10 logical ports or physical ports. The feature applies when Device Control Channel (DCC) protocol is running on the Flex-10 port. If DCC is not available, the feature applies to the physical downlink port. Network loop protection uses two methods to detect loops: 1. It periodically injects a special probe frame into the VC domain and monitors downlink ports for the looped back probe frame. If this special probe frame is detected on downlink ports, the port is considered to cause the loop condition. 2. It monitors and intercepts common loop detection frames used in other switches. In network environments where the upstream switches send loop detection frames, the VC interconnects must ensure that any downlink loops do not cause these frames to be sent back to the uplink ports. Even though the probe frames ensure loops are detected, there is a small time window depending on the probe frame transmission interval in which the loop detection frames from the external switch might loop through down link ports and reach uplink ports. By intercepting the external loop detection frames on downlinks, the possibility of triggering loop protection on the upstream switch is eliminated. When network loop protection is enabled, VC interconnects intercept loop detection frames from various switch vendors, such as Cisco and HP Networking. When the network loop protection feature is enabled, any probe frame or other supported loop detection frame received on a downlink port is considered to be causing the network loop, and the port is disabled immediately until an administrative action is taken. The administrative action involves resolving the loop condition and clearing the loop protection error condition. The loop detected status on a port can be cleared by un-assigning all networks from the profile connect corresponding to the port in the loop detected state. The SNMP agent supports trap generation when a loop condition is detected or cleared. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="PauseProtect"> <maml:name>EnablePauseFloodProtection</maml:name> <maml:description> <maml:para>Enables or disables pause flood protection. Pause flood protection: Ethernet switch interfaces use pause frame based flow control mechanisms to control data flow. When a pause frame is received on a flow control enabled interface, the transmit operation is stopped for the pause duration specified in the pause frame. All other frames destined for this interface are queued up. If another pause frame is received before the previous pause timer expires, the pause timer is refreshed to the new pause duration value. If a steady stream of pause frames is received for extended periods of time, the transmit queue for that interface continues to grow until all queuing resources are exhausted. This condition severely impacts the switch operation on other interfaces. In addition, all protocol operations on the switch are impacted because of the inability to transmit protocol frames. Both port pause and priority-based pause frames can cause the same resource exhaustion condition. VC interconnects provide the ability to monitor server downlink ports for pause flood conditions and take protective action by disabling the port. The default polling interval is 10 seconds and is not customer configurable. The SNMP agent supports trap generation when a pause flood condition is detected or cleared. This feature operates at the physical port level. When a pause flood condition is detected on a Flex-10 physical port, all Flex-10 logical ports associated with physical ports are disabled. When the pause flood protection feature is enabled, this feature detects pause flood conditions on server downlink ports and disables the port. The port remains disabled until an administrative action is taken. The administrative action involves the following steps: 1. Resolve the issue with the NIC on the server causing the continuous pause generation. This might include updating the NIC firmware and device drivers. Rebooting the server might not clear the pause flood condition if the cause of the pause flood condition is in the NIC firmware. In this case, the server must be completely disconnected from the power source to reset the NIC firmware. 2. Re-enable the disabled ports on the VC interconnect modules. Default value: Enabled</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>EnableStormControl</maml:name> <maml:description> <maml:para>Enables or disables the suppression of excessive inbound broadcast, multicast, or DLF (Destination Lookup Failure) packets when a threshold is reached. Default value: Disabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>FabricModuleType</maml:name> <maml:description> <maml:para>Specify the Synergy Fabric Module type the Logical Interconnect Group will be modeled for. Allowed value: * SEVC100F32 - Virtual Connect SE 100Gb F32 Module for Synergy * SEVC40F8 - Virtual Connect SE 40Gb F8 Module for Synergy * SEVCFC or SEVC16GbFC - Virtual Connect SE 16Gb FC Module for Synergy * SEVC32FC - Virtual Connect SE 32Gb FC Module for Synergy * SAS - Synergy 12Gb SAS Connection Module</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>FabricRedundancy</maml:name> <maml:description> <maml:para>Define the expected Synergy Fabric Interconnect Redundancy type. Allowed value: * HighlyAvailable * Redundant * ASide * BSide</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Redundant</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>FrameCount</maml:name> <maml:description> <maml:para>The number of Synergy Frames to participate in the Logical Stack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="IGMPIdle"> <maml:name>IgmpIdleTimeoutInterval</maml:name> <maml:description> <maml:para>The Group Membership Interval value, as specified by the IGMP v2 specification (RFC 2236). For optimum network resource usage, set the timeout interval to match your network"s multicast router settings. Data type: Numeric; unit of measure is seconds Default value: 260 Required: Yes, if IGMP snooping is enabled</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>260</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>IgmpVLANs</maml:name> <maml:description> <maml:para>Specify values or range of VLAN IDs, from 1-4094, associated with networks defined in the logical interconnect. Use comma or hyphens as separator, for example: 10-15, 52, 100-200.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import" aliases="i"> <maml:name>Import</maml:name> <maml:description> <maml:para>Specify JSON source file to create Logical Interconnect Group.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>InterconnectBaySet</maml:name> <maml:description> <maml:para>Which Synergy Interconnect Bay Set ID will the interconnects be populated in. Allowed value: * 1 - Interconnect Bay set 1 & 4 * 2 - Interconnect Bay set 2 & 5 * 3 - Interconnect Bay set 3 & 6</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>InterconnectConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>InternalNetworkConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>InternalNetworks</maml:name> <maml:description> <maml:para>An Array collection of Networks that will be marked as Internal only.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>LldpAddressingMode</maml:name> <maml:description> <maml:para>Specify the IP address format type to support. Allowed values: * IPv4 * IPv6 * IPv4AndIPv6</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="C7000" aliases="FastMACRefresh"> <maml:name>MacRefreshInterval</maml:name> <maml:description> <maml:para>The time interval at which MAC caches are refreshed Data type: Numeric; unit of measure is seconds Default value: 5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="ligname"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Interconnect Group Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>QoSConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="qos, QosConfig"> <maml:name>QosConfiguration</maml:name> <maml:description> <maml:para>A collection of QOS configurations that are created using the New-HPOVQosConfig helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>SNMP</maml:name> <maml:description> <maml:para>SNMP Settings to define SNMP configruation. Use New-HPOVSnmpConfiguration and New-HPOVSnmpTrapDestination Cmdlets to create the necessary SNMP Configuration object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>SNMPConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Synergy, C7000" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv1.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify the SNMP version type is SNMPv3.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>Provide the SNMPv3 user object from New-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>StormControlPacketsPerSecondThreshold</maml:name> <maml:description> <maml:para>The Storm Control packet threshold at which traffic is suppressed. Valid range: 1-262143 packets per second</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy" aliases="None"> <maml:name>StormControlPollingInterval</maml:name> <maml:description> <maml:para>When enabling Storm Control, Specify a value between 5 and 30 seconds.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Synergy, C7000" aliases="None"> <maml:name>UplinkSet</maml:name> <maml:description> <maml:para>A collection of uplink sets from New-HPOVUplinkSet using the -Passthru parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para>Hashtable containing Interconnect Bay layout and associated interconnect module</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Logical Interconnect Group creation async task</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>$Dest1 = New-HPOVSnmpTrapDestination -Destination mysnmpserver.domain.local -Community MyR3adcommun1ty -SnmpFormat SNMPv1 -TrapSeverities critical,warning $Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy "Other","PortStatus","PortThresholds" "Other","PortStatus" $SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0/22" -TrapDestinations $Dest1,$Dest2 $Bays = @{1 = "FlexFabric";2 = "FlexFabric"} New-HPOVLogicalInterconnectGroup "FlexFabric Production 1" -bays $Bays -snmp $SnmpConfig</dev:code> <dev:remarks> <dev:para>Create a Logical Interconnect Group with VC FlexFabric modules in Bays 1 and 2, and SNMP Settings</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$InternalNetworks = Get-HPOVNetwork -Name "My Internal VLANs*" New-HPOVLogicalInterconnectGroup -Name "Synergy VC Prod" -FrameCount 3 -InterconnectBaySet 3 -FabricModuleType "SEVC40F8" -Bays @{Frame1 = @{Bay3 = "SEVC40f8" ; Bay6 = "SE20ILM"};Frame2 = @{Bay3 = "SE20ILM"; Bay6 = "SEVC40f8" };Frame3 = @{Bay3 = "SE20ILM"; Bay6 = "SE20ILM"}} -FabricRedundancy "HighlyAvailable" -InternalNetworks $InternalNetworks</dev:code> <dev:remarks> <dev:para>Create a Synergy Virtual Connect multi-Frame Logical Interconnect Group resource, using Bay Set 3 and Synergy 20Gb Satellite modules.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -enableIgmpSnooping $True -igmpIdleTimeoutInterval 300 -LoopProtect $True</dev:code> <dev:remarks> <dev:para>Create a Logical Interconnect Group with VC Flex10/10D in Bays 1 and 2, FlexFabric modules in Bays 3 and 4, Enable IGMP Snooping, IGMP Idle timeout and LoopProtect</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVLogicalInterconnectGroup -Name "Synergy SAS Prod" -FrameCount 1 -InterconnectBaySet 1 -FabricModuleType "SAS" -Bays @{Frame1 = @{Bay1 = "SE12SAS" ; Bay4 = "SE12SAS"}}</dev:code> <dev:remarks> <dev:para>Create a Synergy SAS Logical Interconnect Group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVLogicalInterconnectGroup -Name "Synergy VC FC Prod" -FrameCount 1 -InterconnectBaySet 2 -FabricModuleType "SEVCFC" -Bays @{Frame1 = @{Bay2 = "SEVC16GbFC" ; Bay5 = "SEVC16GbFC"}}</dev:code> <dev:remarks> <dev:para>Create a Synergy Virtual Connect Fibre Channel Logical Interconnect Group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVLogicalInterconnectGroup -import c:\dir\mylig.json</dev:code> <dev:remarks> <dev:para>Create a Logical Interconnect Group by using a JSON formatted input file.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLOGICALJBOD--> <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"> <!--NEW-HPOVLOGICALJBOD--> <command:details> <command:name>New-HPOVLogicalJBOD</command:name> <maml:description> <maml:para>Create a new HPE Synergy Logical JBOD resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLogicalJBOD</command:noun> </command:details> <maml:description> <maml:para>A logical JBOD is a group of physical drives that are dynamically defined as virtual drives. Logical JBOD uses the drives from the drive enclosures that are installed in the device bays of the enclosure and are associated with a SAS logical interconnect. You can assign or unassign a logical JBOD to a server hardware through the server profile. If the logical drive settings in the server profile indicate that the data in the logical JBOD is to be retained when you delete the server profile, then the data is retained and you can assign this logical JBOD to a different server profile. Using this Cmdlet will create a new logical JBOD on the connected appliance. Considerations when configuring logical JBODs: * You can configure the available scopes to allow or restrict access to the drive enclosures. * You can assign a logical JBOD to only one server profile. * You can choose the drive enclosures that belong to the same SAS logical interconnect to create the logical JBOD. * You can create a logical JBOD using homogenous drives like SAS SSD, SAS HDD, SATA SSD, or SATA HDD. You cannot mix different types of drives in a logical JBOD. * You cannot add or remove drives to a logical JBOD after it is created. * You can choose to either erase or retain the drive data when you delete the logical JBOD by setting using the -EraseDataOnDelete parameter during the creation of a logical JBOD. You can change the Erase on delete settings later, using the Set-HPOVLogicalJBOD Cmdlet, only if you set -EraseDataOnDelete to True during creation. Minimum required privileges: Infrastructure administrator, server administrator, server profile architect, server profile administrator * A logical interconnect group is created with the interconnect type Synergy 12 GB SAS Connection Module. * An enclosure group is created with the above created logical interconnect group set as the Logical interconnect group. * A logical enclosure is created. A SAS logical interconnect is created as part of creating the logical enclosure. * If scopes have been defined, make sure that sufficient number of drive enclosures are mapped to the user scopes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLogicalJBOD</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a globally unique name for the logical JBOD resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, and not specifying the exact drives, you must provide either a SAS Logical Interconnect or HPE Synergy Frame resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType"> <maml:name>DriveType</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, specify the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Allowed value: * SAS * SATA * SASSSD * SATASSD * Auto NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk technology type with -DriveType or -AvailableDriveType is used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the number of drives the system should allocate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType"> <maml:name>MinDriveSize</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the minimum disk size in GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType"> <maml:name>MaxDriveSize</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the maximum disk size in GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>If set to True, and drives support erase on delete option, the drive enclosure will erase the data on the drives. This operation will take time, as the drive will not be added back into the available pool until the erase operation finishes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalJBOD</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a globally unique name for the logical JBOD resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives"> <maml:name>Drives</maml:name> <maml:description> <maml:para>Provide the specific drives to assign to the logical JBOD. Use the Get-HPOVDriveEnclosureInventory Cmdlet to identify the drives you wish to allocate to the new logical JBOD resource. Drives can be allocated from different HPE Synergy drive enclosures, but must reside within the same SAS Logical Interconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.Drive[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>If set to True, and drives support erase on delete option, the drive enclosure will erase the data on the drives. This operation will take time, as the drive will not be added back into the available pool until the erase operation finishes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalJBOD</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a globally unique name for the logical JBOD resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, and not specifying the exact drives, you must provide either a SAS Logical Interconnect or HPE Synergy Frame resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DriveSizeAndTechnology"> <maml:name>AvailableDriveType</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, specify the availabe drive type from Get-HPOVAvailableDriveType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.AvailableDriveType</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the number of drives the system should allocate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>If set to True, and drives support erase on delete option, the drive enclosure will erase the data on the drives. This operation will take time, as the drive will not be added back into the available pool until the erase operation finishes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalJBOD</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DriveSizeAndTechnology" aliases="None"> <maml:name>AvailableDriveType</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, specify the availabe drive type from Get-HPOVAvailableDriveType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.AvailableDriveType</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.AvailableDriveType</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType" aliases="None"> <maml:name>DriveType</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, specify the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Allowed value: * SAS * SATA * SASSSD * SATASSD * Auto NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk technology type with -DriveType or -AvailableDriveType is used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives" aliases="None"> <maml:name>Drives</maml:name> <maml:description> <maml:para>Provide the specific drives to assign to the logical JBOD. Use the Get-HPOVDriveEnclosureInventory Cmdlet to identify the drives you wish to allocate to the new logical JBOD resource. Drives can be allocated from different HPE Synergy drive enclosures, but must reside within the same SAS Logical Interconnect.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.Drive[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.Drive[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType" aliases="None"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>If set to True, and drives support erase on delete option, the drive enclosure will erase the data on the drives. This operation will take time, as the drive will not be added back into the available pool until the erase operation finishes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType" aliases="SasLogicalInterconnect, Enclosure, Frame"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, and not specifying the exact drives, you must provide either a SAS Logical Interconnect or HPE Synergy Frame resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType" aliases="None"> <maml:name>MaxDriveSize</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the maximum disk size in GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveType" aliases="None"> <maml:name>MinDriveSize</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the minimum disk size in GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a globally unique name for the logical JBOD resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DriveSizeAndTechnology, DriveType" aliases="None"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>When attempting to create a logical JBOD, you can specify the min and max drive size for the system to locate drive availability. Specify the number of drives the system should allocate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SpcificDrives, DriveSizeAndTechnology, DriveType" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>AllResourcesInScope</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.AvailableDriveType</maml:name> </dev:type> <maml:description> <maml:para>The available drive type from Get-HPOVAvailableDriveType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>$CreatedLogicalJbod = New-HPOVLogicalJbod -Name "MyLogicalJBOD1" ` -InputObject (Get-HPOVSasLogicalInterconnect -Name "LE1-SAS Synergy LIG-1" -ErrorAction Stop) ` -DriveType "SAS" ` -MinDriveSize 600 ` -NumberOfDrives 5 ` -EraseDataOnDelete $True | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a new logical JBOD specifying a SAS logical interconnect, requesting a specific drive media type, minimum size and number of drives.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$CreatedLogicalJbod = New-HPOVLogicalJbod -Name "MyLogicalJBOD1" ` -InputObject (Get-HPOVDriveEnclosure -Name "Frame1, bay 1" -ErrorAction Stop) ` -DriveType "SAS" ` -MinDriveSize 600 ` -NumberOfDrives 5 ` -EraseDataOnDelete $True | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a new logical JBOD specifying a SAS drive enclosure, requesting a specific drive media type, minimum size and number of drives.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Drives = Get-HPOVDriveEnclosureInventory -Available ` -SasLogicalInterconnect (Get-HPOVSasLogicalInterconnect -Name "LE1-SAS Synergy LIG-1" -ErrorAction Stop) | ? Capacity -eq 1200 $CreatedLogicalJbod = New-HPOVLogicalJbod -Name "MyLogicalJBOD2" ` -Drives $Drives ` -EraseDataOnDelete $True | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a new logical JBOD with specific drive bays from a SAS logical interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Drives = Get-HPOVDriveEnclosureInventory -Available ` -DriveEnclosure (Get-HPOVDriveEnclosure -Name "Frame1, bay 1" -ErrorAction Stop) | ? Capacity -eq 1200 $CreatedLogicalJbod = New-HPOVLogicalJbod -Name "MyLogicalJBOD2" ` -Drives $Drives ` -EraseDataOnDelete $True | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a new logical JBOD with specific drive bays from a specific drive enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosureInventory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLOGICALSWITCH--> <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"> <!--NEW-HPOVLOGICALSWITCH--> <command:details> <command:name>New-HPOVLogicalSwitch</command:name> <maml:description> <maml:para>Create a new Logical Switch resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLogicalSwitch</command:noun> </command:details> <maml:description> <maml:para>A logical switch is added into HPE OneView as a managed or monitored logical switch. The logical switch can consist of a maximum of two physical top-of-rack switches (external to the c7000 enclosure) configured in a single stacking domain. It is based on a logical switch group configuration. If the logical switch transitions to an Inconsistent with group state (because of changes in either the logical switch or the logical switch group), update the logical switch configuration based on the logical switch group to return to a consistent state. You can create a logical switch with a maximum of two Cisco Nexus switches. When there are two Cisco Nexus switches in a logical switch, they are expected to be in a virtual port channel (vPC) environment. vPC must be configured on both switches, and they should belong to the same vPC domain. For information about supported switches, see the Hewlett Packard Enterprise Information Library for supportability information. Before you add a logical switch as managed, consider the following for Fabric Extender and Virtual Connect interconnects physically connected to the logical switch: * When only IPv4 Ethernet networks are assigned to an uplink set at creation time, the uplink set can be physically connected to any upstream switch in the logical switch. * When an FCoE network is assigned to an uplink set at creation time, the uplink set is limited to single-homed physical connectivity and all uplink ports must connect to the same upstream switch in the logical switch. If a port is subsequently added to the uplink set with an FCoE network or an existing port in the uplink set is connected to a second upstream switch, that port is not available for configuration and an alert is generated. If a new port added to the uplink set is connected to the same switch as the other ports, that port is available to carry traffic and an alert is not generated. To change an uplink set from single-homed connectivity to multi-homed connectivity or vice-versa, the uplink set configuration must be deleted and re-created with the appropriate network assignments and physical configuration. * Make sure that LLDP is enabled on the top-of-rack switch internal (downlink) ports where Virtual Connect interconnects under HPE OneView management are connected. Adding a logical switch as monitored enables HPE OneView to monitor the logical switch for operation status, collect statistics, and alert users to specific conditions and incompatibilities between the switch and Fabric Extender or Virtual Connect interconnect. In the monitored mode, deployment of the server profile connections is supported for HPE Virtual Connect interconnects but not for Fabric Extender (FEX) interconnects. Logical switch configuration guidelines * When Virtual Connect interconnects are connected to a logical switch, an uplink set cannot span multiple interconnects. This limitation is similar to FEX interconnects. However, multiple uplink sets are supported on a single Virtual Connect interconnect. * When you enable or disable a top-of-rack switch internal port, the associated port on a FEX interconnect also displays the updated port status. * When retrieving MAC addresses for FEX interconnects, only the entries that are associated with the managed FEX interconnects are displayed. * If an FCoE network is assigned to an uplink set that is configured as dual-homed, (an invalid configuration), that FCoE network is not provisioned on the switch. Deployment of any server profile connection with this FCoE network will fail. * When a logical switch is defined and configured with only a single physical switch, the uplink set associated with any FEX module connected to this logical switch is considered single-homed. Therefore, you can add an FCoE network to the uplink set even if the uplink set was initially created only with Ethernet networks. Deployment of any server profile connection with this FCoE network will succeed. * For server profiles created for server ports connected to FEX interconnects, Ethernet networks are only supported on physical function a, and FCoE networks are only supported on physical function b at the server port. When both physical functions have connections defined, traffic is split evenly across both ports. * If HPE OneView cannot log in to the switch, a critical alert is generated. Prevent any event on the switch that might trigger switch configuration; otherwise, the switch transitions to ConfigError state and you must reapply the configuration on the associated logical interconnects to recover. * If HPE OneView is unable to claim a member switch of the logical switch when the operational mode of the logical switch is Managed, the operating state of the switch will transition to Added with Error. In this case, the Message of the Day (MOTD) banner on the switch will indicate that the switch is currently claimed by another HPE OneView appliance and the message "This switch is being controlled by OneView Domain, Appliance ID: {}" displays. You should remove the logical switch from that HPE OneView appliance, and then perform a refresh on the logical switch from the current HPE OneView appliance to re-initiate the claim operation. * HPE OneView does not fully automate configuration of FCoE connectivity on the switch specified in the logical switch. For each FCoE network specified in the uplink set, HPE OneView only provisions the VLAN for that network on the switch. Network administrators must provision additional configuration for FCoE connectivity manually on the switch in addition to what HPE OneView provisions. * To deploy server profile connections to a FEX interconnect, HPE OneView provisions the virtual Fibre Channel interface (VFC), VFC binding to FEX downlink port, and VSAN interface assignment on the switch. * For the deployment of server profile connections for a Virtual Connect interconnect, the Network administrator must configure the virtual Fibre Channel interface (vFC), VFC binding to server port, and VSAN interface assignment binding manually. * When a Nexus switch expansion module is removed, a warning alert is generated unless the module is powered off. * HPE OneView can detect configuration changes that occur on the switches specified in the logical switch when it no longer matches the configuration that HPE OneView provisions. Warning alerts are generated. Administrators can correct the configuration manually or reapply the configuration on the associated logical interconnects to recover. Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>LogicalSwitchGroup</maml:name> <maml:description> <maml:para>Provide the Logical Switch Group policy object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedSnmpV3, Managed"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Managed resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch1Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshUserName</maml:name> <maml:description> <maml:para>The SSH account name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshPassword</maml:name> <maml:description> <maml:para>Password of the SSH User. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>SnmpCommunity</maml:name> <maml:description> <maml:para>Specify the SNMPv1 Community name. This parameter is not used if needing to configure SNMPv3.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch2Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SnmpPort</maml:name> <maml:description> <maml:para>The UDP port SNMP is configured to listen on the target Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 is available. Otherwise, use the -SNMPv3 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>LogicalSwitchGroup</maml:name> <maml:description> <maml:para>Provide the Logical Switch Group policy object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, Monitored"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Monintored resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch1Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshUserName</maml:name> <maml:description> <maml:para>The SSH account name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshPassword</maml:name> <maml:description> <maml:para>Password of the SSH User. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch2Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SnmpPort</maml:name> <maml:description> <maml:para>The UDP port SNMP is configured to listen on the target Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 is available. Otherwise, use the -SNMPv1 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>Specify the SNMPv3 Username.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>Defines the security levels supported by SNMPv3: * Auth - Communication with authorization and without privacy. Messages are authenticated but not encrypted. * AuthAndPrive - Communication with authorization as well as privacy. Messages are authenticated as well as encrypted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>The protocol used for Authentication are either MD5 (Message Digest 5) or SHA (Secure Hash Algorithm).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 Authorization Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>The protocols used to encrypt the messages are Data Encryption Standard (DES56) or Advanced Encryption Standard (AES128).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>LogicalSwitchGroup</maml:name> <maml:description> <maml:para>Provide the Logical Switch Group policy object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedSnmpV3, Managed"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Managed resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch1Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshUserName</maml:name> <maml:description> <maml:para>The SSH account name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshPassword</maml:name> <maml:description> <maml:para>Password of the SSH User. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch2Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SnmpPort</maml:name> <maml:description> <maml:para>The UDP port SNMP is configured to listen on the target Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 is available. Otherwise, use the -SNMPv1 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>Specify the SNMPv3 Username.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>Defines the security levels supported by SNMPv3: * Auth - Communication with authorization and without privacy. Messages are authenticated but not encrypted. * AuthAndPrive - Communication with authorization as well as privacy. Messages are authenticated as well as encrypted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>The protocol used for Authentication are either MD5 (Message Digest 5) or SHA (Secure Hash Algorithm).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 Authorization Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>The protocols used to encrypt the messages are Data Encryption Standard (DES56) or Advanced Encryption Standard (AES128).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>LogicalSwitchGroup</maml:name> <maml:description> <maml:para>Provide the Logical Switch Group policy object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, Monitored"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Monintored resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch1Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshUserName</maml:name> <maml:description> <maml:para>The SSH account name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SshPassword</maml:name> <maml:description> <maml:para>Password of the SSH User. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>SnmpCommunity</maml:name> <maml:description> <maml:para>Specify the SNMPv1 Community name. This parameter is not used if needing to configure SNMPv3.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Switch2Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>SnmpPort</maml:name> <maml:description> <maml:para>The UDP port SNMP is configured to listen on the target Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 is available. Otherwise, use the -SNMPv3 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>LogicalSwitchGroup</maml:name> <maml:description> <maml:para>Provide the Logical Switch Group policy object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagedSnmpV3, Managed" aliases="None"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Managed resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, Monitored" aliases="None"> <maml:name>Monitored</maml:name> <maml:description> <maml:para>Specify if the Logical Switch will be a Monintored resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Logical Switch resource. Supports wildcard * character.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>Defines the security levels supported by SNMPv3: * Auth - Communication with authorization and without privacy. Messages are authenticated but not encrypted. * AuthAndPrive - Communication with authorization as well as privacy. Messages are authenticated as well as encrypted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 Authorization Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>The protocol used for Authentication are either MD5 (Message Digest 5) or SHA (Secure Hash Algorithm).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed" aliases="None"> <maml:name>SnmpCommunity</maml:name> <maml:description> <maml:para>Specify the SNMPv1 Community name. This parameter is not used if needing to configure SNMPv3.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>SnmpPort</maml:name> <maml:description> <maml:para>The UDP port SNMP is configured to listen on the target Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Password. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>The protocols used to encrypt the messages are Data Encryption Standard (DES56) or Advanced Encryption Standard (AES128).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>Specify the SNMPv3 Username.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Monitored, Managed" aliases="None"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 is available. Otherwise, use the -SNMPv3 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3" aliases="None"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 is available. Otherwise, use the -SNMPv1 switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>SshPassword</maml:name> <maml:description> <maml:para>Password of the SSH User. Either [System.String] or [System.Security.SecureString] values are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>SshUserName</maml:name> <maml:description> <maml:para>The SSH account name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>Switch1Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MonitoredSnmpV3, ManagedSnmpV3, Monitored, Managed" aliases="None"> <maml:name>Switch2Address</maml:name> <maml:description> <maml:para>IP Address or FQDN of first Switch resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Switch Group resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitch [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Logical Switch resource.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.LogicalSwitch></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Logical Switch resources.</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>$LogicalSwitchGroup = Get-HPOVLogicalSwitchGroup -Name "My Nexus 5500 Switch Group Policy" $SshPassword = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force New-HPOVLogicalSwitch -Name "My Logical Switch 1" -LogicalSwitchGroup $LogicalSwitchGroup -Monitored -Switch1Address 10.1.1.1 -Switch2Address 10.1.1.2 -SshUserName admin -SshPassword $SshPassword -Snmpv1 -SnmpCommunity MyCommunity</dev:code> <dev:remarks> <dev:para>Create the "My Logical Switch 1" as a Monitored Logical Switch resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LogicalSwitchGroup = Get-HPOVLogicalSwitchGroup -Name "My Nexus 6001 Switch Group Policy" $Password = ConvertTo-SecureString -String "MyPassword" -AsPlainText -Force $Results = New-HPOVLogicalSwitch -Name "My Logical Switch 2" -LogicalSwitchGroup $LogicalSwitchGroup -Managed -Switch1Address 10.1.2.1 -Switch2Address 10.1.2.2 -SshUserName admin-SshPassword $Password -Snmpv3 -SnmpUserName SnmpV3User -SnmpAuthLevel AuthAndPriv -SnmpAuthProtocol SHA -SnmpAuthPassword $Password -SnmpPrivProtocol aes128 -SnmpPrivPassword $Password -Async</dev:code> <dev:remarks> <dev:para>Create the "My Logical Switch 2" as a Managed Logical Switch resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVLOGICALSWITCHGROUP--> <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"> <!--NEW-HPOVLOGICALSWITCHGROUP--> <command:details> <command:name>New-HPOVLogicalSwitchGroup</command:name> <maml:description> <maml:para>Create a new Logical Switch Group resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVLogicalSwitchGroup</command:noun> </command:details> <maml:description> <maml:para>The logical switch group is a template for creating logical switches. Logical switches are an aggregation of up to two physical top-of-rack switches. Once constructed from a logical switch group, a logical switch continues to be associated with its logical switch group. Any change in consistency between the logical switch group and its associated logical switches is monitored and made visible on the associated logical switch screen in HPE OneView. This Cmdlet will help create a Logical Switch Group resources. Use Get-HPOVSwitchType to identify which switch family and models are supported. Please refer to either Get-HPOVSwitchType values, or the HPE OneView Support Matrix for which specific models are supported. Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVLogicalSwitchGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Switch Group resource Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>SwitchType</maml:name> <maml:description> <maml:para>The Switch Type resource from Get-HPOVSwitchType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Networking.SwitchType</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NumberOfSwitches</maml:name> <maml:description> <maml:para>The maximum number of switches supported in the Logical Switch Group. Only 1 or 2 are allowed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Logical Switch Group resource Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NumberOfSwitches</maml:name> <maml:description> <maml:para>The maximum number of switches supported in the Logical Switch Group. Only 1 or 2 are allowed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>SwitchType</maml:name> <maml:description> <maml:para>The Switch Type resource from Get-HPOVSwitchType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Networking.SwitchType</command:parameterValue> <dev:type> <maml:name>HPOneView.Networking.SwitchType</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.SwitchType</maml:name> </dev:type> <maml:description> <maml:para>Switch Type resource from Get-HPOVSwitchType.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object to monitor (if -Async was used) or results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of remove Logical Switch async task resources.</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>Get-HPOVSwitchType -Name "Cisco Nexus 56xx" | New-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1" -NumberOfSwitches 2</dev:code> <dev:remarks> <dev:para>Create a Logical Switch Group fro the "Cisco Nexus 5600" series, specifying 2 expected switches.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVNETWORK--> <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"> <!--NEW-HPOVNETWORK--> <command:details> <command:name>New-HPOVNetwork</command:name> <maml:description> <maml:para>Creates one or more new Ethernet or Fibre-Channel networks on the appliance.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVNetwork</command:noun> </command:details> <maml:description> <maml:para>Create a new network resource, including its default connection type. Network definitions can be supplied as direct Cmdlet parameters or as input from a file containing the network definition in JSON format. To create an Ethernet Network for Image Streamer, use the following paramters: * Name * VlanType = Untagged * IPv4Subnet Object * Purpose = Management</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Name</maml:name> <maml:description> <maml:para>Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Type</maml:name> <maml:description> <maml:para>Required value that specifies the type of Network Resource to create. Allowed values are: * Ethernet * FC * FibreChannel * FCoE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, FCOE"> <maml:name>VlanId</maml:name> <maml:description> <maml:para>The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be changed once the network has been created. When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>NetworkSet</maml:name> <maml:description> <maml:para>Specify one or more network set objects the network should be added to during creation from Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>VLANType</maml:name> <maml:description> <maml:para>The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not the Network Set it could be assigned to. Accepted values are * Tagged * Tunnel * Access Default value is Tagged.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>A description of the network"s role within the logical interconnect. Accepted values in string format are: * General * Management * VMMigration * FaultTolerance * iSCSI</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>SmartLink</maml:name> <maml:description> <maml:para>Default value is TRUE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>PrivateNetwork</maml:name> <maml:description> <maml:para>Default value is FALSE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Name</maml:name> <maml:description> <maml:para>Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange"> <maml:name>VlanRange</maml:name> <maml:description> <maml:para>VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both. e.g. -VLANRange "10-90,94,96,200-210"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Type</maml:name> <maml:description> <maml:para>Required value that specifies the type of Network Resource to create. Allowed values are: * Ethernet * FC * FibreChannel * FCoE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>VLANType</maml:name> <maml:description> <maml:para>The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not the Network Set it could be assigned to. Accepted values are * Tagged * Tunnel * Access Default value is Tagged.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>A description of the network"s role within the logical interconnect. Accepted values in string format are: * General * Management * VMMigration * FaultTolerance * iSCSI</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>SmartLink</maml:name> <maml:description> <maml:para>Default value is TRUE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet"> <maml:name>PrivateNetwork</maml:name> <maml:description> <maml:para>Default value is FALSE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Name</maml:name> <maml:description> <maml:para>Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Type</maml:name> <maml:description> <maml:para>Required value that specifies the type of Network Resource to create. Allowed values are: * Ethernet * FC * FibreChannel * FCoE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, FCOE"> <maml:name>VlanId</maml:name> <maml:description> <maml:para>The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be changed once the network has been created. When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FCOE, FC"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>Managed SAN Object or Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Name</maml:name> <maml:description> <maml:para>Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC"> <maml:name>Type</maml:name> <maml:description> <maml:para>Required value that specifies the type of Network Resource to create. Allowed values are: * Ethernet * FC * FibreChannel * FCoE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>LinkStabilityTime</maml:name> <maml:description> <maml:para>The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>AutoLoginRedistribution</maml:name> <maml:description> <maml:para>Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available). True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually. This parameter is not applicable for Direct Attach Fabric Types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>FabricType</maml:name> <maml:description> <maml:para>Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FCOE, FC"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>Managed SAN Object or Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Full path and file name of a JSON formatted input file containing network definitions.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="None"> <maml:name>AutoLoginRedistribution</maml:name> <maml:description> <maml:para>Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available). True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually. This parameter is not applicable for Direct Attach Fabric Types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="None"> <maml:name>FabricType</maml:name> <maml:description> <maml:para>Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>FabricAttach</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile" aliases="i, import"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Full path and file name of a JSON formatted input file containing network definitions.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="None"> <maml:name>LinkStabilityTime</maml:name> <maml:description> <maml:para>The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FCOE, FC" aliases="None"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>Managed SAN Object or Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet" aliases="None"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>20000</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>NetworkSet</maml:name> <maml:description> <maml:para>Specify one or more network set objects the network should be added to during creation from Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet" aliases="None"> <maml:name>PrivateNetwork</maml:name> <maml:description> <maml:para>Default value is FALSE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet" aliases="None"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>A description of the network"s role within the logical interconnect. Accepted values in string format are: * General * Management * VMMigration * FaultTolerance * iSCSI</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>General</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, VLANIDRange, FCOE, FC, Ethernet" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet" aliases="None"> <maml:name>SmartLink</maml:name> <maml:description> <maml:para>Default value is TRUE.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, VLANIDRange, FCOE, FC" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Required value that specifies the type of Network Resource to create. Allowed values are: * Ethernet * FC * FibreChannel * FCoE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Ethernet</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FC, FCOE, VLANIDRange, Ethernet" aliases="None"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>2500</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange, Ethernet" aliases="None"> <maml:name>VLANType</maml:name> <maml:description> <maml:para>The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not the Network Set it could be assigned to. Accepted values are * Tagged * Tunnel * Access Default value is Tagged.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Tagged</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet, FCOE" aliases="None"> <maml:name>VlanId</maml:name> <maml:description> <maml:para>The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be changed once the network has been created. When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VLANIDRange" aliases="None"> <maml:name>VlanRange</maml:name> <maml:description> <maml:para>VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both. e.g. -VLANRange "10-90,94,96,200-210"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>ManagedSan resource object to be assigned to a FC or FCoE Network</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A custom status object or array of objects containing the following PsCustomObject keys: * Name - name of the network object attempted to be created * Status - status of the creation attempt (Failed for http error return; Complete if a task object is returned) * Description - Task object or Error object * Exception - System.Management.Automation.ErrorRecord object of the error generated</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>New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500</dev:code> <dev:remarks> <dev:para>Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, and specifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s. Network will be created on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance MyAppliance</dev:code> <dev:remarks> <dev:para>Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on "MyAppliance"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Connection1 = Connect-HPOVMgmt MyAppliance1.domain.local Administrator MyPassword $Connection2 = Connect-HPOVMgmt MyAppliance2.domain.local Administrator MyPassword New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance $Connection1,$Connection2</dev:code> <dev:remarks> <dev:para>Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on "MyAppliance1" and "MyAppliance2" using the connection objects.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }</dev:code> <dev:remarks> <dev:para>Create multiple Ethernet Networks.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ } 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }</dev:code> <dev:remarks> <dev:para>Create Ethernet Networks for an Active/Active configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetwork -name "VLAN A Side" -vlanRange "10,20,30,40,50,60" New-HPOVNetwork -name "VLAN B Side" -VlanRange "10,20,30,40,50,60"</dev:code> <dev:remarks> <dev:para>Create Ethernet Networks for an Active/Active configuration using the -VlanRange parameter.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000</dev:code> <dev:remarks> <dev:para>Creates a new FC network type, called "Fabric A" and preferred bandwidth is 2Gb/s and max is 4Gb/s.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000 -fabricType FabricAttach -managedSAN Fabric_A</dev:code> <dev:remarks> <dev:para>Creates a new FC network type, called "Fabric A", preferred bandwidth is 2Gb/s and max is 4Gb/s, and is associated with a Managed SAN Fabric.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"</dev:code> <dev:remarks> <dev:para>Creates the network(s) defined in the input file myNewNets.json</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVNETWORKSET--> <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"> <!--NEW-HPOVNETWORKSET--> <command:details> <command:name>New-HPOVNetworkSet</command:name> <maml:description> <maml:para>Create a new Network Set.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVNetworkSet</command:noun> </command:details> <maml:description> <maml:para>A network set is a group of Ethernet L2/L3 networks assigned to one or more connections, giving each single connection access to multiple networks. A network set is a shared resource available to all logical interconnects. It is directly associated with a connection template governing the bandwidth permitted to connections that use the network set. Within a network set, all network frames are exchanged over the connection with their 802.1Q VLAN ID in place (in other words, network traffic is tagged with its VLAN ID). However, there is one exception to this rule: one network within the network set can be designated as the 'nativeNetwork'. The 802.1Q VLAN ID is removed from 'nativeNetwork' traffic egressing the interconnect downlink (in other words, 'nativeNetwork' traffic is untagged). This allows a single connection to support multiple tagged networks plus a single untagged network over the same downlink. All Ethernet networks in a network set must have unique VLAN IDs. This Cmdlet will create a new Network Set resource. Minimum required permissions: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVNetworkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Network Set resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Ethernet Network Name(s), URI(")s or Resource Object(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>Network (from the above list) to be considered the "native" network in this set. Traffic on this network will leave the Virtual Connect downlink port untagged. When untagged traffic is received on this port, it will be mapped to this network.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Large</maml:name> <maml:description> <maml:para>A "Regular" network set may contain up to 162 networks. "Large" network sets can contain up to 4000 networks and can only be used by server profile template connections or server profile connections assigned to rackmount or HPE Synergy server hardware. By default, "Regular" Network Sets are created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="5" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Large</maml:name> <maml:description> <maml:para>A "Regular" network set may contain up to 162 networks. "Large" network sets can contain up to 4000 networks and can only be used by server profile template connections or server profile connections assigned to rackmount or HPE Synergy server hardware. By default, "Regular" Network Sets are created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="None"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>10000</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Network Set resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="networkUris"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Ethernet Network Name(s), URI(")s or Resource Object(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>2500</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="untagged, native, untaggedNetworkUri"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>Network (from the above list) to be considered the "native" network in this set. Traffic on this network will leave the Virtual Connect downlink port untagged. When untagged traffic is received on this port, it will be mapped to this network.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If bandwidth settings are specified, the newly created Network Set resource is returned</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If no bandwidth settings specified, an async task object is returned</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>New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow</dev:code> <dev:remarks> <dev:para>Create a new Network Set called "Production Networks", adding Ethernet Networks "blue", "green", and "yellow", on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$networks = "blue","green","yellow" | % { Get-HPOVNetwork $_ -type Ethernet } New-HPOVNetworkSet -name "Production Networks" -Networks $networks -UntaggedNetwork $networks[1]</dev:code> <dev:remarks> <dev:para>Get Ethernet Networks "blue", "green", and "yellow", then create a new Network Set, with "Green" as the UntaggedNetowrk for the specified appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVNetworkSet -name "Production Networks" -untaggedNetwork yellow -networks blue, green, yellow -TypicalBandwidth 1000 -MaximumBandwidth 5000</dev:code> <dev:remarks> <dev:para>Create a new Network Set called "Production Networks", adding Ethernet Networks "blue", "green", and "yellow", setting the Typical and Maximum Bandwidth.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVOSDEPLOYMENTSERVER--> <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"> <!--NEW-HPOVOSDEPLOYMENTSERVER--> <command:details> <command:name>New-HPOVOSDeploymentServer</command:name> <maml:description> <maml:para>Create a new HPE Synergy OS Deployment Server.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVOSDeploymentServer</command:noun> </command:details> <maml:description> <maml:para>An OS deployment server is a resource that enables you to deploy (install and configure) operating systems for use by servers. HPE OneView connects to an OS deployment server and configures it for deploying operating systems. HPE OneView manages the OS deployment server after it is configured and displays the list of attributes, management settings, the OS deployment plans, and the server profiles that reference the available OS deployment plans. To create an OS Deployment Server, HPE Synergy Image Streamer appliances must be installed into managed or monitored Synergy Frames, a Management Network created with an association to an IPv4 address pool Subnet, and available IP Addresses within the pool.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVOSDeploymentServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS Deployment resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE Synergy Image Streamer appliance. Can be any Image Streamer resource object from Get-HPOVImageStreamerAppliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManagementNetwork</maml:name> <maml:description> <maml:para>Either a Tagged or Untagged Ethernet Network associated with an IPv4 address pool Subnet. Subnet must be in the same IPv4 Address Network ID as the HPE Synergy Composer IPv4 Address(es).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the OS Deployment Server resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the OS Deployment Server resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="ImageStreamer, I3S"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE Synergy Image Streamer appliance. Can be any Image Streamer resource object from Get-HPOVImageStreamerAppliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManagementNetwork</maml:name> <maml:description> <maml:para>Either a Tagged or Untagged Ethernet Network associated with an IPv4 address pool Subnet. Subnet must be in the same IPv4 Address Network ID as the HPE Synergy Composer IPv4 Address(es).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>OS Deployment resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject [HPOneView.Appliance.ImageStreamerAppliance]</maml:name> </dev:type> <maml:description> <maml:para>HPE Synergy Image Streamer Appliance object from Get-HPOVImageStreamerAppliance.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for modifying the Remote Support Collection schedules.</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>$ManagementNetwork = Get-HPOVNetwork -Type Ethernet -Name "Deployment Network" Get-HPOVImageStreamerAppliance | Select -First 1 | New-HPOVOSDeploymentServer -Name "MY OS Deployment Server" -ManagementNetwork $ManagementNetwork</dev:code> <dev:remarks> <dev:para>Get the Ethernet network resource object, then pass via the pipeline the first HPE Synergy Image Streamer object, and create a new OS Deployment Server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVQOSCONFIG--> <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"> <!--NEW-HPOVQOSCONFIG--> <command:details> <command:name>New-HPOVQosConfig</command:name> <maml:description> <maml:para>Create QoS Configuration Object</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVQosConfig</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet provides the capability to create a new Logical Interconnect Group or Logical Interconnect QoS Configuration object. TrafficClassifiers are created using the New-HPOVQosTrafficClass helper Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVQosConfig</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Passthrough"> <maml:name>ConfigType</maml:name> <maml:description> <maml:para>The QOS Configuration Type. Allowed values are: * Passthrough (Default) - All ingress packets are not classified at egress. FCoE packets having a separate PG (Priority Group) are processed at ingress. There are no traffic classes, maps, or rules applied. Passthrough mode is equivalent to no QoS (QoS disabled). * CustomNoFCoE - Enables QoS and allows a customized configuration without FCoE. The configuration defines one system class (Best Effort). You can configure up to seven additional classes for non-FCoE Ethernet traffic. * CustomWithFCoE - Enables QoS and allows a customized configuration that includes FCoE class. The configuration defines two default system classes, Best Effort and FCoE Lossless. FCoE Lossless class cannot be edited by the user and is pre-configured for 50% bandwidth of the port. You can also configure up to six additional classes for non-FCoE Ethernet traffic.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVQosConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Passthrough"> <maml:name>ConfigType</maml:name> <maml:description> <maml:para>The QOS Configuration Type. Allowed values are: * Passthrough (Default) - All ingress packets are not classified at egress. FCoE packets having a separate PG (Priority Group) are processed at ingress. There are no traffic classes, maps, or rules applied. Passthrough mode is equivalent to no QoS (QoS disabled). * CustomNoFCoE - Enables QoS and allows a customized configuration without FCoE. The configuration defines one system class (Best Effort). You can configure up to seven additional classes for non-FCoE Ethernet traffic. * CustomWithFCoE - Enables QoS and allows a customized configuration that includes FCoE class. The configuration defines two default system classes, Best Effort and FCoE Lossless. FCoE Lossless class cannot be edited by the user and is pre-configured for 50% bandwidth of the port. You can also configure up to six additional classes for non-FCoE Ethernet traffic.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom"> <maml:name>UplinkClassificationType</maml:name> <maml:description> <maml:para>Configure the Uplink QOS Marking classification type. * DOT1P (Default) * DSCP * DOT1P_AND_DSCP</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom"> <maml:name>DownlinkClassificationType</maml:name> <maml:description> <maml:para>Configure the Downlink QOS Marking classification type. * DOT1P * DSCP * DOT1P_AND_DSCP (Default)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom"> <maml:name>TrafficClassifiers</maml:name> <maml:description> <maml:para>A collection of traffic classes created using the New-HPOVQosTrafficClass.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">ArrayList</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom, Passthrough" aliases="None"> <maml:name>ConfigType</maml:name> <maml:description> <maml:para>The QOS Configuration Type. Allowed values are: * Passthrough (Default) - All ingress packets are not classified at egress. FCoE packets having a separate PG (Priority Group) are processed at ingress. There are no traffic classes, maps, or rules applied. Passthrough mode is equivalent to no QoS (QoS disabled). * CustomNoFCoE - Enables QoS and allows a customized configuration without FCoE. The configuration defines one system class (Best Effort). You can configure up to seven additional classes for non-FCoE Ethernet traffic. * CustomWithFCoE - Enables QoS and allows a customized configuration that includes FCoE class. The configuration defines two default system classes, Best Effort and FCoE Lossless. FCoE Lossless class cannot be edited by the user and is pre-configured for 50% bandwidth of the port. You can also configure up to six additional classes for non-FCoE Ethernet traffic.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Passthrough</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom" aliases="None"> <maml:name>DownlinkClassificationType</maml:name> <maml:description> <maml:para>Configure the Downlink QOS Marking classification type. * DOT1P * DSCP * DOT1P_AND_DSCP (Default)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>DOT1P_AND_DSCP</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom" aliases="None"> <maml:name>TrafficClassifiers</maml:name> <maml:description> <maml:para>A collection of traffic classes created using the New-HPOVQosTrafficClass.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">ArrayList</command:parameterValue> <dev:type> <maml:name>ArrayList</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Custom" aliases="None"> <maml:name>UplinkClassificationType</maml:name> <maml:description> <maml:para>Configure the Uplink QOS Marking classification type. * DOT1P (Default) * DSCP * DOT1P_AND_DSCP</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>DOT1P</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.QosConfiguration [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>QoS Configuration object</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>$QosConfig = New-HPOVQosConfig CustomWithFCoE DSCP DOT1P_AND_DSCP $TrafficClassifiers New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -enableIgmpSnooping $True -igmpIdleTimeoutInterval 300 -LoopProtect $True -QosConfig $QosConfig</dev:code> <dev:remarks> <dev:para>Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVQOSTRAFFICCLASS--> <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"> <!--NEW-HPOVQOSTRAFFICCLASS--> <command:details> <command:name>New-HPOVQosTrafficClass</command:name> <maml:description> <maml:para>Create QoS Traffic Classifier Object</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVQosTrafficClass</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet provides the capability to create a new QoS Traffic Classifier Object, which can then be added to either a Logical Interconnect Group, or Logica Interconnect resource. Only non-FCoE Traffic Classifiers are allowed to be created. When creating the "Best effort" Traffic Classifier, only the MaxBandwidth parameter is allowed to be modified.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVQosTrafficClass</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the QoS Classifier. Value cannot be "FCoE lossless". If value is "Best effort", only the MaxBandwidth Parameter is allowed to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>MaxBandwidth</maml:name> <maml:description> <maml:para>Maximum share the traffic class can use when other traffic classes are not using their guaranteed share. The max share and the % share for a real time class must be equal and not exceed 50%. For other classes, the max share is greater than or equal to the % share. Value between 1 and 100</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>BandwidthShare</maml:name> <maml:description> <maml:para>Minimum guaranteed bandwidth for the traffic class. The % share and the max share for a real time class must be equal and not exceed 50%. Value between 1 and 100</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>EgressDot1pValue</maml:name> <maml:description> <maml:para>Specifies the dot1p priority value to remark for the egressing packets. This provides flexibility to control priority treatment for packets at the next hops based on the remarked dot1p value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>IngressDot1pClassMapping</maml:name> <maml:description> <maml:para>Specify an array of ingress Dot1p values, and to which traffic class it is currently mapped. Allowed values: * 0 * 1 * 2 * 3 * 4 * 5 * 5 * 6 * 7</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>IngressDscpClassMapping</maml:name> <maml:description> <maml:para>Specify an array of DSCP class mappings, per RFC 2475. Allowed values: * DSCP 0, CS0 * DSCP 10, AF11 * DSCP 12, AF12 * DSCP 14, AF13 * DSCP 8, CS1 * DSCP 18, AF21 * DSCP 20, AF22 * DSCP 22, AF23 * DSCP 26, AF31 * DSCP 28, AF32 * DSCP 30, AF33 * DSCP 34, AF41 * DSCP 36, AF42 * DSCP 38, AF43 * DSCP 16, CS2 * DSCP 24, CS3 * DSCP 32, CS4 * DSCP 46, EF * DSCP 40, CS5 * DSCP 48, CS6 * DSCP 56, CS7</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>RealTime</maml:name> <maml:description> <maml:para>Specifies whether the traffic class is real time. Only 1 traffic class can be real time. Enabling real time for this class removes the real time flag for other classes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specify to Enable the traffic class. By default, the class is disabled, even though it is defined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>BandwidthShare</maml:name> <maml:description> <maml:para>Minimum guaranteed bandwidth for the traffic class. The % share and the max share for a real time class must be equal and not exceed 50%. Value between 1 and 100</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>EgressDot1pValue</maml:name> <maml:description> <maml:para>Specifies the dot1p priority value to remark for the egressing packets. This provides flexibility to control priority treatment for packets at the next hops based on the remarked dot1p value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specify to Enable the traffic class. By default, the class is disabled, even though it is defined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>IngressDot1pClassMapping</maml:name> <maml:description> <maml:para>Specify an array of ingress Dot1p values, and to which traffic class it is currently mapped. Allowed values: * 0 * 1 * 2 * 3 * 4 * 5 * 5 * 6 * 7</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>IngressDscpClassMapping</maml:name> <maml:description> <maml:para>Specify an array of DSCP class mappings, per RFC 2475. Allowed values: * DSCP 0, CS0 * DSCP 10, AF11 * DSCP 12, AF12 * DSCP 14, AF13 * DSCP 8, CS1 * DSCP 18, AF21 * DSCP 20, AF22 * DSCP 22, AF23 * DSCP 26, AF31 * DSCP 28, AF32 * DSCP 30, AF33 * DSCP 34, AF41 * DSCP 36, AF42 * DSCP 38, AF43 * DSCP 16, CS2 * DSCP 24, CS3 * DSCP 32, CS4 * DSCP 46, EF * DSCP 40, CS5 * DSCP 48, CS6 * DSCP 56, CS7</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>MaxBandwidth</maml:name> <maml:description> <maml:para>Maximum share the traffic class can use when other traffic classes are not using their guaranteed share. The max share and the % share for a real time class must be equal and not exceed 50%. For other classes, the max share is greater than or equal to the % share. Value between 1 and 100</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="ClassName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the QoS Classifier. Value cannot be "FCoE lossless". If value is "Best effort", only the MaxBandwidth Parameter is allowed to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>RealTime</maml:name> <maml:description> <maml:para>Specifies whether the traffic class is real time. Only 1 traffic class can be real time. Enabling real time for this class removes the real time flag for other classes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.QosTrafficClassifier [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>QoS Traffic Classifier Object @{ qosTrafficClass = [PSCustomObject]@{ maxBandwidth = 100; bandwidthShare = "0"; egressDot1pValue = 0; realTime = $false; className = "Class"; enabled = $false; }; qosClassificationMapping = [PSCustomObject]@{ dot1pClassMapping = @(); dscpClassMapping = @() } }</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>$Class1 = New-HPOVQosTrafficClass -Name Class1 -MaxBandwidth 50 -BandwidthShare 20 -ExgressDot1pValue 2 -IngressDot1pClassMapping 5,6 -EgressDscpClassMapping "DSCP 0, CS0","DSCP 10, AF11","DSCP 12, AF12","DSCP 14, AF13" -Enabled $Class2 = New-HPOVQosTrafficClass -Name Class2 -MaxBandwidth 10 -BandwidthShare 10 -ExgressDot1pValue 3 -IngressDot1pClassMapping 1 -EgressDscpClassMapping "DSCP 30, AF33","SCP 32, CS4" -Enabled $TrafficClasses = $Class1,$Class2</dev:code> <dev:remarks> <dev:para>Create new traffic class objects "Class1" and "Class2", creating a new collection $TrafficClasses.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVRACK--> <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"> <!--NEW-HPOVRACK--> <command:details> <command:name>New-HPOVRack</command:name> <maml:description> <maml:para>Create a new facilities Rack.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVRack</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will create a new Rack resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVRack</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ThermalLimit</maml:name> <maml:description> <maml:para>Thermal limit supported by the rack, in BTU"s.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Serial number of the rack resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>Part number of the rack resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Model</maml:name> <maml:description> <maml:para>Provide the model of the rack to add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Rack depth, in millimeters. Default: 1000</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Height</maml:name> <maml:description> <maml:para>Height of rack, in millimeters. Default: 2004</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>UHeight</maml:name> <maml:description> <maml:para>The rack unit height of the rack. Default: 40</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of rack, in millimeters. Default: 600</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Rack depth, in millimeters. Default: 1000</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Height</maml:name> <maml:description> <maml:para>Height of rack, in millimeters. Default: 2004</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>2004</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Model</maml:name> <maml:description> <maml:para>Provide the model of the rack to add.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PartNumber</maml:name> <maml:description> <maml:para>Part number of the rack resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>Serial number of the rack resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ThermalLimit</maml:name> <maml:description> <maml:para>Thermal limit supported by the rack, in BTU"s.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>UHeight</maml:name> <maml:description> <maml:para>The rack unit height of the rack. Default: 40</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>220</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of rack, in millimeters. Default: 600</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>600</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.Rack</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created rack.</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>$Params = @{ Name = "Rack-230"; ThermalLimit = 10000; SerialNumber = "AABB1122CCDD"; PartNumber = "AF046A"; Depth = 1075; Height = 2032; UHeight = 42; Width = 600 } New-HPOVRack @Params</dev:code> <dev:remarks> <dev:para>Create new "Rack-230" rack resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVRackToDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRackMemberLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVREMOTESUPPORTCONTACT--> <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"> <!--NEW-HPOVREMOTESUPPORTCONTACT--> <command:details> <command:name>New-HPOVRemoteSupportContact</command:name> <maml:description> <maml:para>Configure new Remote Support contact.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVRemoteSupportContact</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to create a new Remote Support Contact. The Remote Support Contact is used to identify authorized users HPE Support can contact for service events. Only a single contact can be defined as the Default. The Default contact cannot be removed, and at least 1 contact must be configured before attempting to register the appliance with HPE support using the Set-HPOVRemoteSupport Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVRemoteSupportContact</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Firstname</maml:name> <maml:description> <maml:para>The contacts first or given name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Lastname</maml:name> <maml:description> <maml:para>The contacts last or sur name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contacts email address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PrimaryPhone</maml:name> <maml:description> <maml:para>The contacts primary phone number.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AlternatePhone</maml:name> <maml:description> <maml:para>The contacts alternate phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Language</maml:name> <maml:description> <maml:para>The contacts primary spoken language.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Notes</maml:name> <maml:description> <maml:para>The contacts special instructions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Default</maml:name> <maml:description> <maml:para>Use to specify if this contact is the Default.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DefaultSecondary</maml:name> <maml:description> <maml:para>Use to indicate if the specified contact should be the appliance default secondary contact.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AlternatePhone</maml:name> <maml:description> <maml:para>The contacts alternate phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Default</maml:name> <maml:description> <maml:para>Use to specify if this contact is the Default.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DefaultSecondary</maml:name> <maml:description> <maml:para>Use to indicate if the specified contact should be the appliance default secondary contact.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Email</maml:name> <maml:description> <maml:para>The contacts email address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="GivenName"> <maml:name>Firstname</maml:name> <maml:description> <maml:para>The contacts first or given name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Language</maml:name> <maml:description> <maml:para>The contacts primary spoken language.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>en</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Surname"> <maml:name>Lastname</maml:name> <maml:description> <maml:para>The contacts last or sur name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Notes</maml:name> <maml:description> <maml:para>The contacts special instructions.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PrimaryPhone</maml:name> <maml:description> <maml:para>The contacts primary phone number.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Contact [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The created Remote Support Contact.</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>New-HPOVRemoteSupportContact -Firstname Rebert -Lastname Jones -Email robert.jones@domain.local -PrimaryPhone 123-111-2222 -AlternatePhone 111-333-4444 -Language en -Default</dev:code> <dev:remarks> <dev:para>Configure a new user who is the default contact.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVREMOTESUPPORTPARTNER--> <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"> <!--NEW-HPOVREMOTESUPPORTPARTNER--> <command:details> <command:name>New-HPOVRemoteSupportPartner</command:name> <maml:description> <maml:para>Retrieve Remote Support Default Site.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVRemoteSupportPartner</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to retrieve the configured default site.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVRemoteSupportPartner</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Supply the Partner Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify if the authorized partner is a Reseller or Support. If requiring a partner that is both Support and a Reseller, create it twice.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PartnerId</maml:name> <maml:description> <maml:para>The HPE Authorized Support and/or Reseller Partner ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Default</maml:name> <maml:description> <maml:para>Use to specify if the partner should be the default Support or Reseller partner. All supproted monitored resources by default will inherit from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Default</maml:name> <maml:description> <maml:para>Use to specify if the partner should be the default Support or Reseller partner. All supproted monitored resources by default will inherit from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Supply the Partner Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PartnerId</maml:name> <maml:description> <maml:para>The HPE Authorized Support and/or Reseller Partner ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify if the authorized partner is a Reseller or Support. If requiring a partner that is both Support and a Reseller, create it twice.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Partner [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created Remote Support Partner.</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>New-HPOVRemoteSupportPartner -Name "My Authorized Partner" -Type Reseller -PartnerId 123456</dev:code> <dev:remarks> <dev:para>Define a new authorized HPE Reseller partner.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVRemoteSupportPartner -Name "My Authorized Partner" -Type Support -PartnerId 123456 -Default</dev:code> <dev:remarks> <dev:para>Define a new authorized HPE Support partner, and make it the default appliance Support partner.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVRESOURCE--> <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"> <!--NEW-HPOVRESOURCE--> <command:details> <command:name>New-HPOVResource</command:name> <maml:description> <maml:para>Create a new resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVResource</command:noun> </command:details> <maml:description> <maml:para>Create a new resource by passing the URI and the resource details in the form of a PowerShell hashtable.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVResource</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The location where the new object is to be created, using the HTTP POST method.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The new resource that is to be created</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="1" parameterSetName="(All)" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The new resource that is to be created</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The location where the new object is to be created, using the HTTP POST method.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Resource object to create</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The newly created resource, or async task</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>New-HPOVResource /rest/ethernet-networks @{vlanId=2000; purpose="General"; name="VLAN 2000"; smartLink=$true; privateNetwork=$false; type="ethernet-networkV2"}</dev:code> <dev:remarks> <dev:para>Create a new Ethernet Network, "VLAN 2000".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVRESTORE--> <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"> <!--NEW-HPOVRESTORE--> <command:details> <command:name>New-HPOVRestore</command:name> <maml:description> <maml:para>Upload appliance backup file to restore its configuration.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVRestore</command:noun> </command:details> <maml:description> <maml:para>Using this Cmdlet will initiate a restore of the appliance to the backup file specified. Starts a restore operation from the backup file already uploaded to the appliance. Only one restore operation can run at a time. There is no way to cancel a restore once it has been started. The restore operation is destructive. Any configuration changes not included in the backup file will be lost. The appliance will raise alerts for any inconsistencies detected after the restore. If an unrecoverable error is detected during the restore, then the appliance will be set to the factory reset mode. Restoring from a backup is a disruptive action: * The appliance restarts and users cannot log in to the appliance during the restore process. All users are logged out and their work is lost. * To prevent duplicate identifiers on the network, server hardware configurations are cleared if an associated server profile is not in the backup. * Server profiles that have been modified since the backup was taken are flagged with this message: "Server profile settings conflict with the server hardware configuration". To reapply the server profile configuration and restore network connectivity, you must unassign all flagged server profiles and then individually reassign the server profiles to the server hardware. * To prevent unintentional assignment of duplicate addresses or identifiers, all address and identifier ranges are disabled after the post-restore process completes. The appliance automatically re-creates replacement address and identifier ranges. Minimum required privileges: Infrastructure administrator, Software administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVRestore</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The full path and file name of the appliance configuration backup file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>EncryptionKey</maml:name> <maml:description> <maml:para>Provide the encryption key file path or file object. When restoring an appliance backup, and after the appliance has been factory reset, the prior encryption key is needed to decrypt the backup file. This is only supported with HPE Synergy Composer 2 appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>EncryptionKey</maml:name> <maml:description> <maml:para>Provide the encryption key file path or file object. When restoring an appliance backup, and after the appliance has been factory reset, the prior encryption key is needed to decrypt the backup file. This is only supported with HPE Synergy Composer 2 appliances.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="File"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The full path and file name of the appliance configuration backup file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.IO.FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The restore process object. This is not an Async Task</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>New-HPOVRestore -FileName "C:\Users\me\Documents\appliance_backup_2013-11-01_110203.bkp"</dev:code> <dev:remarks> <dev:para>Upload a backup file to restore in the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVRestore -FileName "C:\Users\me\Documents\appliance_backup_2013-11-01_110203.bkp -EncryptionKey "C:\Path\To\encryptionkey.aek""</dev:code> <dev:remarks> <dev:para>Upload a backup file to restore in the appliance, supplying the path to the encryption key file.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSCOPE--> <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"> <!--NEW-HPOVSCOPE--> <command:details> <command:name>New-HPOVScope</command:name> <maml:description> <maml:para>Create new Scope.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVScope</command:noun> </command:details> <maml:description> <maml:para>A scope is a grouping of resources that can be used to restrict the range of an operation or action. For example, you can create scopes based on: * Organizations (Marketing, Research and Development, Finance) * Usage (Production, Development, Testing) * Skills (Linux, Windows) The resources are arranged by categories. All the resources in these categories can be added to or removed from a scope: * Enclosures * Server Hardware * Networks (Ethernet, FC, and FCoE) * Network Sets * Interconnects, excluding SAS resources * Logical Interconnects, excluding SAS resources * Logical Interconnect Groups, excluding SAS resources * Switches * Logical Switches * Logical Switch Groups NOTE: Resources in other categories are considered to be included in all scopes, and they cannot be removed. When scopes are defined and resources assigned to them, you can: * Restrict your view of the user interface (UI) to the resources in the scope. * Filter email notifications for alerts based on the scope of the associated resources. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVScope</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scope to create.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Administrator account of the target iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Administrator account of the target iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the scope to create.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.Scope [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance Scope resource object.</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>New-HPOVScope -Name MyFinanceScope</dev:code> <dev:remarks> <dev:para>Create a "MyFinanceScope" for the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVScope -Name MyFinanceScope -Descrition "Finance Scope of resources"</dev:code> <dev:remarks> <dev:para>Create a "MyFinanceScope" with a descrition for the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVScope -Name MyFinanceScope -Descrition "Finance Scope of resources" -ApplianceConnection $ConnectedSessions</dev:code> <dev:remarks> <dev:para>Create a "MyFinanceScope" with a descrition for all appliance connections.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILE--> <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"> <!--NEW-HPOVSERVERPROFILE--> <command:details> <command:name>New-HPOVServerProfile</command:name> <maml:description> <maml:para>Create or Import a Server Profile</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to create or import an HPE OneView Server Profile. A server profile is the configuration for a server instance. Server profiles capture the entire server configuration in one place, enabling you to consistently replicate new server profiles and to rapidly modify them to reflect changes in your data center. A server profile includes: * Server identification information * Connectivity settings for Ethernet networks, network sets, and Fibre Channel networks * Firmware policy * Local storage settings * SAN storage settings (for environments that have Virtual Connect) * BIOS settings * Boot order * Physical or virtual UUIDs, MAC addresses, and WWN addresses You can create an unassigned server profile that serves as a template. Typically, you capture best-practice configurations in a server profile template, and then copy and deploy instances as individual server profiles. Similar to virtual machine (VM) templates, profiles enable you to create a provisioning baseline for server hardware types in an enclosure. When you create a server profile, it is designated for a server hardware type and enclosure group (for server blades), whether the profile is assigned or unassigned. To figure out BIOS Settings to override or set within the Server Profile, you will need to get the Server Hardware Type resource that your are modeling the Server Profile for. When retrieving the resource: $bl460cgen9sht = Get-HPOVServerHardwareType "BL460c Gen9 1" The "biosSettings" Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To locate potential BIOS Settings, you can use the following code as an example: $biosSettings = $bl460cgen9sht.biosSettings | ? name -match "power" The code example above will return all matching BIOS Settings where the name contains "power". The found BIOS settings object(s) are then saved into $biosSettings. Update the "value" property accordingly, and you can then pass $biosSettings variable to the -biosSettings parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>AssignmentType</maml:name> <maml:description> <maml:para>The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or unassigned. Valid values for this parameter are "unassigned", "server", or "bay"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is "bay"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>EnclosureBay</maml:name> <maml:description> <maml:para>The empty enclosure bay to assign the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Starting with HPE OneView 5.0, unmanaged Fibre Channel connections are supported, and can be deployed to servers without HPE Virtual Connect. Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile will be bound to. Only required when Server value is "Unassigned".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile will be bound to. Required when Server value is "Unassigned" or assigning to an empty device bay in an enclosure which must include the -enclosure and -enclosureBay parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivateDateTime</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also specify the UUID by using the uuid parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify the Serial Number by using the serialnumber parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SANStorageAttach, SPT, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default, Import"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Import, SANStorageAttach, SPT, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>Provide a Server Profile Template Object or Resource Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>AssignmentType</maml:name> <maml:description> <maml:para>The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or unassigned. Valid values for this parameter are "unassigned", "server", or "bay"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is "bay"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>EnclosureBay</maml:name> <maml:description> <maml:para>The empty enclosure bay to assign the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Starting with HPE OneView 5.0, unmanaged Fibre Channel connections are supported, and can be deployed to servers without HPE Virtual Connect. Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>FCConnectionAddresses</maml:name> <maml:description> <maml:para>When providing a server profile template to create a server profile from and it contains unmanaged Fibre Channel connections, use this parameter to specify the connection ID and the FC WWPN value that should be associated with the connection. Expected format: @{1 = "10:00:00:60:69:00:23:90"; 2 = "10:00:00:60:69:00:23:92"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivateDateTime</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also specify the UUID by using the uuid parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify the Serial Number by using the serialnumber parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>IscsiIPv4Address</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value. A collection of IPv4 Addresses to allocate for found iSCSI initiators that are Bootable.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>ISCSIInitatorName</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value which contain iSCSI Connections that are bootable. Value to provide for the iSCSI Initiator. All iSCSI Connections will share this value. If no value is provided, the connection will default to using the Server Profile Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>ChapSecret</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile, specifying a ServerProfileTemplate parameter value, and a Connection iSCSI Authentication Protocol is set to Chap or MutualChap. The CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT"> <maml:name>MutualChapSecret</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile, specifying a ServerProfileTemplate parameter value, and a Connection iSCSI Authentication Protocol is set to MutualChap. The Mutual CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SANStorageAttach, SPT, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default, Import"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Import, SANStorageAttach, SPT, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Optional. Enable SAN Storage Management within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage System. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>Optional. Array of Storage Volume resources to attach. Can be created by using the New-HPOVServerProfileAttachVolume Cmdlet. This parameter does not accept a Storage Volume resource from the Get-HPOVStorageVolume Cmdlet. The format of the Storage Volume resource should be a PsCustomObject PowerShell resource with the following keys and values: [PsCustomObject]@{ [System.Int]id - Valid Host LUN ID 0-254 [System.String]lunType - Auto or Manual [System.String]volumeUri - URI to Storage Volume that has been created and not assigned to another Server Profile if it is a Private Volume. [System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri - URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC Connection ID associated with the path to the attached volume, and if the path is enabled or disabled. @( [System.Int]connectionId - FC Connection ID. If using New-HPOVServerProfileAttachVolume helper Cmdlet, New-HPOVServerProfile will automatically determine the FC connection ID. [System.Boolean]isEnabled - Enable or disable the path ) }</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>AssignmentType</maml:name> <maml:description> <maml:para>The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or unassigned. Valid values for this parameter are "unassigned", "server", or "bay"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is "bay"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>EnclosureBay</maml:name> <maml:description> <maml:para>The empty enclosure bay to assign the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Starting with HPE OneView 5.0, unmanaged Fibre Channel connections are supported, and can be deployed to servers without HPE Virtual Connect. Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile will be bound to. Only required when Server value is "Unassigned".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile will be bound to. Required when Server value is "Unassigned" or assigning to an empty device bay in an enclosure which must include the -enclosure and -enclosureBay parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>FirmwareActivateDateTime</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>EvenPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable even paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>OddPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable odd paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also specify the UUID by using the uuid parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify the Serial Number by using the serialnumber parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SANStorageAttach, SPT, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default, Import"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Import, SANStorageAttach, SPT, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import"> <maml:name>Import</maml:name> <maml:description> <maml:para>Switch to import Server Profile JSON object or file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import"> <maml:name>ProfileObj</maml:name> <maml:description> <maml:para>Source Server Profile JSON object or file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>AssignmentType</maml:name> <maml:description> <maml:para>The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or unassigned. Valid values for this parameter are "unassigned", "server", or "bay"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default, Import"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Import, SANStorageAttach, SPT, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Bay</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Import, SANStorageAttach, SPT, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default" aliases="assign"> <maml:name>AssignmentType</maml:name> <maml:description> <maml:para>The instruction of how the profile will be assigned. The profile can be assigned to an empty server bay, a specific server, or unassigned. Valid values for this parameter are "unassigned", "server", or "bay"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default, Import" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>BIOS</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>ChapSecret</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile, specifying a ServerProfileTemplate parameter value, and a Connection iSCSI Authentication Protocol is set to Chap or MutualChap. The CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Starting with HPE OneView 5.0, unmanaged Fibre Channel connections are supported, and can be deployed to servers without HPE Virtual Connect. Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The blade enclosure resource containing the bay where the server profile will be assigned. Only required if assignmentType is "bay"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="bay"> <maml:name>EnclosureBay</maml:name> <maml:description> <maml:para>The empty enclosure bay to assign the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="eg"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile will be bound to. Only required when Server value is "Unassigned".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="Even"> <maml:name>EvenPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable even paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>FCConnectionAddresses</maml:name> <maml:description> <maml:para>When providing a server profile template to create a server profile from and it contains unmanaged Fibre Channel connections, use this parameter to specify the connection ID and the FC WWPN value that should be associated with the connection. Expected format: @{1 = "10:00:00:60:69:00:23:90"; 2 = "10:00:00:60:69:00:23:92"}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>FirmwareActivateDateTime</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Immediate</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="FirmwareMode"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>FirmwareAndSoftware</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="OS"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage System. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>ISCSIInitatorName</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value which contain iSCSI Connections that are bootable. Value to provide for the iSCSI Initiator. All iSCSI Connections will share this value. If no value is provided, the connection will default to using the Server Profile Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import" aliases="None"> <maml:name>Import</maml:name> <maml:description> <maml:para>Switch to import Server Profile JSON object or file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>IscsiIPv4Address</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile and specifying a ServerProfileTemplate parameter value. A collection of IPv4 Addresses to allocate for found iSCSI initiators that are Bootable.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server. Will only enable embedded Smart Array controller management.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="boot"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>MutualChapSecret</maml:name> <maml:description> <maml:para>Parameter is required when creating a Server Profile, specifying a ServerProfileTemplate parameter value, and a Connection iSCSI Authentication Protocol is set to MutualChap. The Mutual CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>OSDeploymentAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="Odd"> <maml:name>OddPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable odd paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import" aliases="location, file"> <maml:name>ProfileObj</maml:name> <maml:description> <maml:para>Source Server Profile JSON object or file.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="None"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Optional. Enable SAN Storage Management within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="SANStorageAttach, SPT, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>SerialNumber</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined Serial Number value. You must also specify the UUID by using the uuid parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Import, SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="sht"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile will be bound to. Required when Server value is "Unassigned" or assigning to an empty device bay in an enclosure which must include the -enclosure and -enclosureBay parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT" aliases="None"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>Provide a Server Profile Template Object or Resource Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="LogicalDisk"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A collection (System.Collections.ArrayList or System.Collections.ArrayList) of LogicalDisk Controller configuration objects from New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="None"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>Optional. Array of Storage Volume resources to attach. Can be created by using the New-HPOVServerProfileAttachVolume Cmdlet. This parameter does not accept a Storage Volume resource from the Get-HPOVStorageVolume Cmdlet. The format of the Storage Volume resource should be a PsCustomObject PowerShell resource with the following keys and values: [PsCustomObject]@{ [System.Int]id - Valid Host LUN ID 0-254 [System.String]lunType - Auto or Manual [System.String]volumeUri - URI to Storage Volume that has been created and not assigned to another Server Profile if it is a Private Volume. [System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri - URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC Connection ID associated with the path to the attached volume, and if the path is enabled or disabled. @( [System.Int]connectionId - FC Connection ID. If using New-HPOVServerProfileAttachVolume helper Cmdlet, New-HPOVServerProfile will automatically determine the FC connection ID. [System.Boolean]isEnabled - Enable or disable the path ) }</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>When specifying snAssignment parameter to UserDefined, you can provide a user defined UUID value. You must also specify the Serial Number by using the serialnumber parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SPT, SANStorageAttach, Default" aliases="None"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The full path to the Server Profile JSON export file</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful returns a task resource which may be polled to follow the progress of the profile creation. Otherwise, a request validation error will be returned</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>$svr = Get-HPOVServer -Name "Encl1, Bay 1" New-HPOVServerProfile -name "My Basic Server Profile" -server $svr | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a simple profile for "ServerA", and wait for it to be applied.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$spt = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Node Template v1" Get-HPOVServer -Name "Encl1, Bay 1" | New-HPOVServerProfile -name "Hyp-Clus-01" -ServerProfileTemplate $spt | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a Server Profile from the "Hypervisor Cluster Node Template v1" Server Profile Template, assigning to "Encl1, Bay 1" server device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Web Server 10" $svr = Get-HPOVServer -Name "Encl1, Bay 1" $con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -ConnectionId 1 $con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -ConnectionId 2 $params = @{ >> name = $profileName; >> assignmentType = "server"; >> server = $svr; >> connections = ($con1, $con2); >> ApplianceConnection = "MyAppliance.domain.com" >> } >> New-HPOVServerProfile @params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a BL Gen8 Server Profile template, and pipe to Wait-HPOVTaskComplete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node 1" $svr = Get-HPOVServer -Name "Encl1, Bay 1" $con1 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -id 1 -type Ethernet $con2 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -id 2 -type Ethernet $con3 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 3 -type FibreChannel -bootable -priority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0 $con4 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0 $conList = $con1, $con2, $con3, $con4 $task = New-HPOVServerProfile -name $profileName -assignmentType "unassigned" -connections $conList | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create an unassigned server profile which includes networks "Net-41" and "Net-42", adds FC Connections for BfS.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node 1" $svr = Get-HPOVServer -Name "Encl1, Bay 1" $con1 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -id 1 -type Ethernet $con2 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -id 2 -type Ethernet $con3 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 3 -type FibreChannel -bootable -priority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0 $con4 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0 $conList = $con1, $con2, $con3, $con4 $volume1 = Get-HPOVStorageVolume -Name Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1 $volume2 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume -volumeid 2 $attachVolumes = @($volume1,$volume2) $task = New-HPOVServerProfile -name $profileName -assignmentType "unassigned" -connections $conList -SANStorage -ostype VMware -StorageVolume $attachVolumes | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create an unassigned server profile which includes networks "Net-41" and "Net-42", and attaches two storage volumes.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node 1" $bl460SHT = Get-HPOVServerHardwareTypes -name "BL460c Gen8 1" $enclosure = Get-HPOVEnclosure -Name "Encl1" $bay = 12 $con1 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -id 1 -type Ethernet $con2 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -id 2 -type Ethernet $con3 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 3 -type FibreChannel -bootable -priority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0 $con4 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0 $conList = $con1, $con2, $con3, $con4 $task = New-HPOVServerProfile -name $profileName -assignmentType bay -connections $conList -sht $bl460SHT -enclosure $enclosure -bay $bay | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a profile which includes networks "Net-41" and "Net-42", adds FC Connections for BfS, and assign to Bay 12 of "Encl1" which is currently empty.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node 1" $server = Get-HPOVServer -Name "Encl1, Bay 1" #display the BL460 Gen8 BIOS Settings $bl460SHT.biosSettings #Set HP Power Profile (ID 210) to Maximum Performance and HP Power Regulator (ID 140) to HP Static High Performance Mode. $bl460bios = @(@{id=210;value=3},@{id=140;value=3}) $con41 = Get-HPOVNetwork -Name "Net-41" | New-HPOVServerProfileConnection -ID 1 -bootable -priority Primary $con42 = Get-HPOVNetwork -Name "Net-42" | New-HPOVServerProfileConnection -ID 2 -bootable -priority Secondary $conList = @($con41, $con42) $task = New-HPOVServerProfile -name $profileName -assignmentType "server" -server $server -connections $conList -manageboot -bootorder @("PXE","HardDisk","CD","Floppy","USB") -bios -biossettings $bl460bios | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a profile which includes networks "Net-41" and "Net-42", sets the boot order, and sets the BIOS. Then pipes to Wait-HPOVTaskComplete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node 1" $server = Get-HPOVServer -Name "Encl1, Bay 1" #Gen9 Server $con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -connectionId 1 $con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -connectionId 2 $LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "My Local Disk" -RAID RAID1 -NumberofDrives 2 -DiskType SasSsd $params = @{ >> name = $profileName; >> assignmentType = "server" >> server = $server; >> connections = $con1, $con2 >> manageboot = $True; >> bootMode = "UEFI"; >> pxeBootPolicy = "IPv4ThenIPv6"; >> bootOrder = "HardDisk"; >> HideUnusedFlexnics = $True; >> LocalStorage = $True; >> Initialize = $True; >> LogicalDisk = $LogicalDisk >> } >> New-HPOVServerProfile @params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a BL Gen9 UEFI Server Profile, and pipe to Wait-HPOVTaskComplete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Synergy Hypervisor Cluster Node 1" $sht = Get-HPOVServerHardwareType -Name "SY480 Gen9 1" $server = Get-HPOVServer -NoProfile -ServerHardwareType $sht | ? { $_.cpuCount -ge 4 -and $_.memoryMb -ge 524288 } | Select -First 1 $con1 = Get-HPOVNetwork -Name "Net-41-A" | New-HPOVServerProfileConnection -connectionId 1 $con2 = Get-HPOVNetwork -Name "Net-41-B" | New-HPOVServerProfileConnection -connectionId 2 $LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "Data Drive" -RAID RAID1 -NumberofDrives 5 -DiskType SasSsd $Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Initialize -LogicalDisk $LogicalDisk $params = @{ >> name = $profileName; >> assignmentType = "server" >> server = $server; >> connections = $con1, $con2 >> manageboot = $True; >> bootMode = "UEFI"; >> pxeBootPolicy = "IPv4ThenIPv6"; >> bootOrder = "HardDisk"; >> HideUnusedFlexnics = $True; >> LocalStorage = $True; >> Initialize = $True; >> LogicalDisk = $LogicalDisk >> } >> New-HPOVServerProfile @params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a Synergy Gen9 Server Profile by looking for the first available SY480 Gen9 with 4 CPU"s and 512GB of RAM, configuring with D3940 Disk Storage.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 10 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ServerProfileName = 'My DL with FC Server Profile 1' $FCConnection1FibreChannelNetworkName = 'Fabric A' $FCConnection1Wwpn = '10:00:00:60:69:00:23:90' $FCConnection2FibreChannelNetworkName = 'Fabric B' $FCConnection2Wwpn = '10:00:00:60:69:00:23:92' $FCConnection1 = Get-HPOVNetwork -Type FibreChannel -Name $FCConnection1FibreChannelNetworkName | New-HPOVServerProfileConnection -type FibreChannel -ConnectionID 1 -WWPN $FCConnection1Wwpn -UserDefined $FCConnection2 = Get-HPOVNetwork -Type FibreChannel -Name $FCConnection2FibreChannelNetworkName | New-HPOVServerProfileConnection -type FibreChannel -ConnectionID 2 -WWPN $FCConnection2Wwpn -UserDefined $Params = @{ Name = $DLServerProfileWithUnManagedFCConnectionsName; Description = 'Testing Creation'; BootMode = 'UEFI'; ServerHardwareType = (Get-HPOVServerHardwareType -Name 'DL360 Gen9 1' -ErrorAction Stop); AssignmentType = 'Unassigned'; Connections = $FCConnection1, $FCConnection2 } New-HPOVServerProfile -Confirm:$False @Params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a server profile with unmanaged Fibre Channel connections.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 11 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVServerProfile -import -file C:\profiles\ServerProfile1.json</dev:code> <dev:remarks> <dev:para>Basic Server Profile import.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 12 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>(Get-Content C:\profiles\ServerProfile1.json) -join "`n" | New-HPOVServerProfile -import</dev:code> <dev:remarks> <dev:para>Read the contents from ServerProfile1.json, join each line into a single object, and pipe to New-HPOVServerProfile to import.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 13 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$jsonProfiles = Get-ChildItem C:\profiles\*.json $jsonProfiles | foreach-object { New-HPOVServerProfile -import -file $_.fullname }</dev:code> <dev:remarks> <dev:para>Retrieve list of all JSON files in C:\profiles, then pass each file and its full path to New-HPOVServerProfile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILEASSIGN--> <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"> <!--NEW-HPOVSERVERPROFILEASSIGN--> <command:details> <command:name>New-HPOVServerProfileAssign</command:name> <maml:description> <maml:para>Unassign or Reassign an existing Server Profile.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileAssign</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to unassign or reassign an existing HPE OneView Server Profile. The destination Server and its Server Hardware Type does not need to match the original Server Hardware Type defined in the Server Profile. The Server Profile will be updated accordingly.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileAssign</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Unassigned"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>The name or object of the server profile resource to modify assignment.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name.s</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force add the Server Profile if there are any async task validation failures, like server hardware is in a Warning or Failed state, or SAN attach volume only have a single path configured.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Unassigned"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileAssign</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Unassigned"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>The name or object of the server profile resource to modify assignment.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Unassigned"> <maml:name>Unassigned</maml:name> <maml:description> <maml:para>Siwtch parameter to unassign a Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force add the Server Profile if there are any async task validation failures, like server hardware is in a Warning or Failed state, or SAN attach volume only have a single path configured.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Unassigned"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Unassigned" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default, Unassigned" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force add the Server Profile if there are any async task validation failures, like server hardware is in a Warning or Failed state, or SAN attach volume only have a single path configured.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server hardware resource where the new profile is to be applied. This is normally retrieved with a "Get-HPOVServer" call, and the Server state property should be "NoProfileApplied". Can also be the Server Hardware name.s</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Unassigned" aliases="Profile"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>The name or object of the server profile resource to modify assignment.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Unassigned" aliases="None"> <maml:name>Unassigned</maml:name> <maml:description> <maml:para>Siwtch parameter to unassign a Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource object from Get-HPOVServerProfile</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful returns a task resource which may be polled to follow the progress of the profile creation. Otherwise, a request validation error will be returned</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>Get-HPOVServerProfile "Profile 1" | New-HPOVServerProfileAssign -Server "Encl1, Bay 10" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Get "Profile 1" Server Profile and assign it to "Encl1, Bay 10", then wait for the async task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile "Profile 1" | New-HPOVServerProfileAssign -unassign | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Get "Profile 1" Server Profile and unassign it, then wait for the async task to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILEATTACHVOLUME--> <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"> <!--NEW-HPOVSERVERPROFILEATTACHVOLUME--> <command:details> <command:name>New-HPOVServerProfileAttachVolume</command:name> <maml:description> <maml:para>Create volume attachment for a server profile.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileAttachVolume</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist with creating a Storage Volume object to then attach to a new Server Profile being created (New-HPOVServerProfile), and attach either an existing Storage Volume (Get-HPOVStorageVolume) or new Ephemeral Volume to an existing Server Profile (Get-HPOVServerProfile). If attempting to attach to an existing Server Profile, the HostOSType parameter is required, and will enable SAN Management within the Server Profile, if the Server Hardware resource supports the feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileAttachVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ServerProfileObject, Default"> <maml:name>Volume</maml:name> <maml:description> <maml:para>The Volume Name, URI or Object to attach.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>LunIdType</maml:name> <maml:description> <maml:para> Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a numerical value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>BootVolume</maml:name> <maml:description> <maml:para>Use to indicate this volume is a bootable device. When using this parameter, the Server Profile"s FC Connection(s) BootVolumeSource parameter set to "ManagedVolume". This parameter is only applicable with Private volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetPortAssignment</maml:name> <maml:description> <maml:para>Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetAddresses</maml:name> <maml:description> <maml:para>An array of target Port ID(s) or WWN(s). Example: @("1:0:1", "1:2:1", "3:1:1", "4:0:0")</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileAttachVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>Name</maml:name> <maml:description> <maml:para>Ephemeral Storage Volume resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>An existing Server Profile resource object from Get-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>VolumeTemplate</maml:name> <maml:description> <maml:para>For Ephemeral (private) volumes that should be provisioned from Storage Volume Templates. Provide a valid resource from Get-HPOVStorageVolumeTemplate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>The Storage Resource Pool object to provision the Ephemeral Volume from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>The supported Snapshot storage pool for a StoreServ storage system. Snapshot storage pool must originate from the same storage system as the assigned storage pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>If provided a StoragePool Resource Name, you must provide the StorageSystem name value if there are multiple Storage Pool resources with the same name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>The requested Ephemeral Volume storage capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the volume provisioning type. Supported values: * Thin * Full * ThinDeduplication (only supported with HPE StoreServe)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>Full</maml:name> <maml:description> <maml:para>DEPRECATED. This parameter is replaced by ProvisioningType. Specify if the Ephemeral Volume provisioning type should be Thick. Default is Thin Volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>Permanent</maml:name> <maml:description> <maml:para>Specify if the Ephemeral Volume should be permanent.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify if HPE StoreVirtual volume Adaptive Optimization is enabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>LunIdType</maml:name> <maml:description> <maml:para> Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a numerical value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>LunID</maml:name> <maml:description> <maml:para>The Host LUN ID numerical value that will be configured in the Volume export on the Storage System. Accepted range: 0-254</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Specify the Host OS type, which will set the Host OS value when HPE OneView creates the Host object on the Storage System. This parameter is only necessary if the Server Profile object does not have SAN Management enabled. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>BootVolume</maml:name> <maml:description> <maml:para>Use to indicate this volume is a bootable device. When using this parameter, the Server Profile"s FC Connection(s) BootVolumeSource parameter set to "ManagedVolume". This parameter is only applicable with Private volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetPortAssignment</maml:name> <maml:description> <maml:para>Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetAddresses</maml:name> <maml:description> <maml:para>An array of target Port ID(s) or WWN(s). Example: @("1:0:1", "1:2:1", "3:1:1", "4:0:0")</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileAttachVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>An existing Server Profile resource object from Get-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ServerProfileObject, Default"> <maml:name>Volume</maml:name> <maml:description> <maml:para>The Volume Name, URI or Object to attach.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>LunIdType</maml:name> <maml:description> <maml:para> Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a numerical value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>LunID</maml:name> <maml:description> <maml:para>The Host LUN ID numerical value that will be configured in the Volume export on the Storage System. Accepted range: 0-254</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Specify the Host OS type, which will set the Host OS value when HPE OneView creates the Host object on the Storage System. This parameter is only necessary if the Server Profile object does not have SAN Management enabled. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>BootVolume</maml:name> <maml:description> <maml:para>Use to indicate this volume is a bootable device. When using this parameter, the Server Profile"s FC Connection(s) BootVolumeSource parameter set to "ManagedVolume". This parameter is only applicable with Private volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetPortAssignment</maml:name> <maml:description> <maml:para>Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>TargetAddresses</maml:name> <maml:description> <maml:para>An array of target Port ID(s) or WWN(s). Example: @("1:0:1", "1:2:1", "3:1:1", "4:0:0")</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="Bootable"> <maml:name>BootVolume</maml:name> <maml:description> <maml:para>Use to indicate this volume is a bootable device. When using this parameter, the Server Profile"s FC Connection(s) BootVolumeSource parameter set to "ManagedVolume". This parameter is only applicable with Private volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>The requested Ephemeral Volume storage capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify if HPE StoreVirtual volume Adaptive Optimization is enabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.NimbleFolder</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>Full</maml:name> <maml:description> <maml:para>DEPRECATED. This parameter is replaced by ProvisioningType. Specify if the Ephemeral Volume provisioning type should be Thick. Default is Thin Volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject" aliases="OS"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Specify the Host OS type, which will set the Host OS value when HPE OneView creates the Host object on the Storage System. This parameter is only necessary if the Server Profile object does not have SAN Management enabled. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject" aliases="None"> <maml:name>LunID</maml:name> <maml:description> <maml:para>The Host LUN ID numerical value that will be configured in the Volume export on the Storage System. Accepted range: 0-254</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="type"> <maml:name>LunIdType</maml:name> <maml:description> <maml:para> Specify Auto or Manual for the LUN ID assignment type. If Manual, use the -LunID parameter and provide a numerical value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Ephemeral Storage Volume resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject" aliases="None"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile object. In order to save the changes, please use the Save-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.PerformancePolicy</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>Permanent</maml:name> <maml:description> <maml:para>Specify if the Ephemeral Volume should be permanent.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the volume provisioning type. Supported values: * Thin * Full * ThinDeduplication (only supported with HPE StoreServe)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Thin</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject" aliases="None"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>An existing Server Profile resource object from Get-HPOVServerProfile Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>The supported Snapshot storage pool for a StoreServ storage system. Snapshot storage pool must originate from the same storage system as the assigned storage pool.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>The Storage Resource Pool object to provision the Ephemeral Volume from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>If provided a StoragePool Resource Name, you must provide the StorageSystem name value if there are multiple Storage Pool resources with the same name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="wwpns"> <maml:name>TargetAddresses</maml:name> <maml:description> <maml:para>An array of target Port ID(s) or WWN(s). Example: @("1:0:1", "1:2:1", "3:1:1", "4:0:0")</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="None"> <maml:name>TargetPortAssignment</maml:name> <maml:description> <maml:para>Define whether host initiator port(s) should be mapped to target storage ports automatically or manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ServerProfileObject, Default" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>The Volume Name, URI or Object to attach.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol, ServerProfileObject, Default" aliases="id"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The numeric identifier for this volume. Does not pertain to exported LUN ID value on array.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSet</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ServerProfileObjectEphmeralVol" aliases="None"> <maml:name>VolumeTemplate</maml:name> <maml:description> <maml:para>For Ephemeral (private) volumes that should be provisioned from Storage Volume Templates. Provide a valid resource from Get-HPOVStorageVolumeTemplate.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume Resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When attaching a one or more Storage Volumes to an existing Server Profile, an Appliance Async Task will be created</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Profile.SanVolume [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns a storage volume attachment object which may be used during profile creation.</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>$attachVolume = New-HPOVServerProfileAttachVolume -volumeid 1 -volume Volume1</dev:code> <dev:remarks> <dev:para>Create a Volume Attach object that maps to the "Volume1" storage volume with an Auto assigned Host LUN ID.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$attachVolume = Get-HPOVStorageVolume -Name Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1</dev:code> <dev:remarks> <dev:para>Get the "Volume1" Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-HPOVServerProfileAttachVolume Cmdlet.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$attachVolume = Get-HPOVStorageVolume -Name Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1 -lunidtype manual -lunid 1</dev:code> <dev:remarks> <dev:para>Get the "Volume1" Storage Volume via the Get-HPOVStorageVolume Cmdlet, and pipe the resource object to the Get-HPOVServerProfileAttachVolume Cmdlet, providing a manual Host LUN ID.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$volume1 = Get-HPOVStorageVolume -Name Volume1 | New-HPOVServerProfileAttachVolume -volumeid 1 $volume2 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume -volumeid 2 $attachVolumes = @($volume1,$volume2)</dev:code> <dev:remarks> <dev:para>Get the "Volume1" and "SharedVolume1" Storage Volumes via the Get-HPOVStorageVolume Cmdlet, and pipe the resource objects to the Get-HPOVServerProfileAttachVolume Cmdlet, saving to $attachVolumes array.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$storagepool = Get-HPOVStoragePool R1_FC $sp = Get-HPOVServerProfile "chef-web01" New-HPOVServerProfileAttachVolume -ServerProfile $sp -Name "Chef Web01 Vol 2" -StoragePool $storagepool | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Attach a new 10Gb Ephemeral Volume to an existing Server Profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$sp = Get-HPOVServerProfile "chef-web01" Get-HPOVStorageVolume "My New Volume 3" | New-HPOVServerProfileAttachVolume -ServerProfile $sp | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Attach an existing Storage Volume to a Server Profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$storagepool = Get-HPOVStoragePool R1_FC $sp = Get-HPOVServerProfile "My Server Profile" New-HPOVServerProfileAttachVolume -Name "My Server Profile Boot Vol" -ServerProfile $sp -StoragePool $storagepool -Bootable | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Add a bootable volume to an existing Server Profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$SVT = Get-HPOVStorageVolumeTemplate -Name StoreServe4-TPDD-SVT -ErrorAction Stop $StorageVolumeObject = New-HPOVServerProfileAttachVolume -Name "Template 3 Private Vol 1" -VolumeTemplate $SVT</dev:code> <dev:remarks> <dev:para>Create a new ephemeral storage volume attachment, using a storage volume template.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILECONNECTION--> <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"> <!--NEW-HPOVSERVERPROFILECONNECTION--> <command:details> <command:name>New-HPOVServerProfileConnection</command:name> <maml:description> <maml:para>Create network connection for a server profile.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileConnection</command:noun> </command:details> <maml:description> <maml:para>A helper function to assist with connections when creating (New-HPOVServerProfile) or editing (Set-HPOVProfile) a server profile.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionID</maml:name> <maml:description> <maml:para>The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Network</maml:name> <maml:description> <maml:para>The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Deprecated parameter. Connection type is now derived from the provided Network resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>PortId</maml:name> <maml:description> <maml:para>Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port, the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]". G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb" Mezzanine adapter prefix is "Mezz" An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Name</maml:name> <maml:description> <maml:para>A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must be unique within the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>RequestedBW</maml:name> <maml:description> <maml:para>Requested bandwidth (in Mbps) to be used for this connection. Default: 2500</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>UserDefined</maml:name> <maml:description> <maml:para>Use to specify user defined address values</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>MAC</maml:name> <maml:description> <maml:para>Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a FlexHBA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable. Default: False</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>LagName</maml:name> <maml:description> <maml:para>Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Common"> <maml:name>BootVolumeSource</maml:name> <maml:description> <maml:para>Specify how the Boot Volume Source will be set. Allowed values are: * AdapterBIOS - Boot from adapter BIOS volume parameters. * ManagedVolume - Boot from a managed volume defined in SAN Storage section. * UserDefined - Boot from user defined volume parameters. Default: AdapterBIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Optional boot option for this connection, but Required if -bootable is specified. Allowed values: * NotBootable * UseBIOS * Primary * Secondary * IscsiPrimary * IscsiSecondary When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings. Default: NotBootable</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionID</maml:name> <maml:description> <maml:para>The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Network</maml:name> <maml:description> <maml:para>The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Deprecated parameter. Connection type is now derived from the provided Network resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>PortId</maml:name> <maml:description> <maml:para>Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port, the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]". G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb" Mezzanine adapter prefix is "Mezz" An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Name</maml:name> <maml:description> <maml:para>A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must be unique within the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>RequestedBW</maml:name> <maml:description> <maml:para>Requested bandwidth (in Mbps) to be used for this connection. Default: 2500</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>UserDefined</maml:name> <maml:description> <maml:para>Use to specify user defined address values</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>MAC</maml:name> <maml:description> <maml:para>Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a FlexHBA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable. Default: False</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>LagName</maml:name> <maml:description> <maml:para>Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Common"> <maml:name>BootVolumeSource</maml:name> <maml:description> <maml:para>Specify how the Boot Volume Source will be set. Allowed values are: * AdapterBIOS - Boot from adapter BIOS volume parameters. * ManagedVolume - Boot from a managed volume defined in SAN Storage section. * UserDefined - Boot from user defined volume parameters. Default: AdapterBIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Optional boot option for this connection, but Required if -bootable is specified. Allowed values: * NotBootable * UseBIOS * Primary * Secondary * IscsiPrimary * IscsiSecondary When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings. Default: NotBootable</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Target LUN ID, if BootVolumeSource is set to UserDefined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiIPv4AddressSource</maml:name> <maml:description> <maml:para>Specify the IPv4 Address Source for the connection. Allowed values are: * DHCP * UserDefined * SubnetPool</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>ISCSIInitatorName</maml:name> <maml:description> <maml:para>Value to provide for the iSCSI Initiator. All iSCSI Connections will share this value. If no value is provided, the connection will default to using the Server Profile Name. If configuring a Connection for a Server Profile Template, the value will be ignored</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiIPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address to allocate for the initiator. This parameter value is ignored when assiging the Connection to a Server Profile Template. It will be enforced when creating a Server Profile from a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiIPv4SubnetMask</maml:name> <maml:description> <maml:para>The IPv4 Subnet Mask in full or CIDR bit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiIPv4Gateway</maml:name> <maml:description> <maml:para>The IPv4 Gateway.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiBootTargetIqn</maml:name> <maml:description> <maml:para>The IQN of the target iSCSI host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiPrimaryBootTargetAddress</maml:name> <maml:description> <maml:para>The Primary Boot Target IPv4 Address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiPrimaryBootTargetPort</maml:name> <maml:description> <maml:para>The Primary Boot Target TCP Port. Default is 3260 if not otherwise specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiSecondaryBootTargetAddress</maml:name> <maml:description> <maml:para>The Secondary Boot Target IPv4 Address.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiSecondaryBootTargetPort</maml:name> <maml:description> <maml:para>The Secondary Boot Target TCP Port. Default is 3260 if not otherwise specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>IscsiAuthenticationProtocol</maml:name> <maml:description> <maml:para>Specify the Authentication protocol to use. Allowed values are None, CHAP, MutualCHAP. When creating a Server Profile Connection for a Server Profile Template, the CHAP and Mutual CHAP credential parameters are ignored. They will be enforced when creating a Server Profile from a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>ChapName</maml:name> <maml:description> <maml:para>The CHAP challange name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>ChapSecret</maml:name> <maml:description> <maml:para>The CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>MutualChapName</maml:name> <maml:description> <maml:para>The Mutual CHAP challange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI"> <maml:name>MutualChapSecret</maml:name> <maml:description> <maml:para>The Mutual CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionID</maml:name> <maml:description> <maml:para>The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Network</maml:name> <maml:description> <maml:para>The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Deprecated parameter. Connection type is now derived from the provided Network resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>PortId</maml:name> <maml:description> <maml:para>Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port, the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]". G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb" Mezzanine adapter prefix is "Mezz" An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Name</maml:name> <maml:description> <maml:para>A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must be unique within the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>RequestedBW</maml:name> <maml:description> <maml:para>Requested bandwidth (in Mbps) to be used for this connection. Default: 2500</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>UserDefined</maml:name> <maml:description> <maml:para>Use to specify user defined address values</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>MAC</maml:name> <maml:description> <maml:para>Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a FlexHBA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>WWNN</maml:name> <maml:description> <maml:para>Requested WWNN address of the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>WWPN</maml:name> <maml:description> <maml:para>Requested WWPN address of the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable. Default: False</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>LagName</maml:name> <maml:description> <maml:para>Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Common"> <maml:name>BootVolumeSource</maml:name> <maml:description> <maml:para>Specify how the Boot Volume Source will be set. Allowed values are: * AdapterBIOS - Boot from adapter BIOS volume parameters. * ManagedVolume - Boot from a managed volume defined in SAN Storage section. * UserDefined - Boot from user defined volume parameters. Default: AdapterBIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Optional boot option for this connection, but Required if -bootable is specified. Allowed values: * NotBootable * UseBIOS * Primary * Secondary * IscsiPrimary * IscsiSecondary When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings. Default: NotBootable</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC"> <maml:name>TargetWwpn</maml:name> <maml:description> <maml:para>Target FC array WWPN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Target LUN ID, if BootVolumeSource is set to UserDefined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionID</maml:name> <maml:description> <maml:para>The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Network</maml:name> <maml:description> <maml:para>The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Deprecated parameter. Connection type is now derived from the provided Network resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>PortId</maml:name> <maml:description> <maml:para>Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port, the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]". G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb" Mezzanine adapter prefix is "Mezz" An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Name</maml:name> <maml:description> <maml:para>A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must be unique within the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>RequestedBW</maml:name> <maml:description> <maml:para>Requested bandwidth (in Mbps) to be used for this connection. Default: 2500</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>UserDefined</maml:name> <maml:description> <maml:para>Use to specify user defined address values</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>MAC</maml:name> <maml:description> <maml:para>Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a FlexHBA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>Virtualfunctions</maml:name> <maml:description> <maml:para>Specify the number of Virtual Functions to enable on an Ethernet Connection. Must be in increments of 16.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable. Default: False</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>LagName</maml:name> <maml:description> <maml:para>Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Optional boot option for this connection, but Required if -bootable is specified. Allowed values: * NotBootable * UseBIOS * Primary * Secondary * IscsiPrimary * IscsiSecondary When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings. Default: NotBootable</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Common" aliases="None"> <maml:name>BootVolumeSource</maml:name> <maml:description> <maml:para>Specify how the Boot Volume Source will be set. Allowed values are: * AdapterBIOS - Boot from adapter BIOS volume parameters. * ManagedVolume - Boot from a managed volume defined in SAN Storage section. * UserDefined - Boot from user defined volume parameters. Default: AdapterBIOS</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>AdapterBIOS</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Specify to configure bootable settings. If omitted, then the connection is not bootable, and -priority is set to NotBootable. Default: False</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>ChapName</maml:name> <maml:description> <maml:para>The CHAP challange name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>ChapSecret</maml:name> <maml:description> <maml:para>The CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="id"> <maml:name>ConnectionID</maml:name> <maml:description> <maml:para>The numeric identifier for this connection. Connections are normally numbered sequentially from 1 within each profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="type"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Deprecated parameter. Connection type is now derived from the provided Network resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Ethernet</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>ISCSIInitatorName</maml:name> <maml:description> <maml:para>Value to provide for the iSCSI Initiator. All iSCSI Connections will share this value. If no value is provided, the connection will default to using the Server Profile Name. If configuring a Connection for a Server Profile Template, the value will be ignored</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiAuthenticationProtocol</maml:name> <maml:description> <maml:para>Specify the Authentication protocol to use. Allowed values are None, CHAP, MutualCHAP. When creating a Server Profile Connection for a Server Profile Template, the CHAP and Mutual CHAP credential parameters are ignored. They will be enforced when creating a Server Profile from a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiBootTargetIqn</maml:name> <maml:description> <maml:para>The IQN of the target iSCSI host.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiIPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address to allocate for the initiator. This parameter value is ignored when assiging the Connection to a Server Profile Template. It will be enforced when creating a Server Profile from a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiIPv4AddressSource</maml:name> <maml:description> <maml:para>Specify the IPv4 Address Source for the connection. Allowed values are: * DHCP * UserDefined * SubnetPool</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiIPv4Gateway</maml:name> <maml:description> <maml:para>The IPv4 Gateway.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiIPv4SubnetMask</maml:name> <maml:description> <maml:para>The IPv4 Subnet Mask in full or CIDR bit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiPrimaryBootTargetAddress</maml:name> <maml:description> <maml:para>The Primary Boot Target IPv4 Address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiPrimaryBootTargetPort</maml:name> <maml:description> <maml:para>The Primary Boot Target TCP Port. Default is 3260 if not otherwise specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>3260</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiSecondaryBootTargetAddress</maml:name> <maml:description> <maml:para>The Secondary Boot Target IPv4 Address.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>IscsiSecondaryBootTargetPort</maml:name> <maml:description> <maml:para>The Secondary Boot Target TCP Port. Default is 3260 if not otherwise specified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>3260</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC" aliases="None"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Target LUN ID, if BootVolumeSource is set to UserDefined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>LagName</maml:name> <maml:description> <maml:para>Specify the LAG Name for a Synergy Ethernet connection. Allowed value is "LAG1" - "LAG24".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>MAC</maml:name> <maml:description> <maml:para>Requested MAC address of the connection. Must be specified if setting WWPN and WWNN, and the connection is mapped to a FlexHBA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>MutualChapName</maml:name> <maml:description> <maml:para>The Mutual CHAP challange.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI" aliases="None"> <maml:name>MutualChapSecret</maml:name> <maml:description> <maml:para>The Mutual CHAP challange secret. Accepts ASCII or HEX values. If providing an ASCII secret value, the length must be bewteen 12 and 16 characters. If HEX, it must start with 0x and with 24-32 characters. Value is ignored when creating a Connection for a Server Profile Template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>A string used to identify the respective connection. The connection name is case insensitive, limited to 63 characters and must be unique within the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>Network</maml:name> <maml:description> <maml:para>The Network (Ethernet or Fibre Channel) or Network Set resource object to be used with this connection. Can either be the Name, URI, or object obtained with Get-HPOVNetwork or Get-HPOVNetworkSet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>PortId</maml:name> <maml:description> <maml:para>Identifies the port (FlexNIC) used for this connection. The port can be automatically selected by specifying "Auto" when creating the connection. "None" is a valid portID for an unconfigured, and unmapped Connection. If you wish to specify the specific port, the portId format is "[adapter_type_prefix] [adapter_id]:[subport_id]". G7 only: For LOM ports, the valid portId prefix will be "Lom" Gen8 only: For FlexLOMs, the valid portId prefix will be "Flb" Mezzanine adapter prefix is "Mezz" An example of a FlexLOM 1, FlexNIC 1a interface would be "Flb 1:1a". An example Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Optional boot option for this connection, but Required if -bootable is specified. Allowed values: * NotBootable * UseBIOS * Primary * Secondary * IscsiPrimary * IscsiSecondary When the Connection Type is Ethernet, this affects PXE boot. If the Connection Type is FibreChannel, this enables BfS settings. Default: NotBootable</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>NotBootable</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>RequestedBW</maml:name> <maml:description> <maml:para>Requested bandwidth (in Mbps) to be used for this connection. Default: 2500</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>2500</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="ArrayWwpn"> <maml:name>TargetWwpn</maml:name> <maml:description> <maml:para>Target FC array WWPN.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ISCSI, FC, Ethernet, Common" aliases="None"> <maml:name>UserDefined</maml:name> <maml:description> <maml:para>Use to specify user defined address values</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>Virtualfunctions</maml:name> <maml:description> <maml:para>Specify the number of Virtual Functions to enable on an Ethernet Connection. Must be in increments of 16.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="None"> <maml:name>WWNN</maml:name> <maml:description> <maml:para>Requested WWNN address of the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FC" aliases="None"> <maml:name>WWPN</maml:name> <maml:description> <maml:para>Requested WWPN address of the connection.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns a connection object which may be used during profile creation with the New-HPOVServerProfile Cmdlet</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>$net41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop $con41 = New-HPOVServerProfileConnection -ConnectionID 1 -ConnectionType Ethernet -Network $net41</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$con41 = Get-HPOVNetwork -Name "FCoE Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1 -ConnectionType FibreChannel</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 1, that is assigned to the FCoE network "FCoE Fabric A", with Auto Port assignment.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$net42 = Get-HPOVNetwork -Name "Net-42" -ErrorAction Stop $con42 = New-HPOVServerProfileConnection -ConnectionID 2 -ConnectionType Ethernet -network $net42 -bootable -priority Primary</dev:code> <dev:remarks> <dev:para>Create a Server Profile Connection ID 2, assigned to Net42 that is PXE Primary bootable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$conFabricA = Get-HPOVNetwork -Name "Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -ConnectionType FibreChannel -bootable -priority Primary -Bootable</dev:code> <dev:remarks> <dev:para>Create a Server Profile Connection ID 3, assigned to Fabric A that is FC BfS Primary bootable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$con41 = Get-HPOVNetwork -Name "Net-41" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 1 -ConnectionType Ethernet -userdefined -mac 11:22:33:44:55:66 -name "VLAN41 Prod Net"</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 1, that is assigned to Net41 network, with Auto Port assignment and custom MAC Address.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$con41 = Get-HPOVNetwork -Name "Fabric A" | New-HPOVServerProfileConnection -ConnectionID 3 -ConnectionType FibreChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:a1:55:1b:8f -name "VC FF Fabric A Connection"</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 3, that is assigned to a FibreChannel network, with Auto Port assignment and user defined hardware address values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$con41 = Get-HPOVNetwork -Name "Fabric A" -ErrorAction Stop | New-HPOVServerProfileConnection -ConnectionID 3 -ConnectionType FibreChannel -userdefined -mac 11:22:33:44:55:66 -wwpn 10:00:00:00:a1:55:1b:8f -wwnn 20:00:00:00:a1:55:1b:8f -name "VC FF Fabric A Connection"</dev:code> <dev:remarks> <dev:para>Create a Network Connection ID 3, that is assigned to a FibreChannel network, with Auto Port assignment and user defined hardware address values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 9 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ISCSINetwork = Get-HPOVNetwork -Name "ImageStreamer Boot Network" -ErrorAction Stop $IscsiParams = @{ ConnectionID = 1; Name = "ImageStreamer Connection 1"; ConnectionType = "Ethernet"; Network = $ISCSINetwork; Bootable = $true; Priority = "Primary"; IscsiIPv4AddressSource = "SubnetPool" } $ImageStreamerBootConnection1 = New-HPOVServerProfileConnection @IscsiParams</dev:code> <dev:remarks> <dev:para>Create an HPE Synergy Image Streamer compliant connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILEILOPOLICY--> <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"> <!--NEW-HPOVSERVERPROFILEILOPOLICY--> <command:details> <command:name>New-HPOVServerProfileIloPolicy</command:name> <maml:description> <maml:para>Create compliant iLO settings object for server profile type resources.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileIloPolicy</command:noun> </command:details> <maml:description> <maml:para>iLO settings enable you to configure and manage the settings in HPE OneView instead of logging into the iLO to apply the needed settings. These settings are included when you move the profile to another server hardware instance. Use a server profile template if you want to maintain consistent management for a specific iLO setting across multiple iLO. Using this Cmdlet will help create a compliant iLO settings object for either a server profile template or server profile resource. Manage administrator account Configure the password of the predefined iLO administrator account or delete the account. Manage local accounts Configure and manage the local accounts. When managed from HPE OneView, all the local accounts on the iLO are replaced when configuring the accounts specified in the server profile. Use New-HPOVIloLocalUserAccount helper Cmdlet to create a compliant object. Manage iLO Hostname Configure the iLO subsystem name (hostname). When the iLO networking is configured to use DHCP, the iLO subsystem name will be used as the DNS name for the iLO. When the Manage iLO Hostname setting is enabled for a server profile, the hostname applied to the iLO is determined by replacing any serverProfileName token present with the name of server profile. The resulting hostname must match the limitations of a hostname (A-Z, a-z, 0-9, and dash). When applied to the server hardware, the iLO is reset to apply the new networking configuration. When the server profile is unassigned or the Manage iLO hostname setting is disabled, the iLO hostname is reverted to the factory default, which is, ΓǣiLO + Server Physical Serial NumberΓǥ. Manage directory configuration Configure the iLO directory (Active Directory, LDAP, or Kerberos) to enable single sign-on. Manage directory groups Grant access to specific directory groups for the iLO on the server hardware that is associated with the profile. When managed from HPE OneView, all the directory groups on the iLO are replaced when configuring the directory groups specified in the server profile. Use New-HPOVIloDirectoryGroup helper Cmdlet to create a compliant object. Manage key manager Configure the iLO key manager for data at rest secure encryption. Planning for iLOdirectory configuration and key management Hewlett Packard Enterprise recommends that you plan your iLOdirectory configuration and key management in advance, and test on an iLO in the iLO interface. Confirm that the configuration is correct before configuring the iLO directory and key manager in HPE OneView using the tested settings. For more information, see the HPE iLO User Guide (http://www.hpe.com/support/ilo-docs).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileIloPolicy</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManageLocalAdministratorAccount</maml:name> <maml:description> <maml:para>The iLO Administrator account will be managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LocalAdministratorPassword</maml:name> <maml:description> <maml:para>The password to set for the local administrator account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>RemoveLocalAdministratorAccount</maml:name> <maml:description> <maml:para>Delete the account named Administrator from the iLO. WARNING: The iLO account named Administrator will be deleted when the profile is applied and cannot later be restored by OneView with the original permissions. The 'Administrative Recovery Set' privilege can only be restored via an iLO factory reset operation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManageLocalAccounts</maml:name> <maml:description> <maml:para>Replace all local iLO accounts beyond Administrator. If you omit the LocalAccount parameter, all existing local accounts will be removed, except the build-in local Administrator and the configured _HPOneViewAdmin privileged accounts. The local Administrator account can be removed using the RemoveLocalAdministratorAccount, but you then risk locking everyone from accessing the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LocalAccounts</maml:name> <maml:description> <maml:para>A collection of 1 or more local accounts created from New-HPOVIloLocalUserAccount helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManageDirectoryConfiguration</maml:name> <maml:description> <maml:para>The iLO directory configuration (Active Directory, LDAP, or Kerberos) is managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LdapSchema</maml:name> <maml:description> <maml:para>Enable use of a directory service for iLO user authorization. Allowed values: * Disabled * DirectoryDefaulr * HPEExtended</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>GenericLDAP</maml:name> <maml:description> <maml:para>Use the OpenLDAP supported BIND method. Only supported when LdapSchema is DirectoryDefault.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LOMObjectDistinguishedName</maml:name> <maml:description> <maml:para>Specifies the CAC LDAP service account when CAC/Smartcard authentication is configured and used with the schema-free directory option. User search contexts are not applied to the iLO object DN when iLO accesses the directory server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>IloObjectPassword</maml:name> <maml:description> <maml:para>Specifies the password for the CAC LDAP service account when CAC/Smartcard authentication is configured and used with the schema-free directory option. User search contexts are not applied to the iLO object DN when iLO accesses the directory server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryServerAddress</maml:name> <maml:description> <maml:para>Specifies the network DNS name or IP address of the directory server. The directory server address can be up to 127 characters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryServerPort</maml:name> <maml:description> <maml:para>Specifies the port number for the secure LDAP service on the server. The default value is 636. If your directory service is configured to use a different port, you can specify a different value. Make sure that you enter a secured LDAP port. iLO cannot connect to an unsecured LDAP port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryServerCertificate</maml:name> <maml:description> <maml:para>Specifies a CA certificate to authenticate the directory server. The relative path and file name of the PEM Base64 string format file of the certificate to be used. Omit if the certificate has already been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryServerCertificateBase64</maml:name> <maml:description> <maml:para>Specifies a CA certificate to authenticate the directory server. The PEM Base64 string format of the certificate to be used. Omit if the certificate has already been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryUserContext</maml:name> <maml:description> <maml:para>A common directory sub-context to be searched such that users do not need to enter their full DNs at login.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnableKerberosAuthentication</maml:name> <maml:description> <maml:para>Enables Kerberos login. When Kerberos login is enabled and configured correctly, the Zero Sign In button appears on the iLO login page. Kerberos configuration is independent of the LdapSchema chosen.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KerberosRealm</maml:name> <maml:description> <maml:para>The name of the Kerberos realm in which the iLO processor operates. This value can be up to 128 characters. The realm name is usually the DNS name converted to uppercase letters. Realm names are case-sensitive.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KerberosKDCServerAddress</maml:name> <maml:description> <maml:para>The IP address or DNS name of the KDC server. This value can be up to 128 characters. Each realm must have at least one Key Distribution Center (KDC) that contains an authentication server and a ticket grant server. These servers can be combined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KerberosKDCServerPort</maml:name> <maml:description> <maml:para>The TCP or UDP port number on which the KDC is listening. The default value is 88.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KerbersKeyTabFile</maml:name> <maml:description> <maml:para>An encoded binary file that contains pairs of service principal names and encrypted passwords. In the Windows environment, you use the ktpass utility to generate the keytab file. The components of the service principal name stored in the Kerberos keytab file are case sensitive. The primary (service type) must be in upper case (HTTP). The instance (iLO hostname) must be in lower case (e.g., iloexample.example.net). The realm name must be in upper case (e.g., EXAMPLE.NET). The REST encoding of this argument is a Base64-encoded Kerberos Keytab file as a string.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManageDirectoryGroups</maml:name> <maml:description> <maml:para>Replace all directory groups providing iLO management permissions. If you omit the DirectoryGroups parameter, all configured directory groups that exist on the iLO will be removed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryGroups</maml:name> <maml:description> <maml:para>A collection of 1 or more directory groups created from New-HPOVIloDirectoryGroup helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ManageKeyManager</maml:name> <maml:description> <maml:para>The iLO Key Manager (e.g. ESKM) configuration will be managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PrimaryKeyServerAddress</maml:name> <maml:description> <maml:para>The primary key server hostname, IP address, or FQDN. This string can be up to 79 characters long.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PrimaryKeyServerPort</maml:name> <maml:description> <maml:para>The primary key server port. The default is 9000.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecondaryKeyServerAddress</maml:name> <maml:description> <maml:para>The secondary key server hostname, IP address, or FQDN. This string can be up to 79 characters long.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecondaryKeyServerPort</maml:name> <maml:description> <maml:para>The secondary key server port. The default is 9000.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>RedundancyRequired</maml:name> <maml:description> <maml:para>If enabled, both a primary and secondary key server must be specified and will be validated by the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KeymanagerGroupName</maml:name> <maml:description> <maml:para>The Local Group created on the key manager for use with iLO user accounts and the keys iLO imports into the key manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KeymanagerLocalCertificateName</maml:name> <maml:description> <maml:para>The optional name of the local certificate authority certificate on the key manager. It is typically named Local CA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KeymanagerLoginName</maml:name> <maml:description> <maml:para>The Local User name with administrator permissions that is configured on the key manager. The deployment user account must be created before you add key manager configuration details in iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>KeymanagerPassword</maml:name> <maml:description> <maml:para>The password for the Local User name with administrator permissions that is configured on the key manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryGroups</maml:name> <maml:description> <maml:para>A collection of 1 or more directory groups created from New-HPOVIloDirectoryGroup helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryServerAddress</maml:name> <maml:description> <maml:para>Specifies the network DNS name or IP address of the directory server. The directory server address can be up to 127 characters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryServerCertificate</maml:name> <maml:description> <maml:para>Specifies a CA certificate to authenticate the directory server. The relative path and file name of the PEM Base64 string format file of the certificate to be used. Omit if the certificate has already been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryServerCertificateBase64</maml:name> <maml:description> <maml:para>Specifies a CA certificate to authenticate the directory server. The PEM Base64 string format of the certificate to be used. Omit if the certificate has already been added to the appliance trust store.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryServerPort</maml:name> <maml:description> <maml:para>Specifies the port number for the secure LDAP service on the server. The default value is 636. If your directory service is configured to use a different port, you can specify a different value. Make sure that you enter a secured LDAP port. iLO cannot connect to an unsecured LDAP port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryUserContext</maml:name> <maml:description> <maml:para>A common directory sub-context to be searched such that users do not need to enter their full DNs at login.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnableKerberosAuthentication</maml:name> <maml:description> <maml:para>Enables Kerberos login. When Kerberos login is enabled and configured correctly, the Zero Sign In button appears on the iLO login page. Kerberos configuration is independent of the LdapSchema chosen.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>GenericLDAP</maml:name> <maml:description> <maml:para>Use the OpenLDAP supported BIND method. Only supported when LdapSchema is DirectoryDefault.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>IloObjectPassword</maml:name> <maml:description> <maml:para>Specifies the password for the CAC LDAP service account when CAC/Smartcard authentication is configured and used with the schema-free directory option. User search contexts are not applied to the iLO object DN when iLO accesses the directory server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KerberosKDCServerAddress</maml:name> <maml:description> <maml:para>The IP address or DNS name of the KDC server. This value can be up to 128 characters. Each realm must have at least one Key Distribution Center (KDC) that contains an authentication server and a ticket grant server. These servers can be combined.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KerberosKDCServerPort</maml:name> <maml:description> <maml:para>The TCP or UDP port number on which the KDC is listening. The default value is 88.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KerberosRealm</maml:name> <maml:description> <maml:para>The name of the Kerberos realm in which the iLO processor operates. This value can be up to 128 characters. The realm name is usually the DNS name converted to uppercase letters. Realm names are case-sensitive.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KerbersKeyTabFile</maml:name> <maml:description> <maml:para>An encoded binary file that contains pairs of service principal names and encrypted passwords. In the Windows environment, you use the ktpass utility to generate the keytab file. The components of the service principal name stored in the Kerberos keytab file are case sensitive. The primary (service type) must be in upper case (HTTP). The instance (iLO hostname) must be in lower case (e.g., iloexample.example.net). The realm name must be in upper case (e.g., EXAMPLE.NET). The REST encoding of this argument is a Base64-encoded Kerberos Keytab file as a string.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KeymanagerGroupName</maml:name> <maml:description> <maml:para>The Local Group created on the key manager for use with iLO user accounts and the keys iLO imports into the key manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KeymanagerLocalCertificateName</maml:name> <maml:description> <maml:para>The optional name of the local certificate authority certificate on the key manager. It is typically named Local CA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KeymanagerLoginName</maml:name> <maml:description> <maml:para>The Local User name with administrator permissions that is configured on the key manager. The deployment user account must be created before you add key manager configuration details in iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>KeymanagerPassword</maml:name> <maml:description> <maml:para>The password for the Local User name with administrator permissions that is configured on the key manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LOMObjectDistinguishedName</maml:name> <maml:description> <maml:para>Specifies the CAC LDAP service account when CAC/Smartcard authentication is configured and used with the schema-free directory option. User search contexts are not applied to the iLO object DN when iLO accesses the directory server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LdapSchema</maml:name> <maml:description> <maml:para>Enable use of a directory service for iLO user authorization. Allowed values: * Disabled * DirectoryDefaulr * HPEExtended</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LocalAccounts</maml:name> <maml:description> <maml:para>A collection of 1 or more local accounts created from New-HPOVIloLocalUserAccount helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LocalAdministratorPassword</maml:name> <maml:description> <maml:para>The password to set for the local administrator account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManageDirectoryConfiguration</maml:name> <maml:description> <maml:para>The iLO directory configuration (Active Directory, LDAP, or Kerberos) is managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManageDirectoryGroups</maml:name> <maml:description> <maml:para>Replace all directory groups providing iLO management permissions. If you omit the DirectoryGroups parameter, all configured directory groups that exist on the iLO will be removed.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManageKeyManager</maml:name> <maml:description> <maml:para>The iLO Key Manager (e.g. ESKM) configuration will be managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManageLocalAccounts</maml:name> <maml:description> <maml:para>Replace all local iLO accounts beyond Administrator. If you omit the LocalAccount parameter, all existing local accounts will be removed, except the build-in local Administrator and the configured _HPOneViewAdmin privileged accounts. The local Administrator account can be removed using the RemoveLocalAdministratorAccount, but you then risk locking everyone from accessing the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ManageLocalAdministratorAccount</maml:name> <maml:description> <maml:para>The iLO Administrator account will be managed via the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PrimaryKeyServerAddress</maml:name> <maml:description> <maml:para>The primary key server hostname, IP address, or FQDN. This string can be up to 79 characters long.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PrimaryKeyServerPort</maml:name> <maml:description> <maml:para>The primary key server port. The default is 9000.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>RedundancyRequired</maml:name> <maml:description> <maml:para>If enabled, both a primary and secondary key server must be specified and will be validated by the iLO.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>RemoveLocalAdministratorAccount</maml:name> <maml:description> <maml:para>Delete the account named Administrator from the iLO. WARNING: The iLO account named Administrator will be deleted when the profile is applied and cannot later be restored by OneView with the original permissions. The 'Administrative Recovery Set' privilege can only be restored via an iLO factory reset operation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecondaryKeyServerAddress</maml:name> <maml:description> <maml:para>The secondary key server hostname, IP address, or FQDN. This string can be up to 79 characters long.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecondaryKeyServerPort</maml:name> <maml:description> <maml:para>The secondary key server port. The default is 9000.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An iLO settings complient object for server profile resources. </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>$AdministratorPasswordSecureString = Read-Host "Administrator password" -AsSecureString # Create iLO settings policy for server profile New-HPOVServerProfileIloPolicy -ManageLocalAdministratorAccount ` -LocalAdministratorPassword $AdministratorPasswordSecureString ` -ManageIloHostname ` -IloHostname "{serverProfileName}-prod-ilo"</dev:code> <dev:remarks> <dev:para>Create a server profile compliant iLO settings policy by setting the local administrator password to the prompted value, and set the iLO hostname.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Create account1 object $Account1 = New-HPOVIloLocalUserAccount -Username "localuser1" ` -Password (Read-Host "localuser1 password" -AsSecureString) ` -DisplayName "localuser1" ` -AdministerUserAccounts ` -RemoteConsole ` -VirtualMedia ` -VirtualPowerAndReset ` -ConfigureIloSettings ` -Login ` -HostBIOS ` -HostNIC ` -HostStorage # Create account2 object $Account2 = New-HPOVIloLocalUserAccount -Username "localuser2" ` -Password (Read-Host "localuser1 password" -AsSecureString) ` -DisplayName "localuser2" ` -RemoteConsole ` -VirtualMedia ` -VirtualPowerAndReset ` -Login ` -HostBIOS ` -HostNIC ` -HostStorage # Create group1 object $Group1 = New-HPOVIloDirectoryGroup -GroupDN "dn=ilogroup1, ou=ou1, dc=domain, dc=com" ` -GroupSID "sid12345" ` -AdministerUserAccounts ` -RemoteConsole ` -VirtualMedia ` -ConfigureIloSettings # Create group2 object $Group2 = New-HPOVIloDirectoryGroup -GroupDN "dn=opsgroup, ou=ou1, dc=domain,d c=com" ` -GroupSID "sid67890" ` -RemoteConsole ` -VirtualMedia # Create iLO settings policy for server profile New-HPOVServerProfileIloPolicy -ManageLocalAdministratorAccount ` -LocalAdministratorPassword $AdministratorPasswordSecureString ` -ManageLocalAccounts ` -LocalAccounts $Account1, $Account2 ` -ManageDirectoryConfiguration ` -LdapSchema DirectoryDefault ` -LOMObjectDistinguishedName "dn=lomobject, ou=OU1, dc=domain, dc=com" ` -DirectoryServerAddress "ldap.domain.com" ` -DirectoryUserContext 'ou=OU1, dc=domain, dc=com', 'ou=OU2, dc=domain, dc=com', 'ou=OU3, dc=domain, dc=com' ` -ManageDirectoryGroups ` -DirectoryGroups $Group1, $Group2 ` -ManageIloHostname ` -IloHostname "{serverProfileName}-prod-ilo"</dev:code> <dev:remarks> <dev:para>Create a server profile compliant iLO settings policy, by managing the local administrator account, adding the specified local accounts, directory authentication and directory groups, and iLO hostname.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVIloLocalUserAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVIloDirectoryGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILELOGICALDISK--> <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"> <!--NEW-HPOVSERVERPROFILELOGICALDISK--> <command:details> <command:name>New-HPOVServerProfileLogicalDisk</command:name> <maml:description> <maml:para>Create Server Profile Logical Disk object.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileLogicalDisk</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet will create a Logical Disk object to then be assigned to a Server Profile Template or Server Profile using the -LogicalDisk parameter. The LogicalDisk configuration is supported with the embedded (or Slot 0) HPE SmartArray controller for DL and BL class systems only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileLogicalDisk</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Disk name. Must be unique within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>RAID</maml:name> <maml:description> <maml:para>The RAID level of the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Only RAID0 and RAID1 are supported for embedded BL disk policies. RAID5, RAID6, RAID10 are supported with DL servers with SmartArray controller that supports the RAID type. RAID0, RAID1ADM, RAID10, RAID5, and RAID6 are supported values with HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>The number of physical drives to be used to build the logical drive. The provided values must be consistent with the selected RAID level and cannot exceed the maximum supported number of drives for the selected server hardware type.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>DriveType</maml:name> <maml:description> <maml:para>Defines the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Allowed value: * SAS *SATA *SASSSD *SATASSD *Auto NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk technology type unless -DriveSelectionBy is changed to DriveType and -AvailableDriveType is used. Allowed values are: * SAS * SATA * SASSSD * SATASSD * NVMeSas * NVMeSata * Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>StorageLocation</maml:name> <maml:description> <maml:para>Specify Internal for HPE Synergy Compute Nodes that have the Expanded Storage option connected to an available mezzanine SmartArray controller for NVMe drives. DriveType parameter then must be set to NVMeSata or NVMeSAS. Use External to specify storage will be allocated from the D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>For Gen10 Smart Array controllers only. When using Auto for drive type allocation and supplied 'Enabled', the Accelorator policy will be set to 'ControllerCache'. If drive allocation type is an 'SSD' drive, the accelorator policy will be set to 'IOBypass'. Disabled will set the accelorator policy to 'None'. Default is 'Unmanaged'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Indicates if the logical drive is bootable or not. Cannot be combined with an FC or FCoE Server Profile Connection that is also set as Bootable. Parameter is not valid with defining Synergy JBOD SAS disk policies.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileLogicalDisk</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Disk name. Must be unique within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>RAID</maml:name> <maml:description> <maml:para>The RAID level of the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Only RAID0 and RAID1 are supported for embedded BL disk policies. RAID5, RAID6, RAID10 are supported with DL servers with SmartArray controller that supports the RAID type. RAID0, RAID1ADM, RAID10, RAID5, and RAID6 are supported values with HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>The number of physical drives to be used to build the logical drive. The provided values must be consistent with the selected RAID level and cannot exceed the maximum supported number of drives for the selected server hardware type.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>DriveType</maml:name> <maml:description> <maml:para>Defines the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Allowed value: * SAS *SATA *SASSSD *SATASSD *Auto NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk technology type unless -DriveSelectionBy is changed to DriveType and -AvailableDriveType is used. Allowed values are: * SAS * SATA * SASSSD * SATASSD * NVMeSas * NVMeSata * Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD"> <maml:name>DriveSelectionBy</maml:name> <maml:description> <maml:para>Use to specify how the drive selection will be used. Allowed values: * DriveType - Use Get-HPOVAvailableDriveType to locate available drive types, quantity to which SAS Logical Interconnect or Drive Enclosure. * SizeAndTechnology - Use to define the attributes of the drive based on technology and min/max drive size. The -DriveType and -MinDriveSize parameters are required. Default: SizeAndTechnology</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="SynergyJBOD"> <maml:name>AvailableDriveType</maml:name> <maml:description> <maml:para>A specific availabe drive type from Get-HPOVAvailableDriveType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.AvailableDriveType</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>StorageLocation</maml:name> <maml:description> <maml:para>Specify Internal for HPE Synergy Compute Nodes that have the Expanded Storage option connected to an available mezzanine SmartArray controller for NVMe drives. DriveType parameter then must be set to NVMeSata or NVMeSAS. Use External to specify storage will be allocated from the D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD"> <maml:name>MinDriveSize</maml:name> <maml:description> <maml:para>Only for HPE Synergy D3940. Specify the minimum size disk to request. Required when -DriveSelectionBy is set to SizeAndTechnology.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD"> <maml:name>MaxDriveSize</maml:name> <maml:description> <maml:para>Only for HPE Synergy D3940. If the parameter is not specified, the MinDriveSize parameter value will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>Indicates if the logical drive should be erased when it is deleted from or with the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Indicates if the logical drive is bootable or not. Cannot be combined with an FC or FCoE Server Profile Connection that is also set as Bootable. Parameter is not valid with defining Synergy JBOD SAS disk policies.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Accelerator</maml:name> <maml:description> <maml:para>For Gen10 Smart Array controllers only. When using Auto for drive type allocation and supplied 'Enabled', the Accelorator policy will be set to 'ControllerCache'. If drive allocation type is an 'SSD' drive, the accelorator policy will be set to 'IOBypass'. Disabled will set the accelorator policy to 'None'. Default is 'Unmanaged'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Unmanaged</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="SynergyJBOD" aliases="None"> <maml:name>AvailableDriveType</maml:name> <maml:description> <maml:para>A specific availabe drive type from Get-HPOVAvailableDriveType.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.AvailableDriveType</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.AvailableDriveType</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>Bootable</maml:name> <maml:description> <maml:para>Indicates if the logical drive is bootable or not. Cannot be combined with an FC or FCoE Server Profile Connection that is also set as Bootable. Parameter is not valid with defining Synergy JBOD SAS disk policies.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD" aliases="None"> <maml:name>DriveSelectionBy</maml:name> <maml:description> <maml:para>Use to specify how the drive selection will be used. Allowed values: * DriveType - Use Get-HPOVAvailableDriveType to locate available drive types, quantity to which SAS Logical Interconnect or Drive Enclosure. * SizeAndTechnology - Use to define the attributes of the drive based on technology and min/max drive size. The -DriveType and -MinDriveSize parameters are required. Default: SizeAndTechnology</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>SizeAndTechnology</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>DriveType</maml:name> <maml:description> <maml:para>Defines the interface type for drives that will be used to build the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Allowed value: * SAS *SATA *SASSSD *SATASSD *Auto NOTE: Auto is not supported when attempting to create an HPE Synergy D3940 Logical or JBOD disk. You must specify a disk technology type unless -DriveSelectionBy is changed to DriveType and -AvailableDriveType is used. Allowed values are: * SAS * SATA * SASSSD * SATASSD * NVMeSas * NVMeSata * Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD" aliases="None"> <maml:name>EraseDataOnDelete</maml:name> <maml:description> <maml:para>Indicates if the logical drive should be erased when it is deleted from or with the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD" aliases="None"> <maml:name>MaxDriveSize</maml:name> <maml:description> <maml:para>Only for HPE Synergy D3940. If the parameter is not specified, the MinDriveSize parameter value will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD" aliases="None"> <maml:name>MinDriveSize</maml:name> <maml:description> <maml:para>Only for HPE Synergy D3940. Specify the minimum size disk to request. Required when -DriveSelectionBy is set to SizeAndTechnology.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Disk name. Must be unique within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>NumberofDrives</maml:name> <maml:description> <maml:para>The number of physical drives to be used to build the logical drive. The provided values must be consistent with the selected RAID level and cannot exceed the maximum supported number of drives for the selected server hardware type.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>RAID</maml:name> <maml:description> <maml:para>The RAID level of the logical drive. Supported values depend on the local storage capabilities of the selected server hardware type. Only RAID0 and RAID1 are supported for embedded BL disk policies. RAID5, RAID6, RAID10 are supported with DL servers with SmartArray controller that supports the RAID type. RAID0, RAID1ADM, RAID10, RAID5, and RAID6 are supported values with HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>RAID1</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SynergyJBOD, Default" aliases="None"> <maml:name>StorageLocation</maml:name> <maml:description> <maml:para>Specify Internal for HPE Synergy Compute Nodes that have the Expanded Storage option connected to an available mezzanine SmartArray controller for NVMe drives. DriveType parameter then must be set to NVMeSata or NVMeSAS. Use External to specify storage will be allocated from the D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>External</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.AvailableDriveType</maml:name> </dev:type> <maml:description> <maml:para>An available disk drive type from Get-HPOVAvailableDriveType Cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Logical Disk configuration object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<System.Management.Automation.PSCustomObject></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Logical Disk configuration objects</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>$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "MyDisk"</dev:code> <dev:remarks> <dev:para>Create a default Logical Disk configuration object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ld1 = New-HPOVServerProfileLogicalDisk -Name "Boot Disk" -RAID RAID1 -NumberofDrives 2 -Bootable $True</dev:code> <dev:remarks> <dev:para>Create a custom Logical Disk with the provided parameter values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ld1 = New-HPOVServerProfileLogicalDisk -Name "Boot Disk" -RAID RAID1 -NumberofDrives 2 -DriveType SAS -MinDriveSize 300 -Bootable $True</dev:code> <dev:remarks> <dev:para>Create a custom HPE Synergy D3940 bootable RAID Logical Disk with the provided parameter values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | Get-HPOVAvailableDriveType | ? { $_.Type -eq "SASHDD" -and $_.capacity -eq 900 } $NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "LD1_RAID5_900GB_SASHDD" -DriveSelectionBy DriveType -NumberofDrives 6 -RAID RAID5 -AvailableDriveType $AvailableDriveType</dev:code> <dev:remarks> <dev:para>Create a RAID5 Logical Disk for a Server Profile using D3940 storage, and a specific available drive type, 900GB capacity and SASHDD type.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$JBODLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "JBOD1_900GB_SASHDD" -NumberofDrives 6 -MinDriveSize 900 -DriveType SAS</dev:code> <dev:remarks> <dev:para>Create logical JBOD to then be attached to either a Gen10 Mixed Mode or Gen9 or newer HBA mode controller.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILELOGICALDISKCONTROLLER--> <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"> <!--NEW-HPOVSERVERPROFILELOGICALDISKCONTROLLER--> <command:details> <command:name>New-HPOVServerProfileLogicalDiskController</command:name> <maml:description> <maml:para>Create Server Profile disk controller policy object.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileLogicalDiskController</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet will create a Logical Disk controller object to then be assigned to a Server Profile Template or Server Profile using the -LogicalDisk parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileLogicalDiskController</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>ControllerID</maml:name> <maml:description> <maml:para>Specify the Controller ID location. Supported options for this parameter are * Embedded * Mezz 1 * Mezz 2 * Mezz 3 Please note that Mezz 1, Mezz 2 and Mezz 3 are only supported with HPE Synergy Compute nodes connected to the HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode to configure the Smart Array Controller as. Accepted values are: * HBA * RAID When specifying HBA, you cannot attach a RAID Logical Disk to this policy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>Initialize</maml:name> <maml:description> <maml:para>Use this parameter to re-initialize the controller. This will wipe any existing logical disk configured for the controller and deploy the new policy defined. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>WriteCache</maml:name> <maml:description> <maml:para>For Gen10 controllers, to enable, disable or unmanage controller write cache policy. Allowed values: * Enabled * Disabled * Unmanaged Default value: Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>LogicalDisk</maml:name> <maml:description> <maml:para>A collection of Logical Disk objects from the New-HPOVServerProfileLogicalDisk Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileLogicalDiskController</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>ControllerID</maml:name> <maml:description> <maml:para>Specify the Controller ID location. Supported options for this parameter are * Embedded * Mezz 1 * Mezz 2 * Mezz 3 Please note that Mezz 1, Mezz 2 and Mezz 3 are only supported with HPE Synergy Compute nodes connected to the HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode to configure the Smart Array Controller as. Accepted values are: * HBA * RAID When specifying HBA, you cannot attach a RAID Logical Disk to this policy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>Initialize</maml:name> <maml:description> <maml:para>Use this parameter to re-initialize the controller. This will wipe any existing logical disk configured for the controller and deploy the new policy defined. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default"> <maml:name>WriteCache</maml:name> <maml:description> <maml:para>For Gen10 controllers, to enable, disable or unmanage controller write cache policy. Allowed values: * Enabled * Disabled * Unmanaged Default value: Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import"> <maml:name>ImportExistingConfiguration</maml:name> <maml:description> <maml:para>Specify to import any found Logical Disk configuration and add to the Server Profile as the Logical Disk policy. This option is not available for Server Profile Templates. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default" aliases="None"> <maml:name>ControllerID</maml:name> <maml:description> <maml:para>Specify the Controller ID location. Supported options for this parameter are * Embedded * Mezz 1 * Mezz 2 * Mezz 3 Please note that Mezz 1, Mezz 2 and Mezz 3 are only supported with HPE Synergy Compute nodes connected to the HPE Synergy D3940 disk shelf.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>Embedded</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import" aliases="None"> <maml:name>ImportExistingConfiguration</maml:name> <maml:description> <maml:para>Specify to import any found Logical Disk configuration and add to the Server Profile as the Logical Disk policy. This option is not available for Server Profile Templates. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default" aliases="None"> <maml:name>Initialize</maml:name> <maml:description> <maml:para>Use this parameter to re-initialize the controller. This will wipe any existing logical disk configured for the controller and deploy the new policy defined. Not supported when ControllerID is "Mezz 1", "Mezz 2", or "Mezz 3".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>LogicalDisk</maml:name> <maml:description> <maml:para>A collection of Logical Disk objects from the New-HPOVServerProfileLogicalDisk Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default" aliases="None"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode to configure the Smart Array Controller as. Accepted values are: * HBA * RAID When specifying HBA, you cannot attach a RAID Logical Disk to this policy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>RAID</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Import, Default" aliases="None"> <maml:name>WriteCache</maml:name> <maml:description> <maml:para>For Gen10 controllers, to enable, disable or unmanage controller write cache policy. Allowed values: * Enabled * Disabled * Unmanaged Default value: Unmanaged</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Unmanaged</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile.LogicalDisk [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.ServerProfile.LogicalDisk></maml:name> </dev:type> <maml:description> <maml:para>Collection of Logical Disk configuration policy from New-HPOVServerProfileLogicalDisk</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerProfile.Controller [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Server Profile Controller configuration object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.ServerProfile.Controller></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Server Profile Controller configuration objects</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>$LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "MyDisk" | New-HPOVServerProfileLogicalDiskController -Initialize</dev:code> <dev:remarks> <dev:para>Create a default Logical Disk and Controller configuration object policy.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVServerProfileLogicalDiskController -Mode HBA</dev:code> <dev:remarks> <dev:para>Create an HBA controller policy, which will then set the controller to JBOD mode.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name "MyDisk" $LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name "MyDisk2" $Controller = New-HPOVServerProfileLogicalDiskController -Initialize -LogicalDisk $LogicalDisk1,$LogicalDisk2</dev:code> <dev:remarks> <dev:para>Create a default Logical Disk and Controller configuration object policy.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LogicalDisk1 = New-HPOVServerProfileLogicalDisk -Name Boot -RAID RAID1 -MinDriveSize 300 -MaxDriveSize 300 -DriveType SAS -Bootable $True $LogicalDisk2 = New-HPOVServerProfileLogicalDisk -Name Data -RAID RAID5 -NumberofDrives 5 -MinDriveSize 300 -MaxDriveSize 300 -DriveType SAS $Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Mode RAID -LogicalDisk $LogicalDisk1,$LogicalDisk2</dev:code> <dev:remarks> <dev:para>Create a HPE Synergy D3940 RAID disk policy, with a bootable volume.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$AvailableDriveType = Get-HPOVSasLogicalInterconnect -Name "LE1-Default SAS Synergy LIG-3" -ErrorAction Stop | Get-HPOVAvailableDriveType | ? { $_.Type -eq "SASHDD" -and $_.capacity -eq 900 } $NewLogicalDisk = New-HPOVServerProfileLogicalDisk -Name "LD1_RAID5_900GB_SASHDD" -DriveSelectionBy DriveType -NumberofDrives 6 -RAID RAID5 -AvailableDriveType $AvailableDriveType C:\> $Controller = New-HPOVServerProfileLogicalDiskController -ControllerID "Mezz 1" -Mode RAID -LogicalDisk $NewLogicalDisk</dev:code> <dev:remarks> <dev:para>Create a RAID5 Logical Disk for a Server Profile using D3940 storage, and a specific available drive type, 900GB capacity and SASHDD type, and assign it to a new Controller.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSERVERPROFILETEMPLATE--> <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"> <!--NEW-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>New-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Create a Server Profile Template</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to create or import an HPE OneView Server Profile Template. A Server Profile Template is the parent configuration for a Server Profile instance. Server profiles capture the entire server configuration in one place, enabling you to consistently replicate new server profiles and to rapidly modify them to reflect changes in your data center. A Server Profile Template includes: * Basic server identification information * Connectivity settings for Ethernet networks, network sets, and Fibre Channel networks * Firmware versions * Local storage settings * SAN storage settings * BIOS settings * Boot order * Physical or virtual UUIDs, MAC addresses, and WWN addresses When you create a server profile template, it is designated for a server hardware type and enclosure group (for server blades). To figure out BIOS Settings to override or set within the Server Profile, you will need to get the Server Hardware Type resource that your are modeling the Server Profile for. When retrieving the resource: $bl460cgen9sht = Get-HPOVServerHardwareType "BL460c Gen9 1" The "biosSettings" Array property will be available (only with supported Server Hardware Types; i.e. BL460c Gen8 or newer). To locate potential BIOS Settings, you can use the following code as an example: $biosSettings = $bl460cgen9sht.biosSettings | ? { $_.name -match "power" } The code example above will return all matching BIOS Settings where the name contains "power". The found BIOS settings object(s) are then saved into $biosSettings. Update the "value" property accordingly, and you can then pass $biosSettings variable to the -biosSettings parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile Template will be bound to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerProfileDescription</maml:name> <maml:description> <maml:para>Optional description for created server profiles from this template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageConnections</maml:name> <maml:description> <maml:para>Use this parameter to specify if Connections should be tracked from the Server Profile Template for compliance. If set to False, the -Connections parameter will be ignored, and Connections must be set and managed at the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Expected Connection Format: [System.Collections.ArrayList ] @( [PsCustomObject]@{ [System.Int]id - Connection ID. Valid 1-64. A 0 value is allowed, but means Auto Connection ID assignment. [System.String]function - Ethernet or FibreChannel. [System.String]networkUri - URI to the Network resource. [System.String]portId - Auto or the specific Port ID. For FlexLOMs, the valid portId prefix will be "Flb", and Mezzanine would be "Mezz". Ex. FlexNIC 1a interface would be "Flb 1:1a" Ex. Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c" [System.Int32]requestedMpbs - Requested bandwidth in Mbps. [System.Collections.Hashtable]boot - Nested Hashtable @{ [System.String]priority - Boot priority for this connection. Can be used with Ethernet or FC connections. Allowed values: NotBootable Primary Secondary [System.Collections.ArrayList ]targets - Array of FC boot targets (only 1 entry is allowed) @( [System.String]arrayWwpn - Target WWPN of storage array. [System.String]lun - Boot LUN ID ) } [System.String]macType - Allowed values: Physical UserDefined Virtual [System.String]mac - UserDefined MAC Address. Required for custom MAC and FCoE WWPN addresses. [System.String]wwpnType - Allowed values: Physical UserDefined Virtual [System.String]wwpn - UserDefined WWPN Address [System.String]wwnn - UserDefined WWNN Address } ) Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ConnectionsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * Minimum * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile Template will be bound to. When assigning to an Enclosure Group, OneView will then determine what farbic connectivity and storage devices are available.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentPlanAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. You will need to group required NIC parameters together based on needed values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootModeConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrderConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>LocalStorageConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A resource object containing the StorageController, LogicalDisk or SasJbod configuration. Please refer to the New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController Cmdlets.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IloSettingsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IscsiInitiatorNameAssignmet</maml:name> <maml:description> <maml:para>Specify if the iSCSI initiator name should be automatically managed and assigned, or a custom value should be used. Allowed values: * Virtual * UserDefined Default Value: Virtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile Template object. In order to save the changes, please use the Save-HPOVServerProfileTemplate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile Template will be bound to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Optional. Enable SAN Storage Management within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage System. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>Optional. Array of Storage Volume resources to attach. Can be created by using the New-HPOVServerProfileAttachVolume Cmdlet. This parameter does not accept a Storage Volume resource from the Get-HPOVStorageVolume Cmdlet. The format of the Storage Volume resource should be a PsCustomObject PowerShell resource with the following keys and values: [PsCustomObject]@{ [System.Int]id - Valid Host LUN ID 0-254 [System.String]lunType - Auto or Manual [System.String]volumeUri - URI to Storage Volume that has been created and not assigned to another Server Profile if it is a Private Volume. [System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri - URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC Connection ID associated with the path to the attached volume, and if the path is enabled or disabled. @( [System.Int]connectionId - FC Connection ID. If using New-HPOVServerProfileAttachVolume helper Cmdlet, New-HPOVServerProfile will automatically determine the FC connection ID. [System.Boolean]isEnabled - Enable or disable the path ) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ServerProfileDescription</maml:name> <maml:description> <maml:para>Optional description for created server profiles from this template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageConnections</maml:name> <maml:description> <maml:para>Use this parameter to specify if Connections should be tracked from the Server Profile Template for compliance. If set to False, the -Connections parameter will be ignored, and Connections must be set and managed at the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Expected Connection Format: [System.Collections.ArrayList ] @( [PsCustomObject]@{ [System.Int]id - Connection ID. Valid 1-64. A 0 value is allowed, but means Auto Connection ID assignment. [System.String]function - Ethernet or FibreChannel. [System.String]networkUri - URI to the Network resource. [System.String]portId - Auto or the specific Port ID. For FlexLOMs, the valid portId prefix will be "Flb", and Mezzanine would be "Mezz". Ex. FlexNIC 1a interface would be "Flb 1:1a" Ex. Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c" [System.Int32]requestedMpbs - Requested bandwidth in Mbps. [System.Collections.Hashtable]boot - Nested Hashtable @{ [System.String]priority - Boot priority for this connection. Can be used with Ethernet or FC connections. Allowed values: NotBootable Primary Secondary [System.Collections.ArrayList ]targets - Array of FC boot targets (only 1 entry is allowed) @( [System.String]arrayWwpn - Target WWPN of storage array. [System.String]lun - Boot LUN ID ) } [System.String]macType - Allowed values: Physical UserDefined Virtual [System.String]mac - UserDefined MAC Address. Required for custom MAC and FCoE WWPN addresses. [System.String]wwpnType - Allowed values: Physical UserDefined Virtual [System.String]wwpn - UserDefined WWPN Address [System.String]wwnn - UserDefined WWNN Address } ) Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ConnectionsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * Minimum * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile Template will be bound to. When assigning to an Enclosure Group, OneView will then determine what farbic connectivity and storage devices are available.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>OSDeploymentPlanAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. You will need to group required NIC parameters together based on needed values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BiosConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootModeConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>BootOrderConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>LocalStorageConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A resource object containing the StorageController, LogicalDisk or SasJbod configuration. Please refer to the New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController Cmdlets.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IloSettingsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>SANStorageConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * Minimum * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>EvenPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable even paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach"> <maml:name>OddPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable odd paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>IscsiInitiatorNameAssignmet</maml:name> <maml:description> <maml:para>Specify if the iSCSI initiator name should be automatically managed and assigned, or a custom value should be used. Allowed values: * Virtual * UserDefined Default Value: Virtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile Template object. In order to save the changes, please use the Save-HPOVServerProfileTemplate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Affinity</maml:name> <maml:description> <maml:para>In a server profile, the Affinity control sets the remove-and-replace behavior for blade servers. If you apply a server profile to a blade server and the server is subsequently removed from the device bay, the Affinity setting controls whether the server profile is reapplied when you insert a server blade into the empty bay. Server profiles for rack servers do not have affinity. Accepted values are either "Bay" or "BayAndServer". Default is "Bay".</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Bay</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Firmware baseline to assign. Can be either Baseline Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Bios</maml:name> <maml:description> <maml:para>Enable BIOS Settings Management. Cannot be enabled with Server Hardware Type does not support BIOS Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BiosConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BiosSettings</maml:name> <maml:description> <maml:para>BIOS Settings that are to be managed. You can get the BIOS settings available from Get-HPOVServerHarwareType and the returned biosSettings property.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootMode</maml:name> <maml:description> <maml:para>Specify the Gen9 Boot Envrionment. Sets the boot mode as one of the following: * UEFI * UEFIOptimized * BIOS * Unmanaged If you select UEFI or UEFI optimized for an HP ProLiant DL Gen9 rack mount server, the remaining boot setting available is the PXE boot policy. For the UEFI or UEFI optimized boot mode options, the boot mode choice should be based on the expected OS and required boot features for the server hardware. UEFI optimized boot mode reduces the time the system spends in POST (Video driver initialization). In order to select the appropriate boot mode, consider the following: * If a secure boot is required, the boot mode must be set to UEFI or UEFI optimized . * For operating systems that do not support UEFI (such as DOS, or older versions of Windows and Linux), the boot mode must be set to BIOS. * When booting in UEFI mode, Windows 7, Server 2008, or 2008 R2 should not be set to UEFIOptimized. Default: BIOS</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>BIOS</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootModeConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>Boot Order settings to be managed. Defines the order in which boot will be attempted on the available devices. For Gen7 and Gen8 server hardware the possible values are "CD", "Floppy", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 BL server hardware in UEFI or UEFI Optimized boot mode, only one value is allowed and must be either "HardDisk" or "PXE". For Gen9 DL server hardware in Legacy BIOS boot mode, the possible values are "CD", "USB", "HardDisk", and "PXE". For Gen9 DL server hardware in UEFI or UEFI Optimized boot mode, boot order configuration is not supported. Gen7/8 BIOS Default Boot Order: "CD","Floppy","USB","HardDisk","PXE" Gen9 Legacy BIOS Boot Order: "CD","USB","HardDisk","PXE" Gen9 UEFI Default Boot Order: "HardDisk"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>BootOrderConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Connections</maml:name> <maml:description> <maml:para>The network connections that are to be part of this new server profile. This an array of profile connection objects which may be created with "New-HPOVServerProfileConnection". Expected Connection Format: [System.Collections.ArrayList ] @( [PsCustomObject]@{ [System.Int]id - Connection ID. Valid 1-64. A 0 value is allowed, but means Auto Connection ID assignment. [System.String]function - Ethernet or FibreChannel. [System.String]networkUri - URI to the Network resource. [System.String]portId - Auto or the specific Port ID. For FlexLOMs, the valid portId prefix will be "Flb", and Mezzanine would be "Mezz". Ex. FlexNIC 1a interface would be "Flb 1:1a" Ex. Mezzanine 2, FlexNIC 2c interface would be "Mezz 2:2c" [System.Int32]requestedMpbs - Requested bandwidth in Mbps. [System.Collections.Hashtable]boot - Nested Hashtable @{ [System.String]priority - Boot priority for this connection. Can be used with Ethernet or FC connections. Allowed values: NotBootable Primary Secondary [System.Collections.ArrayList ]targets - Array of FC boot targets (only 1 entry is allowed) @( [System.String]arrayWwpn - Target WWPN of storage array. [System.String]lun - Boot LUN ID ) } [System.String]macType - Allowed values: Physical UserDefined Virtual [System.String]mac - UserDefined MAC Address. Required for custom MAC and FCoE WWPN addresses. [System.String]wwpnType - Allowed values: Physical UserDefined Virtual [System.String]wwpn - UserDefined WWPN Address [System.String]wwnn - UserDefined WWNN Address } ) Default: No connections</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>ConnectionsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * Minimum * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description for this server profile template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="eg"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>The Enclosure Group resource the Server Profile Template will be bound to. When assigning to an Enclosure Group, OneView will then determine what farbic connectivity and storage devices are available.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="Even"> <maml:name>EvenPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable even paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Firmware</maml:name> <maml:description> <maml:para>Enable Firmware Management. Cannot be enabled with Server Hardware Type does not support Firmware Management (i.e. BL G7 servers.)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>FirmwareActivationMode</maml:name> <maml:description> <maml:para>Specify the firmware activation policy. Avialable options are: * Immediate - Immediately activate (aka reboot the host) firmware if needed. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * Scheduled - Specify a future time to activate (aka reboot the host) firmware if needed. You will need to specify the FirmwareActivateDateTime parameter. Requires HPSUT to be installed in the Host OS or Proxy VM (for VMware only) * NotScheduled - Scheduled firmware update is cancelled when you choose this option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Immediate</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>FirmwareConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="FirmwareMode"> <maml:name>FirmwareInstallMode</maml:name> <maml:description> <maml:para>Specify the Firmware Baseline Policy mode. Avialable options are: * FirmwareOnly - Updates the system firmware without powering down the server hardware using using HP Smart Update Tools. * FirmwareAndSoftware - Updates the firmware and OS drivers without powering down the server hardware using HP Smart Update Tools. * FirmwareOffline - Manages the firmware through HPE OneView. Selecting this option requires the server hardware to be powered down.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>FirmwareAndSoftware</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>ForceInstallFirmware</maml:name> <maml:description> <maml:para>Using this parameter will force the bundled firmware components to install when the Server Profile is applied to a server. This will downgrade firmware if the component firmware is newer than what the SPP Baseline contains.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>HideUnusedFlexNics</maml:name> <maml:description> <maml:para>This setting provides the ability to hide unused FlexNICs from the operating system. If Hide Unused FlexNICs is set to $True (default/enabled), FlexNICs that do not map to any server profile connections are not presented to the operating system. For example, if you have a full complement of eight FlexNICs defined in your server profile but map only four, your operating system will see only the four mapped FlexNICs instead of eight. If Hide Unused FlexNICs is set to $False (disabled), eight FlexNICs are enumerated in the operating system as network interfaces for each Flex-10 or FlexFabric adapter. Configuring Fibre Channel connections on a FlexFabric adapter can enumerate two storage interfaces, reducing the number of network interfaces to six. FlexNICs are hidden in pairs, starting with the fourth pair. For example, if the fourth FlexNIC on either physical port corresponds to a profile connection, all eight physical functions are enumerated. If a profile connection corresponds to the second FlexNIC on either physical port, but no connection corresponds to the third or fourth FlexNIC on either physical port, only the first and second physical functions are enumerated in the operating system. By default, Hide Unused FlexNICs is enabled. This setting can be changed only when the server is powered off.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="OS"> <maml:name>HostOStype</maml:name> <maml:description> <maml:para>Optional. Specify the Host OS type, which will set the Host OS value when HPE OneView created the Host object on the Storage System. Accepted values: * CitrixXen = "Citrix Xen Server 5.x/6.x" * AIX = "AIX" * IBMVIO = "IBM VIO Server" * RHEL4 = "RHE Linux (Pre RHEL 5)" * RHEL3 = "RHE Linux (Pre RHEL 5)" * RHEL = "RHE Linux (5.x, 6.x)" * RHEV = "RHE Virtualization (5.x, 6.x)" * VMware = "ESX 4.x/5.x" * Win2k3 = "Windows 2003" * Win2k8 = "Windows 2008/2008 R2" * Win2k12 = "Windows 2012 / WS2012 R2" * OpenVMS = "OpenVMS" * Egenera = "Egenera" * Exanet = "Exanet" * Solaris9 = "Solaris 9/10" * Solaris10 = "Solaris 9/10" * Solaris11 = "Solaris 11" * ONTAP = "NetApp/ONTAP" * OEL = "OE Linux UEK (5.x, 6.x)" * HPUX11iv1 = "HP-UX (11i v1, 11i v2)" * HPUX11iv2 = "HP-UX (11i v1, 11i v2)" * HPUX11iv3 = "HP-UX (11i v3)" * SUSE = "SuSE (10.x, 11.x)" * SUSE9 = "SuSE Linux (Pre SLES 10)" * Inform = "InForm"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>IloSettings</maml:name> <maml:description> <maml:para>Provide an iLO settings object from New-OVServerProfileIloPolicy Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>IloSettingsConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>IscsiInitiatorNameAssignmet</maml:name> <maml:description> <maml:para>Specify if the iSCSI initiator name should be automatically managed and assigned, or a custom value should be used. Allowed values: * Virtual * UserDefined Default Value: Virtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Enable local storage settings to be managed on the server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>LocalStorageConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>MacAssignment</maml:name> <maml:description> <maml:para>Optional setting for MAC address assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="boot"> <maml:name>ManageBoot</maml:name> <maml:description> <maml:para>Enable Boot Order Management. Also required for Connection boot enablement. If this is disabled ($False), then PXE or FC BfS settings are disabled within the entire Server Profile. Default: $True</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>ManageConnections</maml:name> <maml:description> <maml:para>Use this parameter to specify if Connections should be tracked from the Server Profile Template for compliance. If set to False, the -Connections parameter will be ignored, and Connections must be set and managed at the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>ManageIloSettings</maml:name> <maml:description> <maml:para>Use to indicate iLO settings will be managed from the server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the server profile resource to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>OSDeploymentConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>OSDeploymentPlan</maml:name> <maml:description> <maml:para>The HPE Synergy Image Streamer OS deployment plan from Get-HPOVOSDeploymentPlan.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>OSDeploymentPlanAttributes</maml:name> <maml:description> <maml:para>Configured OS Deployment Plan parameters from Get-HPOVOSDeploymentPlanAttribute. You will need to group required NIC parameters together based on needed values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="Odd"> <maml:name>OddPathDisabled</maml:name> <maml:description> <maml:para>Enable to disable odd paths in the attached storage volume(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Use this parameter to return the modified Server Profile Template object. In order to save the changes, please use the Save-HPOVServerProfileTemplate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>PxeBootPolicy</maml:name> <maml:description> <maml:para>Controls the ordering of the network modes available to the Flexible LOM (FLB); for example, IPv4 and IPv6. Select from the following policies: * Auto * IPv4 only * IPv6 only * IPv4 then IPv6 * IPv6 then IPv4 Setting the policy to Auto means the order of the existing network boot targets in the UEFI Boot Order list will not be modified, and any new network boot targets will be added to the end of the list using the System ROM"s default policy. Default: Auto</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="None"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Optional. Enable SAN Storage Management within the Server Profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="None"> <maml:name>SANStorageConsistencyChecking</maml:name> <maml:description> <maml:para>Use to override the consistency checking for the policy. Allowed values: * Exact * Minimum * None</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>SecureBoot</maml:name> <maml:description> <maml:para>Specify if secure boot should be Unmanaged, Enabled or Disabled for Gen10 and newer servers. Boot Mode must be set to 'UEFI Optimized'.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="sht"> <maml:name>ServerHardwareType</maml:name> <maml:description> <maml:para>The Server Hardware Type reource the Server Profile Template will be bound to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>ServerProfileDescription</maml:name> <maml:description> <maml:para>Optional description for created server profiles from this template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>SnAssignment</maml:name> <maml:description> <maml:para>Optional setting for serial number and UUID assignment. May be Virtual, Physical or UserDefined. Default: Virtual serial number and UUID assignment</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="LogicalDisk"> <maml:name>StorageController</maml:name> <maml:description> <maml:para>A resource object containing the StorageController, LogicalDisk or SasJbod configuration. Please refer to the New-HPOVServerProfileLogicalDisk and New-HPOVServerProfileLogicalDiskController Cmdlets.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach" aliases="None"> <maml:name>StorageVolume</maml:name> <maml:description> <maml:para>Optional. Array of Storage Volume resources to attach. Can be created by using the New-HPOVServerProfileAttachVolume Cmdlet. This parameter does not accept a Storage Volume resource from the Get-HPOVStorageVolume Cmdlet. The format of the Storage Volume resource should be a PsCustomObject PowerShell resource with the following keys and values: [PsCustomObject]@{ [System.Int]id - Valid Host LUN ID 0-254 [System.String]lunType - Auto or Manual [System.String]volumeUri - URI to Storage Volume that has been created and not assigned to another Server Profile if it is a Private Volume. [System.String]volumeStoragePoolUri - URI to HPE OneView managed Storage Pool [System.String]volumeStorageSystemUri - URI to HPE OneView managed Storage System [System.Collections.ArrayList ]storagePaths - Array specifying the Profile FC Connection ID associated with the path to the attached volume, and if the path is enabled or disabled. @( [System.Int]connectionId - FC Connection ID. If using New-HPOVServerProfileAttachVolume helper Cmdlet, New-HPOVServerProfile will automatically determine the FC connection ID. [System.Boolean]isEnabled - Enable or disable the path ) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SANStorageAttach, Default" aliases="None"> <maml:name>WwnAssignment</maml:name> <maml:description> <maml:para>Optional setting for WWN assignment. May be Virtual or Physical. Use Virtual if you need to specify a UserDefined value when using the New-HPOVServerProfileConnection helper Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Virtual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The full path to the Server Profile JSON export file</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful returns a task resource which may be polled to follow the progress of the profile creation. Otherwise, a request validation error will be returned</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneVIew.ServerProfileTemplate [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -PassThru parameter, the created server profile template object is returned.</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>$Name = "HP ProLiant BL460 Gen9 Profile Template" $con1 = Get-HPOVNetwork -Name "Net 41-A" | New-HPOVServerProfileConnection -connectionId 1 $con2 = Get-HPOVNetwork -Name "Net 41-B" | New-HPOVServerProfileConnection -connectionId 2 $bl460SHT = Get-HPOVServerHardwareTypes -name "BL460c Gen9 1" $eg = Get-HPOVEnclosureGroup "Default EG1" $params = @{ >> name = $Name; >> serverHardwareType = $bl460SHT; >> enclosureGroup = $eg; >> connections = $con1, $con2; >> ManageBoot = $True; >> BootMode = "UEFI"; >> ApplianceConnection = "MyAppliance1.domain.com" >>} >> New-HPOVServerProfileTemplate @params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a BL Gen8 Server Profile template, and pipe to Wait-HPOVTaskComplete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$net41 = Get-HPOVNetwork -Name "Net-41" $con41 = New-HPOVServerProfileConnection -network $net41 -connectionType Ethernet -connectionId 1 $net42 = Get-HPOVNetwork -Name "Net-42" $con42 = New-HPOVServerProfileConnection -network $net42 -connectionType Ethernet -connectionId 2 $conList = @($con41, $con42) $task = New-HPOVServerProfileTemplate -name $Name -serverHardwareType "bl460c Gen8 1" -enclosureGroup "Production Encl Grp1" -connections $conList | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a server profile template which includes networks "Net-41" and "Net-42".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "Hypervisor Cluster Node Template v1.0" $bl460SHT = Get-HPOVServerHardwareTypes -name "BL460c Gen9 1" $enclosuregroup = Get-HPOVEnclosureGroup "Production EG1" $con1 = Get-HPOVNetwork -Name "Net 41-a" | New-HPOVServerProfileConnection -id 1 $con2 = Get-HPOVNetwork -Name "Net 41-b" | New-HPOVServerProfileConnection -id 2 $con3 = Get-HPOVNetworkSet "Prod Networks A" | New-HPOVServerProfileConnection -id 3 $con4 = Get-HPOVNetworkSet "Prod Networks A" | New-HPOVServerProfileConnection -id 4 $con5 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 5 -type FibreChannel -bootable -priority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0 $con6 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 6 -type FibreChannel -bootable -priority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0 $conList = $con1, $con2, $con3, $con4, $con5, $con6 $task = New-HPOVServerProfileTemplate -name $profileName -connections $conList -sht $bl460SHT -eg $enclosuregroup -ManageBoot | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a new Server Profile template with 6 Connections, 4 Ethernet (including Network Sets) and 2 Fibre Channel (with BfS configured).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profileName = "SQL DB Cluster Node Template v1.0" $bl660SHT = Get-HPOVServerHardwareTypes -name "BL660c Gen9 1" #display the BL660 Gen9 BIOS Settings $bl660SHT.biosSettings #Set HP Power Profile (ID 210) to Maximum Performance and HP Power Regulator (ID 140) to HP Static High Performance Mode. $bl660bios = @(@{id=210;value=3},@{id=140;value=3}) $enclosuregroup = Get-HPOVEnclosureGroup "Production EG1" $con1 = Get-HPOVNetwork -Name "Net 41-A" | New-HPOVServerProfileConnection -connectionId 1 $con2 = Get-HPOVNetwork -Name "Net 41-B" | New-HPOVServerProfileConnection -connectionId 2 $con3 = Get-HPOVNetwork -Name "fabric a" | New-HPOVServerProfileConnection -id 3 -type FibreChannel -bootable -priority Primary -arrayWWPn "21:11:00:02:AC:00:72:03" -LUN 0 $con4 = Get-HPOVNetwork -Name "fabric b" | New-HPOVServerProfileConnection -id 4 -type FibreChannel -bootable -priority Secondary -arrayWWPn "22:12:00:02:AC:00:72:03" -LUN 0 $LogicalDisk = New-HPOVServerProfileLogicalDisk -Name "My Local Disk" -RAID RAID1 -NumberofDrives 2 -DiskType SasSsd $volume1 = Get-HPOVStorageVolume SharedVolume1 | New-HPOVServerProfileAttachVolume $params = @{ >> name = $profileName; >> connections = $con1, $con2, $con3, $con4; >> bios = $true; >> biossettings = $bl660bios >> manageboot = $True; >> bootMode = "UEFI"; >> pxeBootPolicy = "IPv4ThenIPv6"; >> bootOrder = "HardDisk"; >> HideUnusedFlexnics = $True; >> LocalStorage = $True; >> LogicalDisk = $LogicalDisk; >> SANStorage = $True; >> Ostype = "Win2k12"; >> StorageVolume = $volume1; } >> New-HPOVServerProfileTemplate @params | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a BL Gen9 UEFI Server Profile template with Ethernet and FC connections, local storage, SAN Storage and BIOS Settings, then pipe to Wait-HPOVTaskComplete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSNMPCONFIGURATION--> <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"> <!--NEW-HPOVSNMPCONFIGURATION--> <command:details> <command:name>New-HPOVSnmpConfiguration</command:name> <maml:description> <maml:para>Create SNMP LIG Configuration Object</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVSnmpConfiguration</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet provides the capability to create a new SNMP Configuration object for a Logical Interconnect Group or Logical Interconnect resources.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVSnmpConfiguration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>ReadCommunity</maml:name> <maml:description> <maml:para>The SNMP Read Community String to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 should be enabled. Can be disabled when SNMPv3 is enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 should be enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>Contact</maml:name> <maml:description> <maml:para>SNMP Contact Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>AccessList</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of IP Addresses or Subnets. You must include the Subnet Mask Bit value. E.g. 10.44.120.9/32 or 172.20.148.0/22</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>TrapDestinations</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMMP Trap Destinations. Use New-HPOVTrapDestination Cmdlet to create the object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVSnmpConfiguration</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>ReadCommunity</maml:name> <maml:description> <maml:para>The SNMP Read Community String to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 should be enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3"> <maml:name>SnmpV3Users</maml:name> <maml:description> <maml:para>Collection of SNMPv3 users to configure within the SNMP configuration object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SnmpV3User[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 should be enabled. Can be disabled when SNMPv3 is enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>Contact</maml:name> <maml:description> <maml:para>SNMP Contact Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>AccessList</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of IP Addresses or Subnets. You must include the Subnet Mask Bit value. E.g. 10.44.120.9/32 or 172.20.148.0/22</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default"> <maml:name>TrapDestinations</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMMP Trap Destinations. Use New-HPOVTrapDestination Cmdlet to create the object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>AccessList</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of IP Addresses or Subnets. You must include the Subnet Mask Bit value. E.g. 10.44.120.9/32 or 172.20.148.0/22</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>Contact</maml:name> <maml:description> <maml:para>SNMP Contact Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>ReadCommunity</maml:name> <maml:description> <maml:para>The SNMP Read Community String to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>SnmpV1</maml:name> <maml:description> <maml:para>Specify if SNMPv1 should be enabled. Can be disabled when SNMPv3 is enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>SnmpV3</maml:name> <maml:description> <maml:para>Specify if SNMPv3 should be enabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3" aliases="None"> <maml:name>SnmpV3Users</maml:name> <maml:description> <maml:para>Collection of SNMPv3 users to configure within the SNMP configuration object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SnmpV3User[]</command:parameterValue> <dev:type> <maml:name>SnmpV3User[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Snmpv3, Default" aliases="None"> <maml:name>TrapDestinations</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMMP Trap Destinations. Use New-HPOVTrapDestination Cmdlet to create the object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SnmpConfiguration [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>SNMP Configuration object for a Logical Interconnect Group or Logical Interconnect resource</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>$SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0/22 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -enableIgmpSnooping $True -igmpIdleTimeoutInterval 300 -LoopProtect $True -QosConfig $QosConfig</dev:code> <dev:remarks> <dev:para>Create a new QOS Configuration object,and use the created object to add to a new Logical Interconnect Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSNMPTRAPDESTINATION--> <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"> <!--NEW-HPOVSNMPTRAPDESTINATION--> <command:details> <command:name>New-HPOVSnmpTrapDestination</command:name> <maml:description> <maml:para>Create SNMP Trap Destination Object</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVSnmpTrapDestination</command:noun> </command:details> <maml:description> <maml:para>This helper Cmdlet provides the capability to create a new SNMP Trap Destination object. The object can then be used with New-HPOVSnmpConfiguration to create a new SNMP Configuration for a Logical Interconnect Group or Logical Interconnect resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVSnmpTrapDestination</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The SNMP destination IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Community</maml:name> <maml:description> <maml:para>The SNMP Trap Community String to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Provide the alternate SNMP trap reciever port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>SnmpFormat</maml:name> <maml:description> <maml:para>SNMP Format type. Allowed values: * SNMPv1 * SNMPv2 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>TrapSeverities</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Critical * Info * Major * Minor * Normal * Unknown * Warning</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>VCMTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of VCM Trap Categories. Allowed values: * Legacy</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>EnetTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus * PortThresholds</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>FCTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVSnmpTrapDestination</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The SNMP destination IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>A valid SNMPv3 user from New-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Provide the alternate SNMP trap reciever port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>SnmpFormat</maml:name> <maml:description> <maml:para>SNMP Format type. Allowed values: * SNMPv1 * SNMPv2 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3"> <maml:name>NotificationType</maml:name> <maml:description> <maml:para>Indicates whether the trap should be inform message or not. Allowed values: * Inform * Trap</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3"> <maml:name>EngineID</maml:name> <maml:description> <maml:para>The EngineId of remote SNMPv3 user. Only applicable when configuring an SNMPv3 object for the appliance, not logical interconnect groups or logical interconnects.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>TrapSeverities</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Critical * Info * Major * Minor * Normal * Unknown * Warning</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>VCMTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of VCM Trap Categories. Allowed values: * Legacy</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>EnetTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus * PortThresholds</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default"> <maml:name>FCTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Community</maml:name> <maml:description> <maml:para>The SNMP Trap Community String to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>public</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The SNMP destination IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>EnetTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus * PortThresholds</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3" aliases="None"> <maml:name>EngineID</maml:name> <maml:description> <maml:para>The EngineId of remote SNMPv3 user. Only applicable when configuring an SNMPv3 object for the appliance, not logical interconnect groups or logical interconnects.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>FCTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Other * PortStatus</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3" aliases="None"> <maml:name>NotificationType</maml:name> <maml:description> <maml:para>Indicates whether the trap should be inform message or not. Allowed values: * Inform * Trap</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Trap</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Provide the alternate SNMP trap reciever port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>SnmpFormat</maml:name> <maml:description> <maml:para>SNMP Format type. Allowed values: * SNMPv1 * SNMPv2 * SNMPv3</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>SNMPv1</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3" aliases="None"> <maml:name>SnmpV3User</maml:name> <maml:description> <maml:para>A valid SNMPv3 user from New-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>TrapSeverities</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of SNMP Trap Severities to generate Traps for. Allowed values: * Critical * Info * Major * Minor * Normal * Unknown * Warning</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SnmpV3, Default" aliases="None"> <maml:name>VCMTrapCategories</maml:name> <maml:description> <maml:para>A collection [System.Collections.ArrayList ] of VCM Trap Categories. Allowed values: * Legacy</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SnmpTrapDestination [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>SNMP Trap desitnation object for an SNMP Configuration Object</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>$Dest1 = New-HPOVSnmpTrapDestination -Destination mysnmpserver.domain.local -Community MyR3adcommun1ty -SnmpFormat SNMPv1 -TrapSeverities critical,warning $Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy "Other","PortStatus","PortThresholds" "Other","PortStatus" $SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0/22 -TrapDestinations $Dest1,$Dest2 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -SNMP $SnmpConfig</dev:code> <dev:remarks> <dev:para>Create a new SNMP Configuration object, with the specified Trap Destinations, and use the created object to add to a new Logical Interconnect Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Create SNMPv3 user account for appliance. $SNMPv3User = New-HPOVSnmpv3User -Username snmpv3user -SecurityLevel None -ApplianceSnmpUser $Dest1 = New-HPOVSnmpTrapDestination -Destination mysnmpserver.domain.local -Community MyR3adcommun1ty -SnmpFormat SNMPv1 -TrapSeverities critical,warning $Dest2 = New-HPOVSnmpTrapDestination 10.44.120.9 MyR3adcommun1ty SNMPv1 critical,warning legacy "Other","PortStatus","PortThresholds" "Other","PortStatus" $SnmpConfig = New-HPOVSnmpConfiguration -ReadCommunity MyR3adC0mmun1ty -AccessList "10.44.120.9/32","172.20.148.0/22 -TrapDestinations $Dest1,$Dest2 New-HPOVLogicalInterconnectGroup -LIGName "Flex10/10D and FlexFabric Production 1" -bays @{1 = "Flex1010D";2 = "Flex1010D";3 = "FlexFabric";4 = "FlexFabric"} -SNMP $SnmpConfig</dev:code> <dev:remarks> <dev:para>Create a new SNMP Configuration object, with the specified Trap Destinations, and use the created object to add to a new Logical Interconnect Group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSNMPV3USER--> <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"> <!--NEW-HPOVSNMPV3USER--> <command:details> <command:name>New-HPOVSnmpV3User</command:name> <maml:description> <maml:para>Create a new SNMPv3 user from appliance or Logical Interconnect/Switch resoure.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVSnmpV3User</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers and enclosures (OA) to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Appliance SNMP settings allow you to add destinations to which the traps need to be forwarded. You can configure each destination as an SNMPv1 or SNMPv3 destination, depending on whether the traps are sent in SNMPv1 or SNMPv3 formats. Additionally, if you have Gen6 or Gen7 servers being monitored by HPE OneView in your environment, you can configure the read community string that HPE OneView uses for monitoring these servers with SNMPv1. NOTE: To configure SNMP trap forwarding for network devices (interconnects and switches), use the New-HPOVSnmpV3User and include it within the New-HPOVSnmpTrapDestination Cmdlet. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVSnmpV3User</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>SNMPv3 Username</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>SecurityLevel</maml:name> <maml:description> <maml:para>Specify the type of SNMPv3 security policy. Supported values: * None * AuthOnly * AuthAndPriv</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Authentication protocol. Supported values: * None * MD5 * SHA * SHA1 * SHA256 * SHA384 * SHA512</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>AuthPassword</maml:name> <maml:description> <maml:para>SNMpv3 Authentication password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>PrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy protocol. Supported values: * none * des56 * 3des * aes128 * aes192 * aes256"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>PrivPassword</maml:name> <maml:description> <maml:para>SNMpv3 Privacy password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVSnmpV3User</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>SNMPv3 Username</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser"> <maml:name>ApplianceSnmpUser</maml:name> <maml:description> <maml:para>Use this to create an appliance SNMPv3 User. Default is to create an HPOneView.Networking.SnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>SecurityLevel</maml:name> <maml:description> <maml:para>Specify the type of SNMPv3 security policy. Supported values: * None * AuthOnly * AuthAndPriv</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Authentication protocol. Supported values: * None * MD5 * SHA * SHA1 * SHA256 * SHA384 * SHA512</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>AuthPassword</maml:name> <maml:description> <maml:para>SNMpv3 Authentication password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>PrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy protocol. Supported values: * none * des56 * 3des * aes128 * aes192 * aes256"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default"> <maml:name>PrivPassword</maml:name> <maml:description> <maml:para>SNMpv3 Privacy password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser" aliases="None"> <maml:name>ApplianceSnmpUser</maml:name> <maml:description> <maml:para>Use this to create an appliance SNMPv3 User. Default is to create an HPOneView.Networking.SnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>AuthPassword</maml:name> <maml:description> <maml:para>SNMpv3 Authentication password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>AuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Authentication protocol. Supported values: * None * MD5 * SHA * SHA1 * SHA256 * SHA384 * SHA512</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>PrivPassword</maml:name> <maml:description> <maml:para>SNMpv3 Privacy password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>PrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy protocol. Supported values: * none * des56 * 3des * aes128 * aes192 * aes256"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>SecurityLevel</maml:name> <maml:description> <maml:para>Specify the type of SNMPv3 security policy. Supported values: * None * AuthOnly * AuthAndPriv</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ApplianceSnmpUser, Default" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>SNMPv3 Username</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 user account created on the appliance.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.SnmpV3User</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>SNMPv3 user account for a networking resource.</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>$Snmpv3Password = ConvertTo-SecureString "Myp@ssword" -AsPlainText -Force New-HPOVSnmpV3User -ApplianceSnmpUser -Username MySNMPv3us3r -SecurityLevel AuthAndPriv -AuthProtocol SHA512 -AuthPassword AES192 -PrivProtocol $SnmpV3UserPrivProtocol -PrivPassword $Snmpv3Password</dev:code> <dev:remarks> <dev:para>Create a new SNMPv3 user for the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSTORAGEVOLUME--> <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"> <!--NEW-HPOVSTORAGEVOLUME--> <command:details> <command:name>New-HPOVStorageVolume</command:name> <maml:description> <maml:para>Create a Storage Volume resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help create a Storage Volume resource on a managed Storage System. The volume can be created by specifying the Storage Pool or an existing Storage Volume Template. When the Storage Pool name is not unique, you can either use the -StorageSystem parameter, or pass via the pipeline the Storage Pool from Get-HPOVStoragePool. If the Storage Volume Template Global Policy is enabled, a valid Storage Volume Template must be provided.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Name. Device Volume created on the storage system will be this name without spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Storage Pool URI, name or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the volume.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>Storage Pool URI, name or resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableCompression</maml:name> <maml:description> <maml:para>Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports Compression.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableDeduplication</maml:name> <maml:description> <maml:para>Enable deduplication for SSD-based Storage Pools (CPG).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="template, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Name. Device Volume created on the storage system will be this name without spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template"> <maml:name>VolumeTemplate</maml:name> <maml:description> <maml:para>Specify the Storage Volume Template Name, URI or Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the volume.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>Storage Pool URI, name or resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableCompression</maml:name> <maml:description> <maml:para>Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports Compression.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableDeduplication</maml:name> <maml:description> <maml:para>Enable deduplication for SSD-based Storage Pools (CPG).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="template, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="template, default" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="size"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide a description for the volume.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableCompression</maml:name> <maml:description> <maml:para>Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports Compression.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableDeduplication</maml:name> <maml:description> <maml:para>Enable deduplication for SSD-based Storage Pools (CPG).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.NimbleFolder</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="VolumeName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Name. Device Volume created on the storage system will be this name without spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.PerformancePolicy</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="ProvisionType"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>Storage Pool URI, name or resource object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="pool, poolName"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Storage Pool URI, name or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template, default" aliases="None"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSet</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="template" aliases="template, svt"> <maml:name>VolumeTemplate</maml:name> <maml:description> <maml:para>Specify the Storage Volume Template Name, URI or Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.Pool [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Pool resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async create task</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>New-HPOVStorageVolume -name TestVol1 -PoolName PoolR1 -Size 60</dev:code> <dev:remarks> <dev:para>Create a 60GB private, thin provisioned volume named "TestVol1" from the "PoolR1" Storage Pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool PoolR1 | New-HPOVStorageVolume -name TestVol1 PoolR1 -Size 60</dev:code> <dev:remarks> <dev:para>Get the "PoolR1" Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named "TestVol1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool PoolR1 -StorageSystem 3ParSys1 | New-HPOVStorageVolume -name TestVol1 -Size 60</dev:code> <dev:remarks> <dev:para>Get the "PoolR1" Storage Pool resource and pipe it to create a 60GB private, thin provisioned volume named "TestVol1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVStorageVolume -name TestVol1 -StoragePool PoolR1 -StorageSystem 3ParSys1 -Size 60</dev:code> <dev:remarks> <dev:para>Create a 60GB private, thin provisioned volume named "TestVol1" from the "PoolR1" Storage Pool resource that is managed by "3ParSys1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$svt = Get-HPOVStorageVolumeTemplate SVT_120GB_R5 $New-HPOVStorageVolume testvol3 -volumetemplate $svt -capacity 90 | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Create a 90GB volume named "TestVol1", using the "SVT_120GB_R5" Storage Volume Template, then wait for volume to be provisioned.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSTORAGEVOLUMESNAPSHOT--> <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"> <!--NEW-HPOVSTORAGEVOLUMESNAPSHOT--> <command:details> <command:name>New-HPOVStorageVolumeSnapshot</command:name> <maml:description> <maml:para>Create new Storage Volume Snapshot resource.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVStorageVolumeSnapshot</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help create a Storage Volume Snapshot from an existing Storage Volume resource. If a Snapshot Storage Pool has not been configured for the Storage Volume, the Snapshot cannot be created.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVStorageVolumeSnapshot</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specify the Storage Volume object to create a snapshot for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Snapshot. The parameter defaults to "{volumeName}_{timestamp}" variables provided by the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the Storage Volume Snapshot.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description for the Storage Volume Snapshot.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Volume"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specify the Storage Volume object to create a snapshot for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of Snapshot. The parameter defaults to "{volumeName}_{timestamp}" variables provided by the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>{volumeName}_{timestamp}</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage volume resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task to create storage volume snapshot</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async tasks</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>Get-HPOVStorageVolume "Volume 1" -ApplianceConnection hpov.domain.com | New-HPOVStorageVolumeSnapshot</dev:code> <dev:remarks> <dev:para>Create a new storage volume snapshot using the default values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSTORAGEVOLUMETEMPLATE--> <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"> <!--NEW-HPOVSTORAGEVOLUMETEMPLATE--> <command:details> <command:name>New-HPOVStorageVolumeTemplate</command:name> <maml:description> <maml:para>Create storage volume template.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVStorageVolumeTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet supports creating Storage Volume Templates, which are then used to provision Storage Volumes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Template name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be managed by OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide the description for the Storage Volume Template</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the StoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will use for volume snapshot use. The provided Storage Pool must already be managed by OneView. If you omit this value, then the StoragePool parameter value will be used. Only supported with HPE StoreServe platforms.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LockSnapShotStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the SnapshotStoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>If there are multiple Storage Pool resources with the same name, use this parameter to filter for the correct pool object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnableDeduplication</maml:name> <maml:description> <maml:para>Enable deduplication for SSD-based Storage Pools (CPG).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LockEnableDeduplication</maml:name> <maml:description> <maml:para>Lock the EnableDeduplication value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnableCompression</maml:name> <maml:description> <maml:para>Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports Compression.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LockEnableCompression</maml:name> <maml:description> <maml:para>Lock the EnableCompression value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Template name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be managed by OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide the description for the Storage Volume Template</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the StoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockPerformancePolicy</maml:name> <maml:description> <maml:para>Lock the PerformancePolicy value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockEnableEncryption</maml:name> <maml:description> <maml:para>Lock the EnableEncryption value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockCachePinning</maml:name> <maml:description> <maml:para>Lock the CachePinning value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockVolumeSet</maml:name> <maml:description> <maml:para>Lock the VolumeSet value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockIOPSLimit</maml:name> <maml:description> <maml:para>Lock the IOPSLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockDataTransferLimit</maml:name> <maml:description> <maml:para>Lock the DataTransferLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockFolder</maml:name> <maml:description> <maml:para>Lock the Folder value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Template name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be managed by OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide the description for the Storage Volume Template</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the StoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>If there are multiple Storage Pool resources with the same name, use this parameter to filter for the correct pool object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>LockProtectionLevel</maml:name> <maml:description> <maml:para>Specify to lock the DataProtectionLevel value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>LockAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify to lock the EnableAdaptiveOptimization value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="size"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>Max volume capacity in GB. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Provide the description for the Storage Volume Template</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnableCompression</maml:name> <maml:description> <maml:para>Enable compression for StoreServe (3PAR) supported resources. Please verify the InformOS version installed supports Compression.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnableDeduplication</maml:name> <maml:description> <maml:para>Enable deduplication for SSD-based Storage Pools (CPG).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.NimbleFolder</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include this switch to enable Thick volume provisioning. Omit to specify Thin storage provisioning. Default: Thin</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>LockAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify to lock the EnableAdaptiveOptimization value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockCachePinning</maml:name> <maml:description> <maml:para>Lock the CachePinning value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockDataTransferLimit</maml:name> <maml:description> <maml:para>Lock the DataTransferLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LockEnableCompression</maml:name> <maml:description> <maml:para>Lock the EnableCompression value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LockEnableDeduplication</maml:name> <maml:description> <maml:para>Lock the EnableDeduplication value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockEnableEncryption</maml:name> <maml:description> <maml:para>Lock the EnableEncryption value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockFolder</maml:name> <maml:description> <maml:para>Lock the Folder value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockIOPSLimit</maml:name> <maml:description> <maml:para>Lock the IOPSLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockPerformancePolicy</maml:name> <maml:description> <maml:para>Lock the PerformancePolicy value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>LockProtectionLevel</maml:name> <maml:description> <maml:para>Specify to lock the DataProtectionLevel value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LockSnapShotStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the SnapshotStoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>LockStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the StoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockVolumeSet</maml:name> <maml:description> <maml:para>Lock the VolumeSet value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="TemplateName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Storage Volume Template name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.PerformancePolicy</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="ProvisionType"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Appliance.ScopeCollection[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection[]</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume Template as a Shareable resource for shared volume access.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will use for volume snapshot use. The provided Storage Pool must already be managed by OneView. If you omit this value, then the StoragePool parameter value will be used. Only supported with HPE StoreServe platforms.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Specify the Storage Pool (aka CPG) the Storage Volume Template will be associated with. Storage Pool must already be managed by OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>If there are multiple Storage Pool resources with the same name, use this parameter to filter for the correct pool object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSet</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System.Pool [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Managed Storage Pool resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Created Storage Volume Template resource</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>New-HPOVStorageVolumeTemplate -templateName yellow-svt -storagePool yellow -capacity 40</dev:code> <dev:remarks> <dev:para>Create a new Storage Volume Template, setting the max size to 40GB, Thin Provisioning and Private.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool R5-CPG12 -capacity 250 -shared</dev:code> <dev:remarks> <dev:para>Create a new Storage Volume Template, setting the max size to 250GB, Thin Provisioning and Shareable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$storagePool = Get-HPOVStoragePool R5-CPG12 $storageVolTemplate = New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -storagePool $storagePool -capacity 250 -shared</dev:code> <dev:remarks> <dev:para>Use the Get-HPOVStoragePool Cmdlet to get the "R5-CPG12" pool, and create a new Storage Volume Template, setting the max size to 250GB, Thin Provisioning and Shareable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$svt = Get-HPOVStoragePool R5-CPG12 | New-HPOVStorageVolumeTemplate -templateName vmware-shared-svt -SnapshotStoragePool "MySnapShotPool" -capacity 250 -shared</dev:code> <dev:remarks> <dev:para>Use the Get-HPOVStoragePool Cmdlet to get the "R5-CPG12" pool, and create a new Storage Volume Template, setting the max size to 250GB, Thin Provisioning, Shareable, and providing the Snapshot Storage Pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVSUPPORTDUMP--> <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"> <!--NEW-HPOVSUPPORTDUMP--> <command:details> <command:name>New-HPOVSupportDump</command:name> <maml:description> <maml:para /> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVSupportDump</command:noun> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVSupportDump</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="values"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of Support Dump to collect. Possible values are: * Appliance * li</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Object, values"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the directory does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="values"> <maml:name>Encrypted</maml:name> <maml:description> <maml:para>Use this parameter for the appliance to encrypt the Support Dump. Only HPE Support representatives can decrypt the contents.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Object, values"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVSupportDump</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>When the support dump type is LogicalEnclosure, the logical enclosure resource must be passed from Get-OVLogicalEnclosure as a parameter value or pipeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Object, values"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the directory does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Object, values"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Object, values" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="values" aliases="None"> <maml:name>Encrypted</maml:name> <maml:description> <maml:para>Use this parameter for the appliance to encrypt the Support Dump. Only HPE Support representatives can decrypt the contents.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Object" aliases="liobject, li, name, LogicalEnclosure"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>When the support dump type is LogicalEnclosure, the logical enclosure resource must be passed from Get-OVLogicalEnclosure as a parameter value or pipeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Object, values" aliases="save, Location"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to where the Support Dump will be saved to. The downloaded file name will be generated by the appliance. If the directory does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>(get-location).Path</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="values" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of Support Dump to collect. Possible values are: * Appliance * li</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnect</maml:name> </dev:type> <maml:description> <maml:para>Accepts pipeline input from Get-HPOVLogicalInterconnect only.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The location of the saved support dump.</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>New-HPOVSupportDump -Path C:\Temp -Type Appliance</dev:code> <dev:remarks> <dev:para>This command will create and save the Appliance support dump to C:\Temp.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MyLogicalEnclosure = Get-HPOVLogicalEnclosure -Name MyLogicalEnclosure1 New-HPOVSupportDump -Path C:\Temp -Type LogicalEnclosure -InputObject $MyLogicalEnclosure</dev:code> <dev:remarks> <dev:para>This command will create and save the logical enclosure support dump to C:\Temp.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVUNMANAGEDDEVICE--> <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"> <!--NEW-HPOVUNMANAGEDDEVICE--> <command:details> <command:name>New-HPOVUnmanagedDevice</command:name> <maml:description> <maml:para>Create an Unmanaged Device.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVUnmanagedDevice</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides administrators with the capability to define unmanaged devices to them place within Racks, in order to provide a more realistic and complete data center layout. Creating a device does not provide the ability to manage it from HPE OneView. The administrator will need to specify static characteristics of the device being added. The unmanaged device can then be assigned into the appropriate rack manually.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVUnmanagedDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Model</maml:name> <maml:description> <maml:para>The device model.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>MaxPower</maml:name> <maml:description> <maml:para>The maximum power consumption of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Height</maml:name> <maml:description> <maml:para>Rack Unit height of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>Provide the management interface L2 address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>Provide the IPv4 Address value of the management interface. This value does not provide a method for an HPE OneView appliance to communicate with the management interface.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>Provide the IPv6 Address value of the management interface. This value does not provide a method for an HPE OneView appliance to communicate with the management interface.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Height</maml:name> <maml:description> <maml:para>Rack Unit height of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>Provide the IPv4 Address value of the management interface. This value does not provide a method for an HPE OneView appliance to communicate with the management interface.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>Provide the IPv6 Address value of the management interface. This value does not provide a method for an HPE OneView appliance to communicate with the management interface.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>Provide the management interface L2 address.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>MaxPower</maml:name> <maml:description> <maml:para>The maximum power consumption of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Model</maml:name> <maml:description> <maml:para>The device model.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Unmanaged Device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.UnmanagedResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created Unmanaged Device resource</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>New-HPOVUnmanagedDevice -name "Unmanaged-SRVR1" -model "ProLiant DL380 G6" -height 2 -maxpower 750 -IPv4Address 10.154.1.10</dev:code> <dev:remarks> <dev:para>Create a new unmanaged server device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>New-HPOVUnmanagedDevice -name "HPN5900CP1" -model "HPN 5900CP" -height 1 -maxpower 260 -IPv4Address 172.18.254.99 "MyAppliance.domain.com"</dev:code> <dev:remarks> <dev:para>Create a new unmanaged switch device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVUPLINKSET--> <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"> <!--NEW-HPOVUPLINKSET--> <command:details> <command:name>New-HPOVUplinkSet</command:name> <maml:description> <maml:para>Create a new Uplink Set.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVUplinkSet</command:noun> </command:details> <maml:description> <maml:para>Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more networks. The traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet or Fibre Channel networks. Depending on the type of the assigned networks, uplink sets can support both an automatic and a selective failover or distribution strategy. The uplink port state is monitored, which contributes to the overall reachability status of the assigned networks. For each port belonging to the uplink set, the assigned port speed can be monitored. Uplink Sets can be created for Logical Interconnect Groups or Logical Interconnects. When creating a new Uplink Set, either the Logical Interconnect Group or Logical Interconnect must exist. Please know that the UplinkPorts parameter syntax is different between HPE BladeSystem and HPE Synergy Virtual Connect. Minimum required privileges: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVUplinkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-HPOVLogicalInterconnect) resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Uplink set Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Type</maml:name> <maml:description> <maml:para>Uplink set Type. Accepted values are * Ethernet (Default) * FibreChannel * Tunnel * Untagged * ImageStreamer ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink Set, the network resource must be a Tagged Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Array of Ethernet Network Names</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>NativeEthNetwork</maml:name> <maml:description> <maml:para>The valid name of the Native Ethernet Network that is a member of the usNetworks parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>NetworkSets</maml:name> <maml:description> <maml:para>Use this to specify one or more network sets to track the network configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>CopyNetworksFromNetworkSet</maml:name> <maml:description> <maml:para>When specifying the -NetworkSets parameter, you can choose to copy the networks from the associated set(s) only. This will not set the Uplink Set to track the network set(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>EthMode</maml:name> <maml:description> <maml:para>Sets the LACP mode on the uplink ports. Valid for ETHERNET Uplinks only. Accepted Values: * Auto (Default) * Failover</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpTimer</maml:name> <maml:description> <maml:para>Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values: * Long * Short (Default)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpLoadbalancingMode</maml:name> <maml:description> <maml:para>When configuring Synergy Virtual Connect uplink sets, the LACP load balancing algorithm can be modified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverTrigger</maml:name> <maml:description> <maml:para>LACP failover trigger is only applicable to the Ethernet uplink sets in the active-standby configuration when there is no link aggregation configured on the top-of-rack (ToR) switches or an uplink set is configured without MLAG. In this case, all traffic to the compute modules will pass through the active set of uplink ports. Link failover trigger defines failover policy for when traffic will be redirected to the standby uplink ports. In case of failover trigger based on bandwidth/uplink count, link failover can be triggered either by reduction in active uplink bandwidth or increase in standby uplink bandwidth. Allowed values: * AllActiveUplinksOffline * FailoverActiveMemberThreshold * FailoverBandwidthThreshold</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpDistributeUplinkPorts</maml:name> <maml:description> <maml:para>The distribution of LACP uplink ports is supported on HPE Virtual Connect SE 40Gb F8 Module for HPE Synergy and HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy interconnects. When the LacpDistributeUplinkPorts parameter is used, the active and standby uplink ports are distributed across the stacked interconnects within the logical interconnect. The distribution of active ports occurs when the number of uplink ports is more than 16 in an uplink set. LACP distribute uplink ports is applicable for Ethernet networks. This option is enabled by default for new uplink sets. NOTE: The port distribution depends on the number of ports added from each interconnect module. Please see the HPE OneView Online Help for more details on uplink port distribution.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverBandwidthThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 100 % (percent), when the -LacpFailoverTrigger parameter is set to 'FailoverBandwidthThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverActiveMemberThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 16, when the -LacpFailoverTrigger parameter is set to 'FailoverActiveMemberThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>PrimaryPort</maml:name> <maml:description> <maml:para>Specify the Primary Uplink Port when EthMode is set to Failover. Parameter is not valid when EthMode parameter is set to Auto. Example: "Bay1:X1"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVUplinkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Uplink set Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Type</maml:name> <maml:description> <maml:para>Uplink set Type. Accepted values are * Ethernet (Default) * FibreChannel * Tunnel * Untagged * ImageStreamer ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink Set, the network resource must be a Tagged Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return a helper object with the New-HPOVLogicalInterconnectGroup -UplinkSet parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-HPOVLogicalInterconnect) resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Array of Ethernet Network Names</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>NativeEthNetwork</maml:name> <maml:description> <maml:para>The valid name of the Native Ethernet Network that is a member of the usNetworks parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>NetworkSets</maml:name> <maml:description> <maml:para>Use this to specify one or more network sets to track the network configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>CopyNetworksFromNetworkSet</maml:name> <maml:description> <maml:para>When specifying the -NetworkSets parameter, you can choose to copy the networks from the associated set(s) only. This will not set the Uplink Set to track the network set(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>EthMode</maml:name> <maml:description> <maml:para>Sets the LACP mode on the uplink ports. Valid for ETHERNET Uplinks only. Accepted Values: * Auto (Default) * Failover</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpTimer</maml:name> <maml:description> <maml:para>Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values: * Long * Short (Default)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpLoadbalancingMode</maml:name> <maml:description> <maml:para>When configuring Synergy Virtual Connect uplink sets, the LACP load balancing algorithm can be modified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverTrigger</maml:name> <maml:description> <maml:para>LACP failover trigger is only applicable to the Ethernet uplink sets in the active-standby configuration when there is no link aggregation configured on the top-of-rack (ToR) switches or an uplink set is configured without MLAG. In this case, all traffic to the compute modules will pass through the active set of uplink ports. Link failover trigger defines failover policy for when traffic will be redirected to the standby uplink ports. In case of failover trigger based on bandwidth/uplink count, link failover can be triggered either by reduction in active uplink bandwidth or increase in standby uplink bandwidth. Allowed values: * AllActiveUplinksOffline * FailoverActiveMemberThreshold * FailoverBandwidthThreshold</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpDistributeUplinkPorts</maml:name> <maml:description> <maml:para>The distribution of LACP uplink ports is supported on HPE Virtual Connect SE 40Gb F8 Module for HPE Synergy and HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy interconnects. When the LacpDistributeUplinkPorts parameter is used, the active and standby uplink ports are distributed across the stacked interconnects within the logical interconnect. The distribution of active ports occurs when the number of uplink ports is more than 16 in an uplink set. LACP distribute uplink ports is applicable for Ethernet networks. This option is enabled by default for new uplink sets. NOTE: The port distribution depends on the number of ports added from each interconnect module. Please see the HPE OneView Online Help for more details on uplink port distribution.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverBandwidthThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 100 % (percent), when the -LacpFailoverTrigger parameter is set to 'FailoverBandwidthThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>LacpFailoverActiveMemberThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 16, when the -LacpFailoverTrigger parameter is set to 'FailoverActiveMemberThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet"> <maml:name>PrimaryPort</maml:name> <maml:description> <maml:para>Specify the Primary Uplink Port when EthMode is set to Failover. Parameter is not valid when EthMode parameter is set to Auto. Example: "Bay1:X1"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel"> <maml:name>FcUplinkSpeed</maml:name> <maml:description> <maml:para>Specify the Fibre Channel Uplink Port speed. Accepted values: * Auto (Default) * 2 * 4 * 8</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel"> <maml:name>EnableTrunking</maml:name> <maml:description> <maml:para>Use this parameter to enable FC port trunking. This parameter is only supported with HPE 16Gb or newer Virtual Connect Fibre Channel fabric modules.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-HPOVUplinkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-HPOVLogicalInterconnect) resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Uplink set Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Type</maml:name> <maml:description> <maml:para>Uplink set Type. Accepted values are * Ethernet (Default) * FibreChannel * Tunnel * Untagged * ImageStreamer ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink Set, the network resource must be a Tagged Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Array of Ethernet Network Names</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel"> <maml:name>FcUplinkSpeed</maml:name> <maml:description> <maml:para>Specify the Fibre Channel Uplink Port speed. Accepted values: * Auto (Default) * 2 * 4 * 8</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel"> <maml:name>EnableTrunking</maml:name> <maml:description> <maml:para>Use this parameter to enable FC port trunking. This parameter is only supported with HPE 16Gb or newer Virtual Connect Fibre Channel fabric modules.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PipelineOrObjectFibreChannel, PipelineOrObjectEthernet" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet" aliases="None"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>CopyNetworksFromNetworkSet</maml:name> <maml:description> <maml:para>When specifying the -NetworkSets parameter, you can choose to copy the networks from the associated set(s) only. This will not set the Uplink Set to track the network set(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel" aliases="None"> <maml:name>EnableTrunking</maml:name> <maml:description> <maml:para>Use this parameter to enable FC port trunking. This parameter is only supported with HPE 16Gb or newer Virtual Connect Fibre Channel fabric modules.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="usEthMode"> <maml:name>EthMode</maml:name> <maml:description> <maml:para>Sets the LACP mode on the uplink ports. Valid for ETHERNET Uplinks only. Accepted Values: * Auto (Default) * Failover</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel" aliases="None"> <maml:name>FcUplinkSpeed</maml:name> <maml:description> <maml:para>Specify the Fibre Channel Uplink Port speed. Accepted values: * Auto (Default) * 2 * 4 * 8</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectFibreChannel, PipelineOrObjectEthernet" aliases="li, lig, ligName, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group (Get-HPOVLogicalInterconnectGroup) or Logical Interconnect (Get-HPOVLogicalInterconnect) resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpDistributeUplinkPorts</maml:name> <maml:description> <maml:para>The distribution of LACP uplink ports is supported on HPE Virtual Connect SE 40Gb F8 Module for HPE Synergy and HPE Virtual Connect SE 100Gb F32 Module for HPE Synergy interconnects. When the LacpDistributeUplinkPorts parameter is used, the active and standby uplink ports are distributed across the stacked interconnects within the logical interconnect. The distribution of active ports occurs when the number of uplink ports is more than 16 in an uplink set. LACP distribute uplink ports is applicable for Ethernet networks. This option is enabled by default for new uplink sets. NOTE: The port distribution depends on the number of ports added from each interconnect module. Please see the HPE OneView Online Help for more details on uplink port distribution.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpFailoverActiveMemberThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 16, when the -LacpFailoverTrigger parameter is set to 'FailoverActiveMemberThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpFailoverBandwidthThreshold</maml:name> <maml:description> <maml:para>Use to specify a value of 1 through 100 % (percent), when the -LacpFailoverTrigger parameter is set to 'FailoverBandwidthThreshold'. WARNING: Failover from active to standby uplinks will cause a brief interruption in the network and storage connectivity.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpFailoverTrigger</maml:name> <maml:description> <maml:para>LACP failover trigger is only applicable to the Ethernet uplink sets in the active-standby configuration when there is no link aggregation configured on the top-of-rack (ToR) switches or an uplink set is configured without MLAG. In this case, all traffic to the compute modules will pass through the active set of uplink ports. Link failover trigger defines failover policy for when traffic will be redirected to the standby uplink ports. In case of failover trigger based on bandwidth/uplink count, link failover can be triggered either by reduction in active uplink bandwidth or increase in standby uplink bandwidth. Allowed values: * AllActiveUplinksOffline * FailoverActiveMemberThreshold * FailoverBandwidthThreshold</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpLoadbalancingMode</maml:name> <maml:description> <maml:para>When configuring Synergy Virtual Connect uplink sets, the LACP load balancing algorithm can be modified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>LacpTimer</maml:name> <maml:description> <maml:para>Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values: * Long * Short (Default)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Short</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel" aliases="usName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Logical Uplink set Name</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="usNativeEthNetwork, Native, PVID"> <maml:name>NativeEthNetwork</maml:name> <maml:description> <maml:para>The valid name of the Native Ethernet Network that is a member of the usNetworks parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>NetworkSets</maml:name> <maml:description> <maml:para>Use this to specify one or more network sets to track the network configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">array</command:parameterValue> <dev:type> <maml:name>array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel" aliases="usNetworks"> <maml:name>Networks</maml:name> <maml:description> <maml:para>Array of Ethernet Network Names</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru" aliases="None"> <maml:name>Passthru</maml:name> <maml:description> <maml:para>Use this parameter to return a helper object with the New-HPOVLogicalInterconnectGroup -UplinkSet parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet" aliases="None"> <maml:name>PrimaryPort</maml:name> <maml:description> <maml:para>Specify the Primary Uplink Port when EthMode is set to Failover. Parameter is not valid when EthMode parameter is set to Auto. Example: "Bay1:X1"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel" aliases="usType"> <maml:name>Type</maml:name> <maml:description> <maml:para>Uplink set Type. Accepted values are * Ethernet (Default) * FibreChannel * Tunnel * Untagged * ImageStreamer ImageStreamer is only supported with Synergy infrastructure. When assigning an Ethernet Network to an ImageStreamer Uplink Set, the network resource must be a Tagged Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Passthru, PipelineOrObjectEthernet, PipelineOrObjectFibreChannel" aliases="usUplinkPorts"> <maml:name>UplinkPorts</maml:name> <maml:description> <maml:para>Array of uplink ports with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Resource from Get-HPOVLogicalInterconnect</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnectGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Group Resource from Get-HPOVLogicalInterconnectGroup</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource {System.Management.Automation.PSCustomObject}</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task Resource object</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>Get-HPOVLogicalInterconnectGroup -Name "LIG Prod" | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Networks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "Auto"</dev:code> <dev:remarks> <dev:para>To Create an Ethernet Uplink Template</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ethNets = "Net1","Net2","Net3" | Get-HPOVNetwork -Type Ethernet Get-HPOVLogicalInterconnectGroup -Name "LIG Prod" | New-HPOVUplinkSet -Name "Uplink Set 1" -Type Ethernet -Networks $ethNets -NativeEthNetwork $ethNets[0] -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "Auto"</dev:code> <dev:remarks> <dev:para>Get the network resource objects, and define a new Uplink Set template that will be assigned to the Logical Interconnect Group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LIGProd = Get-HPOVLogicalInterconnectGroup -Name "LIG Prod" New-HPOVUplinkSet -Resource $LIGProd -Name "Fabric A" -Type FibreChannel -Networks "FABRIC_A" -UplinkPorts "BAY1:X1","BAY1:X2"</dev:code> <dev:remarks> <dev:para>To Create a Fibre Channel Uplink Template for c-Class or HPE Synergy VC FlexFabric modules.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect -Name "Encl1 LIG Prod" | New-HPOVUplinkSet -Name "New Uplink Set" -Type Ethernet -Networks "RED","BLUE","GREEN" -NativeEthNetwork "RED" -UplinkPorts "BAY1:X5","BAY1:X6","BAY2:X5","BAY2:X6" -EthMode "Auto"</dev:code> <dev:remarks> <dev:para>Add a new Uplink Set to an existing Logical Interconnect resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name "My MLAG Network*" Get-HPOVLogicalInterconnectGroup -Name "My Synergy Prod LIG" | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Ethernet -Networks $MlagNetworks -NativeEthNetwork ($MlagNetworks | ? vlanid -eq 144) -UplinkPorts "Enclosure1:BAY3:Q1","Enclosure1:BAY3:Q2","Enclosure2:BAY6:Q1","Enclosure2:BAY6:Q2" -EthMode "Auto"</dev:code> <dev:remarks> <dev:para>Create a Synergy MLAG Uplink Set using 40Gb capable ports.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MlagNetworks = Get-HPOVNetwork -Type Ethernet -Name "My MLAG Network*" Get-HPOVLogicalInterconnectGroup -Name "My Synergy Prod LIG" | New-HPOVUplinkSet -Name "MLAG UplinkSet" -Type Ethernet -Networks $MlagNetworks -NativeEthNetwork ($MlagNetworks | ? vlanid -eq 144) -UplinkPorts "Enclosure1:BAY3:Q1.1","Enclosure1:BAY3:Q2.1","Enclosure2:BAY6:Q1.1","Enclosure2:BAY6:Q2.1" -EthMode "Auto"</dev:code> <dev:remarks> <dev:para>Create a Synergy MLAG Uplink Set using 10Gb subports of QSFP transceiver slots.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ImageStreamerDeploymentNetworkObject = Get-HPOVNetwork -Name "Deployment Network" -ErrorAction Stop Get-HPOVLogicalInterconnectGroup -Name "My Synergy VC+ImageStreamer LIG" -ErrorAction Stop | New-HPOVUplinkSet -Name "Image Streamer Uplink Set" -Type ImageStreamer -Networks $ImageStreamerDeploymentNetworkObject -UplinkPorts "Enclosure1:Bay3:Q3.1","Enclosure1:Bay3:Q4.1","Enclosure2:Bay6:Q3.1","Enclosure2:Bay6:Q4.1"</dev:code> <dev:remarks> <dev:para>Create a Synergy ImageStreamer Uplink Set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUplinkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--NEW-HPOVUSER--> <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"> <!--NEW-HPOVUSER--> <command:details> <command:name>New-HPOVUser</command:name> <maml:description> <maml:para>Create a new user account.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>HPOVUser</command:noun> </command:details> <maml:description> <maml:para>Create a new local user account on the management appliance</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-HPOVUser</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The name of the new user account to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>The initial password to be assigned to the new user. Passwords must be at least 8 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>FullName</maml:name> <maml:description> <maml:para>Full name for the user.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>OfficePhone</maml:name> <maml:description> <maml:para>Office phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>MobilePhone</maml:name> <maml:description> <maml:para>Mobile phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-HPOVUser Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-HPOVUser Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>FullName</maml:name> <maml:description> <maml:para>Full name for the user.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>MobilePhone</maml:name> <maml:description> <maml:para>Mobile phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>OfficePhone</maml:name> <maml:description> <maml:para>Office phone number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The initial password to be assigned to the new user. Passwords must be at least 8 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>@()</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The name of the new user account to be created.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns a user resource</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>New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles "server administrator","network administrator"</dev:code> <dev:remarks> <dev:para>Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVUserSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--PING-HPOVADDRESS--> <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"> <!--PING-HPOVADDRESS--> <command:details> <command:name>Ping-HPOVAddress</command:name> <maml:description> <maml:para>Validate IP Connectivity to resources.</maml:para> </maml:description> <command:verb>Ping</command:verb> <command:noun>HPOVAddress</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the administrator the capability to PING (ICMP "echo request") to a resource the appliance is or is not managing, to help validate L2 and/or L3 connectivity from the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Ping-HPOVAddress</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Address</maml:name> <maml:description> <maml:para>The IP or FQDN Address of the target device. If using FQDN, please make sure valid DNS Servers are configured on the appliance for proper DNS resolution.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Packets</maml:name> <maml:description> <maml:para>Number of Packets to generate. Default: 5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Address</maml:name> <maml:description> <maml:para>The IP or FQDN Address of the target device. If using FQDN, please make sure valid DNS Servers are configured on the appliance for proper DNS resolution.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Packets</maml:name> <maml:description> <maml:para>Number of Packets to generate. Default: 5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Net.IPAddress</maml:name> </dev:type> <maml:description> <maml:para>IP Address of target node to ping</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Task resource of the PING request</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>$results = Ping-HPOVAddress host.domain.com -Appliance appliance.contoso.com $results.progressUpdates.statusUpdate PING host.domain.com (192.168.1.100) 56(84) bytes of data. 64 bytes from host.domain.com (192.168.1.100): icmp_seq=1 ttl=64 time=0.462 ms 64 bytes from host.domain.com (192.168.1.100): icmp_seq=2 ttl=64 time=0.629 ms 64 bytes from host.domain.com (192.168.1.100): icmp_seq=3 ttl=64 time=0.478 ms 64 bytes from host.domain.com (192.168.1.100): icmp_seq=4 ttl=64 time=0.424 ms</dev:code> <dev:remarks> <dev:para>64 bytes from host.domain.com (192.168.1.100): icmp_seq=5 ttl=64 time=0.578 ms</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--POP-HPOVAPPLIANCEPERMISSION--> <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"> <!--POP-HPOVAPPLIANCEPERMISSION--> <command:details> <command:name>Pop-HPOVAppliancePermission</command:name> <maml:description> <maml:para>Reset appliance connection active permissions back to login default.</maml:para> </maml:description> <command:verb>Pop</command:verb> <command:noun>HPOVAppliancePermission</command:noun> </command:details> <maml:description> <maml:para>Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime by using the Push-HPOVAppliancePermission. Use this Cmdlet to reset the appliance connection active permissions. A new SessionID token will be stored within the ApplianceConnection, and the ConnectionPermissions within the ActivePermissions property that were not provided will have their State set to "true".</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Pop-HPOVAppliancePermission</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ConnectionPermission</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of appliance connection permissions and their active state.</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>Pop-HPOVAppliancePermission</dev:code> <dev:remarks> <dev:para>Reset appliance connection active permissions to default.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Push-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_Appliance_Connection_Permissions</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[${Global:ConnectedSessions}]</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--PUSH-HPOVAPPLIANCEPERMISSION--> <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"> <!--PUSH-HPOVAPPLIANCEPERMISSION--> <command:details> <command:name>Push-HPOVAppliancePermission</command:name> <maml:description> <maml:para>Change appliance connection active permissions.</maml:para> </maml:description> <command:verb>Push</command:verb> <command:noun>HPOVAppliancePermission</command:noun> </command:details> <maml:description> <maml:para>Upon successful login, the caller can change their active permissions, and operate in a less priviledge mode at anytime. The Push-HPOVAppliancePermission Cmdlet will accept a single or collection of [HPOneView.Appliance.ConnectionPermission] objects. A new SessionID token will be stored within the ApplianceConnection, and the ConnectionPermissions within the ActivePermissions property that were not provided will have their State set to "false".</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Push-HPOVAppliancePermission</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SetActivePermissions</maml:name> <maml:description> <maml:para>One or more [HPOneView.Appliance.ConnectionPermission] objects from an [HPOneView.Appliance.Connection] ActivePermissions property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SetActivePermissions</maml:name> <maml:description> <maml:para>One or more [HPOneView.Appliance.ConnectionPermission] objects from an [HPOneView.Appliance.Connection] ActivePermissions property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ConnectionPermission</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more appliance connection permissions and their active state.</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>$ConnectedSessions[0].ActivePermissions RoleName ScopeName Active -------- --------- ------ Network administrator Site A Admins True Server administrator AllResources True $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? RoleName -match "Network" Push-HPOVAppliancePermission -SetActivePermissions $NewPermissions</dev:code> <dev:remarks> <dev:para>Change active permissions by filtering for a specific Role.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ConnectedSessions[0].ActivePermissions RoleName ScopeName Active -------- --------- ------ Network administrator Site A Admins True Server administrator AllResources True Server administrator AllResources True $NewPermissions = $ConnectedSessions[0].ActivePermissions | ? ScopeName -match "Site A Admins" Push-HPOVAppliancePermission -SetActivePermissions $NewPermissions</dev:code> <dev:remarks> <dev:para>Change active permissions by filtering for a specific Scope.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Pop-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_Appliance_Connection_Permissions</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[${Global:ConnectedSessions}]</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVADDRESSPOOLRANGE--> <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"> <!--REMOVE-HPOVADDRESSPOOLRANGE--> <command:details> <command:name>Remove-HPOVAddressPoolRange</command:name> <maml:description> <maml:para>Delete address pool range from an appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVAddressPoolRange</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to remove one or more IPv4 Subnet Pools and associated address pool ranges from one or more appliances.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVAddressPoolRange</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The address pool range resource Object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="AddressPool"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The address pool range resource Object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.AddressPoolRange [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>address pool range from Get-HPOVAddressPoolRange</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result of resource removal</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>Get-HPOVAddressPoolRange | Remove-HPOVAddressPoolSubnet</dev:code> <dev:remarks> <dev:para>Remove all address pool ranges the default connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAddressPoolSubnet | Where startAddress -eq "11:11:11:11:11:11" | Remove-HPOVAddressPoolSubnet</dev:code> <dev:remarks> <dev:para>Remove "192.168.20.0" IPv4 Subnet address pool from MyAppliance.domain.com.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVADDRESSPOOLSUBNET--> <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"> <!--REMOVE-HPOVADDRESSPOOLSUBNET--> <command:details> <command:name>Remove-HPOVAddressPoolSubnet</command:name> <maml:description> <maml:para>Delete an IPv4 Subnet Pool from an appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVAddressPoolSubnet</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to remove one or more IPv4 Subnet Pools and associated address pool ranges from one or more appliances.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVAddressPoolSubnet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPv4"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Subnet, -IPv4Subnet] The IPv4 Subnet Pool resource Object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPv4"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPv4" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPv4" aliases="Subnet, IPv4Subnet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Subnet, -IPv4Subnet] The IPv4 Subnet Pool resource Object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>IPv4 or IPv6 Subnet Pool from Get-HPOVAddressPoolSubnet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result of resource removal</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>Get-HPOVAddressPoolSubnet | Remove-HPOVAddressPoolSubnet</dev:code> <dev:remarks> <dev:para>Remove all IPv4 Subnet address pools from any connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAddressPoolSubnet 192.168.20.0 | Remove-HPOVAddressPoolSubnet</dev:code> <dev:remarks> <dev:para>Remove "192.168.20.0" IPv4 Subnet address pool from MyAppliance.domain.com.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVALERT--> <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"> <!--REMOVE-HPOVALERT--> <command:details> <command:name>Remove-HPOVAlert</command:name> <maml:description> <maml:para>Delete alerts.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVAlert</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet allows the administrator to remove one or more alerts. Alerts can be in one of two administratively controlled states: Active or Cleared. Only alerts that are no longer active (in a Cleared state) can be removed. In order for an administrator to remove an Alert, the administrator must be assigned to the respective resource role (Network, Server, Storage, or Infrastructure.)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVAlert</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Alert [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Alert resource object (i.e. Get-HPOVAlert)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Status object indicating the resource was removed.</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>Get-HPOVAlert -State Cleared | Remove-HPOVAlert</dev:code> <dev:remarks> <dev:para>Remove all cleared alerts on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Clear-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVAPPLIANCEPROXY--> <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"> <!--REMOVE-HPOVAPPLIANCEPROXY--> <command:details> <command:name>Remove-HPOVApplianceProxy</command:name> <maml:description> <maml:para>Remove appliance HTTP/HTTPS proxy.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVApplianceProxy</command:noun> </command:details> <maml:description> <maml:para>The setting an appliance proxy allows you to set the HTTP/HTTPS proxy, port number for client connections, and whether authentication requires a username and a password. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVApplianceProxy</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ProxyServer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance proxy server settings.</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>Remove-HPOVApplianceProxy</dev:code> <dev:remarks> <dev:para>Remove the configured HTTP/HTTP proxy settings on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVAPPLIANCETRAPDESTINATION--> <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"> <!--REMOVE-HPOVAPPLIANCETRAPDESTINATION--> <command:details> <command:name>Remove-HPOVApplianceTrapDestination</command:name> <maml:description> <maml:para>Remove configured appliance SNMP trap destinations.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVApplianceTrapDestination</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to remove configured SNMPv1 and/or SNMPv3 trap destinations. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVApplianceTrapDestination</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Appliance.SnmpV1TrapDestination or HPOneView.Appliance.SnmpV3TrapDestination object from Get-HPOVApplianceTrapDestination to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Appliance.SnmpV1TrapDestination or HPOneView.Appliance.SnmpV3TrapDestination object from Get-HPOVApplianceTrapDestination to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.SnmpV1TrapDestination</maml:name> </dev:type> <maml:description> <maml:para>Appliance SNMPv1 trap destination from Get-HPOVApplianceTrapDestination.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3TrapDestination</maml:name> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 trap destination from Get-HPOVApplianceTrapDestination.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Success message of deleted resource.</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>Get-HPOVApplianceTrapDestination -Destination 10.45.110.76 -ErrorAction Stop | Remove-HPOVApplianceTrapDestination</dev:code> <dev:remarks> <dev:para>Remove the specified trap destination.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVApplianceTrapDestination -Type SNMPv3 | Remove-HPOVApplianceTrapDestination</dev:code> <dev:remarks> <dev:para>Remove all of the SNMPv3 trap destinations.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <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"> <!--REMOVE-HPOVAPPLIANCETRUSTEDCERTIFICATE--> <command:details> <command:name>Remove-HPOVApplianceTrustedCertificate</command:name> <maml:description> <maml:para>Remove X.509 SSL certificates from the appliace trusted store.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVApplianceTrustedCertificate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will allow the Infrastructure Administrator to remove X.509 compliant SSL certificates on the appliance within its trusted store.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVApplianceTrustedCertificate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Certificate] The Alias Name of the certificate. Please know that wildcard is not supported.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] objects or Name property values.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Certificate] The Alias Name of the certificate. Please know that wildcard is not supported.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TrustedCertificate</maml:name> </dev:type> <maml:description> <maml:para>A trusted certificate from Get-HPOVApplianceTrustedCertificate.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Status oject of successfull deletion of trusted certificate.</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>Get-HPOVApplianceTrustedCertificate -AliasName myhost1.domain.com | Remove-HPOVApplianceTrustedCertificate</dev:code> <dev:remarks> <dev:para>Remove the specific trusted certificate from the appliances trusted certificate store.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVBASELINE--> <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"> <!--REMOVE-HPOVBASELINE--> <command:details> <command:name>Remove-HPOVBaseline</command:name> <maml:description> <maml:para>Delete a baseline or hotfix from an appliance repository.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVBaseline</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to remove one or more SPP Baselines from one or more appliances.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVBaseline</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The SPP Baseline or hotfix resource object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="b, Baseline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The SPP Baseline or hotfix resource object. Can be accepted via pipeline input.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Baseline [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Source HPE OneView Baseline from Get-HPOVBaseline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The progress of uploading the file to the appliance, and in-progress or completion result</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>Get-HPOVBaseline | Remove-HPOVBaseline</dev:code> <dev:remarks> <dev:para>Remove all baselines from any connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVBaseline -Name "My Custom Baseline" | Remove-HPOVBaseline</dev:code> <dev:remarks> <dev:para>Remove the specified "My Custom Baseline" baseline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVBaselineRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVBaselineRepositorySize</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVCLUSTERMANAGER--> <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"> <!--REMOVE-HPOVCLUSTERMANAGER--> <command:details> <command:name>Remove-HPOVClusterManager</command:name> <maml:description> <maml:para>Remove configured hypervisor managers. </maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVClusterManager</command:noun> </command:details> <maml:description> <maml:para>You can register a hypervisor manager with HPE OneView by providing hostname and credentials in the Hypervisor Managers user interface. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences using the edit operation. You can override these values in a hypervisor cluster profile. A valid hypervisor manager certificate must be added to HPE OneView trust store to be able to successfully communicate with a hypervisor manager. The user must have an infrastructure administrator privilege to register or update the hypervisor manager resource in HPE OneView.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVClusterManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ClusterProfile.HypervisorManager resource to remove from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.ClusterProfile.HypervisorManager</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.ClusterProfile.HypervisorManager resource to remove from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.ClusterProfile.HypervisorManager</command:parameterValue> <dev:type> <maml:name>HPOneView.ClusterProfile.HypervisorManager</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ClusterProfile.HypervisorManager</maml:name> </dev:type> <maml:description> <maml:para>The hypervisor manager object from Get-HPOVClusterManager.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVClusterManager -Name vcenter1.domain.com -ErrorAction Stop | Remove-HPOVClusterManager</dev:code> <dev:remarks> <dev:para>Remove the specified hypervisor manager.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVCLUSTERPROFILE--> <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"> <!--REMOVE-HPOVCLUSTERPROFILE--> <command:details> <command:name>Remove-HPOVClusterProfile</command:name> <maml:description> <maml:para>Remove a cluster profile resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVClusterProfile</command:noun> </command:details> <maml:description> <maml:para>A cluster profile enables you to deploy and manage a cluster of servers (nodes) managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to members in the cluster. The associated server profiles define physical server configurations for server nodes in the cluster, which are derived from parent cluster profile and its associated server profile template. NOTE: The server profile template must have a configured connection to the hypervisor management network for the template to be valid for use by a hypervisor cluster profile. The cluster profile helps you manage life cycle operations, such as growing or shrinking the cluster, modifying configurations based on needs, consistency checks, and nondisruptive firmware updates on the member nodes. For example, you can grow or shrink a cluster by adding or removing members from the cluster profile. Any change in the configuration of the cluster profile will be reported as an inconsistency. When inconsistencies are remediated, the changed configurations can be applied on cluster and member nodes. A cluster profile can manage VMware ESXi-based hypervisor clusters by leveraging VMware vCenter server. A hypervisor cluster must be managed by one instance of HPE OneView to avoid inconsistencies. Use this Cmdlet to remove a cluster profile within OneView. Removing a cluster within OneView will also destroy the cluster within the cluster manager. Minimum required privileges: Infrastructure administrator, Server administrator, Server profile architect, or Server profile administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVClusterProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster profile from Get-HPOVClusterProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster profile from Get-HPOVClusterProfile.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Cluster.ClusterProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Cluster profile resource from Get-HPOVClusterProfile.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVClusterProfile -Name ProdCluster1 | Remove-HPOVClusterProfile</dev:code> <dev:remarks> <dev:para>Remove the specified cluster profile.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfileMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVDATACENTER--> <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"> <!--REMOVE-HPOVDATACENTER--> <command:details> <command:name>Remove-HPOVDataCenter</command:name> <maml:description> <maml:para>Remove a datacenter resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVDataCenter</command:noun> </command:details> <maml:description> <maml:para>A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server, enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and cooling management of your servers, enclosures, and power delivery devices together in a single management system. When you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects. This Cmdlet will remove 1 or more datacenter resources from an appliance. Removing a datacenter resource will not delete or remove associated resources, like Racks.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVDataCenter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Datacenter object, from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Datacenter object, from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.DataCenter</maml:name> </dev:type> <maml:description> <maml:para>Datacenter resource from Get-HPOVDataCenter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object with status confirmation the resource was deleted.</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>Get-HPOVDataCenter -Name DC2 | Remove-HPOVDataCenter</dev:code> <dev:remarks> <dev:para>Remove "DC2" datacenter resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVDataCenter | Remove-HPOVDataCenter</dev:code> <dev:remarks> <dev:para>Remove Datacenter resources from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenterRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVENCLOSURE--> <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"> <!--REMOVE-HPOVENCLOSURE--> <command:details> <command:name>Remove-HPOVEnclosure</command:name> <maml:description> <maml:para>Removes an enclosure and associated devices.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVEnclosure</command:noun> </command:details> <maml:description> <maml:para>Removes an enclosure, its servers, and interconnects from appliance management</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Enclosure object(s) or name(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance, force-removing will remove the enclosure from this appliance without clearing vcmode. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to force-remove the enclosure. For example, if the enclosure is gone or is now being managed by a different appliance, force-removing will remove the enclosure from this appliance without clearing vcmode. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, Enclosure, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Enclosure object(s) or name(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of Enclosure Resources</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Enclosure resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal async task</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource</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>$enclosure = Get-HPOVEnclosure -name "Enclosure1" Remove-HPOVEnclosure $enclosure -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the enclosure specifed by $enclosure. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure | Remove-HPOVEnclosure</dev:code> <dev:remarks> <dev:para>Search for all enclosures and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureActiveFLM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVENCLOSUREGROUP--> <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"> <!--REMOVE-HPOVENCLOSUREGROUP--> <command:details> <command:name>Remove-HPOVEnclosureGroup</command:name> <maml:description> <maml:para>Remove an enclosure group.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVEnclosureGroup</command:noun> </command:details> <maml:description> <maml:para>Deletes an enclosure group from the appliance. An enclosure group cannot be deleted if any enclosures are currently part of that enclosure group.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Enclosure Group object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to forceably remove the resource from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to forceably remove the resource from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, EnclosureGroup, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Enclosure Group object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of Enclosure Resource Objects</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Enclosure Grou Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A PSCustomObject is returned indicating successful removal of the resource</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>$resp = Remove-HPOVEnclosureGroup -enclosureGroup "My-EG" -force</dev:code> <dev:remarks> <dev:para>Force-remove the enclosure group specifed by name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$eg = Get-HPOVEnclosureGroup -name "My-EG" Remove-HPOVEnclosureGroup $enclosureGroup -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the enclosure group specifed by $eg. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosureGroup | Remove-HPOVEnclosureGroup</dev:code> <dev:remarks> <dev:para>Search for all enclosure groups and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVEXTERNALREPOSITORY--> <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"> <!--REMOVE-HPOVEXTERNALREPOSITORY--> <command:details> <command:name>Remove-HPOVExternalRepository</command:name> <maml:description> <maml:para>Remove an existing external baseline repository.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVExternalRepository</command:noun> </command:details> <maml:description> <maml:para>A firmware repository enables you to store firmware bundles and deploy them across your environment. An externally managed HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You can upload firmware bundles in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This functionality is supported for Linux and Windows systems. The recommended types of external web servers to use with the repository follow: * Apache * Internet Information Services (IIS) NOTE: Only one external repository can be added. This Cmdlet supports removing an existing external repository. Removing an external baseline will cause any assigned baselines in Server Profiles or Server Profile Templates to report the baseline as "removed". Any server profile that is configured to use a firmware bundle residing in the external repository must not be in "staging" state.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.BaselineRepository [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The external repository object from Get-HPOVBaselineRepository</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task for the caller to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async task resource objects.</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>Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Remove-HPOVExternalRepository</dev:code> <dev:remarks> <dev:para>Remove the existing external repository from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVFABRICMANAGER--> <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"> <!--REMOVE-HPOVFABRICMANAGER--> <command:details> <command:name>Remove-HPOVFabricManager</command:name> <maml:description> <maml:para>Remove a configured Fabric Manager and associated tenants.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVFabricManager</command:noun> </command:details> <maml:description> <maml:para>Fabric Managers is a resource manager in HPE OneView that enables integration of a Cisco ACI fabric (an external entity) with HPE Synergy. A fabric manager aligns HPE OneView resources as defined by Cisco Application Policy Infrastructure Controller (APIC) policies. It represents a remote Cisco APIC or an APIC cluster that manages a Cisco ACI fabric. This Cmdlet will remove the fabric manager and will disassociate it's tenant from all logical interconnects, networks and networks sets. Inconsistencies with the APIC tenant configuration will no longer be monitored or remediated by OneView. Minimum required privileges: Infrastructure administrator or Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVFabricManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Networking.FabricManager resource to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Networking.FabricManager[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Networking.FabricManager resource to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Networking.FabricManager[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Networking.FabricManager[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.FabricManager</maml:name> </dev:type> <maml:description> <maml:para>The fabric manager resource from Get-HPOVFabricManager.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Get-HPOVFabricManager -Name fabricmgr.domain.com -ErrorAction Stop | Remove-HPOVFabricManager</dev:code> <dev:remarks> <dev:para>Remove the specified fabric manager.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVFabricManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLDAPDIRECTORY--> <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"> <!--REMOVE-HPOVLDAPDIRECTORY--> <command:details> <command:name>Remove-HPOVLdapDirectory</command:name> <maml:description> <maml:para>Remove authentication Directory.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLdapDirectory</command:noun> </command:details> <maml:description> <maml:para>Remove authentication Directory from the appliance. Can provide Directory Name or Object for removal.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLdapDirectory</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Configured authentication Directory Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Foreably remove the resource from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Foreably remove the resource from the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="d, Directory"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Configured authentication Directory Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of Directories</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Single Directory object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource Removed Status</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>Remove-HPOVLdapDirectory -Directory "My Directory1"</dev:code> <dev:remarks> <dev:para>Remove "My Directroy Group1" from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdapDirectory | Remove-HPOVLdapDirectory</dev:code> <dev:remarks> <dev:para>Get all Directories and remove them from the default connected appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapDirectory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLDAPGROUP--> <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"> <!--REMOVE-HPOVLDAPGROUP--> <command:details> <command:name>Remove-HPOVLdapGroup</command:name> <maml:description> <maml:para>Remove Directory Group.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLdapGroup</command:noun> </command:details> <maml:description> <maml:para>Remove Directory Group(s) from the appliance. Can provide Group Name or Object for removal.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLdapGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Configured Directory Group Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="g, Group, Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Configured Directory Group Name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Single Group resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of Group resource objects</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A PSCustomObject is returned indicating successful removal of the resource</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>Remove-HPOVLdapGroup -Group "My Directory Group1"</dev:code> <dev:remarks> <dev:para>Remove "My Directroy Group1" from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLdapGroup | Remove-HPOVLdapGroup</dev:code> <dev:remarks> <dev:para>Get all groups and remove them from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLdapGroupRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLdapGroups</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLDAPSERVER--> <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"> <!--REMOVE-HPOVLDAPSERVER--> <command:details> <command:name>Remove-HPOVLdapServer</command:name> <maml:description> <maml:para>Remove an existing LDAP Directory Server.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLdapServer</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove an existing LDAP Directory Server resource from an existing LDAP Directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLdapServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>DirectoryServerName</maml:name> <maml:description> <maml:para>Directory server name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with in order to validate LDAP configuration.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password in order to validate LDAP configuration. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HPOVLdapServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>DirectoryServerName</maml:name> <maml:description> <maml:para>Directory server name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="PSCredential, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default" aliases="Name"> <maml:name>DirectoryServerName</maml:name> <maml:description> <maml:para>Directory server name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default" aliases="Directory"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The LDAP Directory Object from Get-HPOVLdapDirectory.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="p, pass"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password in order to validate LDAP configuration. Can be System.String or System.Security.SecureString object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="u, user"> <maml:name>Username</maml:name> <maml:description> <maml:para>Directory Username to authenticate with in order to validate LDAP configuration.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Authentication Directory object that will have the LDAP Server added to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated Authentication Directory.</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>Get-HPOVLdapDirectory -Name MyDirectory | Remove-HPOVLdapServer -DirectoryServerName servera.domain.com -Username MyAdminName -Password (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)</dev:code> <dev:remarks> <dev:para>Remove the specified LDAP Directory server from "MyDirectory". Will be prompted for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLdapServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLICENSE--> <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"> <!--REMOVE-HPOVLICENSE--> <command:details> <command:name>Remove-HPOVLicense</command:name> <maml:description> <maml:para>REmove installed licenses on the appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLicense</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove licenses installed on the appliance. Removing installed licenses is only support via Windows PowerShell, Python or the HPE OneView REST API. However, if a license key is currently assigned to a resource, the license key cannot be removed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLicense</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the License URI or object to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.License</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="uri, name, license, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the License URI or object to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.License</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.License</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.License</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView License object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Success message</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.ErrorRecord</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Error message of in use license key</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>$LicenseKeys = Get-HPOVlicense Remove-HPOVLicense -InputObject $LicenseKeys[0]</dev:code> <dev:remarks> <dev:para>Get all installed licenses saving them to $LicenseKeys, then calling Remove-HPOVLicense to remove the first key in the variable.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVlicense | Remove-HPOVLicense</dev:code> <dev:remarks> <dev:para>Get all installed licenses and remove them.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLicense</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLOGICALENCLOSURE--> <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"> <!--REMOVE-HPOVLOGICALENCLOSURE--> <command:details> <command:name>Remove-HPOVLogicalEnclosure</command:name> <maml:description> <maml:para>Remove a Logical Enclosure.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLogicalEnclosure</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet willRemove a Logical Enclosure. Removing a Logical Enclosure is only supported with Synergy. If a C7000 Enclosure needs to be removed, use the Remove-HPOVEnclosure Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully remove the Logical Enclosure resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully remove the Logical Enclosure resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, le, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.LogicalEnclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Logical Enclosure resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Multiple Logical Enclosure resources</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object</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>Get-HPOVLogicalEnclosure LogicalEnclosure1 | Remove-HPOVLogicalEnclosure</dev:code> <dev:remarks> <dev:para>Remove "LogicalEnclosure1" Logical Enclosure resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosureFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLOGICALINTERCONNECTGROUP--> <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"> <!--REMOVE-HPOVLOGICALINTERCONNECTGROUP--> <command:details> <command:name>Remove-HPOVLogicalInterconnectGroup</command:name> <maml:description> <maml:para>Remove a Logical Interconnect Group.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLogicalInterconnectGroup</command:noun> </command:details> <maml:description> <maml:para>Removes a Logical Interconnect Group from appliance management</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLogicalInterconnectGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical interconnect group object(s), name(s) or uris(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>force</maml:name> <maml:description> <maml:para>Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. Force remove succeeds even if there are network connectivity issues or resource errors. -Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, Lig, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical interconnect group object(s), name(s) or uris(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. Force remove succeeds even if there are network connectivity issues or resource errors. -Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Group Name or URI</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Group resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal Task</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>$lig = Get-HPOVLogicalInterconnectGroup -Name "My-LIG" Remove-HPOVLogicalInterconnectGroup $lig -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the logical interconnect group specifed by $lig. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnectGroup | Remove-HPOVLogicalInterconnectGroup</dev:code> <dev:remarks> <dev:para>Search for all logical interconnect groups and remove them from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLOGICALJBOD--> <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"> <!--REMOVE-HPOVLOGICALJBOD--> <command:details> <command:name>Remove-HPOVLogicalJBOD</command:name> <maml:description> <maml:para>Create a new HPE Synergy Logical JBOD resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLogicalJBOD</command:noun> </command:details> <maml:description> <maml:para>A logical JBOD is a group of physical drives that are dynamically defined as virtual drives. Logical JBOD uses the drives from the drive enclosures that are installed in the device bays of the enclosure and are associated with a SAS logical interconnect. You can assign or unassign a logical JBOD to a server hardware through the server profile. If the logical drive settings in the server profile indicate that the data in the logical JBOD is to be retained when you delete the server profile, then the data is retained and you can assign this logical JBOD to a different server profile. Using this Cmdlet will remove an existing logical JBOD on the connected appliance. You can delete a logical JBOD only after you unassign it from the server profile. If you have chosen to erase the drive data when you delete a logical JBOD, all the drive data will be erased. Minimum required privileges: Infrastructure administrator, server administrator, server profile architect, server profile administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLogicalJBOD</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical JBOD resource from Get-HPOVLogialJBOD Cmdlet. If the logical JBOD is associated with a server profile, it must first be unassociated from the server profile, then you can remove it. If the erase on delete option is enabled (or set to true), then data will be deleted from the drive.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.LogicalJBOD[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force delete the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical JBOD resource from Get-HPOVLogialJBOD Cmdlet. If the logical JBOD is associated with a server profile, it must first be unassociated from the server profile, then you can remove it. If the erase on delete option is enabled (or set to true), then data will be deleted from the drive.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.LogicalJBOD[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.LogicalJBOD[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.LogicalJBOD[]</maml:name> </dev:type> <maml:description> <maml:para>One or more logical JBOD resources from Get-HPOVLogicalJBOD.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>$LogicalJBOD = Get-HPOVLogicalJBOD -Name MyLJbod1 Remove-HPOVLogicalJBOD -InputObject $LogicalJBOD</dev:code> <dev:remarks> <dev:para>Remove the specified logical JBOD.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Get the logical JBOD we intend to remove $LogicalJBOD = Get-HPOVLogicalJBOD -Name MyLJbod1 # Get the associated server profile associated with the logical JBOD $ServerProfile = Get-HPOVServerProfile -Name $LogicalJBOD.UsedBy # Remove the logical JBOD from the profile $ServerProfile.localStorage.sasLogicalJBODs = $ServerProfile.localStorage.sasLogicalJBODs | ? sasLogicalJBODUri -ne $ljbods[0].uri # Save the server profile Save-HPOVServerProfile -InputObject $ServerProfile # Remove the logical JBOD resource Remove-HPOVLogicalJBOD -InputObject $LogicalJBOD</dev:code> <dev:remarks> <dev:para>Remove the specified logical JBOD when it is associated with a server profile resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosureInventory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLOGICALSWITCH--> <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"> <!--REMOVE-HPOVLOGICALSWITCH--> <command:details> <command:name>Remove-HPOVLogicalSwitch</command:name> <maml:description> <maml:para>Remove a new Logical Switch resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLogicalSwitch</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove the configured Logical Switch from the requested appliance(s). When you delete a logical switch, HPE OneView no longer manages the physical switches associated with it. Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, even if there are communication problems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, even if there are communication problems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="ls, LogicalSwitch"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitch [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Switch resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object to monitor (if -Async was used) or results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of remove Logical Switch async task resources.</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>Get-HPOVLogicalSwitch | Remove-HPOVLogicalSwitch</dev:code> <dev:remarks> <dev:para>Remove all logical switch resources found on the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Remove-HPOVLogicalSwitch -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the "My Logical Switch 1" resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVLOGICALSWITCHGROUP--> <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"> <!--REMOVE-HPOVLOGICALSWITCHGROUP--> <command:details> <command:name>Remove-HPOVLogicalSwitchGroup</command:name> <maml:description> <maml:para>Remove a new Logical Switch Group resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVLogicalSwitchGroup</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove the configured Logical Switch Group from the requested appliance(s). You cannot delete a logical switch group while it is being used by one or more logical switches. To delete the logical switch group, first delete the logical switches using the logical switch group. Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVLogicalSwitchGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, even if there are communication problems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, even if there are communication problems.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="ls, LogicalSwitchGroup"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitchGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Switch Group resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of remove Logical Switch async task resources.</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>Get-HPOVLogicalSwitchGroup | Remove-HPOVLogicalSwitchGroup</dev:code> <dev:remarks> <dev:para>Remove all logical switch group resources found on the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalSwitchGroup -Name "My Logical Switch Group Policy 1" | Remove-HPOVLogicalSwitchGroup -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the "My Logical SwitchGroup Policy 1" resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVNETWORK--> <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"> <!--REMOVE-HPOVNETWORK--> <command:details> <command:name>Remove-HPOVNetwork</command:name> <maml:description> <maml:para>Delete network from appliance configuration.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVNetwork</command:noun> </command:details> <maml:description> <maml:para>Delete a network and its corresponding default connection type.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network object(s) or name(s) to be deleted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully remove the network object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forcefully remove the network object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="uri, name, network, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network object(s) or name(s) to be deleted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Network Name or URI</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Network Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Removal task</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>$task = Remove-HPOVNetwork -network "yellow" Wait-HPOVTaskComplete $task</dev:code> <dev:remarks> <dev:para>Remove the network specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Net = Get-HPOVNetwork -name "yellow" Remove-HPOVNetwork -network $net -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the network specifed by $net, and do not prompt for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetwork | Remove-HPOVNetwork</dev:code> <dev:remarks> <dev:para>Search for all networks and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVNETWORKSET--> <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"> <!--REMOVE-HPOVNETWORKSET--> <command:details> <command:name>Remove-HPOVNetworkSet</command:name> <maml:description> <maml:para>Remove a network set.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVNetworkSet</command:noun> </command:details> <maml:description> <maml:para>Delete a network set and its corresponding default connection type.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVNetworkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>NetworkSet</maml:name> <maml:description> <maml:para>The network set object(s), name(s) or uri(s) to be deleted. If providing a URI, you must specify an Appliance Connection.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name"> <maml:name>NetworkSet</maml:name> <maml:description> <maml:para>The network set object(s), name(s) or uri(s) to be deleted. If providing a URI, you must specify an Appliance Connection.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.NetworkSet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Network Set resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal task</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>$task = Remove-HPOVNetworkSet -networkSet "MyNetSet" Wait-HPOVTaskComplete $task</dev:code> <dev:remarks> <dev:para>Remove the network set specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$netSet = Get-HPOVNetworkSet -name "MyNetSet" | Remove-HPOVNetwork</dev:code> <dev:remarks> <dev:para>Remove the specified network set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetworkSet | Remove-HPOVNetworkSet</dev:code> <dev:remarks> <dev:para>Search for all network sets and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVOSDEPLOYMENTSERVER--> <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"> <!--REMOVE-HPOVOSDEPLOYMENTSERVER--> <command:details> <command:name>Remove-HPOVOSDeploymentServer</command:name> <maml:description> <maml:para>Remove an HPE Synergy Image Streamer OS Deployment server.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVOSDeploymentServer</command:noun> </command:details> <maml:description> <maml:para>Deleting an Image Streamer OS deployment server removes the management and storage networking configurations of all the Image Streamer appliances configured in HPE OneView. In addition, the Image Streamer appliances are reset to factory defaults, removing all OS deployment artifacts and all OS volumes. In order to successfully remove an OS Deployment Server, all associated Logical Enclosures must first be removed. If a Logical Enclosure does not contain an HPE Synergy Image Streamer appliance, then it does not need to be removed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVOSDeploymentServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>OS Deployment Server object, from Get-HPOVOSDeploymentServer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.OSDeploymentServer</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forceably remove an OS Deployment Server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forceably remove an OS Deployment Server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>OS Deployment Server object, from Get-HPOVOSDeploymentServer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.OSDeploymentServer</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.OSDeploymentServer</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.OSDeploymentServer</maml:name> </dev:type> <maml:description> <maml:para>HPE Synergy Image Streamer OS Deployment Server from Get-HPOVOSDeploymentServer</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource removal async task.</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>Get-HPOVOSDeploymentServer | Remove-HPOVOSDeploymentServer</dev:code> <dev:remarks> <dev:para>Remove OS Deployment Servers from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVOSDeploymentServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVPENDINGUPDATE--> <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"> <!--REMOVE-HPOVPENDINGUPDATE--> <command:details> <command:name>Remove-HPOVPendingUpdate</command:name> <maml:description> <maml:para>Remove pending or staged appliance update.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVPendingUpdate</command:noun> </command:details> <maml:description> <maml:para>Remove a pending or staged appliance update that prevents the appliance from operating normally or the administrator would like to update the appliance with a different update file.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVPendingUpdate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> None</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>Remove-HPOVPendingUpdate</dev:code> <dev:remarks> <dev:para>Remove any found pending update any connectioned appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Remove-HPOVPendingUpdate</dev:code> <dev:remarks> <dev:para>Remove any found pending update specified appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVPendingUpdate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVPOWERDEVICE--> <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"> <!--REMOVE-HPOVPOWERDEVICE--> <command:details> <command:name>Remove-HPOVPowerDevice</command:name> <maml:description> <maml:para>Remove power device (iPDU)</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVPowerDevice</command:noun> </command:details> <maml:description> <maml:para>Removes a power device (iPDU) from appliance management.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVPowerDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Power Device object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or resource errors. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to $true to force-remove the power device. Force-removing will succeed even when there are connectivity issues or resource errors. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, PowerDevice"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Power Device object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.PowerDeliveryDevice [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Power Device (iPDU) Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async remove task</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource</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>$task = Remove-HPOVPowerDevice -PowerDevice "iPDU16" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Remove the power device specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ipdu = Get-HPOVPowerDevice -name "iPDU24" Remove-HPOVPowerDevice -PowerDevice $ipdu -force -confirm:$false</dev:code> <dev:remarks> <dev:para>Force-Remove the profile specifed by $ipdu. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVPowerDevice | Remove-HPOVPowerDevice</dev:code> <dev:remarks> <dev:para>Search for all power devices and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVPowerDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRACK--> <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"> <!--REMOVE-HPOVRACK--> <command:details> <command:name>Remove-HPOVRack</command:name> <maml:description> <maml:para>Remove a rack resource.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVRack</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will remove an existing Rack resource. Removing a rack resource will not remove the associated rack members.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVRack</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack object, from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack object, from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.Rack</maml:name> </dev:type> <maml:description> <maml:para>Rack resource from Get-HPOVRack.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object with status confirmation the resource was deleted.</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>Get-HPOVRack -Name Rack-221 | Remove-HPOVRack</dev:code> <dev:remarks> <dev:para>Remove "Rack-221" rack resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVRack | Remove-HPOVRack</dev:code> <dev:remarks> <dev:para>Remove rack resources from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVRackToDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRackMemberLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRACKMANAGER--> <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"> <!--REMOVE-HPOVRACKMANAGER--> <command:details> <command:name>Remove-HPOVRackManager</command:name> <maml:description> <maml:para>Remove rack manager from appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVRackManager</command:noun> </command:details> <maml:description> <maml:para>A rack manager platform is a multinode system. The nodes are housed within a rack or across racks, and are centrally managed by a management controller. The Rack Managers screen enables you to manage and visualize the physical location of rack manager platforms within a rack. This Cmdlet will remove a claimed rack manager resource from the appliance. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVRackManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>An HPOneView.Servers.RackManager resource from Get-HPOVRackManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Servers.RackManager</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, in cases where the device manager has been re-addressed and is no longer accessible, or there are other communication issues preventing the resource removal.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force remove resource, in cases where the device manager has been re-addressed and is no longer accessible, or there are other communication issues preventing the resource removal.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="uri, name, Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>An HPOneView.Servers.RackManager resource from Get-HPOVRackManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Servers.RackManager</command:parameterValue> <dev:type> <maml:name>HPOneView.Servers.RackManager</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.RackManager</maml:name> </dev:type> <maml:description> <maml:para>An HPOneView.Servers.RackManager resource from Get-HPOVRackManager.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Get-HPOVRackManager -Name rackmanager2.domain.com -ErrorAction Stop | Remove-HPOVRackManager</dev:code> <dev:remarks> <dev:para>Remove the provided rack manager resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRACKMEMBER--> <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"> <!--REMOVE-HPOVRACKMEMBER--> <command:details> <command:name>Remove-HPOVRackMember</command:name> <maml:description> <maml:para>Remove a member resource from a rack.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVRackMember</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will remove a member from an existing Rack resource. Removing a rack member resource will not delete or remove the resource from the appliance, just the association with the rack.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVRackMember</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack object, from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Rack object, from Get-HPOVRack.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.RackMember</maml:name> </dev:type> <maml:description> <maml:para>Rack member resource from Get-HPOVRackMember.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task object of updating the associated rack.</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>$RackMember = Get-HPOVRack -Name Rack-221 -ErrorAction Stop | Get-HPOVRackMember -Name DL380-1 -ErrorAction Stop Remove-HPOVRackMember -InputObject $Rack1Member</dev:code> <dev:remarks> <dev:para>Remove "Rack-221" rack resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRackMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRackMemberLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVREMOTESUPPORTCONTACT--> <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"> <!--REMOVE-HPOVREMOTESUPPORTCONTACT--> <command:details> <command:name>Remove-HPOVRemoteSupportContact</command:name> <maml:description> <maml:para>Remove a Remote Support contact.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVRemoteSupportContact</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to remove an existing Remote Support Contact. The Default contact cannot be removed, and at least 1 contact must be configured before attempting to register the appliance with HPE support using the Set-HPOVRemoteSupport Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVRemoteSupportContact</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The contacts first or given name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Contact"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The contacts first or given name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Contact [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Remote Support Contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource deleted response.</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>New-HPOVRemoteSupportContact -Firstname Rebert -Lastname Jones -Email robert.jones@domain.local -PrimaryPhone 123-111-2222 -AlternatePhone 111-333-4444 -Language en -Default</dev:code> <dev:remarks> <dev:para>Configure a new user who is the default contact.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVREMOTESUPPORTPARTNER--> <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"> <!--REMOVE-HPOVREMOTESUPPORTPARTNER--> <command:details> <command:name>Remove-HPOVRemoteSupportPartner</command:name> <maml:description> <maml:para>Remove Remote Support support and reseller partners.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVRemoteSupportPartner</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to remove defined Remote Support partner from a specified or all appliances.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVRemoteSupportPartner</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Remote Suport partner resource object, from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Partner"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Remote Suport partner resource object, from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Partner [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Remote Suport partner resource from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object with status confirmation the resource was deleted.</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>Get-HPOVRemoteSupportPartner -Name "ABC IT Vendor" -ErrorAction Stop | Remove-HPOVRemoteSupportPartner</dev:code> <dev:remarks> <dev:para>Remove the specified remote support partner from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRESOURCE--> <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"> <!--REMOVE-HPOVRESOURCE--> <command:details> <command:name>Remove-HPOVResource</command:name> <maml:description> <maml:para>Remove existing resource(s).</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVResource</command:noun> </command:details> <maml:description> <maml:para>Removes a resource identified by either the resource uri or a resource object. Remove-HPOVResource can be called with either -nameOrUri or -resource. *** This Cmdlet will not prompt for delete confirmation. Please use with caution. ***</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVResource</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A resource to be deleted. Value can be either resource object, Name or URI.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>force</maml:name> <maml:description> <maml:para>Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. -Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option. Not all resources support force-delete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="ro, nameOruri, uri, name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A resource to be deleted. Value can be either resource object, Name or URI.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Invoke switch force-delete the resource when OneView can no longer communicate with the resource and removal is needed. -Force is not a PowerShell option, rather an HPE OneView API feature. This does not override the -Confirm PowerShell option. Not all resources support force-delete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>A valid resource object first retrieved by a call to a Get-HPOV*** Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal async task</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>Remove-HPOVResource -Resource "/rest/resource/1234-5678-9123"</dev:code> <dev:remarks> <dev:para>Removes the resource specified by the URI.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Remove-HPOVResource -nameOrUri "ServerProfile-A"</dev:code> <dev:remarks> <dev:para>Removes the resource named "ServerProfile-A". If multiple resources exist with the name "ServerProfile-A", an error is returned.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$MyResourceObject = send-hpovrequest "/rest/resource/1234-5678-9123" Remove-HPOVResource -Resource $MyResourceObject</dev:code> <dev:remarks> <dev:para>Removes the resource $MyReSourceObject.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRESOURCEFROMLABEL--> <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"> <!--REMOVE-HPOVRESOURCEFROMLABEL--> <command:details> <command:name>Remove-HPOVResourceFromLabel</command:name> <maml:description> <maml:para>Remove association of resource with existing Label.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVResourceFromLabel</command:noun> </command:details> <maml:description> <maml:para>Labels identify resources so you can organize them into groups. For example, you might want to identify the servers that are used primarily by the Finance team, or identify the storage systems assigned to the Asia/Pacific division. This Cmdlet will remove the specified resource from the requested label. To remove the resource from all labels, use the -RemoveAllLabelsFromResource switch parameter. If there are no more associated resources with a label, the appliance will automatically delete the label.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVResourceFromLabel</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label associated with the resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RemoveAll, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The resource to remove associatation with the label.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RemoveAll, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HPOVResourceFromLabel</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RemoveAll, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The resource to remove associatation with the label.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoveAll"> <maml:name>RemoveAllLabelsFromResource</maml:name> <maml:description> <maml:para>Use to remove all associated labels with the provide resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RemoveAll, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RemoveAll, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RemoveAll, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The resource to remove associatation with the label.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Label associated with the resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RemoveAll" aliases="None"> <maml:name>RemoveAllLabelsFromResource</maml:name> <maml:description> <maml:para>Use to remove all associated labels with the provide resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Resource to remove label association.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The created or modified Label resource.</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>Get-HPOVNetwork -Name Finance* | Remove-HPOVResourceFromLabel -Name Finance</dev:code> <dev:remarks> <dev:para>Remove the Finance network resources from the "Finance" label.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetwork | Remove-HPOVResourceFromLabel -RemoveAllLabelsFromResource</dev:code> <dev:remarks> <dev:para>Remove all label associations from network resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVRESOURCEFROMSCOPE--> <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"> <!--REMOVE-HPOVRESOURCEFROMSCOPE--> <command:details> <command:name>Remove-HPOVResourceFromScope</command:name> <maml:description> <maml:para>Remove supported resource(s) from Scope.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVResourceFromScope</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will add supported resources to a specified Scope. All the resources in these categories can be added to or removed from a scope: * Enclosures * Server Hardware * Networks (Ethernet, FC, and FCoE) * Network Sets * Interconnects, excluding SAS resources * Logical Interconnects, excluding SAS resources * Logical Interconnect Groups, excluding SAS resources * Switches * Logical Switches * Logical Switch Groups NOTE: Resources in other categories are considered to be included in all scopes, and they cannot be removed. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVResourceFromScope</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> </dev:type> <maml:description> <maml:para>Scope resource object from Get-HPOVScope.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource that updates the Scope and associated resources.</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>$Resources += Get-HPOVNetwork -Name ProdVLan* $Resources += Get-HPOVServer -Name Encl1* Get-HPOVScope -Name MyScope | Add-HPOVResourceToScope -InputObject $Resources</dev:code> <dev:remarks> <dev:para>Add the resources collected to the MyScope scope.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSANMANAGER--> <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"> <!--REMOVE-HPOVSANMANAGER--> <command:details> <command:name>Remove-HPOVSanManager</command:name> <maml:description> <maml:para>Remove a SAN Manager.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVSanManager</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to remove the specified SAN Manager from the appliance. Before removing a SAN Manager, the Managed SAN resource must be removed from any configured FC or FCoE Network resources.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN resource object or name to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Name, SanManager"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN resource object or name to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.SanManager [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>SAN Manager resource object(s)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A PSCustomObject is returned indicating successful removal of the resource</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>Remove-HPOVSanManager bna.contoso.com</dev:code> <dev:remarks> <dev:para>Remove the bna.contoso.com SAN Manager from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSanManager | Remove-HPOVSanManager</dev:code> <dev:remarks> <dev:para>Remove all SAN Managers from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSCMBCERTIFICATE--> <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"> <!--REMOVE-HPOVSCMBCERTIFICATE--> <command:details> <command:name>Remove-HPOVScmbCertificate</command:name> <maml:description> <maml:para>Remove State Change Message Bus certificate from appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVScmbCertificate</command:noun> </command:details> <maml:description> <maml:para>Remove the State Change Message Bus (SCMB) and Metric Streaming Message Bug (MSMB) read only account (rabbitmq_readonly) certificate key pair from an appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVScmbCertificate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HPOVScmbCertificate</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource deleted response.</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>Remove-HPOVScmbCertificates</dev:code> <dev:remarks> <dev:para>Remove the SCMB (rabbitmq_readonly) certificate key pair from an appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVScmbCertificates</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSCOPE--> <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"> <!--REMOVE-HPOVSCOPE--> <command:details> <command:name>Remove-HPOVScope</command:name> <maml:description> <maml:para>Remove Scope from appliance</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVScope</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove a specific Scope. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVScope</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>Scope</maml:name> <maml:description> <maml:para>The Scope resource to add the resource(s) to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.ScopeCollection</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.ScopeCollection</maml:name> </dev:type> <maml:description> <maml:para>Scope resource object from Get-HPOVScope.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Response indicating the resource was deleted successfully.</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>Get-HPOVScope MyScope | Remove-HPOVScope</dev:code> <dev:remarks> <dev:para>Remove the specified scope.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSERVER--> <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"> <!--REMOVE-HPOVSERVER--> <command:details> <command:name>Remove-HPOVServer</command:name> <maml:description> <maml:para>Remove a rackmount server from the appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>Removes a physical server object from appliance management. The server object can be specified by its name or its full URI on the appliance by using the -Server parameter. It can also be supplied as an object by using the -resource parameter the object variable can be piped to Remove-HPOVServer. Blade servers can only be removed by removing the enclosure (Remove-HPOVEnclosure), or phyhsically removing the blade from the enclosure.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force-remove the server. For example, if the server is gone or managed by a different appliance, force-remove will remove the server from this appliance without removing any of the HPE OneView applied configuration. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use to force-remove the server. For example, if the server is gone or managed by a different appliance, force-remove will remove the server from this appliance without removing any of the HPE OneView applied configuration. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="uri, name, Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server object(s), name(s) or uri(s) to be removed from management.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Provide the Server Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async removal task</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource</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>$task = Remove-HPOVServer -name "Server-1234" -force Wait-HPOVTaskComplete $task </dev:code> <dev:remarks> <dev:para>Force-remove the server specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$server = Get-HPOVServer -name "Server-1234" Remove-HPOVServer $server -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the server specifed by $server. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$server = Get-HPOVServer -name "Server-1234" Remove-HPOVServer $server -confirm:$false -force</dev:code> <dev:remarks> <dev:para>Remove the server specifed by $server. Disable confirmation prompt, and force remove the server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer | Remove-HPOVServer</dev:code> <dev:remarks> <dev:para>Search for all rackmount servers and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSERVERPROFILE--> <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"> <!--REMOVE-HPOVSERVERPROFILE--> <command:details> <command:name>Remove-HPOVServerProfile</command:name> <maml:description> <maml:para>Delete Server Profile Resource(s).</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove Server Profile resources from one or more appliance connections. Server Profile objects or names are supported. Server Profile resources can only be removed when the BladeSystem (BL) Server Hardware device is powered off.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>The server profile object(s), name(s) or URI(s) to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been lost to the server or enclosure.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, profile"> <maml:name>ServerProfile</maml:name> <maml:description> <maml:para>The server profile object(s), name(s) or URI(s) to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been lost to the server or enclosure.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Server Profile resource name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A task resource that can be monitored for status of the profile deletion</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async task resources.</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>$task = Remove-HPOVServerProfile -profile "Profile6" Wait-HPOVTaskComplete $task.uri </dev:code> <dev:remarks> <dev:para>Remove the profile specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$profile = Get-HPOVServerProfile -name "Profile2" Remove-HPOVServerProfile $profile -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the profile specifed by $profile. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile | Remove-HPOVServerProfile</dev:code> <dev:remarks> <dev:para>Search for all profiles and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSERVERPROFILETEMPLATE--> <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"> <!--REMOVE-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>Remove-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Delete Server Profile Template Resource(s).</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>Delete one or multiple Server Profile Template resource(s). A Server Profile Template cannot be removed if there are linked Server Profiles.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template object(s) or name(s) to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been lost to the server or enclosure.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="spt, name"> <maml:name>ServerProfileTemplate</maml:name> <maml:description> <maml:para>The server profile template object(s) or name(s) to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-delete the profile. For example, force-remove will successfully remove the profile, even when connectivity has been lost to the server or enclosure.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfileTemplate [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Template resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Template resource name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A task resource that can be monitored for status of the profile deletion</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async task resources.</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>$task = Remove-HPOVServerProfileTemplate -ServerProfileTemplate "My Template Profile" Wait-HPOVTaskComplete $task.uri </dev:code> <dev:remarks> <dev:para>Remove the profile template specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$spt = Get-HPOVServerProfileTemplate -name "My Template Profile" Remove-HPOVServerProfileTemplate $spt -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the profile template specifed by $spt. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfileTemplate | Remove-HPOVServerProfileTemplate</dev:code> <dev:remarks> <dev:para>Search for all profile template resources and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSNMPV3USER--> <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"> <!--REMOVE-HPOVSNMPV3USER--> <command:details> <command:name>Remove-HPOVSnmpV3User</command:name> <maml:description> <maml:para>Remove SNMPv3 user from appliance.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVSnmpV3User</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can be used as a proxy to forward device traps from servers and enclosures (OA) to other SNMP-enabled applications on the network. HPE OneView can forward traps, as SNMPv3 or SNMPv1 traps, to configured destinations. Appliance SNMP settings allow you to add destinations to which the traps need to be forwarded. You can configure each destination as an SNMPv1 or SNMPv3 destination, depending on whether the traps are sent in SNMPv1 or SNMPv3 formats. Additionally, if you have Gen6 or Gen7 servers being monitored by HPE OneView in your environment, you can configure the read community string that HPE OneView uses for monitoring these servers with SNMPv1. NOTE: To configure SNMP trap forwarding for network devices (interconnects and switches), use the New-HPOVSnmpV3User and include it within the New-HPOVSnmpTrapDestination Cmdlet. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVSnmpV3User</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>SNMPv3 user account from Get-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>SNMPv3 user account from Get-HPOVSnmpV3User.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SnmpV3User</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3User</maml:name> </dev:type> <maml:description> <maml:para>Appliance SNMPv3 user account from Get-HPOVSnmpV3User.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Success message of deleted resource.</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>$Snmpv3User = Get-HPOVSnmpV3User -Name Tr@pUser -ErrorAction Stop | Remove-HPOVSnmpV3User</dev:code> <dev:remarks> <dev:para>Remove the specific SNMPv3 user account on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVSnmpV3User</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTANDBYCOMPOSERNODE--> <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"> <!--REMOVE-HPOVSTANDBYCOMPOSERNODE--> <command:details> <command:name>Remove-HPOVStandbyComposerNode</command:name> <maml:description> <maml:para>Remove Standby Composer node.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStandbyComposerNode</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help remove the Standby Composer node from the Synergy management ring. In order to remove the Active node from the Synergy management ring, you first must use the Enable-HPOVComposerHANode Cmdlet to transition the Standby node to the Active role.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStandbyComposerNode</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default -eq $true)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Async task resource of the remove standby node request</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async task resources</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>Remove-HPOVStandbyComposerNode</dev:code> <dev:remarks> <dev:para>Remove the Standby Composer node in the default Appliance Connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTORAGEPOOL--> <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"> <!--REMOVE-HPOVSTORAGEPOOL--> <command:details> <command:name>Remove-HPOVStoragePool</command:name> <maml:description> <maml:para>Delete storage pool resource(s).</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStoragePool</command:noun> </command:details> <maml:description> <maml:para>Delete one or more storage pools from the appliance configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStoragePool</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="StorageSystem, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network object(s) or name(s) to be removed on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StorageSystem, default"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, the Storage Pool resource will forceablly removed despite any problems with network connectivity or errors with the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StorageSystem, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-HPOVStoragePool</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="StorageSystem, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network object(s) or name(s) to be removed on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StorageSystem"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>Provide the Storage System Name, URI or Object when the StoragePool name is not unique.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StorageSystem, default"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, the Storage Pool resource will forceablly removed despite any problems with network connectivity or errors with the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StorageSystem, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="StorageSystem, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StorageSystem, default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, the Storage Pool resource will forceablly removed despite any problems with network connectivity or errors with the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="StorageSystem, default" aliases="uri, name, StoragePool"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network object(s) or name(s) to be removed on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="StorageSystem" aliases="storage"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>Provide the Storage System Name, URI or Object when the StoragePool name is not unique.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System.Pool [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Storage Pool resource, typically retrieved with Get-HPOVStoragePool</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal task</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>$task = Remove-HPOVStoragePool -storagePool "yellow" | Wait-HPOVTaskComplete $task</dev:code> <dev:remarks> <dev:para>Remove the storage pool specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$pool = Get-HPOVStoragePool -name "yellow" Remove-HPOVStoragePool -storagePool $pool -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the network specifed by $pool, and do not prompt for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool | Remove-HPOVStoragePool</dev:code> <dev:remarks> <dev:para>Search for all storage pools and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTORAGESYSTEM--> <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"> <!--REMOVE-HPOVSTORAGESYSTEM--> <command:details> <command:name>Remove-HPOVStorageSystem</command:name> <maml:description> <maml:para>Remove a Storage System</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStorageSystem</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist with removing a discovered and managed storage system from the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStorageSystem</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Name or URI of the managed storage system.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>force</maml:name> <maml:description> <maml:para>Switch to force removal of a storage system the appliance can no longer communicate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, StorageSystem"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Name or URI of the managed storage system.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Switch to force removal of a storage system the appliance can no longer communicate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage System resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.System></maml:name> </dev:type> <maml:description> <maml:para>Collections of Storage System resource objects</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returns an async task resource to monitor.</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>Remove-HPOVStorageSystem HP3PAR_2</dev:code> <dev:remarks> <dev:para>Remove "HP3PAR_2" storage system from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVStorageSystemPerformancePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTORAGEVOLUME--> <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"> <!--REMOVE-HPOVSTORAGEVOLUME--> <command:details> <command:name>Remove-HPOVStorageVolume</command:name> <maml:description> <maml:para>Remove a Storage Volume</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove storage volumes from the HPE OneView appliance. Volumes must first be removed from attached Server Profiles prior to deleting the Storage Volume.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Storage Volume Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ExportOnly</maml:name> <maml:description> <maml:para>Removes the volume from HPE OneView. The volume remains on the storage system, and must be managed manually until it is added back under management of HPE OneView. Default: Delete Export AND Volume from storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>ExportOnly</maml:name> <maml:description> <maml:para>Removes the volume from HPE OneView. The volume remains on the storage system, and must be managed manually until it is added back under management of HPE OneView. Default: Delete Export AND Volume from storage system.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, StorageVolume"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Storage Volume Name, URI or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System.Volume [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async removal task</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>$VolumeToRemove = Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop Remove-HPOVStorageVolume -InputObject $VolumeToRemove</dev:code> <dev:remarks> <dev:para>Remove export and delete volume named "TestVol1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageVolume -Name TestVol1 -ErrorAction Stop | Remove-HPOVStorageVolume -exportonly</dev:code> <dev:remarks> <dev:para>Remove export of volume named "TestVol1" only, which leaves the volume still provisioned on the array and is added back to the HPE OneView Storage Volumes pool.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTORAGEVOLUMESNAPSHOT--> <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"> <!--REMOVE-HPOVSTORAGEVOLUMESNAPSHOT--> <command:details> <command:name>Remove-HPOVStorageVolumeSnapshot</command:name> <maml:description> <maml:para>Remove storage volume snapshot resource(s).</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStorageVolumeSnapshot</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will remove a storage volume snapshot from a storage volume resource object. Removal of a snapshot is a destructive operation of the snapshot only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStorageVolumeSnapshot</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the snapshot resource object to remove from the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Snapshot"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the snapshot resource object to remove from the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.VolumeSnapshot [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume Snapshot resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async create task resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple task resources</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>$Snapshots = Get-HPOVStorageVolume -Name "Volume 1" -ErrorAction Stop | Get-HPOVStorageVolumeSnapshot $Snapshots | ? { ((get-date) - (Get-Date $_.created)).days -ge 5 } | Remove-HPOVStorageVolumeSnapshot</dev:code> <dev:remarks> <dev:para>Get all of the available storage volume snapshots for "Volume 1", then remove any snapshots as old or older than 5 days.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageVolume | Get-HPOVStorageVolumeSnapshot | Remove-HPOVStorageVolumeSnapshot</dev:code> <dev:remarks> <dev:para>Remove all Storage Volume Snapshots managed by HPE OneView.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVSTORAGEVOLUMETEMPLATE--> <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"> <!--REMOVE-HPOVSTORAGEVOLUMETEMPLATE--> <command:details> <command:name>Remove-HPOVStorageVolumeTemplate</command:name> <maml:description> <maml:para>Delete storage volume template(s) from appliance configuration.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVStorageVolumeTemplate</command:noun> </command:details> <maml:description> <maml:para>Delete one or more storage volume templates from the appliance configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-name, -uri, -TemplateName., -Template] The Storage Volume Template object(s), name(s) or URI(s) to be deleted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to remove the resource despite any problems with network connectivity or errors on the resource itself. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify to remove the resource despite any problems with network connectivity or errors on the resource itself. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name, templateName, Template"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-name, -uri, -TemplateName., -Template] The Storage Volume Template object(s), name(s) or URI(s) to be deleted.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume Template resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Multiple Storage Volume Template resources</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Removal async task</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource</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>$task = Remove-HPOVStorageVolumeTemplate -storagePool "yellow" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Remove the storage volume template specifed by name. Wait for remove to complete.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$svt = Get-HPOVStorageVolumeTemplate -name "yellow" Remove-HPOVStorageVolumeTemplate -name $svt -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the network specifed by $svt, and do not prompt for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragVolumeTemplate | Remove-HPOVStorageVolumeTemplate</dev:code> <dev:remarks> <dev:para>Search for all storage volume templates and remove them from appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVUNMANAGEDDEVICE--> <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"> <!--REMOVE-HPOVUNMANAGEDDEVICE--> <command:details> <command:name>Remove-HPOVUnmanagedDevice</command:name> <maml:description> <maml:para>Remove an Unmanaged Device.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVUnmanagedDevice</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to remove an Unmanaged Device from the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVUnmanagedDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>UnmanagedDevice</maml:name> <maml:description> <maml:para>Alias [-name, -uri] The Name, URI or Object of the Unmanaged Device to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-remove the resource. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="uri, name"> <maml:name>UnmanagedDevice</maml:name> <maml:description> <maml:para>Alias [-name, -uri] The Name, URI or Object of the Unmanaged Device to remove.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>force</maml:name> <maml:description> <maml:para>Set to force-remove the resource. When the request is accepted by the appliance, it does not return an Async Task Resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.UnmanagedResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Unmanaged Device resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>When using the -Force parameter, a PSCustomObject is returned indicating successful removal of the resource</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>Remove-HPOVUnmanagedDevice MyDevice</dev:code> <dev:remarks> <dev:para>Remove the Unmanaged Device "MyDevice" from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Remove-HPOVUnmanagedDevice MyDevice -confirm:$false</dev:code> <dev:remarks> <dev:para>Remove the Unmanaged Device "MyDevice" from the appliance and do not prompt for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUnmanagedDevice | Remove-HPOVUnmanagedDevice</dev:code> <dev:remarks> <dev:para>Get all Unmanaged Devices on the appliance and remove them.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVUnmanagedDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--REMOVE-HPOVUSER--> <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"> <!--REMOVE-HPOVUSER--> <command:details> <command:name>Remove-HPOVUser</command:name> <maml:description> <maml:para>Remove a user account.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>HPOVUser</command:noun> </command:details> <maml:description> <maml:para>Remove a specific local user account from the management appliance</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Remove-HPOVUser</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The user account object to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="u, user, UserName, Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The user account object to be removed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView User Account object created on an appliance</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Success message if user was deleted</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>Get-HPOVUser Sally | Remove-HPOVUser</dev:code> <dev:remarks> <dev:para>Retrieve "Sally" user account using Get-HPOVUser, then pipe it to Remove-HPOVUser.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVUserSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--RESET-HPOVENCLOSUREDEVICE--> <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"> <!--RESET-HPOVENCLOSUREDEVICE--> <command:details> <command:name>Reset-HPOVEnclosureDevice</command:name> <maml:description> <maml:para>Power reset or EFuse HPE Synergy Frame component.</maml:para> </maml:description> <command:verb>Reset</command:verb> <command:noun>HPOVEnclosureDevice</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist server administrators in performing various power operations with HPE Synergy enclosure resources. The following resources are supported with their supported operation: * HPE Synergy Appliance Bay - EFuse * HPE Synergy Frame Link Module - EFuse or Reset * Device Bay - EFuse or Reset * HPE Synergy Fabric Module Device - EFuse E-Fuse stands for Electronic Fuse. Setting the power state of a device to "E-Fuse" (or "Reset" for an Enclosure Manager) will reset the bay, but it will soon return to a normal running state. An E-Fuse will turn off power to the bay and then turn it back on. If the bay was powered off before the E-Fuse operation it will be powered on afterwards. A "Reset" will do a hard reset of the bay without affecting the power. E-Fuse on a device bay will power-cycle the whole blade including the iLO. A reset on the active Synergy Frame Link Module causes a failover to the standby Synergy Frame Link Module. The reset will fail if the Synergy Frame Link Module's firmware is being updated. An E-Fuse against an active Synergy Frame Link Module is not allowed. Minimum required privileges: Infrastructure administrator, Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Reset-HPOVEnclosureDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The Synergy Frame resource from Get-HPOVEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Component</maml:name> <maml:description> <maml:para>The embedded component to perform the action against. Allowed value: * FLM - Frame Link Module. Both EFuse and Reset are supported. * Appliance - Management Appliance; Synergy Compser or Synergy Image Streamer. Only supported method is EFuse. * ICM - Synergy Fabric Interconnect Module. Only supported method is EFuse. * Device - Synergy Device (e.g. Compute Node populated in Bay 1). Both EFuse and Reset are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>DeviceID</maml:name> <maml:description> <maml:para>The corrisponding bay ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Efuse</maml:name> <maml:description> <maml:para>EFuse will take away and then present power back to the device. Supported with all component types.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Reset-HPOVEnclosureDevice</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The Synergy Frame resource from Get-HPOVEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Component</maml:name> <maml:description> <maml:para>The embedded component to perform the action against. Allowed value: * FLM - Frame Link Module. Both EFuse and Reset are supported. * Appliance - Management Appliance; Synergy Compser or Synergy Image Streamer. Only supported method is EFuse. * ICM - Synergy Fabric Interconnect Module. Only supported method is EFuse. * Device - Synergy Device (e.g. Compute Node populated in Bay 1). Both EFuse and Reset are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>DeviceID</maml:name> <maml:description> <maml:para>The corrisponding bay ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay"> <maml:name>Reset</maml:name> <maml:description> <maml:para>Reset power to the device. Only supported with certain component types.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ManagerOrDeviceBay, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ManagerOrDeviceBay, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions}</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default" aliases="None"> <maml:name>Component</maml:name> <maml:description> <maml:para>The embedded component to perform the action against. Allowed value: * FLM - Frame Link Module. Both EFuse and Reset are supported. * Appliance - Management Appliance; Synergy Compser or Synergy Image Streamer. Only supported method is EFuse. * ICM - Synergy Fabric Interconnect Module. Only supported method is EFuse. * Device - Synergy Device (e.g. Compute Node populated in Bay 1). Both EFuse and Reset are supported.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay, default" aliases="None"> <maml:name>DeviceID</maml:name> <maml:description> <maml:para>The corrisponding bay ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Efuse</maml:name> <maml:description> <maml:para>EFuse will take away and then present power back to the device. Supported with all component types.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ManagerOrDeviceBay, default" aliases="None"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The Synergy Frame resource from Get-HPOVEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ManagerOrDeviceBay" aliases="None"> <maml:name>Reset</maml:name> <maml:description> <maml:para>Reset power to the device. Only supported with certain component types.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure</maml:name> </dev:type> <maml:description> <maml:para>Resource from Get-HPOVEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>$Enclosure = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop Reset-HPOVEnclosureDevice -Enclosure $Enclosure -Component FLM -DeviceID 1 -EFuse</dev:code> <dev:remarks> <dev:para>Reset the FLM in slot 1 by performing an EFuse.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Enclosure = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop Reset-HPOVEnclosureDevice -Enclosure $Enclosure -Component ICM -DeviceID 3 -EFuse</dev:code> <dev:remarks> <dev:para>Reset the ICM in interconnect bay 3 by performing an EFuse.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Task = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop | Reset-HPOVEnclosureDevice -Component Device -DeviceID 4 -Reset</dev:code> <dev:remarks> <dev:para>Reset the device in bay 4 by requesting it to reset itself.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Task = Get-HPOVEnclosure -Name Enclosure1 -ErrorAction Stop | Reset-HPOVEnclosureDevice -Component Appliance -DeviceID 1 -EFuse</dev:code> <dev:remarks> <dev:para>Reset the appliance device in bay 1 by performing an EFuse.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--RESET-HPOVINTERCONNECTNETOPPASSWORD--> <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"> <!--RESET-HPOVINTERCONNECTNETOPPASSWORD--> <command:details> <command:name>Reset-HPOVInterconnectNetOpPassword</command:name> <maml:description> <maml:para>Reset HPE Synergy Virtual Connect NetOp account password.</maml:para> </maml:description> <command:verb>Reset</command:verb> <command:noun>HPOVInterconnectNetOpPassword</command:noun> </command:details> <maml:description> <maml:para>*** THIS CMDLET SHOULD NOT BE EXECUTED WITHOUT GUIDANCE FROM HPE CUSTOMER SUPPORT CENTER *** This Cmdlet will reset the HPE Synergy Virtual Connect NetOp account password to the specified value. Minimum required privileges: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Reset-HPOVInterconnectNetOpPassword</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Interconnect from Get-HPOVInterconnect Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Interconnect"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Interconnect from Get-HPOVInterconnect Cmdlet.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password in System.Security.SecureString format.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.Interconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Interconnect resource from Get-HPOVInterconnect.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task that tracks the operation.</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>$NetOpPassword = Read-Host -Message "New password: " -AsSecureString $InterconnectObject = Get-HPOVInterconnect -Name MyEncl1-Ethernet-LIG1 Reset-HPOVInterconnectNetOpPassword -InputObject $InterconnectObject -Password $NetOpPassword</dev:code> <dev:remarks> <dev:para>Set the NetOp password to the new value, for the specific Interconnect.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVInterconnect</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--RESTART-HPOVAPPLIANCE--> <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"> <!--RESTART-HPOVAPPLIANCE--> <command:details> <command:name>Restart-HPOVAppliance</command:name> <maml:description> <maml:para>Restart an HPE OneView appliance.</maml:para> </maml:description> <command:verb>Restart</command:verb> <command:noun>HPOVAppliance</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will allow the administrator to restart/reboot the appliance. Restarting the appliance will cause all users to be disconnected and all ongoing tasks to be interrupted. Only the Infrastructure (Full) Administrator may restart the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restart-HPOVAppliance</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>Appliance Connection object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of HPOneView.Appliance.Connection objects</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Warning message the appliance is stopping</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Management.Automation.ErrorRecord</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generated error message</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>Connect-HPOVMgmt appliance.contoso.com Administrator P@ssw0rd Restart-HPOVAppliance</dev:code> <dev:remarks> <dev:para>Restart the appliance</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Restart-HPOVAppliance -confirm:$false</dev:code> <dev:remarks> <dev:para>Restart all connected appliances without confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAvailableSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCertificateStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPOVApplianceCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceCsr</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceSelfSignedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Pop-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Push-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceDefaultConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVAppliance</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVApplianceTrustedAuthorityCrl</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-HPOVApplianceStart</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--RESTART-HPOVSERVER--> <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"> <!--RESTART-HPOVSERVER--> <command:details> <command:name>Restart-HPOVServer</command:name> <maml:description> <maml:para>Restart Server Resource.</maml:para> </maml:description> <command:verb>Restart</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>Restart the power state of the server using the virtual power button. By default, the Cmdlet will request a "Reset" request to initiate a server to restart. Using the ColdBoot will take away and present power back to the server resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restart-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ColdBoot, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ColdBoot, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ColdBoot, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restart-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ColdBoot, Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ColdBoot"> <maml:name>ColdBoot</maml:name> <maml:description> <maml:para>Use this parameter to request power be forcably removed then represented to the server resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ColdBoot, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ColdBoot, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="ColdBoot, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ColdBoot, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ColdBoot" aliases="None"> <maml:name>ColdBoot</maml:name> <maml:description> <maml:para>Use this parameter to request power be forcably removed then represented to the server resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="ColdBoot, Default" aliases="None"> <maml:name>Server</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task that tracks the power state change</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async tasks</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>Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Restart the specific server device by passing the Server Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile "MyWebServer 1" | Restart-HPOVServer | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Restart the specific server device by passing the Server Profile Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer "Encl1, Bay 1" | Restart-HPOVServer -ColdBoot | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Restart the specific server device by passing the Server Object via pipeline, and issue a cold boot request.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--RESTORE-HPOVCUSTOMBASELINE--> <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"> <!--RESTORE-HPOVCUSTOMBASELINE--> <command:details> <command:name>Restore-HPOVCustomBaseline</command:name> <maml:description> <maml:para>Restore a Custom Baseline after Restore of a Backup File.</maml:para> </maml:description> <command:verb>Restore</command:verb> <command:noun>HPOVCustomBaseline</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to restore custom SPP Baselines that were created with component hotfixes on the appliance after a backup file restore procedure has completed. It will search for any custom Baseline resources that are in the "Removed" state, and rebuild the baseline with the associated hotfixes. The source baseline and associated hotfixes must be present within the Baseline repository. Use the Add-HPOVBaseline to upload the starting Baseline and hotfixes after restoring the Appliance Backup file, then use this Cmdlet to rebuild the Custom Baseline.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Restore-HPOVCustomBaseline</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The progress of in-progress or completion result</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>Restore-HPOVCustomBaseline</dev:code> <dev:remarks> <dev:para>Restore all Custom Baselines that were previously created on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVCustomBaseline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SAVE-HPOVAPPLIANCEDATAATRESTENCRYPTIONKEY--> <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"> <!--SAVE-HPOVAPPLIANCEDATAATRESTENCRYPTIONKEY--> <command:details> <command:name>Save-HPOVApplianceDataAtRestEncryptionKey</command:name> <maml:description> <maml:para>Generate a new HPE Synergy Composer appliance encryption key.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>HPOVApplianceDataAtRestEncryptionKey</command:noun> </command:details> <maml:description> <maml:para>HPE OneView encrypts sensitive data, such as managed device credentials, when it is stored on-disk in the appliance. The HPE OneView appliance encryption key (AEK) is used internally to encrypt the credentials for managed devices (such as, iLO, onboard administrator, frame link module). By default, the AEK is stored on the HPE Synergy Composer disk and also included in the appliance backup. This could pose a security risk in case the disk is stolen. The secure data-at-rest option, when enabled, stores the AEK off-disk in Composer NVRAM, and does not include the key in the appliance backup. Enabling this option requires the administrator to save a copy of the AEK (recovery AEK) for use in the following circumstances: * When restoring a backup taken when a different AEK was in effect. * To successfully boot the system in the unlikely event that the system copy of the key is corrupted. * A backup is being restored to a different new Composer or to the same Composer that has been factory reset. The administrator must store the recovery AEK in a secure location, where it can be only accessed by authorized personnel. In the rare circumstance where the key cannot be read from the Composer NVRAM or the key gets corrupted, the administrator must use the appliance maintenance console to upload the AEK recovery copy, based on the error resolution message displayed. In the rare circumstance where the Composer NVRAM itself becomes inaccessible, users can choose to disable secure-data-at-rest option until the hardware issue itself is resolved. If the downloaded recovery key and the AEK stored in the Composer NVRAM are both lost, the appliance data cannot be recovered. This Cmdlet will generate a new encryption key, if the existing encryption key is lost or unknown. Any existing backups that were created with the prior encryption key will become invalid. After creating a new encryption key, it is highly recommended to create a new backup using New-HPOVBackup and save it, along with the new encryption key file that can be generated by this Cmdlet by using the -Location parameter, to a secure and safe location. This Cmdlet can only be used when data at rest encryption has been enabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Save-HPOVApplianceDataAtRestEncryptionKey</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory where to save the appliance encryption key (AEK). If no location is provided, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory where to save the appliance encryption key (AEK). If no location is provided, the current working directory is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue>(Get-Location).Path</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The saved appliance encryption key (AEK).</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>Save-HPOVApplianceDataAtRestEncryptionKey</dev:code> <dev:remarks> <dev:para>Save the appliance data at rest encryption key off the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVApplianceDataAtRestEncryptionKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDataAtRestEncryption</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SAVE-HPOVBACKUP--> <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"> <!--SAVE-HPOVBACKUP--> <command:details> <command:name>Save-HPOVBackup</command:name> <maml:description> <maml:para>Save existing backups on an appliance.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>HPOVBackup</command:noun> </command:details> <maml:description> <maml:para>HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure. The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file. Use this Cmdlet to save the created appliance backup files. Use the -SaveRemoteOnly parameter to save the backup file(s) to the remote location if configured on the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Save-HPOVBackup</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory or UNC path where to save the backup file(s) to.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SaveRemoteOnly, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Save-HPOVBackup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SaveRemoteOnly"> <maml:name>SaveRemoteOnly</maml:name> <maml:description> <maml:para>When appliance automatic backup is configured, use this parameter to specify the backup file(s) should be saved in the remote location, instead of the local PC.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SaveRemoteOnly, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="SaveRemoteOnly, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="save"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specify the directory or UNC path where to save the backup file(s) to.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SaveRemoteOnly" aliases="None"> <maml:name>SaveRemoteOnly</maml:name> <maml:description> <maml:para>When appliance automatic backup is configured, use this parameter to specify the backup file(s) should be saved in the remote location, instead of the local PC.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task resource to monitor progress of the backup file saved to the remote location.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The saved backup file located on the PC.</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>Save-HPOVBackup</dev:code> <dev:remarks> <dev:para>Save the found backup file</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Save-HPOVBackup -Location \\Server\BackupShare\HPOneView</dev:code> <dev:remarks> <dev:para>Save the found backup file to the specified location.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVBackup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SAVE-HPOVSERVERPROFILE--> <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"> <!--SAVE-HPOVSERVERPROFILE--> <command:details> <command:name>Save-HPOVServerProfile</command:name> <maml:description> <maml:para>Save the contents of a Server Profile to the appliance.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet allows administrators to save the modified Server Profile object within the current PowerShell session to the target appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Save-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Server Profile object to be saved.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Server Profile object to be saved.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile</maml:name> </dev:type> <maml:description> <maml:para>A Server Profile resource object from Get-HPOVServerProfile that was modified and needs to be saved.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process.</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>$MyProfile = Get-HPOVServerProfile -Name "My Profile 1" -ErrorAction Stop $MyProfile.name = "My Profile NewName 1" Save-HPOVServerProfile -InputObject $MyProfile</dev:code> <dev:remarks> <dev:para>Get a Server Profile, update its name, then save.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SAVE-HPOVSERVERPROFILETEMPLATE--> <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"> <!--SAVE-HPOVSERVERPROFILETEMPLATE--> <command:details> <command:name>Save-HPOVServerProfileTemplate</command:name> <maml:description> <maml:para>Save the contents of a Server Profile Template to the appliance.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>HPOVServerProfileTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet allows administrators to save the modified Server Profile Template object within the current PowerShell session to the target appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Save-HPOVServerProfileTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Server Profile Template object to be saved.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Server Profile Template object to be saved.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfileTemplate</maml:name> </dev:type> <maml:description> <maml:para>A Server Profile Template resource object from Get-HPOVServerProfileTemplate that was modified and needs to be saved.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process.</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>$MyProfileTemplate = Get-HPOVServerProfileTemplate -Name "My Profile Template 1" -ErrorAction Stop $MyProfileTemplate.name = "My Profile Template NewName 1" Save-HPOVServerProfileTemplate -InputObject $MyProfileTemplate</dev:code> <dev:remarks> <dev:para>Get a Server Profile Template, update its name, then save.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SEARCH-HPOVASSOCIATIONS--> <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"> <!--SEARCH-HPOVASSOCIATIONS--> <command:details> <command:name>Search-HPOVAssociations</command:name> <maml:description> <maml:para>Search the association index.</maml:para> </maml:description> <command:verb>Search</command:verb> <command:noun>HPOVAssociations</command:noun> </command:details> <maml:description> <maml:para>Search the association index for any associations that match the specified name or uri.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Search-HPOVAssociations</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>AssociationName</maml:name> <maml:description> <maml:para>The association name to be matched, if specified. Valid association names are * BLADE_TO_PROFILE * PROFILE_TO_SERVER_HARDWARE_TYPE * RACK_TO_PHYSICAL_DEVICE * BLADE_TO_INTERCONNECT * ENCLOSURE_GROUP_TO_ENCLOSURE * ENCLOSURE_GROUP_TO_LOGICAL_INTERCONNECT_GROUP * ENCLOSURE_TO_BLADE * ENCLOSURE_TO_SWITCH * LOGICAL_SWITCH_TO_LOGICAL_UPLINK * SWITCH_TO_LOGICAL_SWITCH * SERVER_PROFILES_TO_FC_NETWORKS * SERVER_PROFILES_TO_NETWORKS * STORAGE_SYSTEM_TO_STORAGE_POOL * FC_NETWORK_TO_STORAGE_SYSTEM * STORAGE_POOL_TO_VOLUME * STORAGE_POOL_TO_VOLUME_TEMPLATE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The uri of an object which is the start of an association</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Child</maml:name> <maml:description> <maml:para>The uri of an object which is the end of an association</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Count</maml:name> <maml:description> <maml:para>The maximum number of association index entries to be returned. Defaults to 50.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Start</maml:name> <maml:description> <maml:para>The index of the first association index to be returned, defaults to 0.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="5" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>AssociationName</maml:name> <maml:description> <maml:para>The association name to be matched, if specified. Valid association names are * BLADE_TO_PROFILE * PROFILE_TO_SERVER_HARDWARE_TYPE * RACK_TO_PHYSICAL_DEVICE * BLADE_TO_INTERCONNECT * ENCLOSURE_GROUP_TO_ENCLOSURE * ENCLOSURE_GROUP_TO_LOGICAL_INTERCONNECT_GROUP * ENCLOSURE_TO_BLADE * ENCLOSURE_TO_SWITCH * LOGICAL_SWITCH_TO_LOGICAL_UPLINK * SWITCH_TO_LOGICAL_SWITCH * SERVER_PROFILES_TO_FC_NETWORKS * SERVER_PROFILES_TO_NETWORKS * STORAGE_SYSTEM_TO_STORAGE_POOL * FC_NETWORK_TO_STORAGE_SYSTEM * STORAGE_POOL_TO_VOLUME * STORAGE_POOL_TO_VOLUME_TEMPLATE</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Child</maml:name> <maml:description> <maml:para>The uri of an object which is the end of an association</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>The maximum number of association index entries to be returned. Defaults to 50.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Parent</maml:name> <maml:description> <maml:para>The uri of an object which is the start of an association</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>The index of the first association index to be returned, defaults to 0.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Resource Object to find associated resources</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single association index entry</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple association index entries The matching index entries</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>Search-HPOVAssociations BLADE_TO_PROFILE -endObjUri /rest/server-profiles/1ab4c031-a631-4288-9e7d-3cfca24d30cf</dev:code> <dev:remarks> <dev:para>Return any BLADE_TO_PROFILE associations that have an end object with the specified uri</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SEARCH-HPOVINDEX--> <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"> <!--SEARCH-HPOVINDEX--> <command:details> <command:name>Search-HPOVIndex</command:name> <maml:description> <maml:para>Search the resource index.</maml:para> </maml:description> <command:verb>Search</command:verb> <command:noun>HPOVIndex</command:noun> </command:details> <maml:description> <maml:para>Search the resource index for any objects that match the specified search string or category</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Search-HPOVIndex</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Search</maml:name> <maml:description> <maml:para>The search query, text to be found in the index.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Category</maml:name> <maml:description> <maml:para>The resource category to be matched, if specified. Valid resource categories are: * domains * users * racks * enclosure-groups * enclosures * uplink-sets * logical-interconnect-groups * logical-interconnects * interconnect-types * interconnects * networks * firmware-drivers * server-hardware-types * server-hardware * server-profiles * alerts * storage-volumes * storage-systems</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Count</maml:name> <maml:description> <maml:para>The maximum number of resource index entries to be returned. Defaults to 50.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Start</maml:name> <maml:description> <maml:para>The index of the first resource index to be returned, defaults to 0.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Category</maml:name> <maml:description> <maml:para>The resource category to be matched, if specified. Valid resource categories are: * domains * users * racks * enclosure-groups * enclosures * uplink-sets * logical-interconnect-groups * logical-interconnects * interconnect-types * interconnects * networks * firmware-drivers * server-hardware-types * server-hardware * server-profiles * alerts * storage-volumes * storage-systems</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Count</maml:name> <maml:description> <maml:para>The maximum number of resource index entries to be returned. Defaults to 50.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Search</maml:name> <maml:description> <maml:para>The search query, text to be found in the index.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>The index of the first resource index to be returned, defaults to 0.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The matching index entries</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>Search-HPOVIndex "Profile1"</dev:code> <dev:remarks> <dev:para>Return all the index entries which include this string.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Search-HPOVIndex -categroy uplink-sets</dev:code> <dev:remarks> <dev:para>Search for all Uplink Set resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SEND-HPOVREQUEST--> <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"> <!--SEND-HPOVREQUEST--> <command:details> <command:name>Send-HPOVRequest</command:name> <maml:description> <maml:para>Sends a request to the management appliance</maml:para> </maml:description> <command:verb>Send</command:verb> <command:noun>HPOVRequest</command:noun> </command:details> <maml:description> <maml:para>Receives the request input, properly constructs and formats the request header and body and sends the request to the management appliance. This is the main Cmdlet that interacts with the appliance. The message body can contain valid JSON data, with the correct URI and accepted HTTP method accepted by the target resource manager. Please see the online appliance Resource Model for more information (https://[appliance_IP]/help/cic/en/content/images/api/.)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Send-HPOVRequest</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>uri</maml:name> <maml:description> <maml:para>The uri that identifies the required resource on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>method</maml:name> <maml:description> <maml:para>The request HTTP Method. * "GET" (default) to get a resource from the appliance (read) * "POST" to create a new resource * "PUT" to modify a resource (write) * "PATCH" to modify a resource (write), with specific attributes set to values, other attributes should be set to $null. * "DELETE" to delete a resource</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>body</maml:name> <maml:description> <maml:para>Body for the request. Required if the method is POST or PUT.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>start</maml:name> <maml:description> <maml:para>For GETs on resource collections, this specifies the starting index in the collection. If not specified, collection members starting from the beginning are returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>count</maml:name> <maml:description> <maml:para>For GETs on resource collections, this specifies the number of collection members to return. If not specified, all members of the collection are returned from this function.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>AddHeader</maml:name> <maml:description> <maml:para>If additional headers are needed/required than the defaults, include header names and values within a Hashtable.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>OverrideContentType</maml:name> <maml:description> <maml:para>Workaround to override ContentType where needed (e.g. PATCH /rest/scopes/{GUID}.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>OverrideTimeout</maml:name> <maml:description> <maml:para>Specify to override the HttpWebRequest syncronous timeout being made.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The destination appliance to process the request. When specifying a Value, it must match the HostName attribute of a valid HPOneView.Appliance.Connection object within the Global $ConnectedSessions variable. If no match is found, or no HPOneView.Appliance.Connection objects exist, an error will be thrown. Default Value: All valid Appliance Connections within $Global:ConnectedSessions</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="5" parameterSetName="(All)" aliases="None"> <maml:name>AddHeader</maml:name> <maml:description> <maml:para>If additional headers are needed/required than the defaults, include header names and values within a Hashtable.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="Appliance, ApplianceConnection"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The destination appliance to process the request. When specifying a Value, it must match the HostName attribute of a valid HPOneView.Appliance.Connection object within the Global $ConnectedSessions variable. If no match is found, or no HPOneView.Appliance.Connection objects exist, an error will be thrown. Default Value: All valid Appliance Connections within $Global:ConnectedSessions</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="6" parameterSetName="(All)" aliases="None"> <maml:name>OverrideContentType</maml:name> <maml:description> <maml:para>Workaround to override ContentType where needed (e.g. PATCH /rest/scopes/{GUID}.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="7" parameterSetName="(All)" aliases="None"> <maml:name>OverrideTimeout</maml:name> <maml:description> <maml:para>Specify to override the HttpWebRequest syncronous timeout being made.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>body</maml:name> <maml:description> <maml:para>Body for the request. Required if the method is POST or PUT.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="None"> <maml:name>count</maml:name> <maml:description> <maml:para>For GETs on resource collections, this specifies the number of collection members to return. If not specified, all members of the collection are returned from this function.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>method</maml:name> <maml:description> <maml:para>The request HTTP Method. * "GET" (default) to get a resource from the appliance (read) * "POST" to create a new resource * "PUT" to modify a resource (write) * "PATCH" to modify a resource (write), with specific attributes set to values, other attributes should be set to $null. * "DELETE" to delete a resource</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>GET</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>start</maml:name> <maml:description> <maml:para>For GETs on resource collections, this specifies the starting index in the collection. If not specified, collection members starting from the beginning are returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>uri</maml:name> <maml:description> <maml:para>The uri that identifies the required resource on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If collection of resources (.i.e. GET /rest/ethernet-networks)</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single object returned from appliance If Async task, a Hashtable is returned with the following contents: @{ uri = TaskUri; category = "tasks"; type = "TaskResourceV2"; taskState = "New"; resource = @{}; }</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If no resources are found, a PsCustomObject is returned that contains: @{ statusCode = [int]HTTP Status Code; statusMessage = [string]HTTP Status Message; lastCall = [string]URI; }</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>Send-HPOVRequest "/rest/enclosures"</dev:code> <dev:remarks> <dev:para>Returns all the enclosure objects managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$e = Send-HPOVRequest "/rest/enclosures/SGH2X6J1" -Appliance MyAppliance.domain.com $e.name = "New Name" Send-HPOVRequest $e.uri "PUT" $e -Appliance MyAppliance.domain.com</dev:code> <dev:remarks> <dev:para>Updates the name of the enclosure object specified by the uri and Appliance Connection name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVADDRESSPOOLSUBNET--> <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"> <!--SET-HPOVADDRESSPOOLSUBNET--> <command:details> <command:name>Set-HPOVAddressPoolSubnet</command:name> <maml:description> <maml:para>Update an IPv4 Subnet Pool configuration.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVAddressPoolSubnet</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist with updating an existing IPv4 address pool. When updating an IPv4 Address Subnet, you must provide the Subnet Object or Name to modify. Only the Gateway, Domain Name, and DNS Servers can be updated once an IPv4 Subnet has been assigned to a resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVAddressPoolSubnet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPv4"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Subnet, -IPv4Subnet] The IPv4 Subnet resource object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 Subnet Mask of the subnet. Please know that if the Subnet is associated with another resource (Ethernet Network, Logical Enclosure or Deployment Server), there will be an error as the mask cannot be changed until it is unassociated with the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 Address of the default gateway for the subnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4"> <maml:name>Domain</maml:name> <maml:description> <maml:para>DNS Domain Name of the subnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4"> <maml:name>DNSServers</maml:name> <maml:description> <maml:para>An array of DNS Server IPv4 Addresses.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPv4"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="IPv4" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4" aliases="None"> <maml:name>DNSServers</maml:name> <maml:description> <maml:para>An array of DNS Server IPv4 Addresses.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4" aliases="None"> <maml:name>Domain</maml:name> <maml:description> <maml:para>DNS Domain Name of the subnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4" aliases="None"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IPv4 Address of the default gateway for the subnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="IPv4" aliases="Subnet, IPv4Subnet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Subnet, -IPv4Subnet] The IPv4 Subnet resource object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="IPv4" aliases="None"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 Subnet Mask of the subnet. Please know that if the Subnet is associated with another resource (Ethernet Network, Logical Enclosure or Deployment Server), there will be an error as the mask cannot be changed until it is unassociated with the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>IPv4 Address Subnet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.IPAddressSubnet [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated IPv4 Address Subnet</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-HPOVAddressPoolSubnet 192.168.20.0 | Set-HPOVAddressPoolSubnet -Gateway 192.168.20.1</dev:code> <dev:remarks> <dev:para>Update the IPv4 Subnet address pool"s default gateway to the new address.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAddressPoolSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVALERT--> <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"> <!--SET-HPOVALERT--> <command:details> <command:name>Set-HPOVAlert</command:name> <maml:description> <maml:para>Change status of an alert.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVAlert</command:noun> </command:details> <maml:description> <maml:para>The appliance uses alert messages to report issues with the resources it manages and monitors. The resources generate alerts to notify you that some meaningful event occurred and that an action might be required. An event describes a single problem or change that occurred on a resource. For example, an event might be an SNMP trap received from a server's (iLO) management processor. Each alert includes the following information about the event it reports: severity, state, description, and urgency. You can clear alerts, assign owners to alerts, and add notes to alerts. While alerts have an active or locked state, they contribute to the overall displayed status for a resource. After you change their state to Cleared, they no longer affect the displayed status. You can filter the display of the activity list to help you locate and view specific activities. However, you cannot customize filters to otherwise manage the display of the activities. This Cmdlet allows the administrator to change the status of an alert to either Active or Cleared. Notes can also be added to an alert, which will appear with in the alert contents. If an alert should be owned by a specific user, use the -AssignToUser and provide their name. This does not correlate with any user login name. In order for an Administrator to change the status of an Alert, the Administrator must be scoped or have use rights to the respective resource role (Network, Server, Storage, or Infrastructure.)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVAlert</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be cleared. Can be URI or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AssignToUser</maml:name> <maml:description> <maml:para>The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Notes of the action for the alert.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVAlert</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be cleared. Can be URI or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Active"> <maml:name>Active</maml:name> <maml:description> <maml:para>Change the alert to "Active" status.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVAlert</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be cleared. Can be URI or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Cleared"> <maml:name>Cleared</maml:name> <maml:description> <maml:para>Change the alert to "Cleared" status.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Active, Cleared, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Active" aliases="None"> <maml:name>Active</maml:name> <maml:description> <maml:para>Change the alert to "Active" status.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Active, Cleared, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AssignToUser</maml:name> <maml:description> <maml:para>The users name in String value to assign the alert to. The user name does not require, nor is mapped to, a local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Cleared" aliases="None"> <maml:name>Cleared</maml:name> <maml:description> <maml:para>Change the alert to "Cleared" status.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Active, Cleared, Default" aliases="alertUri, Alert"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The alert to be cleared. Can be URI or resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Notes</maml:name> <maml:description> <maml:para>Notes of the action for the alert.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Alert URI</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Alert [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Alert resource object (i.e. Get-HPOVAlert)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Alert [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated alert</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>Set-HPOVAlert -InputObject $Alert -Cleared</dev:code> <dev:remarks> <dev:para>Clears the alert.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVAlert -AlertState Active | Set-HPOVAlert -Cleared</dev:code> <dev:remarks> <dev:para>Get all alerts in an "Active" state, and set their state to "Cleared".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -name "Encl1, bay 1*" | Get-HPOVAlert -State active | Set-HPOVAlert -Cleared</dev:code> <dev:remarks> <dev:para>Get aassociated alerts to the servers in an "Active" state, and set their state to "Cleared".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Clear-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVAlert</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCEAUDITLOGFORWARDING--> <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"> <!--SET-HPOVAPPLIANCEAUDITLOGFORWARDING--> <command:details> <command:name>Set-HPOVApplianceAuditLogForwarding</command:name> <maml:description> <maml:para>Modify remote Syslog audit log forwarding.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceAuditLogForwarding</command:noun> </command:details> <maml:description> <maml:para>HPE OneView can forward the internal audit log entries to a remote syslog server, in standard Syslog format. This Cmdlet will chnage the current status, remote Syslog destination and port to be configured on the appliance. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceAuditLogForwarding</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Using this parameter will enable remote Syslog audit log forwarding on the specified appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The target remote Syslog server IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>The target remote Syslog server port if not using the default 514/UDP port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>RemoveComputerName</maml:name> <maml:description> <maml:para>Specify one or more remote Syslog server IP Address or FQDN to remove from the configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceAuditLogForwarding</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Using this parameter will disable remote Syslog audit log forwarding on the specified appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The target remote Syslog server IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="None"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Using this parameter will disable remote Syslog audit log forwarding on the specified appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Using this parameter will enable remote Syslog audit log forwarding on the specified appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>The target remote Syslog server port if not using the default 514/UDP port.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>RemoveComputerName</maml:name> <maml:description> <maml:para>Specify one or more remote Syslog server IP Address or FQDN to remove from the configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuditLogForwardingConfig</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The appliance audit log forwarding configuration.</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>Set-HPOVApplianceAuditLogForwarding -Enable -ComputerName MyTargetHost1.domain.com</dev:code> <dev:remarks> <dev:para>Enable appliance remote Syslog audit log forwarding to the specified host.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceAuditLogForwarding -Enable -ComputerName MyTargetHost1.domain.com, MyTargetHost2.domain.com -Port 5514</dev:code> <dev:remarks> <dev:para>Enable appliance remote Syslog audit log forwarding to the specified hosts and custom UDP target port.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceAuditLogForwarding -RemoveComputerName MyTargetHost2.domain.com</dev:code> <dev:remarks> <dev:para>Remove the specified host from the existing remote Syslog audit log forwarding configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceAuditLogForwarding -Disable</dev:code> <dev:remarks> <dev:para>Disable remote Syslog audit log forwarding configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCECURRENTSECURITYMODE--> <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"> <!--SET-HPOVAPPLIANCECURRENTSECURITYMODE--> <command:details> <command:name>Set-HPOVApplianceCurrentSecurityMode</command:name> <maml:description> <maml:para>Change the appliance current security mode.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceCurrentSecurityMode</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to change the current security mode (Legacy, FIPS or CNSA) of the appliance. Before modifying the appliance security mode, a compatibility report should be run using the Show-HPOVApplianceSecurityModeCompatibilityReport. When changing active security mode will require an immediate appliance reboot.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceCurrentSecurityMode</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>SecurityMode</maml:name> <maml:description> <maml:para>Specify the Security Mode to change the appliance to by using Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOVApplianceAvailableSecurityMode</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecurityMode</maml:name> <maml:description> <maml:para>Specify the Security Mode to change the appliance to by using Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOVApplianceAvailableSecurityMode</command:parameterValue> <dev:type> <maml:name>HPOVApplianceAvailableSecurityMode</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> </dev:type> <maml:description> <maml:para>The specified appliance security mode from Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>After appliance reboots, the appliance current security mode is returned.</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>Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA | Set-HPOVApplianceCurrentSecurityMode</dev:code> <dev:remarks> <dev:para>Put the appliance into CNSA mode. After confirmation prompt, appliance will immediately reboot.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAvailableSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCEDATETIME--> <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"> <!--SET-HPOVAPPLIANCEDATETIME--> <command:details> <command:name>Set-HPOVApplianceDateTime</command:name> <maml:description> <maml:para>Update Appliance Date/Time Configuration.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceDateTime</command:noun> </command:details> <maml:description> <maml:para>Update the appliance Date and Time configuration, including Locale, NTP Servers, and NTP Polling. Using the -SyncWithHost parameter will set the NTPServers property to null, and is only applicable to a virtual machine applinace. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceDateTime</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SyncHost"> <maml:name>SyncWithHost</maml:name> <maml:description> <maml:para>Specify to configure the embedded hypervisor integration agent to sync time with the hypervisor host. Only used with a virtual machine appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Specify the language local for the appliance * en_US - US English * zh_CN - Simplified Chinese * ja_JP - Japanese</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceDateTime</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers"> <maml:name>NTPServers</maml:name> <maml:description> <maml:para>An array of IPv4 Addresses or Fully Qualified Domain Names. You must ensure DNS is configured on the appliance correctly..</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The polling interval in seconds the NTP client will use to verify time drift.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Specify the language local for the appliance * en_US - US English * zh_CN - Simplified Chinese * ja_JP - Japanese</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers, SyncHost" aliases="None"> <maml:name>Locale</maml:name> <maml:description> <maml:para>Specify the language local for the appliance * en_US - US English * zh_CN - Simplified Chinese * ja_JP - Japanese</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers" aliases="None"> <maml:name>NTPServers</maml:name> <maml:description> <maml:para>An array of IPv4 Addresses or Fully Qualified Domain Names. You must ensure DNS is configured on the appliance correctly..</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="NTPServers" aliases="None"> <maml:name>PollingInterval</maml:name> <maml:description> <maml:para>The polling interval in seconds the NTP client will use to verify time drift.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="SyncHost" aliases="None"> <maml:name>SyncWithHost</maml:name> <maml:description> <maml:para>Specify to configure the embedded hypervisor integration agent to sync time with the hypervisor host. Only used with a virtual machine appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Set-HPOVApplianceDateTime -NTPServers 10.55.1.1, 10.54.1.1 -PollingInterval 60</dev:code> <dev:remarks> <dev:para>This example passes in updated values to set for the appliance networking configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceDateTime -SyncWithHost</dev:code> <dev:remarks> <dev:para>This example passes in updated values to set for the appliance networking configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCEDEFAULTCONNECTION--> <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"> <!--SET-HPOVAPPLIANCEDEFAULTCONNECTION--> <command:details> <command:name>Set-HPOVApplianceDefaultConnection</command:name> <maml:description> <maml:para>Set the Default Appliance Connection.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceDefaultConnection</command:noun> </command:details> <maml:description> <maml:para>When establishing multiple Appliance Connections, this Cmdlet will help set one of the appliance connections stored in the ${Global:ConnectedSessions} variable to the default connection. All Cmdlets that require a specific Appliance Connection will use the default.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceDefaultConnection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>[Aliases -Connection] Either the HPOneView.Appliance.Connection object, full or partial value of the connection objects Name property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Appliance, Connection"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>[Aliases -Connection] Either the HPOneView.Appliance.Connection object, full or partial value of the connection objects Name property.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>The Appliance Connection object either provided from the Connect-HPOVMgmt output or ${Global:ConnectedSessions} variable</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.Connection></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated collection of [HPOneView.Appliance.Connection] Objects</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>$ConnectedSessions ConnectionID Name UserName AuthLoginDomain Default Connection ------------ ---- -------- --------------- ------------------ 1 Appliance1.domain.local administrator LOCAL True 2 Appliance2.domain.local administrator LOCAL False Set-HPOVApplianceDefaultConnection "Appliance2" ConnectionID Name UserName AuthLoginDomain Default Connection ------------ ---- -------- --------------- ------------------ 1 Appliance1.domain.local administrator LOCAL False 2 Appliance2.domain.local administrator LOCAL True</dev:code> <dev:remarks> <dev:para>Display the current appliance connections, then set the new default to "Appliance2" using the parital name value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$ConnectedSessions ConnectionID Name UserName AuthLoginDomain Default Connection ------------ ---- -------- --------------- ------------------ 1 Appliance1.domain.local administrator LOCAL True 2 Appliance2.domain.local administrator LOCAL False $ConnectedSessions[1] | Set-HPOVApplianceDefaultConnection ConnectionID Name UserName AuthLoginDomain Default Connection ------------ ---- -------- --------------- ------------------ 1 Appliance1.domain.local administrator LOCAL False 2 Appliance2.domain.local administrator LOCAL True</dev:code> <dev:remarks> <dev:para>Display the current appliance connections, then set the new default to "Appliance2" using the pipline by passing the HPOneView.Appliance.Connection object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Connect-HPOVMgmt</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPOVMgmt</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_Appliance_Connection_Permissions</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[${Global:ConnectedSessions}]</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCEGLOBALSETTING--> <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"> <!--SET-HPOVAPPLIANCEGLOBALSETTING--> <command:details> <command:name>Set-HPOVApplianceGlobalSetting</command:name> <maml:description> <maml:para>(Reserved for future use) Update appliance global settings.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceGlobalSetting</command:noun> </command:details> <maml:description> <maml:para>(Reserved for future use) Updates the value for an existing global parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceGlobalSetting</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the global parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, Default"> <maml:name>Value</maml:name> <maml:description> <maml:para>The updated value for the global parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceGlobalSetting</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Object] The Appliance Global Setting object from Get-HPOVApplianceGlobalSetting.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.GlobalSetting</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, Default"> <maml:name>Value</maml:name> <maml:description> <maml:para>The updated value for the global parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default, Pipeline" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Object] The Appliance Global Setting object from Get-HPOVApplianceGlobalSetting.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.GlobalSetting</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.GlobalSetting</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the global parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, Default" aliases="None"> <maml:name>Value</maml:name> <maml:description> <maml:para>The updated value for the global parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.GlobalSetting</maml:name> </dev:type> <maml:description> <maml:para>Appliance global setting from Get-HPOVApplianceGlobalSetting.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.GlobalSetting</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The udpated appliance global setting.</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>Set-HPOVApplianceGlobalSetting -Name alertMax -Value 75000</dev:code> <dev:remarks> <dev:para>Returns the "alertMax" setting object with the updated value of 75000</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCENETWORKCONFIG--> <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"> <!--SET-HPOVAPPLIANCENETWORKCONFIG--> <command:details> <command:name>Set-HPOVApplianceNetworkConfig</command:name> <maml:description> <maml:para>Updates the configuration parameters for the primary network interface on the appliance.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceNetworkConfig</command:noun> </command:details> <maml:description> <maml:para>Updates any or all configuration parameters for the primary network interface on the appliance. All parameters are Current settings will be retained for any parameters NOT specified.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceNetworkConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Fully-qualified hostname for the appliance</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Addr</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Subnet</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Gateway</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Addr</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Subnet</maml:name> <maml:description> <maml:para>"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Gateway</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>OverrideIPv4DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCP provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>OverrideIPv6DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCPv6 provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>DNS domain name for the appliance: "my.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>SearchDomains</maml:name> <maml:description> <maml:para>Array of DNS search domains: "my.com", "other.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="VMA"> <maml:name>NtpServers</maml:name> <maml:description> <maml:para>Deprecated parameter. NTP Server configuration is now controlled in the Set-HPOVApplianceDateTime Cmdlet. Please update your scripts accordingly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, Composer, VMA"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceNetworkConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Fully-qualified hostname for the appliance</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Addr</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Subnet</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Gateway</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer"> <maml:name>ServiceIPv4Node1</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer"> <maml:name>ServiceIPv4Node2</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Addr</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Subnet</maml:name> <maml:description> <maml:para>"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6Gateway</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer"> <maml:name>ServiceIPv6Node1</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer"> <maml:name>ServiceIPv6Node2</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>OverrideIPv4DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCP provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>OverrideIPv6DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCPv6 provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>DNS domain name for the appliance: "my.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>SearchDomains</maml:name> <maml:description> <maml:para>Array of DNS search domains: "my.com", "other.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv4NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA"> <maml:name>IPv6NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, Composer, VMA"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceNetworkConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile"> <maml:name>importFile</maml:name> <maml:description> <maml:para> File containing JSON formatted input values for the appliance network configuration parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, Composer, VMA"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile, Composer, VMA" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>DNS domain name for the appliance: "my.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Fully-qualified hostname for the appliance</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv4Addr</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv4Gateway</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="nameServers"> <maml:name>IPv4NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "www.xxx.yyy.zzz", "sss.ttt.uuu.vvv"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv4Subnet</maml:name> <maml:description> <maml:para>"www.xxx.yyy.zzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv4Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>STATIC</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv6Addr</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv6Gateway</maml:name> <maml:description> <maml:para>"ssss:tttt:uuuu:vvvv:wwww:xxxx:yyyy:zzzz" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv6NameServers</maml:name> <maml:description> <maml:para>Array of DNS servers: "fe80::200:f8ff:fe21:67cf", "fe80::200:f8ff:fe21:89cb"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv6Subnet</maml:name> <maml:description> <maml:para>"ffff:ffff:ffff:ffff:0:0:0:0" (leave blank for DHCP)</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>IPv6Type</maml:name> <maml:description> <maml:para>"DHCP", "STATIC" or "UNCONFIGURE"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>UNCONFIGURE</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="VMA" aliases="None"> <maml:name>NtpServers</maml:name> <maml:description> <maml:para>Deprecated parameter. NTP Server configuration is now controlled in the Set-HPOVApplianceDateTime Cmdlet. Please update your scripts accordingly.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="overrideDhcpDns"> <maml:name>OverrideIPv4DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCP provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>OverrideIPv6DhcpDns</maml:name> <maml:description> <maml:para>Switch to override DHCPv6 provided DNS Servers</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer, VMA" aliases="None"> <maml:name>SearchDomains</maml:name> <maml:description> <maml:para>Array of DNS search domains: "my.com", "other.com"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer" aliases="None"> <maml:name>ServiceIPv4Node1</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer" aliases="None"> <maml:name>ServiceIPv4Node2</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer" aliases="None"> <maml:name>ServiceIPv6Node1</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Composer" aliases="None"> <maml:name>ServiceIPv6Node2</maml:name> <maml:description> <maml:para>Reserved for Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="importFile" aliases="i, import"> <maml:name>importFile</maml:name> <maml:description> <maml:para> File containing JSON formatted input values for the appliance network configuration parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Final Task status (for asynchronous appliance config)</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>Set-HPOVApplianceNetworkConfig -hostname "appliance1.my.com" -IPv4Type "DHCP" -IPv6Type "UNCONFIGURE" -domainName "my.com"</dev:code> <dev:remarks> <dev:para>This example passes in updated values to set for the appliance networking configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceNetworkConfig -importFile "c:\myNetworkInput.json"</dev:code> <dev:remarks> <dev:para>This example passes the name of an input file containing JSON formatted properties and values for the appliance network configuration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCEPROXY--> <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"> <!--SET-HPOVAPPLIANCEPROXY--> <command:details> <command:name>Set-HPOVApplianceProxy</command:name> <maml:description> <maml:para>Configure appliance web proxy.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceProxy</command:noun> </command:details> <maml:description> <maml:para>When configuring Remote Support, a Web Proxy may be required. This Cmdlet will assist in defining an HTTPS web proxy for Remote Support outbound connectivity. Proxy configuration does not support SOCKS.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceProxy</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The FQDN or IP Address of the HTTPS Proxy server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>The web proxy TCP port to connect to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Https</maml:name> <maml:description> <maml:para>Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-HPOVApplianceTrustedCertificate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVApplianceProxy</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The FQDN or IP Address of the HTTPS Proxy server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>The web proxy TCP port to connect to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication"> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name of your proxy server to authenticate with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication"> <maml:name>Password</maml:name> <maml:description> <maml:para>The proxy server account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Https</maml:name> <maml:description> <maml:para>Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-HPOVApplianceTrustedCertificate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The FQDN or IP Address of the HTTPS Proxy server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default" aliases="None"> <maml:name>Https</maml:name> <maml:description> <maml:para>Specify if target proxy server requires HTTPS. The target SSL/TSL certificate must be added to the appliance using the Add-HPOVApplianceTrustedCertificate Cmdlet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The proxy server account password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication, Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>The web proxy TCP port to connect to.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Authentication" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>The user name of your proxy server to authenticate with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring.</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>Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080</dev:code> <dev:remarks> <dev:para>Configure the appliance proxy server by providing the required Hostname and Port values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceProxy -Hostname MyProxy.domain.com -Port 8080 -Username MyUserAccount -Password (ConvertTo-SecureString -String MyPassword -AsPlainText -Force)</dev:code> <dev:remarks> <dev:para>Configure the appliance proxy server by providing the required Hostname and Port values, and using proxy authentication.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCESECURITYPROTOCOL--> <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"> <!--SET-HPOVAPPLIANCESECURITYPROTOCOL--> <command:details> <command:name>Set-HPOVApplianceSecurityProtocol</command:name> <maml:description> <maml:para>Change the appliance current security protocols. </maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceSecurityProtocol</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to change the enabled security protocol(s) on the appliance. Before modifying the security protocols, a compatibility report should be run using the Show-HPOVApplianceSecurityModeCompatibilityReport. Please be aware of the following rules: * Enabling or disabling TLS protocols is allowed only for the current cryptography mode. For example, disabling TLSv1.1 in legacy mode of the appliance will not disable TLSv1.1 when the appliance is switched to FIPS mode. * Enabling an unsupported protocol for the current cryptography mode of the appliance is not allowed. For example, enabling TLSv1 is not allowed in the FIPS mode. * TLSv1.2 protocol cannot be disabled * Disabling all the protocols is not allowed. Note: Changing active security protocols will require an immediate appliance reboot. Warning: Not all devices that HPE OneView manages or monitors support these stronger cryptography modes. Some examples are: * ProLiant Gen 6 systems have iLO versions that only support TLS 1.0. These servers are not supported when the appliance is in the FIPS or CNSA modes. * Gen7 systems have iLO versions that only support TLS 1.0 and 1.1. These servers are not supported when the appliance is in the CNSA mode. * ProLiant Gen8 systems have iLO versions that support TLS 1.1 and 1.2, and are compatible with both FIPS and CNSA modes. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceSecurityProtocol</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnableTlsVersion</maml:name> <maml:description> <maml:para>Specify 1 or more security protocols to enable. Allowed values: * TLSv1 * TLSv1.1 * TLSv1.2</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnableTlsVersion</maml:name> <maml:description> <maml:para>Specify 1 or more security protocols to enable. Allowed values: * TLSv1 * TLSv1.1 * TLSv1.2</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityProtocol</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>After appliance reboots, the updated security protocol configuration is returned.</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>Set-HPOVApplianceSecurityProtocol -EnableTlsVersion Tlsv1.2</dev:code> <dev:remarks> <dev:para>Set the appliance to only enable TLSv1.2. After confirmation prompt, appliance will immediately reboot.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVApplianceSecurityProtocol -EnableTlsVersion Tlsv1, Tlsv1.1, Tlsv1.2</dev:code> <dev:remarks> <dev:para>Set the appliance to enable all three supported TLS protocol versions. After confirmation prompt, appliance will immediately reboot.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCESNMPV3ENGINEID--> <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"> <!--SET-HPOVAPPLIANCESNMPV3ENGINEID--> <command:details> <command:name>Set-HPOVApplianceSnmpV3EngineId</command:name> <maml:description> <maml:para>Change the appliance SNMPv3 Engine ID</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceSnmpV3EngineId</command:noun> </command:details> <maml:description> <maml:para>Change or update the appliance SNMPv3 engine ID. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceSnmpV3EngineId</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>EngineID</maml:name> <maml:description> <maml:para>A 16 hexacharacter value. E.g. "0x73cb660f279b9e"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>EngineID</maml:name> <maml:description> <maml:para>A 16 hexacharacter value. E.g. "0x73cb660f279b9e"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SnmpV3EngineId</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The appliance SNMPv3 engine ID.</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>Set-HPOVApplianceSnmpV3EngineId -EngineID 0x73cb660f279b9e</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <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"> <!--SET-HPOVAPPLIANCETWOFACTORAUTHENTICATION--> <command:details> <command:name>Set-HPOVApplianceTwoFactorAuthentication</command:name> <maml:description> <maml:para>Configure appliance two-factor authentication settings.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVApplianceTwoFactorAuthentication</command:noun> </command:details> <maml:description> <maml:para>Enabling two-factor authentication allows you to use smart cards � for example, Common Access Cards (CAC), or Personal Identity Verification (PIV) cards � to authenticate within HPE OneView. The client certificate embedded in the smart card is presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority (CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in HPE OneView. When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned by the user to access an Active Directory entry for the user, rather than using an account associated with the user name received during first time login. Use this Cmdlet to configure two factor authentication state of the connected appliance. An Active Directory authentication directory must be configured, with a Service Account, and the root or issuing certificate authority Base64 certificate must be uploaded to appliance. Required: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVApplianceTwoFactorAuthentication</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SmartCardLoginOnly</maml:name> <maml:description> <maml:para>Use to enforce smart card authentication only. Enabling Smart card only login disables the authentication using a user name and password. User name and password login is still available through the appliance console. You will be prompted to confirm the use of this parameter. Use the -Confirm to override prompt.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EnableEmergencyLocalLogin</maml:name> <maml:description> <maml:para>Boolean value to enable ($true) or disable ($false) emergency local login. Must be set to $false when -SmartCardLoginOnly is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>EmergencyLoginAllowType</maml:name> <maml:description> <maml:para>Allow emergency login access if the configured authentication directory(ies) for 2-factor are unavailable. Highest security is obtained by restricting the local administrator account to "ApplianceConsoleOnly". Choose "NetworkAndApplianceConsole" to allow emergency access via the network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SubjectAlternativeNamePatterns</maml:name> <maml:description> <maml:para>By default, the attribute entry associated with the "Subject Alternative Name" item, within the "Certificate owner" entry, contains OtherName.UPN=(.*). This tells HPE OneView to extract the user name from the "OtherName.UPN" attribute within the Subject Alternative Name field of the certificate on the smart card. This is the user name that HPE OneView uses to query the enterprise directory. You can edit the value to enable HPE OneView to search for the user name within other additional attributes within Subject Alternative Name. The options include: * OtherName.UPN=(.*) The Microsoft certificate viewer displays "OtherName.UPN" underSubject Alternative Name as: Other Name: Principal Name=John.Doe@test.com * OtherName.RFC822Name=(.*) The Microsoft certificate viewer displays OtherName.RFC822Name as: Other Name: RFC822 Name=John.Doe@test.com * RFC822Name=(.*) The Microsoft certificate viewer displays RFC822Name as: RFC822 Name=John.Doe@test.com * DirName=(.*) The Microsoft certificate viewer displays "DirName" under Subject Alternative Name as: Directory Address: CN=John Doe OU=Test Group O=Test Org C=US DC=test DC=com Use a comma-separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject Alternative Name attributes for a valid user name. NOTE: You can instruct HPE OneView to search for the user name within the attributes of the "Subject" field of the smart card certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). See subject entry in the "Certificate owner" field for details. Subject Alternative Name multiple attribute entry example OtherName.UPN=(.*),OtherName.RFC822Name=(.*),RFC822Name=(.*),DirName=(.*)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SubjectPatterns</maml:name> <maml:description> <maml:para>By default, the attribute entry box associated with the "Subject" entry, within the "Certificate owner" field, contains CN=(.*). With this value, HPE OneView extracts the first user name it encounters within a "CN" attribute within the "Subject" field in the smart card certificate. You can edit the regular expression for the "CN" attribute using regular expressions to refine the list of acceptable values. You can edit the value if you need HPE OneView to search for the user name within other additional attributes within the certificate "Subject" field. The choices include: * CN=(.*) * E=(.*) * UID=(.*) * DN=(.*) Microsoft Active Directory users must note that the DN is extracted as an aggregate of the subject attributes from the certificate. This should match the DN value configured for the user in the Active Directory. If this is not an exact match, the login operation fails. Use a comma separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject attributes for a valid user name. NOTE: You can instruct HPE OneView to search for the user name within the attributes of the "Subject" field of the smart card certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). Subject multiple attribute entry example * CN=(.*),E=(.*),UID=(.*),DN=(.*) Variations for the CN attribute: examples To match only user names starting with "J_" use CN=(^J_.*$) To match names in "LastName, FirstName" format use CN=(^[a-zA-Z]*, [a-zA-Z]+$) To match user names containing only numbers CN=(^[0-9]+$) NOTE: This is applicable when there are multiple CN attributes configured in a certificate and the user wants to specify a specific attribute rather than the first available in the CN attribute. It is recommended to use patterns that begin with "^" and ends with "$" so that the system can perform an exact match. </maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ValidationOids</maml:name> <maml:description> <maml:para>This parameter allows you to configure who can access HPE OneView by specifying the Key Usage, Extended Key Usage and Policy ID Object Identifiers (OIDs) that must be present within a smart card certificate in order for the user associated with the card to be authenticated. You can configure up to five OID combinations to accommodate different groups of users within your organization. By default, one combination is configured, containing the OID combination Smart Card Logon (1.3.6.1.4.1.311.20.2.2), Client Authentication (1.3.6.1.5.5.7.3.2). This combination requires the certificate on the smart card to be configured to allow the certificate to be used for smart card logon and for client authentication. It should work for most installations. You can edit this field to opt for a different combination of OIDs, or to add additional OIDs. A maximum of ten OIDs can be configured in a single string. NOTE: If you specify multiple OID combinations and one is a super-set of another, configure the more restrictive combination first.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryDomainType</maml:name> <maml:description> <maml:para>The Directory domain control allows you to specify which domain or directory to use when searching for the user in an enterprise directory. The domain name must match the Base DN of at least one of the directories added to HPE OneView. The options include: * Subject * Subject Alternative Name * Issuer * Manually specify After you select which certificate field HPE OneView must use to extract the domain name, the name is extracted from the DC attributes specified therein. The DC=(.*) configuration extracts the first domain component from the field. The administrator can only specify DC=(.*) here. If you select Manually specify, you can enter a specific domain using dot notation, or an alternate certificate location from which to retrieve domain information to use when querying the directory. You can specify multiple entries or domains in the configuration using ",". Additionally, you can specify the subject, subject alternative name and Issuer DC attributes to support multiple card configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DirectoryDomain</maml:name> <maml:description> <maml:para>Selection values for the "Manually specify" control In the fields of a certificate, the domain components are usually represented by multiple "DC=" entries. A domain BaseDN, like abc.example.com, is represented by the three entries "DC=abc", "DC=example", and "DC=com". Use "example.com" as the domain to use when searching for users in an enterprise directory: example.com Configure HPE OneView to look in multiple certificate locations for domain information. HPE OneView tries each item in order until it finds a successful user entry in the enterprise directory. Subject.DC=(.*),Issuer.DC=(.*),SubjectAlternativeName.DirName.DC=(.*),groupA.example.com,groupB.example.com</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryDomain</maml:name> <maml:description> <maml:para>Selection values for the "Manually specify" control In the fields of a certificate, the domain components are usually represented by multiple "DC=" entries. A domain BaseDN, like abc.example.com, is represented by the three entries "DC=abc", "DC=example", and "DC=com". Use "example.com" as the domain to use when searching for users in an enterprise directory: example.com Configure HPE OneView to look in multiple certificate locations for domain information. HPE OneView tries each item in order until it finds a successful user entry in the enterprise directory. Subject.DC=(.*),Issuer.DC=(.*),SubjectAlternativeName.DirName.DC=(.*),groupA.example.com,groupB.example.com</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DirectoryDomainType</maml:name> <maml:description> <maml:para>The Directory domain control allows you to specify which domain or directory to use when searching for the user in an enterprise directory. The domain name must match the Base DN of at least one of the directories added to HPE OneView. The options include: * Subject * Subject Alternative Name * Issuer * Manually specify After you select which certificate field HPE OneView must use to extract the domain name, the name is extracted from the DC attributes specified therein. The DC=(.*) configuration extracts the first domain component from the field. The administrator can only specify DC=(.*) here. If you select Manually specify, you can enter a specific domain using dot notation, or an alternate certificate location from which to retrieve domain information to use when querying the directory. You can specify multiple entries or domains in the configuration using ",". Additionally, you can specify the subject, subject alternative name and Issuer DC attributes to support multiple card configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EmergencyLoginAllowType</maml:name> <maml:description> <maml:para>Allow emergency login access if the configured authentication directory(ies) for 2-factor are unavailable. Highest security is obtained by restricting the local administrator account to "ApplianceConsoleOnly". Choose "NetworkAndApplianceConsole" to allow emergency access via the network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>EnableEmergencyLocalLogin</maml:name> <maml:description> <maml:para>Boolean value to enable ($true) or disable ($false) emergency local login. Must be set to $false when -SmartCardLoginOnly is used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SmartCardLoginOnly</maml:name> <maml:description> <maml:para>Use to enforce smart card authentication only. Enabling Smart card only login disables the authentication using a user name and password. User name and password login is still available through the appliance console. You will be prompted to confirm the use of this parameter. Use the -Confirm to override prompt.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Bool</command:parameterValue> <dev:type> <maml:name>Bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SubjectAlternativeNamePatterns</maml:name> <maml:description> <maml:para>By default, the attribute entry associated with the "Subject Alternative Name" item, within the "Certificate owner" entry, contains OtherName.UPN=(.*). This tells HPE OneView to extract the user name from the "OtherName.UPN" attribute within the Subject Alternative Name field of the certificate on the smart card. This is the user name that HPE OneView uses to query the enterprise directory. You can edit the value to enable HPE OneView to search for the user name within other additional attributes within Subject Alternative Name. The options include: * OtherName.UPN=(.*) The Microsoft certificate viewer displays "OtherName.UPN" underSubject Alternative Name as: Other Name: Principal Name=John.Doe@test.com * OtherName.RFC822Name=(.*) The Microsoft certificate viewer displays OtherName.RFC822Name as: Other Name: RFC822 Name=John.Doe@test.com * RFC822Name=(.*) The Microsoft certificate viewer displays RFC822Name as: RFC822 Name=John.Doe@test.com * DirName=(.*) The Microsoft certificate viewer displays "DirName" under Subject Alternative Name as: Directory Address: CN=John Doe OU=Test Group O=Test Org C=US DC=test DC=com Use a comma-separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject Alternative Name attributes for a valid user name. NOTE: You can instruct HPE OneView to search for the user name within the attributes of the "Subject" field of the smart card certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). See subject entry in the "Certificate owner" field for details. Subject Alternative Name multiple attribute entry example OtherName.UPN=(.*),OtherName.RFC822Name=(.*),RFC822Name=(.*),DirName=(.*)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SubjectPatterns</maml:name> <maml:description> <maml:para>By default, the attribute entry box associated with the "Subject" entry, within the "Certificate owner" field, contains CN=(.*). With this value, HPE OneView extracts the first user name it encounters within a "CN" attribute within the "Subject" field in the smart card certificate. You can edit the regular expression for the "CN" attribute using regular expressions to refine the list of acceptable values. You can edit the value if you need HPE OneView to search for the user name within other additional attributes within the certificate "Subject" field. The choices include: * CN=(.*) * E=(.*) * UID=(.*) * DN=(.*) Microsoft Active Directory users must note that the DN is extracted as an aggregate of the subject attributes from the certificate. This should match the DN value configured for the user in the Active Directory. If this is not an exact match, the login operation fails. Use a comma separated list to include multiple values in the entry field, allowing HPE OneView to search multiple Subject attributes for a valid user name. NOTE: You can instruct HPE OneView to search for the user name within the attributes of the "Subject" field of the smart card certificate (either in addition to, or instead of, searching within "Subject Alternative Name" attributes). Subject multiple attribute entry example * CN=(.*),E=(.*),UID=(.*),DN=(.*) Variations for the CN attribute: examples To match only user names starting with "J_" use CN=(^J_.*$) To match names in "LastName, FirstName" format use CN=(^[a-zA-Z]*, [a-zA-Z]+$) To match user names containing only numbers CN=(^[0-9]+$) NOTE: This is applicable when there are multiple CN attributes configured in a certificate and the user wants to specify a specific attribute rather than the first available in the CN attribute. It is recommended to use patterns that begin with "^" and ends with "$" so that the system can perform an exact match. </maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ValidationOids</maml:name> <maml:description> <maml:para>This parameter allows you to configure who can access HPE OneView by specifying the Key Usage, Extended Key Usage and Policy ID Object Identifiers (OIDs) that must be present within a smart card certificate in order for the user associated with the card to be authenticated. You can configure up to five OID combinations to accommodate different groups of users within your organization. By default, one combination is configured, containing the OID combination Smart Card Logon (1.3.6.1.4.1.311.20.2.2), Client Authentication (1.3.6.1.5.5.7.3.2). This combination requires the certificate on the smart card to be configured to allow the certificate to be used for smart card logon and for client authentication. It should work for most installations. You can edit this field to opt for a different combination of OIDs, or to add additional OIDs. A maximum of ten OIDs can be configured in a single string. NOTE: If you specify multiple OID combinations and one is a super-set of another, configure the more restrictive combination first.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance global security settings.</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>Set-HPOVApplianceTwoFactorAuthentication -ValidationOids @(@{"1.3.6.1.4.1.311.20.2.2" = "Smart Card Logon"; "1.3.6.1.5.5.7.3.2" = "Client Authentication"})</dev:code> <dev:remarks> <dev:para>Configured two-factory authentication using default validation OIDs.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVAUTOMATICBACKUPCONFIG--> <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"> <!--SET-HPOVAUTOMATICBACKUPCONFIG--> <command:details> <command:name>Set-HPOVAutomaticBackupConfig</command:name> <maml:description> <maml:para>Configure automatic appliance backup.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVAutomaticBackupConfig</command:noun> </command:details> <maml:description> <maml:para>Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order to successfuly configure. During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the async task has successfully completed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVAutomaticBackupConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The IP Address or FQDN of the target SCP or SFTP host.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username to authenticate to the SCP/SFTP host with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the user. Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>HostSSHKey</maml:name> <maml:description> <maml:para>The SCP/SFTP hosts public key, in OpenSSH String format.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is associated with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>The protocol to connect to the remote host with. Supported values are: * SCP * SFTP Default: SCP</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The frequency the backup will be generated. Supported values are: * Daily * Weekly</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Days</maml:name> <maml:description> <maml:para>If specifying a Weekly backup, provide the days in an Array. Accepted values are: * SU or SUN or Sunday * MO or MON or Monday * TU or TUE or Tuesday * WE or WED or Wednesday * TH or THUR or Thursday * FR or FRI or Friday * SA or SAT or Saturday</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Time</maml:name> <maml:description> <maml:para>The time to execute, in 24hr clock.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVAutomaticBackupConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Disable the automatic backup schedule.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Days</maml:name> <maml:description> <maml:para>If specifying a Weekly backup, provide the days in an Array. Accepted values are: * SU or SUN or Sunday * MO or MON or Monday * TU or TUE or Tuesday * WE or WED or Wednesday * TH or THUR or Thursday * FR or FRI or Friday * SA or SAT or Saturday</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is associated with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="None"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Disable the automatic backup schedule.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>HostSSHKey</maml:name> <maml:description> <maml:para>The SCP/SFTP hosts public key, in OpenSSH String format.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The IP Address or FQDN of the target SCP or SFTP host.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The frequency the backup will be generated. Supported values are: * Daily * Weekly</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the user. Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>The protocol to connect to the remote host with. Supported values are: * SCP * SFTP Default: SCP</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>SCP</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Time</maml:name> <maml:description> <maml:para>The time to execute, in 24hr clock.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username to authenticate to the SCP/SFTP host with.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance async task to monitor</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Arraylist <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple appliance async task to monitor</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>$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00</dev:code> <dev:remarks> <dev:para>This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00 New-HPOVBackup</dev:code> <dev:remarks> <dev:para>This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the remote location configured.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVAutomaticBackupConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVCLUSTERMANAGER--> <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"> <!--SET-HPOVCLUSTERMANAGER--> <command:details> <command:name>Set-HPOVClusterManager</command:name> <maml:description> <maml:para>Modify an existing hypervisor manager.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVClusterManager</command:noun> </command:details> <maml:description> <maml:para>You can register a new hypervisor manager with HPE OneView by providing the hostname and credentials. The registered hypervisor manager contains preferences, which are used as default hypervisor or cluster settings during hypervisor cluster profile creation. You can modify the hypervisor manager preferences using the edit operation. You can override these values in a hypervisor cluster profile. A valid hypervisor manager certificate must be added to HPE OneView trust store to be able to successfully communicate with a hypervisor manager. The user must have an infrastructure administrator privilege to register or update the hypervisor manager resource in HPE OneView. You can assign scopes to the hypervisor manager resource in HPE OneView.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVClusterManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster manager resource object from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HypervisorManager</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Use to update the IP or FQDN address of the target cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Change the display name of the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Use to update the TCP port of the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object. Using this parameter will update the authentication credentials needed to communicate with the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>VirtualSwitchType</maml:name> <maml:description> <maml:para>Use to adjust the virtual switch for hypervisor clsuters with the specified type. Allowed values: * Standard - A virtual switch configured and managed at the hypervisor level; provides networking to virtual machines and VM kernels. * Distributed - A virtual switch configured and managed at data center level and configured for each hypervisor to provide networking to virtual machines and VM Kernels.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DistributedSwitchUsage</maml:name> <maml:description> <maml:para>Applicable only when vSwitch type is Distributed. This specifies which networks should be configured for distributed switches. Allowed values: * AllNetworks - Configures all the networks in the hypervisor cluster profile with distributed virtual switches. All networks include Management, special purpose and general purpose networks. The special purpose networks comprise VM Migration, iSCSI and Fault Tolerance. * GeneralNetworks - Configures the general purpose networks in the hypervisor cluster profile with distributed virtual switches.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DistributedSwitchVersion</maml:name> <maml:description> <maml:para>Applicable only when vSwitch type is of type distributed. Configures distributed virtual switch with the specified version, and must be supported by the Hypervisor Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>HAEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware HA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DRSEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware DRS default settings for clusters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>MultiNicVMotionEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware VMotion multi-NIC vmotion.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object. Using this parameter will update the authentication credentials needed to communicate with the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DRSEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware DRS default settings for clusters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Change the display name of the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DistributedSwitchUsage</maml:name> <maml:description> <maml:para>Applicable only when vSwitch type is Distributed. This specifies which networks should be configured for distributed switches. Allowed values: * AllNetworks - Configures all the networks in the hypervisor cluster profile with distributed virtual switches. All networks include Management, special purpose and general purpose networks. The special purpose networks comprise VM Migration, iSCSI and Fault Tolerance. * GeneralNetworks - Configures the general purpose networks in the hypervisor cluster profile with distributed virtual switches.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DistributedSwitchVersion</maml:name> <maml:description> <maml:para>Applicable only when vSwitch type is of type distributed. Configures distributed virtual switch with the specified version, and must be supported by the Hypervisor Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>HAEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware HA.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Use to update the IP or FQDN address of the target cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster manager resource object from Get-HPOVClusterManager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HypervisorManager</command:parameterValue> <dev:type> <maml:name>HypervisorManager</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>MultiNicVMotionEnabled</maml:name> <maml:description> <maml:para>Use to enable or disable VMware VMotion multi-NIC vmotion.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Use to update the TCP port of the cluster manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>VirtualSwitchType</maml:name> <maml:description> <maml:para>Use to adjust the virtual switch for hypervisor clsuters with the specified type. Allowed values: * Standard - A virtual switch configured and managed at the hypervisor level; provides networking to virtual machines and VM kernels. * Distributed - A virtual switch configured and managed at data center level and configured for each hypervisor to provide networking to virtual machines and VM Kernels.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Cluster.ClusterManager</maml:name> </dev:type> <maml:description> <maml:para>The cluster manager from Get-HPOVClusterManager.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Set-HPOVClusterManager</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVDATACENTER--> <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"> <!--SET-HPOVDATACENTER--> <command:details> <command:name>Set-HPOVDataCenter</command:name> <maml:description> <maml:para>Modify an existing Datacenter resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVDataCenter</command:noun> </command:details> <maml:description> <maml:para>A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server, enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and cooling management of your servers, enclosures, and power delivery devices together in a single management system. When you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects. This Cmdlet will create a new datacenter. You will need to specify the Name and dimensions. Optionally, you can override the default Electrical Derating, default voltage, local currency (which will aid in power calculation costs) and power cooling capacity. Remote Support settings can only be set when Remote Support has been enabled and configured on the appliance. If omitting Remote Support location settings, then the datacenter will default to the default location set.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVDataCenter</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Datacenter object from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name to identify the data center. Must not exceed 255 characters; no leading spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If specifying millimeter value for Width and Depth, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ElectricalDerating</maml:name> <maml:description> <maml:para>If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%. Default: 20%</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ElectricalDeratingType</maml:name> <maml:description> <maml:para>The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body temperature, ambient temperature, and type of cooling. You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum power dissipation by specifying None. Default: NA/Jp</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DefaultVoltage</maml:name> <maml:description> <maml:para>The default power line voltage for the data center. Default: 220</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Currency</maml:name> <maml:description> <maml:para>The currency unit for energy costs.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PowerCosts</maml:name> <maml:description> <maml:para>The energy cost per kWh, specified by the Currency.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CoolingCapacity</maml:name> <maml:description> <maml:para>The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>CoolingMultiplier</maml:name> <maml:description> <maml:para>The ratio of cooling cost to power cost for the data center. This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of 1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system. Default: 1.5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>CoolingCapacity</maml:name> <maml:description> <maml:para>The maximum cooling capacity for the data center, in KW. The appliance analyzes heat generation using this value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>CoolingMultiplier</maml:name> <maml:description> <maml:para>The ratio of cooling cost to power cost for the data center. This value represents the relative cost of cooling the system compared to the cost of powering the system. The default value of 1.5 indicates that it costs 1.5 times as much to cool the system as it does to power the system. Default: 1.5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue>1.5</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Currency</maml:name> <maml:description> <maml:para>The currency unit for energy costs.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>USD</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DefaultVoltage</maml:name> <maml:description> <maml:para>The default power line voltage for the data center. Default: 220</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>220</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ElectricalDerating</maml:name> <maml:description> <maml:para>If Custom ElectricalDetratingType is set to Custom, specify a value between 20-100%. Default: 20%</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue>20</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ElectricalDeratingType</maml:name> <maml:description> <maml:para>The percentage below the rated maximum power dissipation at which the devices are operated, accounting for case/body temperature, ambient temperature, and type of cooling. You can specify a derating percentage by choosing Custom, or you can choose not to apply derating to the rated maximum power dissipation by specifying None. Default: NA/Jp</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>NA/Jp</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Datacenter object from Get-HPOVDataCenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Millimeters</maml:name> <maml:description> <maml:para>If specifying millimeter value for Width and Depth, this parameter is required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>A name to identify the data center. Must not exceed 255 characters; no leading spaces.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PowerCosts</maml:name> <maml:description> <maml:para>The energy cost per kWh, specified by the Currency.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the datacenter, in (US) Feet. Maximum of 50 meters (164.042 feet). Millimeters can be used, which requires the -Millimeters switch parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Float</command:parameterValue> <dev:type> <maml:name>Float</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.DataCenter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Newly created datacenter.</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>$DataCenter1Name = "LA DC 12" $DataCenter1Width = 30 $DataCenter1Depth = 30 $DataCenter1Voltage = 220 $DataCenter1PowerCosts = 0.07 $DataCenter1CoolingCapacity = 250 New-HPOVDataCenter -Name $DataCenter1Name -Width $DataCenter1Width -Depth $DataCenter1Depth -DefaultVoltage $DataCenter1Voltage -PowerCosts $DataCenter1PowerCosts -CoolingCapacity $DataCenter1CoolingCapacity</dev:code> <dev:remarks> <dev:para>Create new "LA DC 12" datacenter.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$NewDCParams = @{ Name = "Houston DC1"; Width = 10668; Depth = 13716; Millimeters = $True; DefaultVoltage = 240e; PowerCosts = 0.10; CoolingCapacity = 350; Address1 = "123 Main Place"; Address2 = "Suite 400"; City = "Houston; State = "TX"; Country = "US"; PostCode = "77002"; TimeZone = "US/Central"; PrimaryContact = (Get-HPOVRemoteSupportContact -Name "Joe Ellis" -EA Stop) SecondaryContact = (Get-HPOVRemoteSupportContact -Name "Brandon Pear" -EA Stop) } New-HPOVDataCenter @NewDC2Params</dev:code> <dev:remarks> <dev:para>Create a new datacenter with Remote Support settings.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVDataCenter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVDataCenterRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVDATACENTERREMOTESUPPORT--> <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"> <!--SET-HPOVDATACENTERREMOTESUPPORT--> <command:details> <command:name>Set-HPOVDataCenterRemoteSupport</command:name> <maml:description> <maml:para>Modify an existing Datacenter Remote Support setting.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVDataCenterRemoteSupport</command:noun> </command:details> <maml:description> <maml:para>A data center represents a physically contiguous area in which racks containing IT equipment are located. For example, you have IT equipment in two rooms or on separate floors. You could create a data center for each of these areas. Each server, enclosure, or power distribution device in your data center can report its power requirements, but it can be difficult to understand the power and cooling requirements for your data center as a whole. The appliance enables you to bring power and cooling management of your servers, enclosures, and power delivery devices together in a single management system. When you initialize the appliance for the first time, it creates a data center named Datacenter 1. The appliance provides this data center as a place to visualize your racks. You can rename or edit this data center to match the values and layout of your data center, you can use it as the basis for a planned data center model, or you can delete this data center without adverse effects. This Cmdlet will help modify an existing DataCenters Remote Support location and contacts. In order to set a DataCenter Remote Support location, the appliance must be configured and regsitered with Remote Support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVDataCenterRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The DataCenter to modify.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance. Must not be the same value as the Primary Contact.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Address1</maml:name> <maml:description> <maml:para>Address of datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Address2</maml:name> <maml:description> <maml:para>Optional address line.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>City</maml:name> <maml:description> <maml:para>City of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>State/province of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PostCode</maml:name> <maml:description> <maml:para>Postal code for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Time Zone of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Address1</maml:name> <maml:description> <maml:para>Address of datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Address2</maml:name> <maml:description> <maml:para>Optional address line.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>City</maml:name> <maml:description> <maml:para>City of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Country</maml:name> <maml:description> <maml:para>Country of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The DataCenter to modify.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PostCode</maml:name> <maml:description> <maml:para>Postal code for the datacenter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact object from Get-HPOVRemoteSupportContact defined on the appliance. Must not be the same value as the Primary Contact.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>State</maml:name> <maml:description> <maml:para>State/province of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Time Zone of residence for the datacenter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.DataCenter</maml:name> </dev:type> <maml:description> <maml:para>DataCenter facility object from Get-HPOVDataCenter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AyncTask</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Modified datacenter Remote Support location Asynchronous task.</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>$NewPrimaryConact = Get-HPOVRemoteSupportContact -Name "Vivian Waters" -ErrorAction Stop Get-HPOVDataCenter -Name "LA DC 12" -ErrorAction Stop | Set-HPOVDataCenterRemoteSupport -PrimaryContact $NewPrimaryConact</dev:code> <dev:remarks> <dev:para>Modify "LA DC 12" datacenter with new Primary Contact.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVENCLOSURE--> <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"> <!--SET-HPOVENCLOSURE--> <command:details> <command:name>Set-HPOVEnclosure</command:name> <maml:description> <maml:para>Rename Synergy Frame Name or Rack Name.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVEnclosure</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to set a Synergy Frame/Enclosure Name and/or the Synergy Rack Name to provided values. Each requires a seperate async task to complete.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Syngery Frame/Enclosure Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of a Synergy Frame.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>RackName</maml:name> <maml:description> <maml:para>The new name of ta Synergy Rack.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="Enclosure, Encl"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Syngery Frame/Enclosure Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of a Synergy Frame.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>RackName</maml:name> <maml:description> <maml:para>The new name of ta Synergy Rack.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Syngery Enclosure resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single async task resource for resource name update</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of async tasks</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>Get-HPOVEnclosure -Name "0000A66101" -ErrorAction Stop | Set-HPOVEnclosure -Name "MyEnclName1" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Set the provided Synergy Frame resource Name to a new value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure -Name "0000A66101" -ErrorAction Stop | Set-HPOVEnclosure -Name "MyEnclName1" -RackName "DC11-Rack4A" | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Set the provided Synergy Frame resource Name and RackName to a new value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureActiveFLM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVENCLOSUREACTIVEFLM--> <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"> <!--SET-HPOVENCLOSUREACTIVEFLM--> <command:details> <command:name>Set-HPOVEnclosureActiveFLM</command:name> <maml:description> <maml:para>Power reset Enclosure component.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVEnclosureActiveFLM</command:noun> </command:details> <maml:description> <maml:para>Obtain a collection of enclosure hardware resources which have the specified name.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVEnclosureActiveFLM</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The Synergy Frame resource from Get-HPOVEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>BayID</maml:name> <maml:description> <maml:para>BAYID</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>FORCE</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>BayID</maml:name> <maml:description> <maml:para>BAYID</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>Enclosure</maml:name> <maml:description> <maml:para>The Synergy Frame resource from Get-HPOVEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>FORCE</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Enclosure Report</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource to monitor</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>EXAMPLE1</dev:code> <dev:remarks> <dev:para>Return all the enclosure hardware managed by this appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Example2</dev:code> <dev:remarks> <dev:para>Return the enclosure hardware resource with name "A".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>EXAMPLE3</dev:code> <dev:remarks> <dev:para>Display a brief list of the enclosures managed or monitored by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVENCLOSUREGROUP--> <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"> <!--SET-HPOVENCLOSUREGROUP--> <command:details> <command:name>Set-HPOVEnclosureGroup</command:name> <maml:description> <maml:para>Modify an existing enclosure group policy.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVEnclosureGroup</command:noun> </command:details> <maml:description> <maml:para>An enclosure group is a logical resource that defines a standard configuration for member logical enclosures. Use this Cmdlet to update the configuration policy for a specific enclosure group resource. Minimum required privileges: Server administrator or Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVEnclosureGroup</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>An enclosure group resource from Get-HPOVEnclosureGroup.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a new resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>An Onboard Administrator CLI Script. Only applicable for HPE BladeSystem C-Class.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="EnclosureGroup"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>An enclosure group resource from Get-HPOVEnclosureGroup.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a new resource name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PowerRedundantMode</maml:name> <maml:description> <maml:para>The Power Redundancy Mode to set when an Enclosure is added to the appliance. Allowed Values: * RedundantPowerFeed - Provides N+N Power Redundancy Configuration * RedundantPowerSupply - Provided N+1 Power Redundancy Configuration</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Enclosure group resource from Get-HPOVEnclosureGroup.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Servers.EnclosureGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated enclosure group resource.</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>$EnclosureGroup = Get-HPOVEnclosureGroup -Name ProdEG1 -ErrorAction Stop Set-HPOVEnclosureGroup -InputObject $EnclosureGroup -Name VirtProdEG1</dev:code> <dev:remarks> <dev:para>Change the name of the provided enclosure group resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$UpdatedConfigScript = 'REMOVE USER "admin" ADD USER "ops" "*********" SET USER CONTACT "ops" "MySecretPassword" SET USER FULLNAME "ops" "" SET USER ACCESS "ops" OPERATOR ASSIGN SERVER 1-16 "ops" ENABLE USER "ops" hponcfg all >> end_marker <RIBCL VERSION="2.0"> <LOGIN USER_LOGIN="ops" PASSWORD="passthrough"> <USER_INFO MODE="write"> <ADD_USER USER_NAME="ops" USER_LOGIN="ops" PASSWORD="Supersecretpassword"> <ADMIN_PRIV value ="N"/> <REMOTE_CONS_PRIV value ="Y"/> <RESET_SERVER_PRIV value ="N"/> <VIRTUAL_MEDIA_PRIV value ="N"/> <CONFIG_ILO_PRIV value="Yes"/> </ADD_USER> </USER_INFO> </LOGIN> </RIBCL> end_marker' Get-HPOVEnclosureGroup -Name EG1 -ErrorAction Stop | Set-HPOVEnclosureGroup -ConfigurationScript $UpdatedConfigScript</dev:code> <dev:remarks> <dev:para>Update the configuration script of the provided enclosure group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVEULASTATUS--> <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"> <!--SET-HPOVEULASTATUS--> <command:details> <command:name>Set-HPOVEulaStatus</command:name> <maml:description> <maml:para>Accept the EULA and set support access for the specified appliance.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVEulaStatus</command:noun> </command:details> <maml:description> <maml:para>Accept the EULA and set support access for the specified appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVEulaStatus</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>The FQDN or IP Address of an HPE OneView appliance or HPOneView.Appliance.Connection must be provided.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>SupportAccess</maml:name> <maml:description> <maml:para>Set to "yes" to allow HP suport access to the appliance, otherwise set to "no".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>The FQDN or IP Address of an HPE OneView appliance or HPOneView.Appliance.Connection must be provided.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>SupportAccess</maml:name> <maml:description> <maml:para>Set to "yes" to allow HP suport access to the appliance, otherwise set to "no".</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Version and current support access state</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>Set-HPOVEulaStatus -Appliance appliance.contoso.com -supportAccess "yes"</dev:code> <dev:remarks> <dev:para>Connects to a specific appliance, accepting the EULA and enable Support Access.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVEulaStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVEXTERNALREPOSITORY--> <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"> <!--SET-HPOVEXTERNALREPOSITORY--> <command:details> <command:name>Set-HPOVExternalRepository</command:name> <maml:description> <maml:para>Modify an existing external baseline repository.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVExternalRepository</command:noun> </command:details> <maml:description> <maml:para>A firmware repository enables you to store firmware bundles and deploy them across your environment. An externally managed HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You can upload firmware bundles in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This functionality is supported for Linux and Windows systems. The recommended types of external web servers to use with the repository follow: * Apache * Internet Information Services (IIS) NOTE: Only one external repository can be added. This Cmdlet supports modifying an existing external repository. Use this Cmdlet to modify the Name, authentication credentials and/or HTTP SSL certificate.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to modify.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Update the configured repository with the new name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the username to authenticate to the target web server with if required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the username using a System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to modify.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Update the configured repository with the new name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object if the target web server requires authentication. By default, HTTPS will be used and basic authentication is used to communicate with the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVExternalRepository</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The Base64 Certificate of the target web server. Must be specified if the -HTTP parameter is not used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object if the target web server requires authentication. By default, HTTPS will be used and basic authentication is used to communicate with the target web server.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to modify.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredentials, Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Update the configured repository with the new name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the username using a System.Security.SecureString.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the username to authenticate to the target web server with if required.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.BaselineRepository [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The external repository object from Get-HPOVBaselineRepository</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task for the caller to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async task resource objects.</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>Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Name UpdatedRepoName</dev:code> <dev:remarks> <dev:para>Modify an existing external repository with a new name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVBaselineRepository -Name MyRepoName MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Credential (Get-PSCredential -Username "Domain\MyUpdatedAccountName")</dev:code> <dev:remarks> <dev:para>Modify an existing repository with new credentials.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$UpdatedSslCertificate = Get-Content C:\Dir\UpdatedCert.cer -raw Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Set-HPOVExternalRepository -Certificate $UpdatedSslCertificate</dev:code> <dev:remarks> <dev:para>Modify an existing repository with new Base64 SSL public certificate.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVINITIALPASSWORD--> <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"> <!--SET-HPOVINITIALPASSWORD--> <command:details> <command:name>Set-HPOVInitialPassword</command:name> <maml:description> <maml:para>Change the initial password of the Administrator user account.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVInitialPassword</command:noun> </command:details> <maml:description> <maml:para>Changes the initial default password of the Administrator local appliance account to the supplied new password during first time setup (FTS.)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVInitialPassword</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>OldPassword</maml:name> <maml:description> <maml:para>Current default password for this account. Will prompt for password if not supplied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>New password for this account. Will prompt for password if not supplied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>Specify Appliance FQDN, Name or IP Address. If no valid Appliance Connection is found, a temporary connection is created for the specified appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Appliance</maml:name> <maml:description> <maml:para>Specify Appliance FQDN, Name or IP Address. If no valid Appliance Connection is found, a temporary connection is created for the specified appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>New password for this account. Will prompt for password if not supplied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>OldPassword</maml:name> <maml:description> <maml:para>Current default password for this account. Will prompt for password if not supplied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> None</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>Set-HPOVInitialPassword -Appliance MyAppliance.domain.com</dev:code> <dev:remarks> <dev:para>Change the Administrator password, and prompted for both the original and new password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVLDAPDEFAULTDIRECTORY--> <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"> <!--SET-HPOVLDAPDEFAULTDIRECTORY--> <command:details> <command:name>Set-HPOVLdapDefaultDirectory</command:name> <maml:description> <maml:para>Configure Authentication Directory default directory.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVLdapDefaultDirectory</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to set the default Authentication Directory on the appliance. Use Get-HPOVLdapDirectory to pass in the directory to configure as the default. Once the Default Directory is set, the Cmdlet will configure a Registry Key (HKCU:\Software\Hewlett-Packard\HPOneView) called "AuthProvider#{ApplianceConnectionName}". The Library will read this value upon load and use it as the default value for the -AuthDirectory parameter in Connect-HPOVMgmt.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVLdapDefaultDirectory</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Directory] Provide the Directory Name, URI or Object. If you want to set the Authentication Directory back to Local, specify LOCAL as the name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>DisableLocalLogin</maml:name> <maml:description> <maml:para>Use to disable appliance local login accounts. You cannot use this parameter if an Authentication Directory is not configured.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>DisableLocalLogin</maml:name> <maml:description> <maml:para>Use to disable appliance local login accounts. You cannot use this parameter if an Authentication Directory is not configured.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Directory"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Directory] Provide the Directory Name, URI or Object. If you want to set the Authentication Directory back to Local, specify LOCAL as the name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Authentication Directory retrieved using Get-HPOVLdapDirectory</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Appliance Authentication Directory setting</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>Set-HPOVLdapDefaultDirectory -InputObject "Domain1" # Cmdlet will create: # HKCU:\Software\Hewlett-Packard\HPOneView\AuthProvider#MyAppliance.domain.com REG_SZ, value = "Domain1"</dev:code> <dev:remarks> <dev:para>Set "Domain1" as the default authentication directory for the appliance. Then, the Cmdlet will create the REG_SZ "AuthProvider#MyAppliance.domain.com" with a value of "Domain1".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVLDAPGROUPROLE--> <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"> <!--SET-HPOVLDAPGROUPROLE--> <command:details> <command:name>Set-HPOVLdapGroupRole</command:name> <maml:description> <maml:para>Assign or change roles for LDAP Groups.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVLdapGroupRole</command:noun> </command:details> <maml:description> <maml:para>Changes current roles of an LDAP Group with a given set of roles. You must provide the list of all roles the LDAP Group should be set to, and not a subset of roles.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVLdapGroupRole</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Directroy Group to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Role"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVLdapGroupRole</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Directroy Group to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Role"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. To indiate all resouroures, use 'All' as the value. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVLdapGroupRole</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Directroy Group to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. To indiate all resouroures, use 'All' as the value. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RoleAndScope, Scope, Role"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="RoleAndScope, Scope, Role" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RoleAndScope, Scope, Role" aliases="g, name, GroupName, Group"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Directroy Group to add.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>Directory User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Role" aliases="r, role"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope" aliases="None"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. To indiate all resouroures, use 'All' as the value. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RoleAndScope, Scope, Role" aliases="u"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Directory Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para>Directory User Account password</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated LDAP Group object with new role assignment(s)</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>Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles "Server administrator" -u "Sarah Peterson"</dev:code> <dev:remarks> <dev:para>Add "MY Directory Group1" from Domain1 with Server Administrator role and prompt for password for group validation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$roles = "Server administrator","Backup administrator" $password = ConvertTo-SecureString -asplaintext "password123890" -force Set-HPOVLdapGroupRole -d Domain1 -GroupName "MY Directory Group1" -roles $roles -u "Sarah Peterson" -p $password</dev:code> <dev:remarks> <dev:para>Set "MY Directory Group1" from Domain1 with Server and Backup administrator roles, and specify password for group validation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$LdapDirectoryName = "CorpDomain" $MyAdCreds = Get-Credential Get-HPOVLdapGroup -Group $CorpNetworkAdmins -ErrorAction Stop | ? loginDomain -eq $LdapDirectoryName | Set-HPOVLdapGroupRole -ScopePermissions @{Role = "Network administrator"; Scope = $NewSBACScope } -Credential $MyAdCreds</dev:code> <dev:remarks> <dev:para>Change the Scope permissions for the specified authentication directory group.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$scope = Get-HPOVScope -Name $scopename $ScopePermissions = @{ Role = "Server administrator"; Scope = $scope } Get-HPOVLdapGroup -Name $scopename | Set-HPOVLdapGroupRole -ScopePermissions $ScopePermissions -Roles "Software administrator" -Credential $MyAdCreds</dev:code> <dev:remarks> <dev:para>Change the Scope permissions for the specified authentication directory group by using both ScopePermissions and Roles parameters.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVLOGICALENCLOSURE--> <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"> <!--SET-HPOVLOGICALENCLOSURE--> <command:details> <command:name>Set-HPOVLogicalEnclosure</command:name> <maml:description> <maml:para>Modify a configured Logical Enclosure resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVLogicalEnclosure</command:noun> </command:details> <maml:description> <maml:para>A logical enclosure represents a logical view of a single enclosure with an enclosure group serving as a template. If the intended configuration in the logical enclosure does not match the actual configuration on the enclosures, the logical enclosure becomes inconsistent. Use the Logical Enclosures screen to manage firmware, configuration scripts, create a support dump, and to apply updates made from the Enclosure Groups screen to the enclosures in the logical enclosure. A logical enclosure is automatically created when a c7000 enclosure is added. Use this Cmdlet to modify an existing Logical Enclosure.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="cClass, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Logical Enclosure resource from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="cClass, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Associate the Logical Enclosure with a new Enclosure Group.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="cClass, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="cClass, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="cClass, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Logical Enclosure resource from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a new Logical Enclosure name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>Specify a new HPE BladeSystem c-Class Onboard Administrator configuration script to set. This is not supported with HPE Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="cClass, Default"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Associate the Logical Enclosure with a new Enclosure Group.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PowerMode</maml:name> <maml:description> <maml:para>Change the Power Mode of the Logical Enclosure. Allowed values: * RedundantPowerFeed - There are at least twice as many power supplies as are necessary (n + n). * RedundantPowerSupply - There is at least 1 more power supply than is necessary (n + 1).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AmbientTemperatureSetting</maml:name> <maml:description> <maml:para>The ambient temperature mode describing the environment in which the logical enclosure should be optimized to operate. When not specified, a default value of Standard is assumed. Allowed values: * ASHRAE_A3 - Extended ambient temperatures up to 40C/104F degrees. * ASHRAE_A4 - Extended ambient temperatures up to 45C/113F degrees. * Standard - Expected ambient temperatures up to 35C/95F degrees. * Telco - Extended ambient temperatures up to 40C/104F degrees and operation extremes up to 55C/131F degrees.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="cClass, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="cClass, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AmbientTemperatureSetting</maml:name> <maml:description> <maml:para>The ambient temperature mode describing the environment in which the logical enclosure should be optimized to operate. When not specified, a default value of Standard is assumed. Allowed values: * ASHRAE_A3 - Extended ambient temperatures up to 40C/104F degrees. * ASHRAE_A4 - Extended ambient temperatures up to 45C/113F degrees. * Standard - Expected ambient temperatures up to 35C/95F degrees. * Telco - Extended ambient temperatures up to 40C/104F degrees and operation extremes up to 55C/131F degrees.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="cClass, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="cClass, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ConfigurationScript</maml:name> <maml:description> <maml:para>Specify a new HPE BladeSystem c-Class Onboard Administrator configuration script to set. This is not supported with HPE Synergy.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="cClass, Default" aliases="eg"> <maml:name>EnclosureGroup</maml:name> <maml:description> <maml:para>Associate the Logical Enclosure with a new Enclosure Group.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="cClass, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Logical Enclosure resource from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify a new Logical Enclosure name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PowerMode</maml:name> <maml:description> <maml:para>Change the Power Mode of the Logical Enclosure. Allowed values: * RedundantPowerFeed - There are at least twice as many power supplies as are necessary (n + n). * RedundantPowerSupply - There is at least 1 more power supply than is necessary (n + 1).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.LogicalEnclosure</maml:name> </dev:type> <maml:description> <maml:para>HPE Syngery Logical Enclosure resource from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -Name NewName</dev:code> <dev:remarks> <dev:para>Change the Logical Enclosure name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalEnclosure -Name OriginalName | Set-HPOVLogicalEnclosure -AmbientTemperatureSetting ASHRAE_A3</dev:code> <dev:remarks> <dev:para>Change the Logical Enclosure ambient temperature setting.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosureFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVLOGICALJBOD--> <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"> <!--SET-HPOVLOGICALJBOD--> <command:details> <command:name>Set-HPOVLogicalJBOD</command:name> <maml:description> <maml:para>Modify a logical JBOD resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVLogicalJBOD</command:noun> </command:details> <maml:description> <maml:para>A logical JBOD is a group of physical drives that are dynamically defined as virtual drives. Logical JBOD uses the drives from the drive enclosures that are installed in the device bays of the enclosure and are associated with a SAS logical interconnect. You can assign or unassign a logical JBOD to a server hardware through the server profile. This Cmdlet will allow you to change the erase on delete option to False if the logical JBOD was created with the feature enabled (true). Data can also be erased on the logial drive by clearing the metadata. The number of assigned drives or type cannot be modified once the logical JBOD has been created. Minimum required privileges: Infrastructure administrator, server administrator, server profile architect, server profile administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVLogicalJBOD</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical JBOD resource from Get-HPOVLogicalJBOD.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.LogicalJBOD[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>DisableEraseData</maml:name> <maml:description> <maml:para>Can only be used if the logical JBOD was created with EraseDataOnDelete parameter was used in the call to New-HPOVLogicalJBOD.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>ClearMetadata</maml:name> <maml:description> <maml:para>Clear metadata on the associated drives, effectively wiping the data on the drive. This is not a secure erase, and data recovery could be possible.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>ClearMetadata</maml:name> <maml:description> <maml:para>Clear metadata on the associated drives, effectively wiping the data on the drive. This is not a secure erase, and data recovery could be possible.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>DisableEraseData</maml:name> <maml:description> <maml:para>Can only be used if the logical JBOD was created with EraseDataOnDelete parameter was used in the call to New-HPOVLogicalJBOD.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The logical JBOD resource from Get-HPOVLogicalJBOD.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.LogicalJBOD[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.LogicalJBOD[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.LogicalJBOD</maml:name> </dev:type> <maml:description> <maml:para>A logical JBOD resource from Get-HPOVLogicalJBOD.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Set-HPOVLogicalJBOD -InputObject $MyLogicalJBOD -DisableEraseData</dev:code> <dev:remarks> <dev:para>Disable erase data on delete policy for the specific logical JBOD. This cannot be undone or reverted back.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVDriveEnclosureInventory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalJBOD</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVLOGINMESSAGE--> <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"> <!--SET-HPOVLOGINMESSAGE--> <command:details> <command:name>Set-HPOVLoginMessage</command:name> <maml:description> <maml:para>Set appliance Login Message.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVLoginMessage</command:noun> </command:details> <maml:description> <maml:para>Configure the Login Message for the connected appliance(s). You can also set the Acknowledgement to be required.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVLoginMessage</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Message</maml:name> <maml:description> <maml:para>The login message to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default"> <maml:name>Acknowledgment</maml:name> <maml:description> <maml:para>Set to True if the login message should be acknowledged before authentication completes. If set to True, the COnnect-HPOVMgmt Cmdlet will prompt the user to acknowledge the message, if -LoginAcknowledge is not provided in the Cmdlet parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVLoginMessage</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default"> <maml:name>Acknowledgment</maml:name> <maml:description> <maml:para>Set to True if the login message should be acknowledged before authentication completes. If set to True, the COnnect-HPOVMgmt Cmdlet will prompt the user to acknowledge the message, if -LoginAcknowledge is not provided in the Cmdlet parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default" aliases="None"> <maml:name>Acknowledgment</maml:name> <maml:description> <maml:para>Set to True if the login message should be acknowledged before authentication completes. If set to True, the COnnect-HPOVMgmt Cmdlet will prompt the user to acknowledge the message, if -LoginAcknowledge is not provided in the Cmdlet parameters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="ChangeEnablement, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Message</maml:name> <maml:description> <maml:para>The login message to set.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.LoginMessage</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> If successful, returns a resource</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>Set-HPOVLoginMessage -Message "************************************ >> ***** WARNING ******** >> ************************************ >> Updated Message: This management appliance is a company owned asset and provided for the exclusive use of authorized personnel. Unauthorized use or >> abuse of this system may lead to corrective action including termination, civil and/or criminal penalties." >> -Acknowledgement $true</dev:code> <dev:remarks> <dev:para>Set the Login Message from all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Message = "************************************ >> ***** WARNING ******** >> ************************************ >> Updated Message: This management appliance is a company owned asset and provided for the exclusive use of authorized personnel. Unauthorized use or >> abuse of this system may lead to corrective action including termination, civil and/or criminal penalties." >> Set-HPOVLoginMessage -Message $Message -Acknowledgment $true </dev:code> <dev:remarks> <dev:para>Set the Login Message from the specified appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLoginMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVMANAGEDSAN--> <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"> <!--SET-HPOVMANAGEDSAN--> <command:details> <command:name>Set-HPOVManagedSan</command:name> <maml:description> <maml:para>Enable or Disable Automated SAN Zoning.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVManagedSan</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to Enable or Disable a Managed SAN resource on the appliance. Disabling a Managed SAN will prevent the appliance from configuring FC Zones.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVManagedSan</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ZoningPolicy</maml:name> <maml:description> <maml:para>Policy setting that affects the way that zones are created. Allowed values: * NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning. * SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator. * SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are created for targets that reside on different storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Enable"> <maml:name>EnableAutomatedZoning</maml:name> <maml:description> <maml:para>(DEPRICATED - Please use -ZoningPolicy parameter.) Enable Automated Zoning for the specified Managed SAN. When used, the default Zone Policy "SingleInitiatorAllTargets" is set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>EnableAliasing</maml:name> <maml:description> <maml:para>Enable aliases to be created for initiators, targets and target groups based on the specified name formats</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>InitiatorNameFormat</maml:name> <maml:description> <maml:para>Format to use for initiator alias names. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}. Example: "initiator_{hostname}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>TargetGroupNameFormat</maml:name> <maml:description> <maml:para>Format to use for target group (ex. storage system port group) alias names. The following built-in variables can be used: {storageSystemName}, {targetGroupName}. Example: "TargetGroup_{storageSystemName}_{targetGroupName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>DisableTargetGroupAliasing</maml:name> <maml:description> <maml:para>When the zoning policy is not set to SingleInitiatorSingleTarget, Target Group Aliasing can be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>TargetNameFormat</maml:name> <maml:description> <maml:para>Format to use for target (ex. storage system port) alias names. The following built-in variables can be used: {storageSystemName}, {targetName}. Example: "Target_{storageSystemName}_{targetName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>ZoneNameFormat</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>UpdateZoneNames</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>UpdateInitiatorAliases</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>UpdateTargetAliases</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>UpdateTargetGroupAliases</maml:name> <maml:description> <maml:para>When Enabled (True), target and target group aliases will be updated in the SAN whenever resources are renamed in OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVManagedSan</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Enable"> <maml:name>EnableAutomatedZoning</maml:name> <maml:description> <maml:para>(DEPRICATED - Please use -ZoningPolicy parameter.) Enable Automated Zoning for the specified Managed SAN. When used, the default Zone Policy "SingleInitiatorAllTargets" is set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ZoningPolicy</maml:name> <maml:description> <maml:para>Policy setting that affects the way that zones are created. Allowed values: * NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning. * SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator. * SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are created for targets that reside on different storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias"> <maml:name>DisableAliasing</maml:name> <maml:description> <maml:para>Disable aliases to be created for initiators, targets and target groups based on the specified name formats</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVManagedSan</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ZoningPolicy</maml:name> <maml:description> <maml:para>Policy setting that affects the way that zones are created. Allowed values: * NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning. * SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator. * SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are created for targets that reside on different storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>DisableAutomatedZoning</maml:name> <maml:description> <maml:para>(DEPRICATED - Please use -ZoningPolicy parameter.) Disable Automated Zoning for the specified Managed SAN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DisableAlias, Disable, Enable"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DisableAlias, Disable, Enable" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias" aliases="None"> <maml:name>DisableAliasing</maml:name> <maml:description> <maml:para>Disable aliases to be created for initiators, targets and target groups based on the specified name formats</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="ZoningDisable, Disable"> <maml:name>DisableAutomatedZoning</maml:name> <maml:description> <maml:para>(DEPRICATED - Please use -ZoningPolicy parameter.) Disable Automated Zoning for the specified Managed SAN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>DisableTargetGroupAliasing</maml:name> <maml:description> <maml:para>When the zoning policy is not set to SingleInitiatorSingleTarget, Target Group Aliasing can be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>EnableAliasing</maml:name> <maml:description> <maml:para>Enable aliases to be created for initiators, targets and target groups based on the specified name formats</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Enable" aliases="ZoningEnable, Enable"> <maml:name>EnableAutomatedZoning</maml:name> <maml:description> <maml:para>(DEPRICATED - Please use -ZoningPolicy parameter.) Enable Automated Zoning for the specified Managed SAN. When used, the default Zone Policy "SingleInitiatorAllTargets" is set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>InitiatorNameFormat</maml:name> <maml:description> <maml:para>Format to use for initiator alias names. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}. Example: "initiator_{hostname}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="DisableAlias, Disable, Enable" aliases="Fabric, Name, ManagedSan, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Name or Object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>TargetGroupNameFormat</maml:name> <maml:description> <maml:para>Format to use for target group (ex. storage system port group) alias names. The following built-in variables can be used: {storageSystemName}, {targetGroupName}. Example: "TargetGroup_{storageSystemName}_{targetGroupName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>TargetNameFormat</maml:name> <maml:description> <maml:para>Format to use for target (ex. storage system port) alias names. The following built-in variables can be used: {storageSystemName}, {targetName}. Example: "Target_{storageSystemName}_{targetName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>UpdateInitiatorAliases</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>UpdateTargetAliases</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>UpdateTargetGroupAliases</maml:name> <maml:description> <maml:para>When Enabled (True), target and target group aliases will be updated in the SAN whenever resources are renamed in OneView.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>UpdateZoneNames</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>ZoneNameFormat</maml:name> <maml:description> <maml:para>Format to use when naming new and updated zones. The following built-in variables can be used: {hostName}, {initiatorName}, {initiatorWwn}, {storageSystemName}, {targetName}, {targetGroupName} Example: "{initiatorWwn}_{initiatorName}"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="DisableAlias, Disable, Enable" aliases="None"> <maml:name>ZoningPolicy</maml:name> <maml:description> <maml:para>Policy setting that affects the way that zones are created. Allowed values: * NoZoning - Disable all automated zoning on the SAN and ignore policy settings related to zoning. * SingleInitiatorAllTargets - Create one zone per initiator containing all targets connected to that initiator. * SingleInitiatorSingleStorageSystem - Similar to SingleInitiatorAllTargets except that separate zones are created for targets that reside on different storage systems.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>SingleInitiatorAllTargets</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collection.ArrayList <HPOneView.Storage.ManagedSan></maml:name> </dev:type> <maml:description> <maml:para>Multiple Resources</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single Resource</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Resources</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>Set-HPOVManagedSan Fabric_A -ZoningPolicy SingleInitiatorAllTargets</dev:code> <dev:remarks> <dev:para>Enable Automated SAN Zoning for "Fabric_A"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVManagedSan Fabric_A -ZoningPolicy NoZoning</dev:code> <dev:remarks> <dev:para>Disable Automated SAN Zoning for "Fabric_A"</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVManagedSan | Set-HPOVManagedSan -ZoningPolicy SingleInitiatorAllTargets</dev:code> <dev:remarks> <dev:para>Enable Automated SAN Zoning for all managed SAN Fabrics</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVManagedSan</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVNETWORK--> <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"> <!--SET-HPOVNETWORK--> <command:details> <command:name>Set-HPOVNetwork</command:name> <maml:description> <maml:para>Modify an existing network.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVNetwork</command:noun> </command:details> <maml:description> <maml:para>Modify a network and it"s attributes information. Use this Cmdlet to change the Network Name, Purpose, Enable or Disable Smartlink, Enable or Disable Private Network, and adjust the allocated bandwidth.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource object of the network to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Name</maml:name> <maml:description> <maml:para>The network resource"s new Name value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>A description of the network"s role within the logical interconnect. Accepted values in string format are: * General * Management * VMMigration * FaultTolerance</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>Smartlink</maml:name> <maml:description> <maml:para>Enable or Disable Smartlink within the Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>PrivateNetwork</maml:name> <maml:description> <maml:para>Enable or Disable Private Network within the Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection, expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is 20Gbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>IPv4Subnet</maml:name> <maml:description> <maml:para>Use to specify the one IPv4 subnet the network should be associated with from Get-HPOVAddressPoolSubnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>IPv6Subnet</maml:name> <maml:description> <maml:para>Use to specify the one IPv6 subnet the network should be associated with from Get-HPOVAddressPoolSubnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVNetwork</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource object of the network to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Name</maml:name> <maml:description> <maml:para>The network resource"s new Name value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection, expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is 20Gbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel"> <maml:name>LinkStabilityTime</maml:name> <maml:description> <maml:para>The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly). Parameter is only supported with FibreChannel network resources. Minimum Value: 1 Maximum Value: 1800</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel"> <maml:name>AutoLoginRedistribution</maml:name> <maml:description> <maml:para>Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available). Parameter is only supported with FibreChannel network resources. True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>Managed SAN Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel" aliases="ald"> <maml:name>AutoLoginRedistribution</maml:name> <maml:description> <maml:para>Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available). Parameter is only supported with FibreChannel network resources. True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>IPv4Subnet</maml:name> <maml:description> <maml:para>Use to specify the one IPv4 subnet the network should be associated with from Get-HPOVAddressPoolSubnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>IPv6Subnet</maml:name> <maml:description> <maml:para>Use to specify the one IPv6 subnet the network should be associated with from Get-HPOVAddressPoolSubnet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet" aliases="net, Network"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource object of the network to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel" aliases="lst"> <maml:name>LinkStabilityTime</maml:name> <maml:description> <maml:para>The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly). Parameter is only supported with FibreChannel network resources. Minimum Value: 1 Maximum Value: 1800</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel" aliases="None"> <maml:name>ManagedSan</maml:name> <maml:description> <maml:para>Managed SAN Name or URI.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection, expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is 20Gbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The network resource"s new Name value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>PrivateNetwork</maml:name> <maml:description> <maml:para>Enable or Disable Private Network within the Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>A description of the network"s role within the logical interconnect. Accepted values in string format are: * General * Management * VMMigration * FaultTolerance</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>Smartlink</maml:name> <maml:description> <maml:para>Enable or Disable Smartlink within the Ethernet Network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>Suffix</maml:name> <maml:description> <maml:para>Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal name. Use the -Name parameter to adjust the entire name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.EthernetNetwork [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Ethernet Network resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.FCNetwork [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>FC Network resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.FCoENetwork [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>FCoE Network resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Update Network Resource Task object</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>Get-HPOVNetwork -Name "Net-11" | Set-HPOVNetwork -name NewNet-11 -Purpose Management -SmartLink $true -PrivateNetwork $false -TypicalBandwidth 500 -MaximumBandwidth 1500 | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Get the "Net-11" Ethernet Network, pipe it to Set-HPOVNetwork to update values.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$fabricAManagedSan = Get-HPOVManagedSan -Name "Fabric A" Get-HPOVNetwork -Name "Prod Fabric A" | Set-HPOVNetwork -ManagedSan $fabricAManagedSan | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Update "Prod Fabric A" FC Network with "Fabric a" Managed SAN resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$NewSuffix = "-prod A" Get-HPOVNetwork -type Ethernet | Set-HPOVNetwork -Suffix $NewSuffix</dev:code> <dev:remarks> <dev:para>Get all Ethernet networks, and add a Suffix to their names.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetwork</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVNETWORKSET--> <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"> <!--SET-HPOVNETWORKSET--> <command:details> <command:name>Set-HPOVNetworkSet</command:name> <maml:description> <maml:para>Modify an existing network set.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVNetworkSet</command:noun> </command:details> <maml:description> <maml:para>A network set is a group of Ethernet L2/L3 networks assigned to one or more connections, giving each single connection access to multiple networks. A network set is a shared resource available to all logical interconnects. It is directly associated with a connection template governing the bandwidth permitted to connections that use the network set. Within a network set, all network frames are exchanged over the connection with their 802.1Q VLAN ID in place (in other words, network traffic is tagged with its VLAN ID). However, there is one exception to this rule: one network within the network set can be designated as the 'UntaggedNetwork', or Native VLAN. The 802.1Q VLAN ID is removed from 'UntaggedNetwork' traffic egressing the interconnect downlink (in other words, 'UntaggedNetwork' traffic is untagged). This allows a single connection to support multiple tagged networks plus a single untagged network over the same downlink. All Ethernet networks in a network set must have unique VLAN IDs. Use this Cmdlet to change the Name, add or remove Ethernet networks, switch to a Large network set resource, what is the untagged network and adjust the allocated bandwidth of an existing network set. Minimum required permissions: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVNetworkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Network Set resource object to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The updated name value of the Network Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Networks</maml:name> <maml:description> <maml:para>An array containing the updated list of networks. May contain Network objects, names or URI"s.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>AddNetwork</maml:name> <maml:description> <maml:para>Specify 1 or more network resources to add to the specified network set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>RemoveNetwork</maml:name> <maml:description> <maml:para>Specify 1 or more network resources to remove from the specified network set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>The Name or URI of the Untaggged, or Native Network for the Network Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>The updated Typical or Preferred bandwidth, in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>The updated MAximum bandwidth, in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Large</maml:name> <maml:description> <maml:para>A "Regular" network set (-Large:$False) may contain up to 162 networks. "Large" network sets can contain up to 4000 networks and can only be used by server profile template connections or server profile connections assigned to rackmount or HPE Synergy server hardware. A network set cannot be converted from regular to large if the network set is already in use by a server profile or server profile template. By default, "Regular" Network Sets are created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="None"> <maml:name>AddNetwork</maml:name> <maml:description> <maml:para>Specify 1 or more network resources to add to the specified network set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="8" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="NetSet, NetworkSet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Network Set resource object to be modified.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Large</maml:name> <maml:description> <maml:para>A "Regular" network set (-Large:$False) may contain up to 162 networks. "Large" network sets can contain up to 4000 networks and can only be used by server profile template connections or server profile connections assigned to rackmount or HPE Synergy server hardware. A network set cannot be converted from regular to large if the network set is already in use by a server profile or server profile template. By default, "Regular" Network Sets are created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="7" parameterSetName="(All)" aliases="None"> <maml:name>MaximumBandwidth</maml:name> <maml:description> <maml:para>The updated MAximum bandwidth, in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The updated name value of the Network Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Networks</maml:name> <maml:description> <maml:para>An array containing the updated list of networks. May contain Network objects, names or URI"s.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="4" parameterSetName="(All)" aliases="None"> <maml:name>RemoveNetwork</maml:name> <maml:description> <maml:para>Specify 1 or more network resources to remove from the specified network set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="6" parameterSetName="(All)" aliases="None"> <maml:name>TypicalBandwidth</maml:name> <maml:description> <maml:para>The updated Typical or Preferred bandwidth, in Mbps.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="5" parameterSetName="(All)" aliases="untagged, native, untaggedNetworkUri"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>The Name or URI of the Untaggged, or Native Network for the Network Set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.NetworkSet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Network Set resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Update Network Set resource task</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>$netset = Get-HPOVNetworkSet -Name "Set-1" $netset.maximumBandwidth = 5000 $netset.typicalBandwidth = 3000 Set-HPOVNetworkSet $netset</dev:code> <dev:remarks> <dev:para>Modify "Set-1" to be maximum bandwidth of 5000.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVNetworkSet -Name NetSet-1 | Set-HPOVNetworkSet -name NewNetSet-1 -networks @(bluenet,rednet,greennet) -untagged bluenet</dev:code> <dev:remarks> <dev:para>Update "NetSet-1" with a new name, adjust the networks, and set "bluenet" as the Untagged Network.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$NetworkToAdd = Get-HPOVNetwork -Name "Prod 442 VLAN" Get-HPOVNetworkSet -Name NetSet-1 | Set-HPOVNetworkSet -AddNetwork $NetworkToAdd</dev:code> <dev:remarks> <dev:para>Add the specified network to the existing network set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$NetworksToRemove = Get-HPOVNetwork -Name "Dev 45*" Get-HPOVNetworkSet -Name NetSet-2 | Set-HPOVNetworkSet -RemoveNetwork $NetworksToRemove</dev:code> <dev:remarks> <dev:para>Remove the specified networks from the existing network set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVNetworkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVRACKMEMBERLOCATION--> <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"> <!--SET-HPOVRACKMEMBERLOCATION--> <command:details> <command:name>Set-HPOVRackMemberLocation</command:name> <maml:description> <maml:para>Modify an existing rack member U location.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRackMemberLocation</command:noun> </command:details> <maml:description> <maml:para>A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices, and unmanaged devices (an unmanaged device uses slots in the rack and consumes power or exhausts heat, but it is not managed by the appliance). You can manage your racks and the equipment in them by adding them to the appliance. Having your racks managed by the appliance enables you to use the appliance for space and power planning. The appliance also gathers statistical data and monitors the power and temperature of the racks it manages. When you add an enclosure to the appliance, it automatically creates a rack and places the enclosure in it. The appliance places into the rack all enclosures connected by management link cables. When enclosures are added, the appliance places them in the rack from top to bottom. When an enclosure is placed in an Intelligent Series Rack, the enclosure slots are automatically detected. For other racks, to accurately depict the layout of your enclosures within the rack you must edit the rack to place the enclosure in the proper slots. You can use the appliance to view and manage your rack configuration and power delivery topology. You can specify the physical dimensions of the rack (width, height, and depth), the number of U slots, and the location of each piece of equipment in the rack. You can specify the rack PDUs that provide power to the rack, and their physical position in the rack or on either side. You can also describe how the devices in the rack are connected to those PDUs. The appliance automatically discovers the rack height and rack model for a ProLiant server with Location Discovery Services and updates the physical locations of devices when they are relocated within and between racks for c7000 enclosures. This Cmdlet will modify an existing rack member U Location within the rack it is located.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRackMemberLocation</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The rack member to modify from Get-HPOVRackMember.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Facilities.RackMember</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ULocation</maml:name> <maml:description> <maml:para>The new Rack Unit location where the resource is located.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The rack member to modify from Get-HPOVRackMember.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Facilities.RackMember</command:parameterValue> <dev:type> <maml:name>HPOneView.Facilities.RackMember</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ULocation</maml:name> <maml:description> <maml:para>The new Rack Unit location where the resource is located.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Facilities.RackMember</maml:name> </dev:type> <maml:description> <maml:para>DataCenter facility object from Get-HPOVDataCenter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Facilities.RackMember</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Modified rack member object with the updated Rack Unit location.</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>$RackMember = Get-HPOVRack -Name "Rack-221" -ErrorAction Stop | Get-HPOVRackMember -Name "DL380 1" -ErrorAction Stop Set-HPOVRackMemberLocation -InputObject $RackMember -ULocation ($RackMember.ULocation + 5)</dev:code> <dev:remarks> <dev:para>Update the "DL380 1" rack member raising its current rack unit location by 5.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORT--> <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"> <!--SET-HPOVREMOTESUPPORT--> <command:details> <command:name>Set-HPOVRemoteSupport</command:name> <maml:description> <maml:para>Configure Remote Support and authorize appliance.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupport</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Eligible devices are Gen8 and newer blades and enclosures. NOTE: Servers must be at iLO 2.1 firmware level or above to be enabled for remote support Hewlett Packard Enterprise will contact you to ship a replacement part or send an engineer for devices that are under warranty or support contract. Remote support enables Proactive Care services including Proactive Scan reports and Firmware/Software Analysis reports with recommendations that are based on collected configuration data. Remote support is secure. No business data is collected, only device-specific configuration and fault data. All communications are outbound only and use industry standard TLS encryption ensuring confidentiality and integrity of the information. Once the appliance is configured, it cannot be unauthorized or disabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>The company name Remote Support will be authorized for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>OptimizeOptIn</maml:name> <maml:description> <maml:para>Opt-in to allow HPE marketing to discuss datacenter optimization.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>AutoEnableDevices</maml:name> <maml:description> <maml:para>Choose to allow the appliance to auto enable remote support for all and devices added in the future.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>The company name Remote Support will be authorized for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline"> <maml:name>InsightOnlineUsername</maml:name> <maml:description> <maml:para>The user name of your Insight Online account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline"> <maml:name>InsightOnlinePassword</maml:name> <maml:description> <maml:para>The Insight Online account password.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>OptimizeOptIn</maml:name> <maml:description> <maml:para>Opt-in to allow HPE marketing to discuss datacenter optimization.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default"> <maml:name>AutoEnableDevices</maml:name> <maml:description> <maml:para>Choose to allow the appliance to auto enable remote support for all and devices added in the future.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Use this parameter to enable remote support on an appliance, only if the appliance was previously configured for Remote Support and it was disabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Use this parameter to disable remote support globally on the appliance. Use the -Enable parameter to re-enable Remote Support.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable, InsightOnline, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default" aliases="None"> <maml:name>AutoEnableDevices</maml:name> <maml:description> <maml:para>Choose to allow the appliance to auto enable remote support for all and devices added in the future.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default" aliases="None"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>The company name Remote Support will be authorized for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="None"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Use this parameter to disable remote support globally on the appliance. Use the -Enable parameter to re-enable Remote Support.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Use this parameter to enable remote support on an appliance, only if the appliance was previously configured for Remote Support and it was disabled.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline" aliases="None"> <maml:name>InsightOnlinePassword</maml:name> <maml:description> <maml:para>The Insight Online account password.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline" aliases="None"> <maml:name>InsightOnlineUsername</maml:name> <maml:description> <maml:para>The user name of your Insight Online account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InsightOnline, Default" aliases="None"> <maml:name>OptimizeOptIn</maml:name> <maml:description> <maml:para>Opt-in to allow HPE marketing to discuss datacenter optimization.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupportConfig [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The appliance Remote Support configuration applied.</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>Set-HPOVRemoteSupport -CompanyName MyCompany</dev:code> <dev:remarks> <dev:para>Configure and register the appliance for Remote Support.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVRemoteSupport -CompanyName MyCompany -InsightOnlineUsername mypassport@domain.local -InsightOnlinePassword (ConvertTo-SecureString -String MyPassword -AsPlainText -Force)</dev:code> <dev:remarks> <dev:para>Configure and register the appliance for Remote Support, and enable Insight Online portal registration.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVRemoteSupport -Disable</dev:code> <dev:remarks> <dev:para>Disable Remote Support on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVRemoteSupport -Enable -ApplianceConnection $Appliance2</dev:code> <dev:remarks> <dev:para>Enable Remote Support after it was previously disabled for the specific appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRemoteSupportPartner</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVRemoteSupportCollection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVRemoteSupportEntitlement</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORTDATACOLLECTIONSCHEDULE--> <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"> <!--SET-HPOVREMOTESUPPORTDATACOLLECTIONSCHEDULE--> <command:details> <command:name>Set-HPOVRemoteSupportDataCollectionSchedule</command:name> <maml:description> <maml:para>Modify Remote Support Schedule settings on an appliance.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupportDataCollectionSchedule</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to set a new schedule to collect Remote Support logs. There are two defined schedules: Active Health scheduled on a weekly basis, and Server Basic Configuration scheduled on a monthly basis. Either scheduled collection task can be modified, to set the Day of Week, Day of Month, Hour and Minute. When supplying a DateTime value, the Day will be converted to the Day of Month, and Day of the Week respectively. For instance, if "Oct 30, 2016 13:00" is provided, Day of Month will be every "30th" day, and Day of Week will be every "Sunday" (which Oct 30th 2016 is a Sunday). To schedule different Day of the Month and Day of the Week, use the -Type paramter to specify AHS or Basic. The -DateTime paramter value will only be applied to that schedule.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportDataCollectionSchedule</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Specify a DateTime value for the schedule to execute. AHS schedule is executed on a weekly basis, and Server Basic Configuration is executed on a monthly basis. When needing to configure a schedule for AHS log collection, the Month Day"s week day name will be used. For instance, if "Oct 30, 2016" is provided and scheduling for AHS log collection, the task will execute every Sunday, which October 30th 2016 is on a Sunday. When providing the hour of the day to execute, the value must be in 24hr time.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">DateTime</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the schedule type to modify. Allowed value is: * AHS *Basic If no value is provided, both schedules will be modified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>DateTime</maml:name> <maml:description> <maml:para>Specify a DateTime value for the schedule to execute. AHS schedule is executed on a weekly basis, and Server Basic Configuration is executed on a monthly basis. When needing to configure a schedule for AHS log collection, the Month Day"s week day name will be used. For instance, if "Oct 30, 2016" is provided and scheduling for AHS log collection, the task will execute every Sunday, which October 30th 2016 is on a Sunday. When providing the hour of the day to execute, the value must be in 24hr time.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specify the schedule type to modify. Allowed value is: * AHS *Basic If no value is provided, both schedules will be modified.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for modifying the Remote Support Collection schedules.</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>Set-HPOVRemoteSupportDataCollectionSchedule -DateTime "11/01/2016 20:00"</dev:code> <dev:remarks> <dev:para>Set a new Remote Support schedule for November 11, 2016, which is a Monday, at 20:00 (8:00pm).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVRemoteSupportDataCollectionSchedule -Type AHS -DateTime "11/01/2016 20:00"</dev:code> <dev:remarks> <dev:para>Set a new schedule to collect AHS logs every Monday of every week, at 20:00 (8:00pm).</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDataCollectionSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORTDEFAULTSITE--> <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"> <!--SET-HPOVREMOTESUPPORTDEFAULTSITE--> <command:details> <command:name>Set-HPOVRemoteSupportDefaultSite</command:name> <maml:description> <maml:para>Define the Remote Support Default Site.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupportDefaultSite</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to set the default data center site used for Remote Support. All resources defined will use this data center site.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportDefaultSite</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AddressLine1</maml:name> <maml:description> <maml:para>Aliases [-a1] Primary Address line 1.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>City</maml:name> <maml:description> <maml:para>City.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>State</maml:name> <maml:description> <maml:para>Aliases [-Provence] State or Provence.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Country</maml:name> <maml:description> <maml:para>2-letter country code.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Timezone of the data center, in ISO-3166 location format (e.g. US/Central).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AddressLine2</maml:name> <maml:description> <maml:para>Aliases [-a2] Primary Address line 2.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PostalCode</maml:name> <maml:description> <maml:para>Postal or zip code.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="a1"> <maml:name>AddressLine1</maml:name> <maml:description> <maml:para>Aliases [-a1] Primary Address line 1.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="a2"> <maml:name>AddressLine2</maml:name> <maml:description> <maml:para>Aliases [-a2] Primary Address line 2.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>City</maml:name> <maml:description> <maml:para>City.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Country</maml:name> <maml:description> <maml:para>2-letter country code.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PostalCode</maml:name> <maml:description> <maml:para>Postal or zip code.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Province"> <maml:name>State</maml:name> <maml:description> <maml:para>Aliases [-Provence] State or Provence.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Timezone of the data center, in ISO-3166 location format (e.g. US/Central).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Configured Remote Support default site.</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>Set-HPOVRemoteSupportDefaultSite -AddressLine1 "3000 Hanover St." -City "Palo Alto" -State CA -PostalCode 94304 -Country US -TimeZone "US/Pacific"</dev:code> <dev:remarks> <dev:para>Get the configured Remote Support default site.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportDefaultSite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORTPRIMARYCONTACT--> <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"> <!--SET-HPOVREMOTESUPPORTPRIMARYCONTACT--> <command:details> <command:name>Set-HPOVRemoteSupportPrimaryContact</command:name> <maml:description> <maml:para>Set HPE OneView Remote Support default primary contact.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupportPrimaryContact</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Use this Cmdlet to change or update the HPE OneView Remote Support primary Contact. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportPrimaryContact</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE OneView Remote Support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Contact"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE OneView Remote Support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Contact [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Remote support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>$PrimaryContact = Get-HPOVRemoteSupportContact -Name "Bob Smith" Set-HPOVRemoteSupportPrimaryContact -InputObject $PrimaryContact</dev:code> <dev:remarks> <dev:para>Set a new HPE OneView Remote Support primary contact on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportSecondaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORTSECONDARYCONTACT--> <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"> <!--SET-HPOVREMOTESUPPORTSECONDARYCONTACT--> <command:details> <command:name>Set-HPOVRemoteSupportSecondaryContact</command:name> <maml:description> <maml:para>Set HPE OneView Remote Support default secondary contact.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupportSecondaryContact</command:noun> </command:details> <maml:description> <maml:para>Register with Hewlett Packard Enterprise to allow automatic case creation for hardware failures on servers and enclosures and to enable Proactive Care. Once enabled, all eligible devices added in the future will be automatically enabled for remote support. Use this Cmdlet to change or update the HPE OneView Remote Support secondary Contact. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportSecondaryContact</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE OneView Remote Support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Contact"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPE OneView Remote Support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.RemoteSupport.Contact [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Remote support contact from Get-HPOVRemoteSupportContact.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>$PrimaryContact = Get-HPOVRemoteSupportContact -Name "Susan Jones" Set-HPOVRemoteSupportSecondaryContact -InputObject $SecondaryContact</dev:code> <dev:remarks> <dev:para>Set a new HPE OneView Remote Support secondary contact on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVRemoteSupportPrimaryContact</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESUPPORTSETTING--> <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"> <!--SET-HPOVREMOTESUPPORTSETTING--> <command:details> <command:name>Set-HPOVRemoteSupportSetting</command:name> <maml:description> <maml:para>Configure supported resource Remote Support settings.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSupportSetting</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to configure a supported resources Remote Support collection settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportSetting</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Disable, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact user object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact user object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ServicePartner</maml:name> <maml:description> <maml:para>Authorized HPE service partner object from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Reseller</maml:name> <maml:description> <maml:para>Authorized HPE reseller partner object from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ContractType</maml:name> <maml:description> <maml:para>Use to override the contract type. If specifying a different contract type, you must supply the SupportID. Allowed values are: * SupportAgreement * PackagedSupport.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>The support Contract ID. You must specify the type of contract by using the -ContractType parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NewSerialNumber</maml:name> <maml:description> <maml:para>Use to update the HPE support backend with an updated serial number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>NewProductNumber</maml:name> <maml:description> <maml:para>Use to update the HPE support backend with an updated product number</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Use to enable HPE OneView Remote Support configuration on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVRemoteSupportSetting</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Disable, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Use to disable HPE OneView Remote Support configuration on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Disable, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Disable, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ContractType</maml:name> <maml:description> <maml:para>Use to override the contract type. If specifying a different contract type, you must supply the SupportID. Allowed values are: * SupportAgreement * PackagedSupport.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="None"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Use to disable HPE OneView Remote Support configuration on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Use to enable HPE OneView Remote Support configuration on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Disable, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Server Hardware or Enclosure resource to get the configured Remote Support collection settings.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NewProductNumber</maml:name> <maml:description> <maml:para>Use to update the HPE support backend with an updated product number</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>NewSerialNumber</maml:name> <maml:description> <maml:para>Use to update the HPE support backend with an updated serial number.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>PrimaryContact</maml:name> <maml:description> <maml:para>Primary Remote Support Contact user object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Reseller</maml:name> <maml:description> <maml:para>Authorized HPE reseller partner object from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SecondaryContact</maml:name> <maml:description> <maml:para>Secondary Remote Support Contact user object.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ServicePartner</maml:name> <maml:description> <maml:para>Authorized HPE service partner object from Get-HPOVRemoteSupportPartner.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SupportID</maml:name> <maml:description> <maml:para>The support Contract ID. You must specify the type of contract by using the -ContractType parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server hardware resource object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Enclosure resource object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>$NewReseller = Get-HPOVRemoteSupportContact -Name "New Reseller Name" Get-HPOVEnclosure -Name Encl1 | Set-HPOVRemoteSupportSetting -Reseller $NewReseller</dev:code> <dev:remarks> <dev:para>Update "Encl1" with a new reseller contact that was added to the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name Prd-host-* | Set-HPOVRemoteSupportSetting -ContractType SupportAgreement -SupportID 111199990 </dev:code> <dev:remarks> <dev:para>Update the servers with a new support agreement.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PrimaryContact = Get-HPOVRemoteSupportContact -Name "Gladi Chua" $SecondaryContact = Get-HPOVRemoteSupportContact -Name "Luke Smith" Get-HPOVEnclosure -Name Prod* | Set-HPOVRemoteSupportSetting -PrimaryContact $PrimaryContact -SecondaryContact $SecondaryContact -Async -OutVariable Tasks</dev:code> <dev:remarks> <dev:para>Update the Enclosures with new primary and secondary contacts, returning async tasks to monitor using the OutVariable Common Parameter.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVREMOTESYSLOG--> <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"> <!--SET-HPOVREMOTESYSLOG--> <command:details> <command:name>Set-HPOVRemoteSyslog</command:name> <maml:description> <maml:para>Configure remote syslog.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVRemoteSyslog</command:noun> </command:details> <maml:description> <maml:para>The remoteSyslog API provides the ability to configure remote logging on devices managed by OneView. This Cmdlet handles setting or updating the remote syslog configuration. Only a single destination can be set. When configured, the HPE OneView appliance will deploy the SysLog settings to managed resources automatically.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVRemoteSyslog</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Destination IPv4 Address of the Remote SysLog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>The destination TCP port. Default value: 514</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SendTestMessage</maml:name> <maml:description> <maml:para>Use to generate a syslog test message after the managed endpoint has finished configuring.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Destination IPv4 Address of the Remote SysLog.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>The destination TCP port. Default value: 514</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>514</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SendTestMessage</maml:name> <maml:description> <maml:para>Use to generate a syslog test message after the managed endpoint has finished configuring.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns Appliance Async Task object to monitor</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Appliance Async Task objects to monitor</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>Set-HPOVRemoteSyslog -Destination 10.150.20.1 -SendTestMessage -Async | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Set the remote syslog to the provided destination, using the default destination TCP port, and send a test message for all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSyslog</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVRESERVEDVLANRANGE--> <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"> <!--SET-HPOVRESERVEDVLANRANGE--> <command:details> <command:name>Set-HPOVReservedVlanRange</command:name> <maml:description> <maml:para>Modify the reserved VLAN range for HPE Synergy.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVReservedVlanRange</command:noun> </command:details> <maml:description> <maml:para>A reserved VLAN pool is a range of VLANs used for allocation of non-tagged networks: * Tunnel * Untagged Tagged networks and FCoE networks use VLANs outside of the reserved pool. You cannot use a reserved VLAN for tagged or FCoE networks. The VLAN pool allows the number of available VLANs to be segregated between tagged and non-tagged networks. Because non-tagged networks use VLANs for internal translation resources, a reserved VLAN pool can provide a sufficient number of VLANs available for allocation of those internal VLANs. In addition, the reserved pool range removes the need for translation resources to be used on tagged networks. For the maximum number of VLANs per physical downlink port, see the HPE OneView Support Matrix for HPE Synergy. Creating and managing a reserved VLAN pool A reserved VLAN pool is unique within a fabric, but independently allocated within each logical interconnect. The reserved range is identical across all logical interconnects within a fabric. The remaining VLANs (outside of the pool) are shared among all the logical interconnects within the fabric. For HPE OneView running embedded on a HPE Synergy 12000 Frame, the default range starts at 3967 and the size is 128. The minimum size of the pool must be 60 VLANs to ensure the pool is not exhausted. The size of the pool cannot exceed 128 VLANs. Minimum required privileges: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVReservedVlanRange</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Start</maml:name> <maml:description> <maml:para>The starting VLAN ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Length</maml:name> <maml:description> <maml:para>Must not exceed 128.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Length</maml:name> <maml:description> <maml:para>Must not exceed 128.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Start</maml:name> <maml:description> <maml:para>The starting VLAN ID.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Set-HPOVReservedVlanRange -Start 2700 -Length 128</dev:code> <dev:remarks> <dev:para>Change the reserved VLAN range to start at 2700, and end at 2828.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVReservedVlanRange</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVRESOURCE--> <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"> <!--SET-HPOVRESOURCE--> <command:details> <command:name>Set-HPOVResource</command:name> <maml:description> <maml:para>Update existing resource(s).</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVResource</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will assist the user to update an existing resource. The resource should first be retrieved with a "Get-HPOV[resourcename]" Cmdlet. The PowerShell resource may then be modified, followed by this "Set-HPOVResource" Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVResource</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The modified resource that is to be updated. Can be resource object, name or URI.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to $true to force-update the resource. Not all resources support force-update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Set to $true to force-update the resource. Not all resources support force-update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The modified resource that is to be updated. Can be resource object, name or URI.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Resource Object to modify by either using Send-HPOVRequest with the resource URI, or the resource GET Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The modified resource or async task depending on the resource being modified</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>$profile = Get-HPOVServerProfile "Profile 1" $profile.name = "New Name" Set-HPOVResource $profile</dev:code> <dev:remarks> <dev:para>Updates the name of the Server Profile resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToRack</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPOVResourceToScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResource</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromLabel</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVResourceFromScope</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSANMANAGER--> <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"> <!--SET-HPOVSANMANAGER--> <command:details> <command:name>Set-HPOVSanManager</command:name> <maml:description> <maml:para>Update SAN Manager configuration</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVSanManager</command:noun> </command:details> <maml:description> <maml:para>Updates an existing SAN Manager configuration. Can update the hostname/IP Address and credentials. At least one optional parameter must be provided.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="BNA, HPCisco"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource Object (from Get-HPOVSanManager) or Name of the SAN Manager to update. If specifying a resource Name, the ApplianceConnection parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Username</maml:name> <maml:description> <maml:para>Updated Username used to authenticate and manage the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Password</maml:name> <maml:description> <maml:para>Updated Password used to authenticate and manage the SAN Manager. Can either be a String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Updated Hostname or IP Address of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Port</maml:name> <maml:description> <maml:para>Updated TCP Port of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA"> <maml:name>EnableSsl</maml:name> <maml:description> <maml:para>Enable Secure WBEM communications to Brocade SAN Network Advisor.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA"> <maml:name>DisableSsl</maml:name> <maml:description> <maml:para>Enable Secure WBEM communications to Brocade SAN Network Advisor.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="BNA, HPCisco"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="BNA, HPCisco"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource Object (from Get-HPOVSanManager) or Name of the SAN Manager to update. If specifying a resource Name, the ApplianceConnection parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Username</maml:name> <maml:description> <maml:para>Updated Username used to authenticate and manage the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Password</maml:name> <maml:description> <maml:para>Updated Password used to authenticate and manage the SAN Manager. Can either be a String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Updated Hostname or IP Address of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Port</maml:name> <maml:description> <maml:para>Updated TCP Port of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>The SNMPv3 Community User Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>The SNMPv3 Authentication Level. Allowed values are: * None - No Security is required, only the SNMPv3 UserName is provided. * AuthOnly - SNMPv3 Authentication Encryption Security Level only. Must also provide -SnmpAuthProtocol and -SnmpAuthPassword parameters. * AuthAndPriv - SNMPv3 Authentication Encryption Security and Privacy Levels. Must also provide -SnmpAuthProtocol, -SnmpAuthPassword, -SnmpPrivProtocol and -SnmpPrivPassword parameters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Password Encryption Protocol. Allowed values are: * SHA * MD5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 UserName Password. Can either be a System.String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Protocol. Allowed values are: * AES * DES</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Encryption Password. Can either be a System.String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="BNA, HPCisco"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used. Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA" aliases="None"> <maml:name>DisableSsl</maml:name> <maml:description> <maml:para>Enable Secure WBEM communications to Brocade SAN Network Advisor.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA" aliases="None"> <maml:name>EnableSsl</maml:name> <maml:description> <maml:para>Enable Secure WBEM communications to Brocade SAN Network Advisor.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Updated Hostname or IP Address of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="BNA, HPCisco" aliases="name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Resource Object (from Get-HPOVSanManager) or Name of the SAN Manager to update. If specifying a resource Name, the ApplianceConnection parameter is required.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Updated Password used to authenticate and manage the SAN Manager. Can either be a String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Updated TCP Port of the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthLevel</maml:name> <maml:description> <maml:para>The SNMPv3 Authentication Level. Allowed values are: * None - No Security is required, only the SNMPv3 UserName is provided. * AuthOnly - SNMPv3 Authentication Encryption Security Level only. Must also provide -SnmpAuthProtocol and -SnmpAuthPassword parameters. * AuthAndPriv - SNMPv3 Authentication Encryption Security and Privacy Levels. Must also provide -SnmpAuthProtocol, -SnmpAuthPassword, -SnmpPrivProtocol and -SnmpPrivPassword parameters.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthPassword</maml:name> <maml:description> <maml:para>SNMPv3 UserName Password. Can either be a System.String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpAuthProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Password Encryption Protocol. Allowed values are: * SHA * MD5</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpPrivPassword</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Encryption Password. Can either be a System.String or System.Security.SecureString value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpPrivProtocol</maml:name> <maml:description> <maml:para>SNMPv3 Privacy Protocol. Allowed values are: * AES * DES</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="HPCisco" aliases="None"> <maml:name>SnmpUserName</maml:name> <maml:description> <maml:para>The SNMPv3 Community User Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="BNA, HPCisco" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Updated Username used to authenticate and manage the SAN Manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.SanManager [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>SAN Manager resource from Get-HPOVSanManager</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Update async task</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>$task = Get-HPOVSanManager bna.domain.com -ApplianceConnection hpov.domain.com | Set-HPOVSanManager -hostname bna.newdomain.com | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Get the SAN Manager using Get-HPOVSanManager, and pipling the resource in order to update the hostname value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$task = Set-HPOVSanManager -name BNA.contoso.com -hostname bna.newdomain.com -ApplianceConnection hpov.domain.com | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Update the existing Brocade Network Advisor SAN Manager"s hostname with the new value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$task = Set-HPOVSanManager -name BNA.contoso.com -username newadmin -password updatedpassword -ApplianceConnection hpov.domain.com | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Update the existing Brocade Network Advisor SAN Manager"s username and password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSERVERHARDWARETYPE--> <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"> <!--SET-HPOVSERVERHARDWARETYPE--> <command:details> <command:name>Set-HPOVServerHardwareType</command:name> <maml:description> <maml:para>Rename or set a description to a Server Hardware Type resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVServerHardwareType</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to rename or set a description to one or more Server Hardware Type resource(s). Minimum required privileges: Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVServerHardwareType</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.ServerHardwareType resource from Get-HPOVServerHardwareType.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Set a new name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set a new description.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set a new description.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.ServerHardwareType resource from Get-HPOVServerHardwareType.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Set a new name.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardwareType</maml:name> </dev:type> <maml:description> <maml:para>Resource from Get-HPOVServerHardwareType.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerHardwareType</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated resource object.</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>Get-HPOVServerHardwareType -Name "BL460c Gen9 1" -ErrorAction Stop | Set-HPOVServerHardwareType -Name "Corp Hypervisor Host Type"</dev:code> <dev:remarks> <dev:para>Rename the default "BL460c Gen9 1" server hardware type resource to a new name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSERVERONETIMEBOOT--> <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"> <!--SET-HPOVSERVERONETIMEBOOT--> <command:details> <command:name>Set-HPOVServerOneTimeBoot</command:name> <maml:description> <maml:para>Modify a servers current One Time Boot setting.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVServerOneTimeBoot</command:noun> </command:details> <maml:description> <maml:para>HPE OneView allows you to set a one-time boot option for the server hardware. You can set the one-time boot option to any of the following: * Keep current settings—Keeps the previously chosen settings. * No one-time boot—Normal boot is used when this option is selected. * PXE—Boots from the PXE server on the network. * Hard disk—Boots from the first local disk. * CD—Boots from a local or virtual optical drive. * USB—Boots from a physical or virtual USB drive. Other one-time boot options are available through the HPE iLO interface; however, HPE OneView offers only a common subset of one-time boot options. The one-time boot option requires the server hardware to be powered off and powered back on. If you set the one-time boot option while the server power is on, the one-time boot value is remembered until the server is powered off and then powered back on. HPE OneView does not support setting of the one-time boot option while the server is in power-on self-test (POST). After setting the one-time boot option, when the server hardware is powered off and powered on, HPE iLO attempts to boot the server using the selected boot option. If the selected boot option is not available, HPE iLO attempts to boot the server using the boot order defined in the server profile. After using or attempting to use the one-time boot value, the one-time boot value is reset to No one-time boot and the server boots using the boot order defined in its server profile or through HPE iLO. Minimum required privileges: Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVServerOneTimeBoot</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The server hardware or server profile resource object from Get-HPOVServer or Get-HPOVServerProfile. If providing a server profile resource, it must be assigned to a server in order for one time boot settings to be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Setting</maml:name> <maml:description> <maml:para>The intended one time boot setting. Allowed values: * Normal - Normal boot, or to disable one time boot on a server that has a different value set. * PXE - Network boot from the default PXE adapter device. * HDD - instruct the server to find the first bootable disk drive. * CD - instruct the server to boot from an available CD/DVD drive, including iLO Virtual Media * USB - boot from a USB removal storage device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>PowerOn</maml:name> <maml:description> <maml:para>If the server is already powered off, instruct OneView to power on the server once the one time boot setting has been applied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The server hardware or server profile resource object from Get-HPOVServer or Get-HPOVServerProfile. If providing a server profile resource, it must be assigned to a server in order for one time boot settings to be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="PowerState"> <maml:name>PowerOn</maml:name> <maml:description> <maml:para>If the server is already powered off, instruct OneView to power on the server once the one time boot setting has been applied.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Setting</maml:name> <maml:description> <maml:para>The intended one time boot setting. Allowed values: * Normal - Normal boot, or to disable one time boot on a server that has a different value set. * PXE - Network boot from the default PXE adapter device. * HDD - instruct the server to find the first bootable disk drive. * CD - instruct the server to boot from an available CD/DVD drive, including iLO Virtual Media * USB - boot from a USB removal storage device.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server profile resource object from Get-HPOVServerProfile.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVServer -Name MyServer1 | Set-HPOVServerOneTimeBoot -Setting PXE</dev:code> <dev:remarks> <dev:para>Set the specific server to PXE boot.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name MyServer* | ? powerState -eq On | Stop-HPOVServer -Confirm:$false Get-HPOVServer -Name MyServer* | Set-HPOVServerOneTimeBoot -Setting PXE -PowerOn</dev:code> <dev:remarks> <dev:para>Power off the servers that need to be powered off. The set those servers to PXE boot and power on.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer -Name MyOtherServer | Set-HPOVServerOneTimeBoot -Setting Normal</dev:code> <dev:remarks> <dev:para>Set the specified server to boot normally, clearing the one time boot value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSERVERPOWER--> <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"> <!--SET-HPOVSERVERPOWER--> <command:details> <command:name>Set-HPOVServerPower</command:name> <maml:description> <maml:para>[DEPRECATED] Set the power state of a server.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVServerPower</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is now deprecated. Please use the Start-HPOVServer, Stop-HPOVServer or Restart-HPOVServer Cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVServerPower</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server object, URI or Name, or can be a Server Profile object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>State</maml:name> <maml:description> <maml:para>Optional power state. Default is On, other option is Off</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>powerControl</maml:name> <maml:description> <maml:para>Optional setting to control the virtual power button.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>The name of the appliance or list of appliances to execute the command against.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="name, uri, serverUri"> <maml:name>Server</maml:name> <maml:description> <maml:para>The server object, URI or Name, or can be a Server Profile object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="PowerState"> <maml:name>State</maml:name> <maml:description> <maml:para>Optional power state. Default is On, other option is Off</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>On</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>powerControl</maml:name> <maml:description> <maml:para>Optional setting to control the virtual power button.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>MomentaryPress</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> None </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> None</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSMTPCONFIG--> <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"> <!--SET-HPOVSMTPCONFIG--> <command:details> <command:name>Set-HPOVSmtpConfig</command:name> <maml:description> <maml:para>Configure appliance SMTP Reporting settings.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVSmtpConfig</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet configures the SMTP settings for the appliance. SMTP settings include deining the Sender EMAIL Address, SMTP relay server address, SMTP relay server TCP port, optional password, and if SMTP alerting is enabled or disabled. Currently, HPE OneView does not support Secure SMTP, even though the TCP Port can be modified. Using the SmtpPort parameter is to specify an alternate TCP Port than the default TCP/25.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVSmtpConfig</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SenderEmailAddress</maml:name> <maml:description> <maml:para>Specify the Sender Email Address for the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify the SMTP Relay Server if DNS does not contain a valid DNS MX record for the sender email address domain name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Port</maml:name> <maml:description> <maml:para>Provide an alternate TCP port number than the default SMTP port value 25/TCP.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ConnectionSecurity</maml:name> <maml:description> <maml:para>Use to specify if the target SMTP server requires TLS security/authentication. Supported values: * None * TLS * StartTls</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide an SMTP Password to authenticate to the SMTP Server. This password will be sent in clear text to the SMTP server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>AlertEmailEnabled</maml:name> <maml:description> <maml:para>Enable SMTP Email Alerting</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVSmtpConfig</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled"> <maml:name>AlertEmailDisabled</maml:name> <maml:description> <maml:para>Disable SMTP Email Alerting.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled" aliases="None"> <maml:name>AlertEmailDisabled</maml:name> <maml:description> <maml:para>Disable SMTP Email Alerting.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>AlertEmailEnabled</maml:name> <maml:description> <maml:para>Enable SMTP Email Alerting</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disabled, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ConnectionSecurity</maml:name> <maml:description> <maml:para>Use to specify if the target SMTP server requires TLS security/authentication. Supported values: * None * TLS * StartTls</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide an SMTP Password to authenticate to the SMTP Server. This password will be sent in clear text to the SMTP server.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="SmtpPort"> <maml:name>Port</maml:name> <maml:description> <maml:para>Provide an alternate TCP port number than the default SMTP port value 25/TCP.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> </dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SenderEmailAddress</maml:name> <maml:description> <maml:para>Specify the Sender Email Address for the appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="SmtpServer"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specify the SMTP Relay Server if DNS does not contain a valid DNS MX record for the sender email address domain name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The finished Task object that includes the task result</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>Set-HPOVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled</dev:code> <dev:remarks> <dev:para>Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com" and enable SMTP Email Alerting.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled</dev:code> <dev:remarks> <dev:para>Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com" and enable SMTP Email Alerting.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -AlertEmailEnabled -ConnectionSecurity StartTls</dev:code> <dev:remarks> <dev:para>Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com", enabling SMTP Email Alerting and specifying StartTls connection security.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSMTPConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSNMPREADCOMMUNITY--> <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"> <!--SET-HPOVSNMPREADCOMMUNITY--> <command:details> <command:name>Set-HPOVSnmpReadCommunity</command:name> <maml:description> <maml:para>Set SNMP Read Community.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVSnmpReadCommunity</command:noun> </command:details> <maml:description> <maml:para>Set a new SNMP Read Community value on the appliance. Updating this value will cause the appliance to refresh the managed devices with the updated Read-Only SNMP Community string. This does not update the SNMP trap destination(s) for Logical Interconnects or Logical Interconnect Groups.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVSnmpReadCommunity</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new SNMP Read-Only Community.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new SNMP Read-Only Community.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> None</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>Set-HPOVSnmpReadCommunity -name "MySNMPC0mmunity"</dev:code> <dev:remarks> <dev:para>Set the appliance SNMP Read Community string to the new value.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVSnmpReadCommunity</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSTORAGEPOOL--> <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"> <!--SET-HPOVSTORAGEPOOL--> <command:details> <command:name>Set-HPOVStoragePool</command:name> <maml:description> <maml:para>Modify storage pool managed state.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVStoragePool</command:noun> </command:details> <maml:description> <maml:para>A reserved VLAN pool is a range of VLANs used for allocation of non-tagged networks: * Tunnel * Untagged Tagged networks and FCoE networks use VLANs outside of the reserved pool. You cannot use a reserved VLAN for tagged or FCoE networks. The VLAN pool allows the number of available VLANs to be segregated between tagged and non-tagged networks. Because non-tagged networks use VLANs for internal translation resources, a reserved VLAN pool can provide a sufficient number of VLANs available for allocation of those internal VLANs. In addition, the reserved pool range removes the need for translation resources to be used on tagged networks. For the maximum number of VLANs per physical downlink port, see the HPE OneView Support Matrix for HPE Synergy. Creating and managing a reserved VLAN pool A reserved VLAN pool is unique within a fabric, but independently allocated within each logical interconnect. The reserved range is identical across all logical interconnects within a fabric. The remaining VLANs (outside of the pool) are shared among all the logical interconnects within the fabric. For HPE OneView running embedded on a HPE Synergy 12000 Frame, the default range starts at 3967 and the size is 128. The minimum size of the pool must be 60 VLANs to ensure the pool is not exhausted. The size of the pool cannot exceed 128 VLANs. Minimum required privileges: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVStoragePool</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>One or more HPOneView.Storage.StoragePool resources from Get-HPOVStoragePool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.StoragePool[]</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify a boolean value to modify the storage pools managed state.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Pool"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>One or more HPOneView.Storage.StoragePool resources from Get-HPOVStoragePool.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.StoragePool[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.StoragePool[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify a boolean value to modify the storage pools managed state.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.StoragePool</maml:name> </dev:type> <maml:description> <maml:para>Storage pool resource(s) from Get-HPOVStoragePool.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>$StoragePool = Get-HPOVStoragePool -Name "r5_cpg1" -ErrorAction Stop Set-HPOVStoragePool -InputObject $StoragePool -Managed $true</dev:code> <dev:remarks> <dev:para>Manage the specified storage pool to provision volumes.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStoragePool -Name r5_* -ErrorAction Stop | Set-HPOVStoragePool -Managed $false</dev:code> <dev:remarks> <dev:para>Change the managed state to "unmanaged" of the specified storage pools.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSTORAGEVOLUME--> <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"> <!--SET-HPOVSTORAGEVOLUME--> <command:details> <command:name>Set-HPOVStorageVolume</command:name> <maml:description> <maml:para>Modify an existing Storage Volume resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVStorageVolume</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help modify an existing Storage Volume resource. Only the Volume Name, Description, Capcity, volume shared state and permenance can be modified.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVStorageVolume</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>SnapShotStoragePool</maml:name> <maml:description> <maml:para>The Storage Pool Name, URI or Object to be used for Volume Snapshots.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the new StoreVirtual data protection level (aka Network RAID). Allowed values: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>PermitAdaptiveOptimization</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="size"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the new StoreVirtual data protection level (aka Network RAID). Allowed values: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="SourceVolume"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="VolumeName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>PermitAdaptiveOptimization</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>SnapShotStoragePool</maml:name> <maml:description> <maml:para>The Storage Pool Name, URI or Object to be used for Volume Snapshots.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.Volume [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async create task</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>Get-HPOVStorageVolume ProdVol1 | Set-HPOVStorageVolume -Size 160</dev:code> <dev:remarks> <dev:para>Update "ProdVol1" volume size to 160GB.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeSnapShot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeSnapshot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSTORAGEVOLUMETEMPLATE--> <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"> <!--SET-HPOVSTORAGEVOLUMETEMPLATE--> <command:details> <command:name>Set-HPOVStorageVolumeTemplate</command:name> <maml:description> <maml:para>Modify an existing Storage Volume Template resource.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVStorageVolumeTemplate</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help modify an existing Storage Volume Template resource. Only the Volume Name, Description, Capcity, Snapshot Storage Pool, volume shared state and permenance can be modified.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume Template resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Template Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>The Storage Pool Name, URI or Object to be used for Volume Snapshots.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>LockSnapShotStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the SnapshotStoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Thin</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Thin.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Full.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume Template resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Template Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockPerformancePolicy</maml:name> <maml:description> <maml:para>Lock the PerformancePolicy value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockEnableEncryption</maml:name> <maml:description> <maml:para>Lock the EnableEncryption value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockCachePinning</maml:name> <maml:description> <maml:para>Lock the CachePinning value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockVolumeSet</maml:name> <maml:description> <maml:para>Lock the VolumeSet value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockIOPSLimit</maml:name> <maml:description> <maml:para>Lock the IOPSLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockDataTransferLimit</maml:name> <maml:description> <maml:para>Lock the DataTransferLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble"> <maml:name>LockFolder</maml:name> <maml:description> <maml:para>Lock the Folder value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVStorageVolumeTemplate</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume Template resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Template Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int64</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Thin</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Thin.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Full.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>LockProtectionLevel</maml:name> <maml:description> <maml:para>Specify to lock the DataProtectionLevel value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual"> <maml:name>LockAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify to lock the EnableAdaptiveOptimization value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>CachePinning</maml:name> <maml:description> <maml:para>This is applicable for hybrid (a mix of flash and mechanical storage) arrays, and provides a 100 percent cache hit rate for specific volumes (for example, volumes dedicated to critical applications), and delivers the response times of an all-flash storage system. A volume is pinned when the entire active volume is placed in cache; associated snapshot (inactive) blocks are not pinned. All incoming data after that point is pinned. The number of volumes that can be pinned is limited by the size of the volumes and amount of available cache. When defined in the Performance Profile, select to enable Cache Pinnning for the Nimble volume to be created.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="size"> <maml:name>Capacity</maml:name> <maml:description> <maml:para>New Max volume capacity in GB. Volume capacity can be increased to maximum of 16 TiB. Decreasing the capacity of volume is not supported. Before increasing the capacity of fully provisioned volumes, ensure that the storage pool has enough capacity to support the operation. The update operation might fail if there is not enough space available in the storage pool. e.g. 20 to specify 20GB.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>DataProtectionLevel</maml:name> <maml:description> <maml:para>Specify the StoreVirtual protection level (aka Network RAID) for the volume. Allowed values are: * NetworkRaid0None * NetworkRaid5SingleParity * NetworkRaid10Mirror2Way * NetworkRaid10Mirror3Way * NetworkRaid10Mirror4Way * NetworkRaid6DualParity</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>DataTransferLimit</maml:name> <maml:description> <maml:para>Specify the data transfer limit in MiB/S.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>Description</maml:name> <maml:description> <maml:para>Updated description for the volume.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>EnableAdaptiveOptimization</maml:name> <maml:description> <maml:para>Whether or not Adaptive Optimization is enabled on the storage volume. Only supported with StoreVirtual</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableDataTransferLimit</maml:name> <maml:description> <maml:para>Enable data transfer limit. If enabled, the -DataTransferLimit parameter must be set. By default, data transfer limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableEncryption</maml:name> <maml:description> <maml:para>When the storage system has encryption enabled, the volume can also be encrypted. Specify if the volume should be encrypted during creation.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>EnableIOPSLimit</maml:name> <maml:description> <maml:para>Set to enable or disable IOPS limit. If enabled, the -IOPSLimit parameter must be set. By default, IOPS limit is not set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Specify the Nimble folder where the volume should be created. To get availabe folder objects, use the Get-HPOVStoragePool Cmdlet. Folders are defined as a device specific attribute. Example: (Get-HPOVStoragePool -name default).DeviceSpecificAttributes.Folders ID Name -- ---- 2f1ca8a5d76e271722000000000000000000000001 POSH</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.NimbleFolder</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.NimbleFolder</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>Full</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Full.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>IOPSLimit</maml:name> <maml:description> <maml:para>When enabling IOPS limit, provide a value that is greater than or equal to 256.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="SVT, Template"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Source Storage Volume Template resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>LockAdaptiveOptimization</maml:name> <maml:description> <maml:para>Specify to lock the EnableAdaptiveOptimization value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockCachePinning</maml:name> <maml:description> <maml:para>Lock the CachePinning value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>LockCapacity</maml:name> <maml:description> <maml:para>Specify to lock the Capacity value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockDataTransferLimit</maml:name> <maml:description> <maml:para>Lock the DataTransferLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockEnableEncryption</maml:name> <maml:description> <maml:para>Lock the EnableEncryption value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockFolder</maml:name> <maml:description> <maml:para>Lock the Folder value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockIOPSLimit</maml:name> <maml:description> <maml:para>Lock the IOPSLimit value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockPerformancePolicy</maml:name> <maml:description> <maml:para>Lock the PerformancePolicy value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual" aliases="None"> <maml:name>LockProtectionLevel</maml:name> <maml:description> <maml:para>Specify to lock the DataProtectionLevel value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>LockProvisionMode</maml:name> <maml:description> <maml:para>Specify to lock the Provision Mode (Shared or Private) value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>LockProvisionType</maml:name> <maml:description> <maml:para>Specify to lock the ProvisionType value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>LockSnapShotStoragePool</maml:name> <maml:description> <maml:para>Specify to lock the SnapshotStoragePool value in the template.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>LockVolumeSet</maml:name> <maml:description> <maml:para>Lock the VolumeSet value.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="TemplateName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Updated Storage Volume Template Name.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>PerformancePolicy</maml:name> <maml:description> <maml:para>A Nimble Performance Policy is associated with a storage system. Using the Show-HPOVStorageSystemPerformancePolicy, choose an available performance policy. Example: Get-HPOVStorageSystem -Name MyNimbleSys | Show-HPOVStorageSystemPerformancePolicy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.PerformancePolicy</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.PerformancePolicy</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="ProvisionType"> <maml:name>ProvisioningType</maml:name> <maml:description> <maml:para>Specify the type of volume to provision. Allowed values are: * Thin * Full * TPDD (Thin Provision Dedup) - Only available for HPE StoreServ storage systems with SSD storage pools (aka CPG"s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Include this switch to mark the Storage Volume as a Shareable resource for shared volume access. Default: Private</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>SnapshotStoragePool</maml:name> <maml:description> <maml:para>The Storage Pool Name, URI or Object to be used for Volume Snapshots.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble, StoreVirtual, Default" aliases="None"> <maml:name>StorageSystem</maml:name> <maml:description> <maml:para>When the Storage Pool name is not unique, specify the Storage System name the pool is managed/associate with.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="StoreVirtual, Default" aliases="None"> <maml:name>Thin</maml:name> <maml:description> <maml:para>NOTE: This parameter is being deprecated for the -ProvisionType parameter. Please update your scripts. Include to change the provisioned type to Thin.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Nimble" aliases="None"> <maml:name>VolumeSet</maml:name> <maml:description> <maml:para>Use to specify a Volume Set the volume will be associated with, from Get-HPOVStorageVolumeSet.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">HPOneView.Storage.VolumeSet</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.VolumeSet</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.VolumeTemplate [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Storage Volume Template resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.VolumeTemplate [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated Storage Volume Template object.</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>Get-HPOVStorageVolumeTemplate -Name MyProdVolTemplate | Set-HPOVStorageVolumeTemplate -Size 160</dev:code> <dev:remarks> <dev:para>Update "MyProdVolTemplate" volume size to 160GB.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageVolumeTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVSTORAGEVOLUMETEMPLATEPOLICY--> <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"> <!--SET-HPOVSTORAGEVOLUMETEMPLATEPOLICY--> <command:details> <command:name>Set-HPOVStorageVolumeTemplatePolicy</command:name> <maml:description> <maml:para>Set Storage Volume Template Global Policy</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVStorageVolumeTemplatePolicy</command:noun> </command:details> <maml:description> <maml:para>By default, Storage Volumes can be created without reference to a Storage Volume Template. This Cmdlet will allow the administrator to change the global policy setting. Use with caution, as this will prevent copying Server Profiles that contain attached Storage Volumes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVStorageVolumeTemplatePolicy</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Switch to enable the policy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVStorageVolumeTemplatePolicy</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Switch to disable the policy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable, Enable" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Disable" aliases="None"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Switch to disable the policy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Enable" aliases="None"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Switch to enable the policy</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Returned boolean value after changing policy</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>Get-HPOVStorageVolumeTemplatePolicy Appliance Name Value --------- ---- ----- MyAppliance.domain.com StorageVolumeTemplateRequired true Set-HPOVStorageVolumeTemplatePolicy -disable -ApplianceConnection $ConnectedSessions Appliance Name Value --------- ---- ----- MyAppliance.domain.com StorageVolumeTemplateRequired false MyAppliance2.domain.com StorageVolumeTemplateRequired false</dev:code> <dev:remarks> <dev:para>Get the Storage Volume Template Global Policy setting, then disable it for all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVStorageVolumeTemplatePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVUPLINKSET--> <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"> <!--SET-HPOVUPLINKSET--> <command:details> <command:name>Set-HPOVUplinkSet</command:name> <maml:description> <maml:para>Update an uplink set resource</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVUplinkSet</command:noun> </command:details> <maml:description> <maml:para>Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more networks. The traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet or Fibre Channel networks. Depending on the type of the assigned networks, uplink sets can support both an automatic and a selective failover or distribution strategy. The uplink port state is monitored, which contributes to the overall reachability status of the assigned networks. For each port belonging to the uplink set, the assigned port speed can be monitored. Uplink Sets can be created for Logical Interconnect Groups or Logical Interconnects. When creating a new Uplink Set, either the Logical Interconnect Group or Logical Interconnect must exist. Please know that the UplinkPorts parameter syntax is different between HPE BladeSystem and HPE Synergy Virtual Connect. Use this Cmdlet to modify an existing Logical Interconect Group uplink set, or Logical Interconnect uplink set. Logical Interconnect Group uplink sets are a poperty of the Logical Interconnect Group resource. Logical Interconnect uplink sets are a different resource, and are not directly a member of the Logical Interconnect. Minimum required privileges: Infrastructure administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVUplinkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group from Get-HPOVLogicalInterconnectGroup or Uplink Set Get-HPOVUplinkSet resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>UplinkSetName</maml:name> <maml:description> <maml:para>When providing a Logical Interconnect Group resource, you must specify the name of the uplink set to modify.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the new name of the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>AddNetwork</maml:name> <maml:description> <maml:para>Specify the networks to add to the specified uplink set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>RemoveNetwork</maml:name> <maml:description> <maml:para>An array of networks to remove from the uplink set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>AddPorts</maml:name> <maml:description> <maml:para>Array of uplink ports to add with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>RemovePorts</maml:name> <maml:description> <maml:para>Array of uplink ports to remove with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>Specify the network object that will be set as the untagged network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet"> <maml:name>LacpTimer</maml:name> <maml:description> <maml:para>Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values: * Long * Short (Default)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVUplinkSet</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group from Get-HPOVLogicalInterconnectGroup or Uplink Set Get-HPOVUplinkSet resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>UplinkSetName</maml:name> <maml:description> <maml:para>When providing a Logical Interconnect Group resource, you must specify the name of the uplink set to modify.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the new name of the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>AddPorts</maml:name> <maml:description> <maml:para>Array of uplink ports to add with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>RemovePorts</maml:name> <maml:description> <maml:para>Array of uplink ports to remove with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel"> <maml:name>EnableTrunking</maml:name> <maml:description> <maml:para>Use this parameter to enable or disable FC port trunking. This parameter is only supported with HPE 16Gb or newer Virtual Connect Fibre Channel fabric modules.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>AddNetwork</maml:name> <maml:description> <maml:para>Specify the networks to add to the specified uplink set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>AddPorts</maml:name> <maml:description> <maml:para>Array of uplink ports to add with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FibreChannel, Ethernet" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>ConsistencyChecking</maml:name> <maml:description> <maml:para>Use to indicate if the group policy will be tracked to with the deployed and configured resource. Allowed values: * None * Exact Default: Exact</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel" aliases="None"> <maml:name>EnableTrunking</maml:name> <maml:description> <maml:para>Use this parameter to enable or disable FC port trunking. This parameter is only supported with HPE 16Gb or newer Virtual Connect Fibre Channel fabric modules.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Either a Logical Interconnect Group from Get-HPOVLogicalInterconnectGroup or Uplink Set Get-HPOVUplinkSet resource.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>LacpTimer</maml:name> <maml:description> <maml:para>Set the LACP Timer value, which sets the lacpdu frequecy to the LACP peer. Accepted values: * Long * Short (Default)</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specify the new name of the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>RemoveNetwork</maml:name> <maml:description> <maml:para>An array of networks to remove from the uplink set.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>RemovePorts</maml:name> <maml:description> <maml:para>Array of uplink ports to remove with "BAYID:FacePlatePortID". When configuring a Synergy infrastructure, the Uplink Port format needs to be "EnclosureID:BayID:FacePlatePortID". FlexFabric e.g. @("BAY1:X1","BAY1:X2") or "BAY1:X5","BAY2:X5" VC Fibre Channel e.g. @("BAY3:1","BAY3:2") or "BAY3:1","BAY3:2" Synergy VC Ethernet e.g. "Enclosure1:Bay3:Q1","Enclosure1:Bay3:Q2","Enclosure2:Bay6:Q1","Enclosure2:Bay6:Q2" Synergy VC Sub-Interface e.g. "Enclosure1:Bay3:Q1.1","Enclosure1:Bay3:Q2.1","Enclosure2:Bay6:Q1.2","Enclosure2:Bay6:Q2.2" Synergy VC FC Primary Port e.g. "Bay2:Q1","Bay2:Q2" or "Bay5:Q1","Bay5:Q2" Synergy VC FC Sub-Interface e.g. "Bay2:Q1.1","Bay2:Q2.1" or "Bay5:Q1.2","Bay5:Q2.2"</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Ethernet" aliases="None"> <maml:name>UntaggedNetwork</maml:name> <maml:description> <maml:para>Specify the network object that will be set as the untagged network.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FibreChannel, Ethernet" aliases="None"> <maml:name>UplinkSetName</maml:name> <maml:description> <maml:para>When providing a Logical Interconnect Group resource, you must specify the name of the uplink set to modify.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnectGroup [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Group resource from Get-HPOVLogicalInterconnectGroup.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.UplinkSet [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Uplink set resource from Get-HPOVUplinkSet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource object to monitor.</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>$NetworkToRemove = Get-HPOVNetwork -Name NetworkToRemove Get-HPOVLogicalInterconnectGroup -Name "My Production LIG" -ErrorAction Stop | Set-HPOVUplinkSet -UplinkSetName "Production Uplink Set 1-A" -RemoveNetwork $NetworkToRemove</dev:code> <dev:remarks> <dev:para>Remove the specific network from the created logical interconnect group's uplink set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnectGroup -Name "My Production LIG" -ErrorAction Stop | Set-HPOVUplinkSet -UplinkSetName "Production Uplink Set" -AddPort "Enclosure1:Bay3:Q1.1", "Enclosure2:Bay6:Q1.1"</dev:code> <dev:remarks> <dev:para>Add the specific ports from the created logical interconnect group's uplink set.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVUplinkSet -Name "Uplink Set 1" -ErrorAction Stop | Set-HPOVUplinkSet -AddPort "Enclosure1:Bay3:Q1.1", "Enclosure2:Bay6:Q1.1" -LacpTimer Short</dev:code> <dev:remarks> <dev:para>Add the specific ports to the created uplink set, and change the LACP Timer to "Short".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUplinkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVUplinkSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVUSER--> <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"> <!--SET-HPOVUSER--> <command:details> <command:name>Set-HPOVUser</command:name> <maml:description> <maml:para>Modify an existing user account.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVUser</command:noun> </command:details> <maml:description> <maml:para>Modify or update an existing local user account on the management appliance. This Cmdlet will not update the password or roles of the currently logged in user account. To update your HPE OneView appliance local account"s password, please use the Set-HPOVUserPassword Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVUser</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The name or object of the user account to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password for the user account. Passwords must be at least 8 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>FullName</maml:name> <maml:description> <maml:para>Updated Full Name of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Updated Email Address of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>OfficePhone</maml:name> <maml:description> <maml:para>Updated office phone of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>MobilePhone</maml:name> <maml:description> <maml:para>Updated mobile phone number</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Enable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Disable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-HPOVUser</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline"> <maml:name>UserObject</maml:name> <maml:description> <maml:para>The object of the user account to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password for the user account. Passwords must be at least 8 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>FullName</maml:name> <maml:description> <maml:para>Updated Full Name of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Updated Email Address of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>OfficePhone</maml:name> <maml:description> <maml:para>Updated office phone of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>MobilePhone</maml:name> <maml:description> <maml:para>Updated mobile phone number</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Enable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Disable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="disable"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Disable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>Updated Email Address of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="enable"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Enable the local user account.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>FullName</maml:name> <maml:description> <maml:para>Updated Full Name of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>MobilePhone</maml:name> <maml:description> <maml:para>Updated mobile phone number</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>OfficePhone</maml:name> <maml:description> <maml:para>Updated office phone of the User Account.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password for the user account. Passwords must be at least 8 characters.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>ScopePermissions</maml:name> <maml:description> <maml:para>Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings. Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The name or object of the user account to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline" aliases="None"> <maml:name>UserObject</maml:name> <maml:description> <maml:para>The object of the user account to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView User Account object created on an appliance</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns a user resource</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>Set-HPOVUser -username Sally -roles @("server administrator","network administrator")</dev:code> <dev:remarks> <dev:para>Update the user account "Sally" with new roles.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Set-HPOVUser -username Sally -password NewP@ssw0rd</dev:code> <dev:remarks> <dev:para>Update the user account "Sally" with a new password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Scope = Get-HPOVScope -Name Scope1 -ErrorAction Stop Get-HPOVUser -Username Sally | Set-HPOVUser -Roles "Server administrator" -ScopePermissions @{Role = "Network administrator"; Scope = $Scope }</dev:code> <dev:remarks> <dev:para>Modify the user account with the new role and scope permissions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserPassword</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVUserRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVUserSession</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVUSERPASSWORD--> <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"> <!--SET-HPOVUSERPASSWORD--> <command:details> <command:name>Set-HPOVUserPassword</command:name> <maml:description> <maml:para>Update current user account password.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVUserPassword</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet provides the ability to update the current user account password. Only HPE OneView appliance local account passwords will be changed. This Cmdlet does not assist with modifying or updating an LDAP or Active Directory user account"s password.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVUserPassword</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Current</maml:name> <maml:description> <maml:para>The current password of the user account. If omitted, the Cmdlet will prompt for the users password as a secure string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>New</maml:name> <maml:description> <maml:para>The new password to be set for the user account. If omitted, the Cmdlet will prompt for the users password as a secure string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para> Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para> Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectedSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="CurrentPassword"> <maml:name>Current</maml:name> <maml:description> <maml:para>The current password of the user account. If omitted, the Cmdlet will prompt for the users password as a secure string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="NewPassword"> <maml:name>New</maml:name> <maml:description> <maml:para>The new password to be set for the user account. If omitted, the Cmdlet will prompt for the users password as a secure string.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>HPOneView appliance local user account.</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>Set-HPOVUserPassword MyCurrentPass NewP@ssw0rd</dev:code> <dev:remarks> <dev:para>Update your HPE OneView account password to the new value on all connected appliances.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SET-HPOVUSERROLE--> <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"> <!--SET-HPOVUSERROLE--> <command:details> <command:name>Set-HPOVUserRole</command:name> <maml:description> <maml:para>(Deprecated) Assign or change roles for an existing user.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>HPOVUserRole</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is now deprecated. Please use the Set-HPOVUser Cmdlet to modify user accounts and associated roles/permissions</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-HPOVUserRole</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the user account to have a role assigned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="user, userName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the user account to have a role assigned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="roleName"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable. Example: $roles = "Server administrator","Network administrator"</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView appliance user account</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Updated user account with new role(s)</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>Set-HPOVUserRole -user Sally -roleName "Server Administrator"</dev:code> <dev:remarks> <dev:para>Set the Server Administrator role for Sally"s user account.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVACTIVEUSER--> <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"> <!--SHOW-HPOVACTIVEUSER--> <command:details> <command:name>Show-HPOVActiveUser</command:name> <maml:description> <maml:para>Display active and connected users.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVActiveUser</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to display active and connected users to an HPE OneView or Synergy management appliance. Infrastructure administrator or Security administrator role is required in order to view all connected users.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVActiveUser</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.ActiveUserSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Connected user session and its details.</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>Get-HPOVActiveUser UserName LoginDomain ClientHost LoginTime -------- ----------- ---------- --------- BobSmith@domain.local doctors-lab.local 192.168.19.3 11/1/2018 9: 39: 34 PM administrator Local 192.168.19.20 11/7/2018 1: 58: 48 PM Administrator Local 192.168.19.3 11/10/2018 5: 36: 39 AM</dev:code> <dev:remarks> <dev:para>Display connected active users to the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVAPPLIANCESECURITYMODECOMPATIBILITYREPORT--> <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"> <!--SHOW-HPOVAPPLIANCESECURITYMODECOMPATIBILITYREPORT--> <command:details> <command:name>Show-HPOVApplianceSecurityModeCompatibilityReport</command:name> <maml:description> <maml:para>Generate or show security mode compatability report. </maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVApplianceSecurityModeCompatibilityReport</command:noun> </command:details> <maml:description> <maml:para>When you are considering switching the cryptography mode for your appliance, Hewlett Packard Enterprise recommends that you run the compatibility report to check for compatibility issues for a chosen cryptography mode. Compatibility reports contain information about the behavior of devices and external servers managed or configured by HPE OneView. The report lists the various resources (storage devices, network devices, servers, enclosures) managed by HPE OneView that are not compatible with the chosen cryptography mode. You can use the compatibility reports to: * Determine the impact of the mode switch on various resources, such as, the appliance certificates, external servers and managed devices. * Understand the actions recommended to be taken before switching the cryptography mode of the appliance. Examples: * Re-importing a higher strength certificate signed by your certificate authority (CA). * Configuring the managed device or external server to be compliant with the cryptography mode of HPE OneView. * Determine the devices or class of devices that cannot be managed by HPE OneView in the target mode. Running this Cmdlet will generate a new compatibility report if one does not exist. Use the -UpdateReport switch to generate a new report.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>TargetSecurityMode</maml:name> <maml:description> <maml:para>Specify the target security mode to test resources from Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SecurityMode</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>UpdateReport</maml:name> <maml:description> <maml:para>Specify to regenerate the report.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>TargetSecurityMode</maml:name> <maml:description> <maml:para>Specify the target security mode to test resources from Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.SecurityMode</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>UpdateReport</maml:name> <maml:description> <maml:para>Specify to regenerate the report.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.SecurityMode</maml:name> </dev:type> <maml:description> <maml:para>Available security mode from Get-HPOVApplianceAvailableSecurityMode.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.SecurityModeCompatibilityReport</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Security mode compatibility report.</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>$TargetSecurityMode = Get-HPOVApplianceAvailableSecurityMode -ModeName CNSA Show-HPOVApplianceSecurityModeCompatibilityReport -TargetSecurityMode $TargetSecurityMode</dev:code> <dev:remarks> <dev:para>Generate a compatibility report for changing the appliance mode to CNSA.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAvailableSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVFIRMWAREREPORT--> <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"> <!--SHOW-HPOVFIRMWAREREPORT--> <command:details> <command:name>Show-HPOVFirmwareReport</command:name> <maml:description> <maml:para>Generate firmware report</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVFirmwareReport</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will generate a CSV-compliance firmware report for various resources. Enclosure Groups, Enclosures, Server Hardware and Interconnects are all suported resources. If an Enclosure Group is provided, all associated Logical Enclosures and Enclosures are examined, with their embedded resources like fabric modules, enclosure managers (Synergy FLM and BladeSystem Onboard Administrator), and server hardware. If a baseline is associated with an Enclosure Group, or server profile, it is used to compare what is expected, versus what the actual installed component is. The baseline can be overridden by specifying a different baseline resource object from Get-HPOVBaseline. The genrated report can be exported. Minimum required permissions: Infrastructure administrator, Server administrator, Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVFirmwareReport</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The managed resource object to generate the report for. Allowed resource object types are: * EG (Enclosure Group) * Enclosure * Server * Interconnect By specifying an Enclosure Group, all associated Enclosures will be included in the report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Resource Object or Name of the Firmware Baseline to report against what is installed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Location</maml:name> <maml:description> <maml:para>File system location where to save the exported report to. Default: Current Working Directory</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Export</maml:name> <maml:description> <maml:para>Indicate to export the report to a CSV file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Resource Object or Name of the Firmware Baseline to report against what is installed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Export</maml:name> <maml:description> <maml:para>Indicate to export the report to a CSV file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The managed resource object to generate the report for. Allowed resource object types are: * EG (Enclosure Group) * Enclosure * Server * Interconnect By specifying an Enclosure Group, all associated Enclosures will be included in the report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Location</maml:name> <maml:description> <maml:para>File system location where to save the exported report to. Default: Current Working Directory</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>(get-location).Path</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.EnclosureGroup or HPOneView.Enclosure or HPOneView.ServerHardware or HPOneView.Networking.Interconnect</maml:name> </dev:type> <maml:description> <maml:para>HPE OneView Managed Resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Firmware report</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>Get-HPOVEnclosureGroup "Production EG" | Show-HPOVFirmwareReport</dev:code> <dev:remarks> <dev:para>Display a firmware report of all associated enclosures to "Production EG" Enclosure Group currently managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Baseline = Get-HPOVBaseline -SppName "Production EG" Get-HPOVEnclosureGroup "Production EG" | Show-HPOVFirmwareReport -Baseline $Baseline</dev:code> <dev:remarks> <dev:para>Display a firmware report of the "Production EG" resource, and components (servers, interconnects and Onboard Administrators) currently managed by the appliance, and compare to the provided Baseline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVHYPERVISORCLUSTER--> <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"> <!--SHOW-HPOVHYPERVISORCLUSTER--> <command:details> <command:name>Show-HPOVHypervisorCluster</command:name> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVHypervisorCluster</command:noun> </command:details> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVHypervisorCluster</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPEOneView.Cluster.UnmanagedCluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Unmanaged cluster resource from the cluster manager. </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>Show-HPOVHypervisorCluster</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVLDAPGROUPS--> <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"> <!--SHOW-HPOVLDAPGROUPS--> <command:details> <command:name>Show-HPOVLdapGroups</command:name> <maml:description> <maml:para>List Directory Groups from the configured LDAP Directory.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVLdapGroups</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will display the available Authentication Directory security groups. The displayed Directory Groups can then be used to define new Directory Group Role assignment on the appliance with the New-HPOVLdapGroup Cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVLdapGroups</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The configured LDAP Directory object on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Password</maml:name> <maml:description> <maml:para>User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-HPOVLdapGroups</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The configured LDAP Directory object on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="PSCredential, Default" aliases="d, domain, AuthProvider"> <maml:name>Directory</maml:name> <maml:description> <maml:para>The configured LDAP Directory object on the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="PSCredential, Default" aliases="None"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="p"> <maml:name>Password</maml:name> <maml:description> <maml:para>User account password</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="u"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Username to authenticate with</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para>Directory User Account password</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.AuthDirectoryGroup [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Authentication Directory Group</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList<HPOneView.Appliance.AuthDirectoryGroup></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of Authentication Directory Groups found</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>Show-HPOVLdapGroups -u "Sarah Peterson" -d Domain1</dev:code> <dev:remarks> <dev:para>Get list of Directory Groups from Domain1 and prompt for password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$password = ConvertTo-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory "Domain99" Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory</dev:code> <dev:remarks> <dev:para>Automate list of Directory Groups from Domain99 with the provided password.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$password = ConvertTo-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory "Domain99" Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory -GroupName "Admins"</dev:code> <dev:remarks> <dev:para>Automate list of Directory Groups from Domain99 with the provided password, searching for group names that contain "Admins".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVLOGICALINTERCONNECTMACTABLE--> <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"> <!--SHOW-HPOVLOGICALINTERCONNECTMACTABLE--> <command:details> <command:name>Show-HPOVLogicalInterconnectMacTable</command:name> <maml:description> <maml:para>Show the MAC Table for Logical Interconnect resource(s).</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVLogicalInterconnectMacTable</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will help show the MAC Table of Logical Interconnect resources. The REST API currently limits the first 100 MAC addresses from the MAC table, regardless of the number of MAC Addresses learned in the table. Use the -Network parameter to specify the Network Name to display learned MAC Addresses. You can export the results to a CSV file, by providing the full path and filename to export to, using the -ExportFile parameter. To display the results in a formatted list, use the -List parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVLogicalInterconnectMacTable</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name, URI, Logical Interconnect Resource or an array of either to display the MAC Address tables from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>network</maml:name> <maml:description> <maml:para>Provide the Network Name to filter the MAC Table results for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export to a CSV, provide the full path and filename.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-HPOVLogicalInterconnectMacTable</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name, URI, Logical Interconnect Resource or an array of either to display the MAC Address tables from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default"> <maml:name>network</maml:name> <maml:description> <maml:para>Provide the Network Name to filter the MAC Table results for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export to a CSV, provide the full path and filename.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-HPOVLogicalInterconnectMacTable</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name, URI, Logical Interconnect Resource or an array of either to display the MAC Address tables from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="MACAddress"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>Provide a MAC Address to locate in the MAC Table.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export to a CSV, provide the full path and filename.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Pipeline, MACAddress, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, MACAddress, default" aliases="x, ExportFile"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export to a CSV, provide the full path and filename.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Pipeline, MACAddress, default" aliases="name, li, LogicalInterconnect"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name, URI, Logical Interconnect Resource or an array of either to display the MAC Address tables from.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="MACAddress" aliases="mac"> <maml:name>MacAddress</maml:name> <maml:description> <maml:para>Provide a MAC Address to locate in the MAC Table.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Pipeline, default" aliases="None"> <maml:name>network</maml:name> <maml:description> <maml:para>Provide the Network Name to filter the MAC Table results for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>An Array of Logical Interconnect resource URI"s, Names or Objects</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Logical Interconnect Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of MAC Address Table entries</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>Show-HPOVLogicalInterconnectMacTable</dev:code> <dev:remarks> <dev:para>Return as many MAC Addresses allowed by the API for all Logical Interconnect resources.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Show-HPOVLogicalInterconnectMacTable -network VLAN100 Enclosure Interconnect Interface Address Type Network VLAN --------- ------------ --------- ------- ---- ------- ---- Encl1 interconnect 2 LAG 27 38:22:D6:35:5A:62 Learned VLAN100 30 Encl1 interconnect 1 LAG 26 38:22:D6:35:5A:62 Learned VLAN100 30 Encl1 interconnect 1 LAG 26 78:AC:C0:72:E5:D9 Learned VLAN100 30</dev:code> <dev:remarks> <dev:para>Display all available MAC Addresses learned in "VLAN100" network in all Logical Interconnect resources, and display in a formatted table.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Show-HPOVLogicalInterconnectMacTable -network VLAN100 -exportfile C:\reports\Encl1-LI_vlan100_mactable.csv</dev:code> <dev:remarks> <dev:para>Retrieve the available MAC Addresses learned in "VLAN100" network, and export to C:\reports\Encl1-LI_vlan100_mactable.csv</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVPORTSTATISTICS--> <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"> <!--SHOW-HPOVPORTSTATISTICS--> <command:details> <command:name>Show-HPOVPortStatistics</command:name> <maml:description> <maml:para>Display Interconnect Port Statistics.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVPortStatistics</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will display the utilization (Format-Table view) or error (Format-List) statistics of a given Interconnect or Interconnect Port. The default view is Format-Table. Piping output to Format-List will display error statistics.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVPortStatistics</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort"> <maml:name>Interconnect</maml:name> <maml:description> <maml:para>The Interconnect resource the Port ID is a member of.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort, Pipeline"> <maml:name>Port</maml:name> <maml:description> <maml:para>The name of the Interconnect Port ID (i.e. X1 or D5) to retrieve. If no Port ID is provided, all Ports of the Interconnect will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-HPOVPortStatistics</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="InterconnectPort, Pipeline"> <maml:name>Port</maml:name> <maml:description> <maml:para>The name of the Interconnect Port ID (i.e. X1 or D5) to retrieve. If no Port ID is provided, all Ports of the Interconnect will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="InterconnectPort, Pipeline"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort, Pipeline" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort" aliases="None"> <maml:name>Interconnect</maml:name> <maml:description> <maml:para>The Interconnect resource the Port ID is a member of.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="InterconnectPort, Pipeline" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>The name of the Interconnect Port ID (i.e. X1 or D5) to retrieve. If no Port ID is provided, all Ports of the Interconnect will be returned.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Netwroking.Interconnect.Port [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>An Interconnect Port object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.PortStatistics.Ethernet [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Ethernet Uplink Port statistics</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Networking.PortStatistics.FibreChannel [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Ethernet Uplink Port statistics</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of multiple Interconnect Port statistics</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>Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1 Port Type: Ethernet Name Rx Kb/s Tx Kb/s Rx Packets Tx Packets Rx Non-Unicast PPS Tx Non-Unicast PPS ---- ------- ------- ---------- ---------- ------------------ ------------------ X1 5Kbps (1min) 0Kbps (1min) 6pps (1min) 0pps (1min) 6pps (1min) 0pps (1min)</dev:code> <dev:remarks> <dev:para>Displays the interface throughput statistics for X1 in a Format-Table display.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" -port X1 | FL Port Type: Ethernet Name : X4 Rx Kb/s : 5Kbps (1min) Tx Kb/s : 0Kbps (1min) In Discards : Out Discards : In Errors : Out Errors : CRC Errors Rx/Tx : MTU Exceeded Discards Rx/Tx : Giants Rx/Tx :</dev:code> <dev:remarks> <dev:para>Displays the interface error statistics for X1 in a Format-List display.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>(Get-HPOVInterconnect "Encl1, Interconnect 1").ports | ? name -eq X1 | Show-HPOVPortStatistics</dev:code> <dev:remarks> <dev:para>Pipe an Interconnect Port object to Show-HPOVPortStatistics and show the interface throughput statistics.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Show-HPOVPortStatistics -interconnect "Encl1, Interconnect 1" Port Type: Ethernet Name Rx Kb/s Tx Kb/s Rx Packets Tx Packets Rx Non-Unicast PPS Tx Non-Unicast PPS ---- ------- ------- ---------- ---------- ------------------ ------------------ d1 0Kbps (1min) 8Kbps (1min) 0pps (1min) 6pps (1min) 0pps (1min) 5pps (1min) d10 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d11 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d12 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d13 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d14 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d15 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d16 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d2 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d3 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d4 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d5 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d6 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d7 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d8 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) d9 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) X4 6Kbps (1min) 0Kbps (1min) 6pps (1min) 0pps (1min) 6pps (1min) 0pps (1min) X5 6Kbps (1min) 0Kbps (1min) 4pps (1min) 0pps (1min) 4pps (1min) 0pps (1min) X6 4Kbps (1min) 0Kbps (1min) 3pps (1min) 0pps (1min) 3pps (1min) 0pps (1min) X7 0Kbps (1min) 0Kbps (1min) 0pps (1min) 0pps (1min) 0pps (1min) 0pps (1min) X8 6Kbps (1min) 11Kbps (1min) 7pps (1min) 14pps (1min) 7pps (1min) 14pps (1min) Port Type: FibreChannel Name Rx Throughput Tx Throughput Rx Frames (Total) Tx Frames (Total) Rx Bytes (Total) Tx Bytes (Total) ---- ------------- ------------- ----------------- ----------------- ---------------- ---------------- X1 0 MB/s 0 MB/s 56868 85074 84809592 146546884 X2 0 MB/s 0 MB/s 7999 7999 579644 622152 X3 0 MB/s 0 MB/s 0 0 0 0</dev:code> <dev:remarks> <dev:para>Display all available ports of the provided Interconnect, using the Interconnect Name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Interconnect = Get-HPOVInterconnect "Encl1, Interconnect 1" Show-HPOVPortStatistics $Interconnect</dev:code> <dev:remarks> <dev:para>Display all available ports of the provided Interconnect, using an Interconnect PowerShell object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVSANENDPOINT--> <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"> <!--SHOW-HPOVSANENDPOINT--> <command:details> <command:name>Show-HPOVSanEndpoint</command:name> <maml:description> <maml:para>View Managed SAN FC Endpoints.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVSanEndpoint</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will dispay the Managed SAN endpoints, or FC addresses, their node information, and Zone Name. By default, all SAN endpoints will be returned. You can filter the results based on Managed SAN resource or WWN address.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVSanEndpoint</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>SAN</maml:name> <maml:description> <maml:para>The Managed SAN Resource Object or Name. Cannot be combined with the WWN parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="WWN, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-HPOVSanEndpoint</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="WWN"> <maml:name>WWN</maml:name> <maml:description> <maml:para>The WWN of the node you are looking for. Cannot be combined with the SAN parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="WWN, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="WWN, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>SAN</maml:name> <maml:description> <maml:para>The Managed SAN Resource Object or Name. Cannot be combined with the WWN parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="WWN" aliases="None"> <maml:name>WWN</maml:name> <maml:description> <maml:para>The WWN of the node you are looking for. Cannot be combined with the SAN parameter.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneview.Storage.ManagedSan</maml:name> </dev:type> <maml:description> <maml:para>Managed SAN resource from Get-HPOVManagedSan</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task</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>Show-HPOVSanEndpoint Appliance WWN Port Type Online SAN Name Zone Name --------- --- --------- ------ -------- --------- hpov-tot2 10:00:F6:9F:5F:70:00:02 N_Port False SAN1_1 Node_1_8 hpov-tot2 20:00:00:02:AC:00:08:DF N_Port True SAN1_1 Node_1_8 hpov-tot2 20:00:00:02:AC:00:08:E3 N_Port True SAN1_1 Node_1_8 hpov-tot2 10:00:F6:9F:5F:70:00:00 N_Port False SAN1_0 Node_1_7 hpov-tot2 20:00:00:02:AC:00:08:E2 N_Port True SAN1_0 Node_1_7 hpov-tot2 20:00:00:02:AC:00:08:DE N_Port True SAN1_0 Node_1_7 hpov-tot2 AA:AA:AA:AA:AA:AA:AA:AA N_Port False SAN1_0 dummy_zone hpov-tot2 20:00:00:02:AC:00:09:03 N_Port True SAN1_0 hpov-tot2 00:00:4A:2B:21:E0:00:1B N_Port True SAN1_1 hpov-tot2 20:00:00:02:AC:00:09:04 N_Port True SAN1_1 hpov-tot2 00:00:4A:2B:21:E0:00:14 N_Port True SAN1_0 hpov-tot2 00:00:4A:2B:21:E0:00:0D N_Port True SAN1_1 hpov-tot2 20:00:00:02:AC:00:09:00 N_Port True SAN1_1 hpov-tot2 20:00:00:02:AC:00:08:FF N_Port True SAN1_0 hpov-tot2 00:00:4A:2B:21:E0:00:06 N_Port True SAN1_0</dev:code> <dev:remarks> <dev:para>Return all SAN Endpoints from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVManagedSan SAN1_1 | Show-HPOVSanEndpoint Appliance WWN Port Type Online SAN Name Zone Name --------- --- --------- ------ -------- --------- hpov-tot2 20:00:00:02:AC:00:08:E3 N_Port True SAN1_1 Node_1_8 hpov-tot2 10:00:F6:9F:5F:70:00:02 N_Port False SAN1_1 Node_1_8 hpov-tot2 20:00:00:02:AC:00:08:DF N_Port True SAN1_1 Node_1_8 hpov-tot2 00:00:4A:2B:21:E0:00:1B N_Port True SAN1_1 hpov-tot2 20:00:00:02:AC:00:09:04 N_Port True SAN1_1 hpov-tot2 00:00:4A:2B:21:E0:00:0D N_Port True SAN1_1 hpov-tot2 20:00:00:02:AC:00:09:00 N_Port True SAN1_1</dev:code> <dev:remarks> <dev:para>Return all SAN Endpoints for the specified Managed SAN resource from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Show-HPOVSanEndpoint -WWN 10:00:F6:9F:5F:70:00:02 Appliance WWN Port Type Online SAN Name Zone Name --------- --- --------- ------ -------- --------- hpov-tot2 10:00:F6:9F:5F:70:00:02 N_Port False SAN1_1 Node_1_8</dev:code> <dev:remarks> <dev:para>Return the specific SAN Endpoint from the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVSTORAGESYSTEMPERFORMANCEPOLICY--> <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"> <!--SHOW-HPOVSTORAGESYSTEMPERFORMANCEPOLICY--> <command:details> <command:name>Show-HPOVStorageSystemPerformancePolicy</command:name> <maml:description> <maml:para>Show available Nimble Performance Policies.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVStorageSystemPerformancePolicy</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to show available Nimble Performance Policies in order to set a desired perforamnce policy value when provisioning a new volume or creating a new volume template.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVStorageSystemPerformancePolicy</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>One or more storage systems from Get-HPOVStorageSystem.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a name of the performance policy to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>One or more storage systems from Get-HPOVStorageSystem.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Provide a name of the performance policy to return.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The Nimble storage system object from Get-HPOVStorageSystem.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Storage.PerformancePolicy</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more available storage system performance policy objects.</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>Show-HPOVStorageSystemPerformancePolicy</dev:code> <dev:remarks> <dev:para>Display the Nimble storage system performance policies configured.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--SHOW-HPOVUSERSESSION--> <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"> <!--SHOW-HPOVUSERSESSION--> <command:details> <command:name>Show-HPOVUserSession</command:name> <maml:description> <maml:para>Display user logon sessions.</maml:para> </maml:description> <command:verb>Show</command:verb> <command:noun>HPOVUserSession</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is decprecated as of v2.0. Please use the $ConnectedSessions Global variable for appliance session information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Show-HPOVUserSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None.</maml:name> </dev:type> <maml:description> <maml:para> None </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para> None</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--START-HPOVLIBRARYTRACE--> <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"> <!--START-HPOVLIBRARYTRACE--> <command:details> <command:name>Start-HPOVLibraryTrace</command:name> <maml:description> <maml:para>Start HPOV Library Verbose Trace.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>HPOVLibraryTrace</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is deprecated. Please use Get-HPOVCommandTrace.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Start-HPOVLibraryTrace</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where to store the log file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where to store the log file.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Stop-HPOVLibraryTrace</dev:code> <dev:remarks> <dev:para>Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Stop-HPOVLibraryTrace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--START-HPOVREMOTESUPPORTCOLLECTION--> <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"> <!--START-HPOVREMOTESUPPORTCOLLECTION--> <command:details> <command:name>Start-HPOVRemoteSupportCollection</command:name> <maml:description> <maml:para>Begin Remote Support collection from endpoints.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>HPOVRemoteSupportCollection</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to initiate colleciton of remote support data. This will help send collection reports back to HPE that are in between the default scheduled task.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Start-HPOVRemoteSupportCollection</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Type</maml:name> <maml:description> <maml:para>Used to specify the type of remote support collection to start. Allowed values are: * AHS - Active Health Service collection * Basic - Basic server configuration collection</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Used to specify the type of remote support collection to start. Allowed values are: * AHS - Active Health Service collection * Basic - Basic server configuration collection</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor</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>Get-HPOVServer -Name Prod-Sql-01 | Start-HPOVRemoteSupportCollection -Type AHS</dev:code> <dev:remarks> <dev:para>Start the collection of AHS logs immediately for the specified server.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure | Start-HPOVRemoteSupportCollection -Type Basic</dev:code> <dev:remarks> <dev:para>Start the collection of basic server configuration immediately.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--START-HPOVSERVER--> <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"> <!--START-HPOVSERVER--> <command:details> <command:name>Start-HPOVServer</command:name> <maml:description> <maml:para>Power on Server Resource.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>Start the power state of the server using the virtual power button.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Start-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task that tracks the power state change</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async tasks</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>Get-HPOVServer "Encl1, Bay 1" | Start-HPOVServer</dev:code> <dev:remarks> <dev:para>Power on the specific server device by passing the Server Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer "Encl1, *" | Start-HPOVServer -Async</dev:code> <dev:remarks> <dev:para>Power on the server devices found by passing the Server Object via pipeline, and return the async task immediately.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile "MyWebServer 1" | Start-HPOVServer</dev:code> <dev:remarks> <dev:para>Power on the specific server device by passing the Server Profile Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--STOP-HPOVAPPLIANCE--> <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"> <!--STOP-HPOVAPPLIANCE--> <command:details> <command:name>Stop-HPOVAppliance</command:name> <maml:description> <maml:para>Stop an HPE OneView appliance.</maml:para> </maml:description> <command:verb>Stop</command:verb> <command:noun>HPOVAppliance</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will allow the administrator to stop/shutdown the appliance. Shutdown of the appliance will cause all users to be disconnected and all ongoing tasks to be interrupted. Only the Infrastructure (Full) Administrator may restart the appliance.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Stop-HPOVAppliance</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). Default Value: ${Global:ConnectSessions} | ? Default</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.Connection</maml:name> </dev:type> <maml:description> <maml:para>Connected Appliance Session</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Collection of HPOneView.Appliance.Connection objects</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Warning message the appliance is stopping</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Management.Automation.ErrorRecord</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generated error message</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>Connect-HPOVMgmt appliance.contoso.com Administrator P@ssw0rd Stop-HPOVAppliance</dev:code> <dev:remarks> <dev:para>Shutdown the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Stop-HPOVAppliance -confirm:$false</dev:code> <dev:remarks> <dev:para>Shutdown all connected appliances, disable confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceComplexPasswords</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAvailableSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCertificateStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceServiceConsoleAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceSshAccess</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPOVApplianceCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceCsr</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceSelfSignedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Pop-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Push-HPOVAppliancePermission</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrapDestination</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVApplianceTrustedCertificate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVAppliance</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceCurrentSecurityMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceDateTime</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceDefaultConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceGlobalSetting</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceNetworkConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceProxy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSecurityProtocol</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceSnmpV3EngineId</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceTwoFactorAuthentication</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVApplianceSecurityModeCompatibilityReport</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVApplianceTrustedAuthorityCrl</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-HPOVApplianceStart</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--STOP-HPOVLIBRARYTRACE--> <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"> <!--STOP-HPOVLIBRARYTRACE--> <command:details> <command:name>Stop-HPOVLibraryTrace</command:name> <maml:description> <maml:para>Stop HPOV Library Verbose Trace.</maml:para> </maml:description> <command:verb>Stop</command:verb> <command:noun>HPOVLibraryTrace</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is deprecated. Please use Get-HPOVCommandTrace.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Stop-HPOVLibraryTrace</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.IO.File</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>{filename}.trace file is generated in the location specified in the Start-HPOVLibraryTrace Cmdlet</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>Stop-HPOVLibraryTrace</dev:code> <dev:remarks> <dev:para>Transcript stopped, output file is C:\Users\Administrator\1604251128_HPOV_transcript.trace</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Start-HPOVLibraryTrace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--STOP-HPOVSERVER--> <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"> <!--STOP-HPOVSERVER--> <command:details> <command:name>Stop-HPOVServer</command:name> <maml:description> <maml:para>Power off Server Resource.</maml:para> </maml:description> <command:verb>Stop</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>Stop the power state of the server using the virtual power button. By default, the Cmdlet will request a "Momentary Press" request to initiate a server to shutdown.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Stop-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Force, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Force, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Force, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Force, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Force"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use this parameter to request the "Press and Hold" virtual power button method, which will forcable power off a server without a graceful shutdown.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Force, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Force, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Force, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Force, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Force" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use this parameter to request the "Press and Hold" virtual power button method, which will forcable power off a server without a graceful shutdown.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Force, Default" aliases="Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Server hardware or Server Profile resource object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task that tracks the power state change</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Async tasks</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>Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Power off the specific server device by passing the Server Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile "MyWebServer 1" | Stop-HPOVServer | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Power off the specific server device by passing the Server Profile Object via pipeline.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServer "Encl1, Bay 1" | Stop-HPOVServer -Force | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Power off the specific server device by passing the Server Object via pipeline, and forcably power off.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--TEST-HPOVAPPLIANCEAUDITLOGFORWARDING--> <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"> <!--TEST-HPOVAPPLIANCEAUDITLOGFORWARDING--> <command:details> <command:name>Test-HPOVApplianceAuditLogForwarding</command:name> <maml:description> <maml:para>Generate test audit log forward message.</maml:para> </maml:description> <command:verb>Test</command:verb> <command:noun>HPOVApplianceAuditLogForwarding</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will generate a syslog message to test connectivity to the appliance configured remote Syslog server. Minimum required privileges: Infrastructure administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-HPOVApplianceAuditLogForwarding</maml:name> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this cmdlet.</maml:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This Cmdlet does not return any object.</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>Test-HPOVApplianceAuditLogForwarding</dev:code> <dev:remarks> <dev:para>Generate audit log test message.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVApplianceAuditLogForwarding</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--TEST-HPOVEMAILALERT--> <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"> <!--TEST-HPOVEMAILALERT--> <command:details> <command:name>Test-HPOVEmailAlert</command:name> <maml:description> <maml:para>Test appliance Email Alerting configuration.</maml:para> </maml:description> <command:verb>Test</command:verb> <command:noun>HPOVEmailAlert</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will generate a test email message. </maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Test-HPOVEmailAlert</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Recipients</maml:name> <maml:description> <maml:para>Specify the Sender Email Address for the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Provide a custom subject for the email message.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Body</maml:name> <maml:description> <maml:para>Provide a custom message body. Can be either a plan text or HTML message.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Body</maml:name> <maml:description> <maml:para>Provide a custom message body. Can be either a plan text or HTML message.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>Test email message from HPE OneView appliance.</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="None"> <maml:name>Recipients</maml:name> <maml:description> <maml:para>Specify the Sender Email Address for the appliance.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Provide a custom subject for the email message.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue>This is a test message.</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para>None. You cannot pipe objects to this Cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If successful, returns an object with the test message details.</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>Test-HPOVEmailAlert -Recipients user1@contoso.com</dev:code> <dev:remarks> <dev:para>Generate a test email message to "user1@contoso.com".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Test-HPOVEmailAlert -Recipients user1@contoso.com.,user2@contoso.com -Subject "This is a test email message." </dev:code> <dev:remarks> <dev:para>Generate a test email message to multiple recipients with a custom subject.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVSmtpAlertEmailFilter</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVAPPLIANCETRUSTEDAUTHORITYCRL--> <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"> <!--UPDATE-HPOVAPPLIANCETRUSTEDAUTHORITYCRL--> <command:details> <command:name>Update-HPOVApplianceTrustedAuthorityCrl</command:name> <maml:description> <maml:para>Update appliance certificate authority revocation list.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVApplianceTrustedAuthorityCrl</command:noun> </command:details> <maml:description> <maml:para>HPE OneView enables users to import a CA CRL file and to perform the appropriate revocation checking on existing certificates in the trust store and for certificates received during communication with a managed device or external server. Certificate revocation checks are enabled by default. However, if a matching CRL has not been imported for a CA-issued certificate, or if a CRL has expired, the appliance bypasses the revocation check for the associated certificate when performing an HTTPS connection. If you want to restrict (or relax) revocation checking, use the options below on the edit screen. The Cmdlet will attempt to download the CRL from the HTTP location specified within the TrustedCertificateAuthority object. You can manually download the updated CRL and use the -Path paramter to specify the offline CRL.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVApplianceTrustedAuthorityCrl</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FilePath, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Appliance.TrustedCertificateAuthority resource from Get-HPOVApplianceTrustedCertificate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.TrustedCertificateAuthority[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FilePath, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FilePath, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVApplianceTrustedAuthorityCrl</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FilePath, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Appliance.TrustedCertificateAuthority resource from Get-HPOVApplianceTrustedCertificate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.TrustedCertificateAuthority[]</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FilePath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to manually downloaded CRL.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">FileInfo</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FilePath, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FilePath, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FilePath, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="FilePath, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FilePath, Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>HPOneView.Appliance.TrustedCertificateAuthority resource from Get-HPOVApplianceTrustedCertificate.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.TrustedCertificateAuthority[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.TrustedCertificateAuthority[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FilePath" aliases="None"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to manually downloaded CRL.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TrustedCertificateAuthority</maml:name> </dev:type> <maml:description> <maml:para>resource from Get-HPOVApplianceTrustedCertificate.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Get-HPOVApplianceTrustedCertificate -Name "VeriSign Class 3 Public Primary Certification Authority - G5" | Update-HPOVApplianceTrustedAuthorityCrl</dev:code> <dev:remarks> <dev:para>Update the built-in certificate authority resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code># Download CA CRL for offline use $CA = Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2" Invoke-WebRequest -Uri $CA.CRLInfo.EndPointList[0] -OutFile C:\Directory\CA-updated.crl # Copy offline CRL to other PC Get-HPOVApplianceTrustedCertificate -CertificateAuthoritiesOnly -Name "DigiCert Global CA G2" | Update-HPOVApplianceTrustedAuthorityCrl -Path C:\Directory\CA-updated.crl</dev:code> <dev:remarks> <dev:para>Update the built-in certificate authority resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVCLUSTERNODE--> <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"> <!--UPDATE-HPOVCLUSTERNODE--> <command:details> <command:name>Update-HPOVClusterNode</command:name> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVClusterNode</command:noun> </command:details> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVClusterNode</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource to monitor.</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>Update-HPOVClusterNode</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enter-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Exit-HPOVClusterNodeMaintenanceMode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVClusterNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVCLUSTERPROFILE--> <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"> <!--UPDATE-HPOVCLUSTERPROFILE--> <command:details> <command:name>Update-HPOVClusterProfile</command:name> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVClusterProfile</command:noun> </command:details> <maml:description> <maml:para>Default content</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVClusterProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name"> <maml:name>InputObject</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task resource to monitor.</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>Update-HPOVClusterProfile</dev:code> <dev:remarks> <dev:para>Default example</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVClusterProfileMember</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVClusterProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVENCLOSURE--> <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"> <!--UPDATE-HPOVENCLOSURE--> <command:details> <command:name>Update-HPOVEnclosure</command:name> <maml:description> <maml:para>Update or Refresh an enclosure.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVEnclosure</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will update or refresh an enclosure. An Enclosure Refresh will instruct HPE OneView to go inventory the enclosure and update any missing management configurations. Use the -Refresh switch for scenarios where adding an enclosure results in a warning or critical error when a BL server cannot be managed due to an existing _HPOneViewAdmin account that cannot be reset or too many HP SSO Certificates are configured (iLO supports no more than 5) and you have manually cleared the HP SSO list and/or removed the _HPOneViewAdmin account.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the enclosure to fix configuration issues.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Refresh, Reapply"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Enclosure] Provide the Enclosure name or Object, or [System.Collections.ArrayList] of names or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Refresh, Reapply"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>When an Enclosure is in an Error state where the Primary Onboard Administrator IP Address changed, or the HPE OneView managed configuration is no longer present, you will need to provide the IP Address or FQDN of one of the Onboard Administrators in the target enclosure. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the Username of an Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an error state and the HPE OneView managed configuration is no longer present. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an error state and the HPE OneView managed configuration is no longer present. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh, Reapply"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Reapply the Enclosure Configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Refresh, Reapply"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Enclosure] Provide the Enclosure name or Object, or [System.Collections.ArrayList] of names or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Refresh, Reapply"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh, Reapply"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Refresh, Reapply" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh, Reapply" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>When an Enclosure is in an Error state where the Primary Onboard Administrator IP Address changed, or the HPE OneView managed configuration is no longer present, you will need to provide the IP Address or FQDN of one of the Onboard Administrators in the target enclosure. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Refresh, Reapply" aliases="Enclosure"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Aliases [-Enclosure] Provide the Enclosure name or Object, or [System.Collections.ArrayList] of names or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Provide the password of the Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an error state and the HPE OneView managed configuration is no longer present. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Reapply the Enclosure Configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Refresh the enclosure to fix configuration issues.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Provide the Username of an Onboard Administrator administrator account to re-apply the configuration if the enclosure is in an error state and the HPE OneView managed configuration is no longer present. You will be prompted for this value if needed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Single Enclosure resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Multiple Enclosure resources</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process</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>Get-HPOVEnclosure | Update-HPOVEnclosure -Refresh</dev:code> <dev:remarks> <dev:para>Refresh all available enclosures, from all connected sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh</dev:code> <dev:remarks> <dev:para>Refresh "Enclosure1" enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$TaskResourceToMonitor = Get-HPOVEnclosure -Name Enclosure1 | Update-HPOVEnclosure -Refresh -Hostname UpdatedOAFQDN.domain.local -Username Administrator -Password MyOAPassw0rd -Async</dev:code> <dev:remarks> <dev:para>Refresh "Enclosure1" enclosure, supplying the updated OA FQDN and administrator credentials</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPOVEnclosureDevice</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureActiveFLM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVEnclosureGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVEXTERNALREPOSITORY--> <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"> <!--UPDATE-HPOVEXTERNALREPOSITORY--> <command:details> <command:name>Update-HPOVExternalRepository</command:name> <maml:description> <maml:para>Refresh an existing external baseline repository.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVExternalRepository</command:noun> </command:details> <maml:description> <maml:para>A firmware repository enables you to store firmware bundles and deploy them across your environment. An externally managed HTTP/HTTPS web server can be added to the appliance as a repository. It is a user-maintained HTTP/HTTPS web server. You can upload firmware bundles in a specific directory and then register the HTTP/HTTPS server with HPE OneView. This functionality is supported for Linux and Windows systems. The recommended types of external web servers to use with the repository follow: * Apache * Internet Information Services (IIS) NOTE: Only one external repository can be added. This Cmdlet supports refreshing an existing external repository. Use this Cmdlet to refresh the details(advertized repo size) and contents of an external repository.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVExternalRepository</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVExternalRepository</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the external repository object to refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.BaselineRepository [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>The external repository object from Get-HPOVBaselineRepository</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task for the caller to monitor.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async task resource objects.</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>Get-HPOVBaselineRepository -Name MyRepoName -ErrorAction Stop | Update-HPOVExternalRepository</dev:code> <dev:remarks> <dev:para>Refresh an existing external repository.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>New-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVExternalRepository</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVLOGICALENCLOSURE--> <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"> <!--UPDATE-HPOVLOGICALENCLOSURE--> <command:details> <command:name>Update-HPOVLogicalEnclosure</command:name> <maml:description> <maml:para>Update or Refresh a Logical Enclosure.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVLogicalEnclosure</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will update or refresh a Logical Enclosure. A Refresh will instruct HPE OneView to go inventory the enclosure and update any missing management configurations. An Update will perform Logical Enclosure compliance remediation with the parent Enclosure Group. Use the -Refresh switch for scenarios where adding an enclosure results in a warning or critical error when a BL server cannot be managed due to an existing _HPOneViewAdmin account that cannot be reset or too many HP SSO Certificates are configured (iLO supports no more than 5) and you have manually cleared the HP SSO list and/or removed the _HPOneViewAdmin account.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Reapply the Enclosure Configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Reapply, Update"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Update"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVLogicalEnclosure</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Update"> <maml:name>Update</maml:name> <maml:description> <maml:para>Useing this switch will update the Logical Enclosure to be compliant with the Parent Enclosure Group. Can be combined with the -WhatIf parameter to perform a Compare with group and return object with differences.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Reapply, Update"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Update"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Update"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Update" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Update" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Reapply, Update" aliases="le, LogicalEnclosure"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Provide the Logical Enclosure name, URI or Object, or [System.Collections.ArrayList ] of names, URIs or Objects to refresh/update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Reapply the Enclosure Configuration.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Update" aliases="UpdateFromGroup"> <maml:name>Update</maml:name> <maml:description> <maml:para>Useing this switch will update the Logical Enclosure to be compliant with the Parent Enclosure Group. Can be combined with the -WhatIf parameter to perform a Compare with group and return object with differences.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.LogicalEnclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Logical Enclosure resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList</maml:name> </dev:type> <maml:description> <maml:para>Multiple Logical Enclosure resources</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Library.CompareObject</maml:name> </dev:type> <maml:description> <maml:para>The Cmdlet will return a compare object with the Parent and Child object and settings that are different. Otherwise, no object is returned. Property Name | Description ========================================================== InputObject | Compared Object Property or Setting Value ---------------------------------------------------------- ParentSetting | Name of Property or Setting ---------------------------------------------------------- ChildSetting | Name of Property or Setting ---------------------------------------------------------- Parent | Name of Parent Object ---------------------------------------------------------- Child | Name of Child Object ---------------------------------------------------------- Description | Description Name of difference ----------------------------------------------------------</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring the enclosure import process</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>Get-HPOVLogicalEnclosure | Update-HPOVLogicalEnclosure -Refresh</dev:code> <dev:remarks> <dev:para>Refresh all available Logical Enclosures, for the default connected session.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalEnclosure -ApplianceConnect $ConnectedSessions | Update-HPOVLogicalEnclosure -Update</dev:code> <dev:remarks> <dev:para>Refresh all available Logical Enclosures, for the all connected sessions.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalEnclosure -Name LogicalEnclosure1 | Update-HPOVLogicalEnclosure -Refresh</dev:code> <dev:remarks> <dev:para>Refresh "LogicalEnclosure1" Logical Enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalEnclosure -Name Encl1 | Update-HPOVLogicalEnclosure -Update -WhatIf What if: Performing the operation "Update Logical Enclosure configuration. WARNING: Depending on this action, there might be a brief outage." on target "Encl1". InputObject SideIndicator ParentSetting ChildSetting Parent Child Description ----------- ------------- ------------- ------------ ------ ----- ----------- macRefreshInterval <=> 7 5 Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enablePauseFloodProtection <=> False True Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enableRichTLV <=> True False Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enableTaggedLldp <=> True False Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH ActiveQosConfig <= CustomWithFCoE Passthrough Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH Uplink Set 2 <= Heartbeat Default VC FF LIG Encl1-Default VC FF LIG MISSING_NETWORK FC Fabric B => Bay2:X8 Default VC FF LIG Encl1-Default VC FF LIG ADDITIONAL_UPLINKPORT FC Fabric B:Bay2:X7 <=> Auto 2Gb Default VC FF LIG Encl1-Default VC FF LIG LINKSPEED_MISMATCH UplinkSets <= New Uplink Set Default VC FF LIG Encl1-Default VC FF LIG MISSING_UPLINKSET InternalNetworks => Heartbeat Default VC FF LIG Encl1-Default VC FF LIG EXTRA_NETWORK InternalNetworks <= Dev VLAN 103-A Default VC FF LIG Encl1-Default VC FF LIG MISSING_NETWORK</dev:code> <dev:remarks> <dev:para>Refresh "LogicalEnclosure1" Logical Enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVLogicalEnclosure</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVLogicalEnclosureFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVLOGICALENCLOSUREFIRMWARE--> <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"> <!--UPDATE-HPOVLOGICALENCLOSUREFIRMWARE--> <command:details> <command:name>Update-HPOVLogicalEnclosureFirmware</command:name> <maml:description> <maml:para>Initiate Logical Enclosure Firmware update.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVLogicalEnclosureFirmware</command:noun> </command:details> <maml:description> <maml:para>You can update firmware from a logical enclosure for shared infrastructure, shared infrastructure and profiles, and OA (Onboard Administrators) only, if any. When you update the firmware for an enclosure associated with a logical enclosure, the firmware baseline configured for the logical enclosure sets the baseline on the enclosure and each of the logical interconnects in the enclosure, as well as the OA. Firmware is updated in the following order: * Onboard Administrators * Logical interconnects * Server hardware and their associated server profiles The Orchestrated activation option allows nondisruptive updates of interconnects in a production ready, properly configured, and redundant environment. Orchestrated firmware updates do not affect the network traffic and no outages are caused while the update process is in progress as one virtual connect module is always forwarding network traffic, with no or minimal impact to application network connection. A default delay of 8 minutes is set between activating or rebooting interconnect modules. Hypervisor clusters are updated nondisruptively when the orchestrated activation option is chosen. If the logical enclosure contains one or more hypervisor profiles, each hypervisor is serially placed into a maintenance mode before updating. It can take up to 90 minutes to place a hypervisor into the maintenance mode, perform the firmware update, and take it back out of the maintenance mode. Parallel activation activates all the interconnect modules at the same time, resulting in disruption of the network and storage connectivity. It is recommended to perform parallel activation during a maintenance window when you can better coordinate the downtime. When selecting "SharedInfrastructureAndServerProfiles" firmware update process, any servers without profiles will perform an automated offline firmware update. Assigned Server Profiles will require HPE Smart Update Tools (HPSUT, iSUT) to be installed and available. Minimum required privileges: Infrastructure administrator or Server administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVLogicalEnclosureFirmware</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.LogicalEnclosure from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>The firmware bundle or baseline to install.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.Baseline</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>FirmwareUpdateProcess</maml:name> <maml:description> <maml:para>Specify the type of firmware update to invoke. Allowed values: * EnclosureOnly - Will only upgrade enclosure or frame components (c-Class Onboard Administrator, Synergy Frame Link Module) * SharedInfrastructureOnly * SharedInfrastructureAndServerProfiles</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>InterconnectActivationMode</maml:name> <maml:description> <maml:para>Specify the logical interconnect activation mode. Choosing "Parallel" is the fastest update operation but will require downtime and servers to be powered off. Allowed values: * Orchestrated * Parallel Default: Orchestrated</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>ForceInstallation</maml:name> <maml:description> <maml:para>Force the re-installation or downgrade of components within the baseline.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>The firmware bundle or baseline to install.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Appliance.Baseline</command:parameterValue> <dev:type> <maml:name>HPOneView.Appliance.Baseline</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>FirmwareUpdateProcess</maml:name> <maml:description> <maml:para>Specify the type of firmware update to invoke. Allowed values: * EnclosureOnly - Will only upgrade enclosure or frame components (c-Class Onboard Administrator, Synergy Frame Link Module) * SharedInfrastructureOnly * SharedInfrastructureAndServerProfiles</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>ForceInstallation</maml:name> <maml:description> <maml:para>Force the re-installation or downgrade of components within the baseline.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="le, LogicalEnclosure"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.LogicalEnclosure from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>InterconnectActivationMode</maml:name> <maml:description> <maml:para>Specify the logical interconnect activation mode. Choosing "Parallel" is the fastest update operation but will require downtime and servers to be powered off. Allowed values: * Orchestrated * Parallel Default: Orchestrated</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.LogicalEnclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical enclosure resource from Get-HPOVLogicalEnclosure.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>$Basline = Get-HPOVBaseline -Name "HPE Service Pack for ProLiant" -ErrorAction Stop Get-HPOVLogicalEnclosure -Name Encl1 -ErrorAction Stop | Update-HPOVLogicalEnclosureFirmware -Baseline $Basline -FirmwareUpdateProcess SharedInfrastructureOnly</dev:code> <dev:remarks> <dev:para>Get the specified baseline, and update the specified logical enclosure's shared infrastructure only.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVLOGICALINTERCONNECT--> <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"> <!--UPDATE-HPOVLOGICALINTERCONNECT--> <command:details> <command:name>Update-HPOVLogicalInterconnect</command:name> <maml:description> <maml:para>Updates a Logical Interconnect.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVLogicalInterconnect</command:noun> </command:details> <maml:description> <maml:para>When a Logical Interconnect is inconsistent with its parent Logical Interconnect Group, it can be made consistent with this Cmdlet. Updating the Logical Interconnect with its parent could cause an network outage depending on the changes about to be applied.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVLogicalInterconnect</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVLogicalInterconnect</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FactoryReset"> <maml:name>FactoryReset</maml:name> <maml:description> <maml:para>Use to factory reset the HPE Synergy Fabric module. Do know that an outage will happen while the fabric modules are reset. Their configuration will need to be re-applied or deployed after task has completed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVLogicalInterconnect</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Switch to reapply the Logical Interconnect configuration. This does NOT update the Logical Interconnect from the parent Logical Interconnect Group.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FactoryReset, Reapply, default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="FactoryReset, Reapply, default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="FactoryReset" aliases="None"> <maml:name>FactoryReset</maml:name> <maml:description> <maml:para>Use to factory reset the HPE Synergy Fabric module. Do know that an outage will happen while the fabric modules are reset. Their configuration will need to be re-applied or deployed after task has completed.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="FactoryReset, Reapply, default" aliases="uri, li, name, Resource"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Interconnect object(s), name(s) or uris(s) to be updated.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Switch to reapply the Logical Interconnect configuration. This does NOT update the Logical Interconnect from the parent Logical Interconnect Group.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalInterconnect [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Logical Interconnect resource object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Networking.LogicalInterconnect></maml:name> </dev:type> <maml:description> <maml:para>Collection of Logical Interconnect Names, URIs or System.Management.Automation.PSCustomObject</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single async Update Task</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple async Update Tasks</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Library.CompareObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Cmdlet will return a compare object with the Parent and Child object and settings that are different. Otherwise, no object is returned. Property Name | Description ========================================================== InputObject | Compared Object Property or Setting Value ---------------------------------------------------------- ParentSetting | Name of Property or Setting ---------------------------------------------------------- ChildSetting | Name of Property or Setting ---------------------------------------------------------- Parent | Name of Parent Object ---------------------------------------------------------- Child | Name of Child Object ---------------------------------------------------------- Description | Description Name of difference ----------------------------------------------------------</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>$task = Update-HPOVLogicalInterconnect -name Encl1-LI Wait-HPOVTaskComplete $task </dev:code> <dev:remarks> <dev:para>Perform an update of the Encl1-LI Logical Interconnect. Will be prompted for confirmation.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$task = Update-HPOVLogicalInterconnect -name Encl1-LI -confirm:$false | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Perform an update of the Encl1-LI Logical Interconnect. Disable confirmation prompt.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect | Update-HPOVLogicalInterconnect</dev:code> <dev:remarks> <dev:para>Search for all Logical Interconnects and update them.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalInterconnect -Name Encl1-Default VC FF LIG | Update-HPOVLogicalInterconnect -WhatIf What if: Performing the operation "Update Logical Interconnect from Group "Default VC FF LIG". WARNING: Depending on the Update, there might be a brief outage." on target "Encl1-Default VC FF LIG". InputObject SideIndicator ParentSetting ChildSetting Parent Child Description ----------- ------------- ------------- ------------ ------ ----- ----------- macRefreshInterval <=> 7 5 Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enablePauseFloodProtection <=> False True Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enableRichTLV <=> True False Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH enableTaggedLldp <=> True False Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH ActiveQosConfig <= CustomWithFCoE Passthrough Default VC FF LIG Encl1-Default VC FF LIG SETTING_MISMATCH Uplink Set 2 <= Heartbeat Default VC FF LIG Encl1-Default VC FF LIG MISSING_NETWORK FC Fabric B => Bay2:X8 Default VC FF LIG Encl1-Default VC FF LIG ADDITIONAL_UPLINKPORT FC Fabric B:Bay2:X7 <=> Auto 2Gb Default VC FF LIG Encl1-Default VC FF LIG LINKSPEED_MISMATCH UplinkSets <= New Uplink Set Default VC FF LIG Encl1-Default VC FF LIG MISSING_UPLINKSET InternalNetworks => Heartbeat Default VC FF LIG Encl1-Default VC FF LIG EXTRA_NETWORK InternalNetworks <= Dev VLAN 103-A Default VC FF LIG Encl1-Default VC FF LIG MISSING_NETWORK</dev:code> <dev:remarks> <dev:para>Refresh "LogicalEnclosure1" Logical Enclosure.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Disable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnect</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalInterconnectPortMonitoring</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPOVLogicalInterconnectFirmware</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalInterconnectGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVLogicalInterconnectMacTable</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVLOGICALSWITCH--> <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"> <!--UPDATE-HPOVLOGICALSWITCH--> <command:details> <command:name>Update-HPOVLogicalSwitch</command:name> <maml:description> <maml:para>Refresh a new Logical Switch resource.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVLogicalSwitch</command:noun> </command:details> <maml:description> <maml:para>A logical switch is based on a logical switch group configuration. If the logical switch transitions to an "Inconsistent with group state", due to changes in either the logical switch or the logical switch group, this Cmdlet will update (or refresh) the logical switch configuration based on the logical switch group and return to a consistent state. Minimum required privileges: Infrastructure administrator or Network administrator</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVLogicalSwitch</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="LS, LogicalSwitch"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Logical Switch resource Name or Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Networking.LogicalSwitch [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Logical Switch resource.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The async task resource object to monitor (if -Async was used) or results.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Update Logical Switch async task resources.</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>Get-HPOVLogicalSwitch | Update-HPOVLogicalSwitch</dev:code> <dev:remarks> <dev:para>Update all logical switch resources found on the default appliance connection.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Update-HPOVLogicalSwitch -confirm:$false</dev:code> <dev:remarks> <dev:para>Update the "My Logical Switch 1" resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitch</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVLogicalSwitchGroup</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVRACKMANAGER--> <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"> <!--UPDATE-HPOVRACKMANAGER--> <command:details> <command:name>Update-HPOVRackManager</command:name> <maml:description> <maml:para>Refresh or reconnect a rack manager resource.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVRackManager</command:noun> </command:details> <maml:description> <maml:para>A rack manager platform is a multinode system. The nodes are housed within a rack or across racks, and are centrally managed by a management controller. The Rack Managers screen enables you to manage and visualize the physical location of rack manager platforms within a rack. This Cmdlet will perform a refresh of the claimed rack manager. If there is a communication issue, the -Hostname and -Crednetial parameters will need to be provided, which will then re-establish communication to the rack manager. Minimum required privileges: Infrastructure administrator or Server administrator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVRackManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Servers.RackManager resource to refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Servers.RackManager[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>****WARNING**** Please use with caution. Using this parameter will force delete a resource for any reason and cannot be undone. Force update the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVRackManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Servers.RackManager resource to refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Servers.RackManager[]</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The FQDN or IP Address of the rack manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Force</maml:name> <maml:description> <maml:para>****WARNING**** Please use with caution. Using this parameter will force delete a resource for any reason and cannot be undone. Force update the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVRackManager</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Array</command:parameterValue> <dev:type> <maml:name>Array</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Use this parameter if you want to provide a PSCredential object instead.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>****WARNING**** Please use with caution. Using this parameter will force delete a resource for any reason and cannot be undone. Force update the resource.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>The FQDN or IP Address of the rack manager.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default" aliases="name, Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The HPOneView.Servers.RackManager resource to refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Servers.RackManager[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Servers.RackManager[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Servers.RackManager</maml:name> </dev:type> <maml:description> <maml:para>The rack manager resource from Get-HPOVRackManager.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</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>Get-HPOVRackManager -Name rackmanager1.domain.com -ErrorAction Stop | Update-HPOVRackManager</dev:code> <dev:remarks> <dev:para>Refresh the specified rack manager resource.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$RackManager = Get-HPOVRackManager -Name rackmanager1.domain.com -ErrorAction Stop $Credential = Get-Credential Administrator -Message "Password" $RefreshParams = @{ InputObject = $RackManager} # Check the rack manager for its state and refresh state reason if ($RackManager.State -eq 'Unmanaged' -and $RackManager.RefreshState -eq 'RefreshFailed') { # Add the "Credential" parameter to the Hashtable splat $RackManager.Add("Credential", $Credential) # Add the Hostname to the Hashtable splat $RackManager.Add("Hostname", $RackManager.SubResources.Managers[0].Hostname) } Update-HPOVRackManager @RefreshParams</dev:code> <dev:remarks> <dev:para>Refresh the specified rack manager resource, and provide the credentials to restablish.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVRackManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVREMOTESUPPORTENTITLEMENT--> <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"> <!--UPDATE-HPOVREMOTESUPPORTENTITLEMENT--> <command:details> <command:name>Update-HPOVRemoteSupportEntitlement</command:name> <maml:description> <maml:para>Refresh Remote Support entitlement for a supported resource.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVRemoteSupportEntitlement</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will initiate a refresh of the Remote Support entitlement for a compute or enclosure resource. If remote support has not been globally enabled and configured on the appliance, this Cmdlet will fail.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVRemoteSupportEntitlement</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="default" aliases="None"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The compute or enclosure resource to enable Remote Support for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Enclosure [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A Gen8 or newer generation server hardware resource object from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for monitoring.</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>Get-HPOVServer -Name Prod* | Update-HPOVRemoteSupportEntitlement</dev:code> <dev:remarks> <dev:para>Get the servers with their name matching "Prod" and refresh their Remote Support entitlement.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Enclosure = Get-HPOVEnclosure -Name Enclosure-1A Update-HPOVRemoteSupportEntitlement -InputObject $Enclusre</dev:code> <dev:remarks> <dev:para>Get the specific enclosure resource and refresh Remote Support entitlement.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVRemoteSupportEntitlementStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSANMANAGER--> <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"> <!--UPDATE-HPOVSANMANAGER--> <command:details> <command:name>Update-HPOVSanManager</command:name> <maml:description> <maml:para>Refresh SAN Manager and it"s configuration.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVSanManager</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet is used to refresh a SAN Managers configuration. You can provide the Name or Object of a single or multiple SAN Managers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVSanManager</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="1" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="Name, SANManager"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Managed SAN Object to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.SanManager [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>SAN Manager resource object from Get-HPOVSanManager</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.SanManager></maml:name> </dev:type> <maml:description> <maml:para>Multiple SAN Manager resource objects from Get-HPOVSanManager</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async Task to update SAN Manager</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Single or Multiple Resources</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>Get-HPOVSanManager -name bna.contoso.com | Update-HPOVSanManager | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Refreshes the SAN Manager.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVSanManager | Update-HPOVSanManager | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Refreshes all SAN Managers on the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVSanManager</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSERVER--> <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"> <!--UPDATE-HPOVSERVER--> <command:details> <command:name>Update-HPOVServer</command:name> <maml:description> <maml:para>Refresh the state of a server resource.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVServer</command:noun> </command:details> <maml:description> <maml:para>By using this Cmdlet, you can manually refresh the connection between the appliance and server hardware by using the Refresh option on the Actions menu. You must refresh server hardware if it has lost connectivity or if it is not synchronized with the appliance. Connectivity loss can occur during normal appliance operation. A device can become unsynchronized if you make changes to it outside of the appliance</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server object or Name, or can be a Server Profile object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVServer</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server object or Name, or can be a Server Profile object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object instead of the Username and Password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>When a server hardware resource is in an Error state where the iLO IP Address or FQDN has changed, or the HPE OneView managed configuration is no longer present, you will need to provide the IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials"> <maml:name>Force</maml:name> <maml:description> <maml:para>If the target server resource is repoting to be claimed by another external manager, use this parameter to force claim from the connected appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVServer</maml:name> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="DefRefreshWithCredentialsault, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Provide a PSCredential object instead of the Username and Password.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials" aliases="None"> <maml:name>Force</maml:name> <maml:description> <maml:para>If the target server resource is repoting to be claimed by another external manager, use this parameter to force claim from the connected appliance.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="RefreshWithCredentials" aliases="None"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>When a server hardware resource is in an Error state where the iLO IP Address or FQDN has changed, or the HPE OneView managed configuration is no longer present, you will need to provide the IP Address or FQDN.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="RefreshWithCredentials, Default" aliases="name, Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Server object or Name, or can be a Server Profile object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Server Hardware Resource</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para>Server Profile Resource</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task that tracks the server refresh request</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>Get-HPOVServer "Encl1, Bay 1" | Update-HPOVServer | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Refresh the state of the provided server hardware device.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$task = Get-HPOVServerProfile "Profile1" | Update-HPOVServer</dev:code> <dev:remarks> <dev:para>Refresh the state of the server hardware device assigned to the Server Profile object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerHardwareType</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerPower</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPOVServer</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerHardwareLicenseIntent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVServerOneTimeBoot</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSERVERHARDWARELICENSEINTENT--> <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"> <!--UPDATE-HPOVSERVERHARDWARELICENSEINTENT--> <command:details> <command:name>Update-HPOVServerHardwareLicenseIntent</command:name> <maml:description> <maml:para>Change the license intent of a server.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVServerHardwareLicenseIntent</command:noun> </command:details> <maml:description> <maml:para>The licensing intent of a server may be changed to either "OneView" (HPE OneView Advanced) or "OneViewNoiLO" (HPE OneView Advanced w/o iLO). The server must be unlicensed and managed in order to be able to update the licensing intent. In addition, a server licensed with "OneViewNoiLO" may be upgraded to "OneView", provided a "OneView" license is available and the server does not already have an embedded or "iLO Advanced" license installed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVServerHardwareLicenseIntent</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A server hardware resource from Get-HPOVServer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="name, Server"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A server hardware resource from Get-HPOVServer.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>A server hardware resource from Get-HPOVServer.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object for configuring port monitoring on the requested logical intercinnect.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>null</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If the resource is already assigned a valid upgraded license, a null response is returned.</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>$Server = Get-HPOVServer -Name iLO123.domain.com -ErrorAction Stop Update-HPOVServerHardwareLicenseIntent -InputObject $Server</dev:code> <dev:remarks> <dev:para>Get the specific server resource, and attempt upgrading the license to "OneView".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$Servers = Get-HPOVServer | ? licensingIntent -eq "OneViewNoIlo" $Tasks = $Servers | Update-HPOVServerHardwareLicenseIntent -async</dev:code> <dev:remarks> <dev:para>Get server resources with "OneViewNoIlo" license, and attempt upgrading the license to "OneView".</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSERVERPROFILE--> <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"> <!--UPDATE-HPOVSERVERPROFILE--> <command:details> <command:name>Update-HPOVServerProfile</command:name> <maml:description> <maml:para>Update Server Profile from Template</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVServerProfile</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet performs one of two different operations. By default, it will perform the "Update from Server Profile Template" operation on 1 or more Server Profile resources. You can use Update from template to update the configuration of the server profile to make it consistent with its parent server profile template. To bring an inconsistent (Inconsistent with template) server profile configuration back into consistency (Consistent) with the server profile template, you must reapply the settings from the server profile template either manually or automatically. Some server profile updates can be automatically performed when the server hardware is powered on and some updates can only be performed when the server hardware is powered off. You can now defer the automatic updates until the next hardware maintenance window or cancel them if you do not want to proceed with the updates. If a Server Profile is already in a "Compliant" state, then no action will be taken The second operation is Reapply, using the -Reapply parameter. You can reapply a server profile to resolve errors or to ensure that the server hardware configuration matches the server profile. To reduce the time required to reapply a profile, individual components can be omitted from the reapply operation by clearing those components by omitting their switch parameter. Profiles that are in an error state can be reapplied, but individual components cannot be omitted. Minimum required permissions: (Update from Template) Infrastructure administrator or Server administrator. (Reapply a server profile) Infrastructure administrator, Server administrator, or Server firmware operator.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Refresh, Reapply"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource Object of the specific Server Profile to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default"> <maml:name>Stage</maml:name> <maml:description> <maml:para>If a setting requires the server tobe powered off, certain updates can be staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Refresh, Reapply"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource Object of the specific Server Profile to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Choose to refresh the server profile state. This does not perform re-apply or update from template operation.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-HPOVServerProfile</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Refresh, Reapply"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource Object of the specific Server Profile to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Use to perform the Reapply Server Profile operation. Server should be powered off to perform certain operations.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Re-apply Baseline. If setting is Firmware only, the associated server hardware must be powered off.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>AdapterAndBoot</maml:name> <maml:description> <maml:para>Re-apply Boot settings, including adapter boot preference.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Connections</maml:name> <maml:description> <maml:para>Re-apply Vitual Connect connections. Will re-provision downlink ports and connection templates for the provided server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Re-apply Local Storage settings. This will cause the SmartArray to rescan for disks that should be part of the configured Logical Disk. Server Hardware must be powered off in order for operation to be successful.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Re-apply SAN storage settings. Only applies to SAN zoning and volume presentation, and not recreating SAN volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>BIOS</maml:name> <maml:description> <maml:para>Re-apply BIOS settings. Gen8 server hardware must be powered off for this operation to be allowed. Gen9 and newer can be performed while the server hardware is powered on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>Ilo</maml:name> <maml:description> <maml:para>Re-apply iLO settings that are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply"> <maml:name>OSDeployment</maml:name> <maml:description> <maml:para>Re-apply OS Deployment Plan settings.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Refresh, Default"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>AdapterAndBoot</maml:name> <maml:description> <maml:para>Re-apply Boot settings, including adapter boot preference.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Reapply, Refresh, Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply, Refresh, Default" aliases="None"> <maml:name>Async</maml:name> <maml:description> <maml:para>Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>BIOS</maml:name> <maml:description> <maml:para>Re-apply BIOS settings. Gen8 server hardware must be powered off for this operation to be allowed. Gen9 and newer can be performed while the server hardware is powered on.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Re-apply Baseline. If setting is Firmware only, the associated server hardware must be powered off.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Connections</maml:name> <maml:description> <maml:para>Re-apply Vitual Connect connections. Will re-provision downlink ports and connection templates for the provided server profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Ilo</maml:name> <maml:description> <maml:para>Re-apply iLO settings that are defined in the profile.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default, Refresh, Reapply" aliases="profile, ServerProfile"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Name or Resource Object of the specific Server Profile to update.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>LocalStorage</maml:name> <maml:description> <maml:para>Re-apply Local Storage settings. This will cause the SmartArray to rescan for disks that should be part of the configured Logical Disk. Server Hardware must be powered off in order for operation to be successful.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>OSDeployment</maml:name> <maml:description> <maml:para>Re-apply OS Deployment Plan settings.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>Reapply</maml:name> <maml:description> <maml:para>Use to perform the Reapply Server Profile operation. Server should be powered off to perform certain operations.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="Refresh" aliases="None"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Choose to refresh the server profile state. This does not perform re-apply or update from template operation.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Reapply" aliases="None"> <maml:name>SANStorage</maml:name> <maml:description> <maml:para>Re-apply SAN storage settings. Only applies to SAN zoning and volume presentation, and not recreating SAN volumes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="Default" aliases="None"> <maml:name>Stage</maml:name> <maml:description> <maml:para>If a setting requires the server tobe powered off, certain updates can be staged.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="False" variableLength="False" /> <dev:type> <maml:name /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.ServerProfile [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>One or more Server Profile resources from Get-HPOVServerProfile.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.ServerProfile.CompliancePreview</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object containing the operations to be performed when the Server Profile object is not compliant.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Async task Resource object to monitoring.</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>Get-HPOVServerProfile -Name "My Profile 1" | Update-HPOVServerProfile</dev:code> <dev:remarks> <dev:para>Get all storage system resource objects managed by the appliance.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVServerProfile | Update-HPOVServerProfile</dev:code> <dev:remarks> <dev:para>Get all Server Profile resources and perform the Update from Server Profile Template action.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Convert-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileConnectionList</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileMessage</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Join-HPOVServerProfileToTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAssign</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileAttachVolume</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileConnection</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileLogicalDiskController</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-HPOVServerProfileTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSTORAGEPOOL--> <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"> <!--UPDATE-HPOVSTORAGEPOOL--> <command:details> <command:name>Update-HPOVStoragePool</command:name> <maml:description> <maml:para>Refresh a storage pool.</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVStoragePool</command:noun> </command:details> <maml:description> <maml:para>Use this Cmdlet to refresh a storage pool when it's associated policies have been updated within the storage system external management console. Can be used to collect new Nimble Volume Sets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVStoragePool</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The storage pool object to update or refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.StoragePool[]</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name, StoragePool"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The storage pool object to update or refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">HPOneView.Storage.StoragePool[]</command:parameterValue> <dev:type> <maml:name>HPOneView.Storage.StoragePool[]</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.StoragePool</maml:name> </dev:type> <maml:description> <maml:para>One or more storage pool resources from Get-HPOVStoragePool.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Asynchronous task resource to monitor.</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>Get-HPOVStoragePool -Name default | Update-HPOVStoragePool</dev:code> <dev:remarks> <dev:para>Update the Nimble storage pool 'default' to refresh available policies.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPOVStoragePool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--UPDATE-HPOVSTORAGESYSTEM--> <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"> <!--UPDATE-HPOVSTORAGESYSTEM--> <command:details> <command:name>Update-HPOVStorageSystem</command:name> <maml:description> <maml:para>Update/Refresh available Storage Systems</maml:para> </maml:description> <command:verb>Update</command:verb> <command:noun>HPOVStorageSystem</command:noun> </command:details> <maml:description> <maml:para>This Cmdlet will update or refresh the specific storage system(s) configured on the HPE OneView appliance. Refreshing the storage system will cause HPE OneView to validate connectivity, the addition of any new CPG"s, and any Storage System Host Port configuration changes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Update-HPOVStorageSystem</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Storage System resource object to update/refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="Default" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="Default" aliases="Name, StorageSystem"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Storage System resource object to update/refresh.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Storage.System [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Single Storage System</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Storage.System></maml:name> </dev:type> <maml:description> <maml:para>Multiple Storage Systems</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Update Storage System async task object</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.ArrayList <HPOneView.Appliance.TaskResource></maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Multiple Update Storage System async task objects</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>Get-HPOVStorageSystem | Update-HPOVStorageSystem</dev:code> <dev:remarks> <dev:para>Get all managed Storage Systems and refresh them.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>Get-HPOVStorageSystem -Name MyStorageSystem | Update-HPOVStorageSystem</dev:code> <dev:remarks> <dev:para>Get the "MyStorageSystem" managed Storage Systems and refresh it.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Add-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPOVStorageSystem</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-HPOVStorageSystemPerformancePolicy</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--WAIT-HPOVAPPLIANCESTART--> <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"> <!--WAIT-HPOVAPPLIANCESTART--> <command:details> <command:name>Wait-HPOVApplianceStart</command:name> <maml:description> <maml:para>Wait for Appliance services to start.</maml:para> </maml:description> <command:verb>Wait</command:verb> <command:noun>HPOVApplianceStart</command:noun> </command:details> <maml:description> <maml:para>Internal module helper function to wait for the appliance services to start. This helper function will be called by Send-HPOVRequest when the [System.Net.WebRequest] GetResponse() client generates an [Net.WebException] exception. Then, this function will be called to provide the caller with an indication that the appliance is starting its services. This will display two prompts: 1. An initial text-based progress bar while the System.Net.WebRequest is able to access the web service on the appliance to begin polling for service startup status. 2. Write-Progress indicator displaying the overall service startup. If any service fails to startup, this function will cause a terminating error, informing the caller to go visit the appliance kiosk console to get more information about the startup error. When the appliance successfully starts, this function will return.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Wait-HPOVApplianceStart</maml:name> <command:parameter required="True" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specify the appliance FQDN or IP Address without a valid connection created by using Connect-HPOVMgmt.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="True" globbing="False" pipelineInput="false" position="0" parameterSetName="(All)" aliases="Appliance"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Specify the appliance FQDN or IP Address without a valid connection created by using Connect-HPOVMgmt.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>None. You cannot pipe objects to this Cmdlet.</maml:name> </dev:type> <maml:description> <maml:para> None. You cannot pipe objects to this Cmdlet </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>Write-Progress</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Write-Progress Cmdlet is used to display the startup progress</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>Wait-HPOVApplianceStart -Appliance appliance.contoso.com</dev:code> <dev:remarks> <dev:para>Wait for the appliance to start, and specify the appliance name.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--WAIT-HPOVTASKCOMPLETE--> <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"> <!--WAIT-HPOVTASKCOMPLETE--> <command:details> <command:name>Wait-HPOVTaskComplete</command:name> <maml:description> <maml:para>Wait for a task to complete.</maml:para> </maml:description> <command:verb>Wait</command:verb> <command:noun>HPOVTaskComplete</command:noun> </command:details> <maml:description> <maml:para>HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asyncrounously. An async task resource object is created and returned to the caller once the request has passed validation. This blocking Cmdlet assists a caller with monitoring a specific task resource, and will wait for the given task to "complete" (get to a terminal state, including error) or timeout. The Cmdlet accepts either the task URI or resource object via pipeline. Once the task is no longer in a running state, the cmlet will return the task resource object. The caller should examine the taskState property/key for the final task status.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Wait-HPOVTaskComplete</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The uri of the task resource to wait for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timespan to wait for the task to complete. Default is to wait for 20 minutes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>ApplianceWillReboot</maml:name> <maml:description> <maml:para>Internal use: to indicate if a task will cause appliance to reboot.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="2" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)" aliases="None"> <maml:name>ApplianceWillReboot</maml:name> <maml:description> <maml:para>Internal use: to indicate if a task will cause appliance to reboot.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="TaskUri, Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The uri of the task resource to wait for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timespan to wait for the task to complete. Default is to wait for 20 minutes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> </dev:type> <dev:defaultValue>$DefaultTimeout</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Task URI</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Task resource object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The finished Task object that includes the task result</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>Wait-HPOVTaskComplete -InputObject $task -timeout (New-TimeSpan -minute 10) Waiting for task to complete..Task completed successfully!</dev:code> <dev:remarks> <dev:para>Wait for task to complete, modifying the default timeout to 10 minutes.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>$svr = Get-HPOVServer -Name "ServerA" $taskResults = New-HPOVServerProfile -name "Profile 1" -server $svr | Wait-HPOVTaskComplete</dev:code> <dev:remarks> <dev:para>Retrieve the server details for ServerA, create a Server Profile and pass via pipeline the task resource object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-HPOVTaskStart</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--WAIT-HPOVTASKSTART--> <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"> <!--WAIT-HPOVTASKSTART--> <command:details> <command:name>Wait-HPOVTaskStart</command:name> <maml:description> <maml:para>Wait for a task to start.</maml:para> </maml:description> <command:verb>Wait</command:verb> <command:noun>HPOVTaskStart</command:noun> </command:details> <maml:description> <maml:para>HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asyncrounously. An async task resource object is created and returned to the caller once the request has passed validation. This blocking Cmdlet assists a caller with waiting for the given task to "start" (get beyond validation phase) or timeout. Once the task enters the running state, the Cmdlet will return the task resource object. The caller could then use Wait-HPOVTaskComplete to further monitor the task progression.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Wait-HPOVTaskStart</maml:name> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="named" parameterSetName="(All)"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The object of the task resource to wait for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>resourceName</maml:name> <maml:description> <maml:para>Specify the associated ResourceName to the task in order to display in the Write-Progress -activity parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="named" parameterSetName="(All)"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The time or object to wait for the task to start. Default is to wait for 20 minutes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="named" parameterSetName="(All)"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="False" globbing="False" pipelineInput="true (ByPropertyName)" position="3" parameterSetName="(All)" aliases="Appliance"> <maml:name>ApplianceConnection</maml:name> <maml:description> <maml:para>Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue>(${Global:ConnectedSessions} | ? Default)</dev:defaultValue> </command:parameter> <command:parameter required="True" globbing="False" pipelineInput="true (ByValue)" position="0" parameterSetName="(All)" aliases="taskuri, task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The object of the task resource to wait for.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="False">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="2" parameterSetName="(All)" aliases="None"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The time or object to wait for the task to start. Default is to wait for 20 minutes.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> </dev:type> <dev:defaultValue>$script:defaultTimeout</dev:defaultValue> </command:parameter> <command:parameter required="False" globbing="False" pipelineInput="false" position="1" parameterSetName="(All)" aliases="None"> <maml:name>resourceName</maml:name> <maml:description> <maml:para>Specify the associated ResourceName to the task in order to display in the Write-Progress -activity parameter.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="False">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Input Types--> <command:inputType> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para>Task async object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Return Values--> <command:returnValue> <dev:type> <maml:name>HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Task async object</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>$Task = Add-HPOVServer -Hostname MyiLO.domain.com -Username Administrator -Password password | Wait-HPOVTaskStart</dev:code> <dev:remarks> <dev:para>Add a new Server Device to the appliance, wait for the Asynchronous task to enter Starting State, and save the task object.</dev:para> <dev:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <!--Related Links--> <maml:navigationLink> <maml:linkText>Get-HPOVTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wait-HPOVTaskComplete</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online: </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited on: 2020-09-29T18:09:40:85.853Z--> </helpItems> |